Skip to content

Commit

Permalink
docs: update README to mention keyboard support
Browse files Browse the repository at this point in the history
  • Loading branch information
justintaddei committed Sep 11, 2024
1 parent 57ae59c commit 59e0de0
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center">
****<p align="center">
<img src="https://raw.githubusercontent.com/justintaddei/v-wave/assets/logo-small.png">
</p>

Expand Down Expand Up @@ -29,6 +29,7 @@ The material-ripple directive for Vue that actually works
- It works ([see for yourself](https://justintaddei.github.io/v-wave)).
- The wave appears on `pointerdown` instead of `pointerup`
_(you might think that's an obvious choice... but you'd be wrong)._
- The wave responds to keyboard events on keyboard-accessible elements (i.e. <kbd>Enter</kbd> and <kbd>Space</kbd> on `<button>`).
- There is a small delay before the ripple appears, during which the animation will be canceled if the user moves the pointer (e.g. scrolling on a mobile phone). This is similar to how native Android ripples work.
- Uses CSS transforms instead of `width` and `height`.
- Doesn't affect the appearance of the element you apply it to (won't explode when used on an element with `display: flex`).
Expand Down

0 comments on commit 59e0de0

Please sign in to comment.