use-wave
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-beta.6 • Public • Published

    use-wave

    The material-ripple hook for React that actually works

    Checks Issues NPM version Downloads License Language

    Why did I make this?

    Because every ripple hook/component I've tried to use in the past either didn't work, or was missing basic features.

    Also available for Vue: v-wave

    Here's what you can expect from this hook:

    • It works (see for yourself).
    • The wave appears on pointerdown instead of pointerup
      (you might think that's an obvious choice... but you'd be wrong).
    • 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 effect the appearance of the element you apply it to (won't explode when used on an element with display: flex).
    • Guesses the color of the wave automatically by default (using currentColor).
    • Works with fixed, absolute, relative, and statically positioned elements.
    • Will handle independent border-radii (e.g. border-radius: 5px 20px 15px 30px) perfectly fine.

    If you have a feature request or you found a bug, please open an issue!

    [ Live Demo ]

    Source code for the demo page can be found on the example branch.

    Install

    npm

    $ npm i use-wave

    or

    CDN

    <script src="https://unpkg.com/use-wave"></script>

    Usage

    import useWave from 'use-wave'
    
    function MyComponent() {
        const wave = useWave()
    
        return <button ref={wave}>Click me!</button>
    }

    It is possible to reuse a single wave for multiple elements

    import useWave from 'use-wave'
    
    function List() {
        const wave = useWave()
        const items = ['item 1', 'item 2', 'item 2']
    
        return (
            <>
                <a ref={wave} href="/">Home</a>
                <ul>
                    {items.map(item => <li ref={wave}>{item}</li>)}
                </ul>
            </>
        )
    }

    Options

    Usage with options

    useWave({
        color: 'red',
        startingOpacity: 0.5,
        easing: 'ease-in',
    })

    Global options

    // your/hooks/directory/use-custom-wave.js
    
    export const useCustomWave = (overrides = {}) => {
        const defaults = {color: 'red'} // your custom global options
        return useWave({...defaults, ...overrides})
    }

    Options Summary

    Name Type Default
    color string "currentColor"
    initialOpacity number 0.2
    finialOpacity number 0.1
    duration number 0.4
    easing string ease-out
    cancellationPeriod number 75

    Details

    color

    • type: string

    • default: "currentColor"

      The background-color of the wave.

    initialOpacity

    • type: number

    • default: 0.2

      The opacity of the wave when it first appears.

    finalOpacity

    • type: number

    • default: 0.1

      The opacity the wave should be when it has stopped moving.

    duration

    • type: number

    • default: 0.4

      The duration of the wave animation in seconds.

    easing

    • type: string

    • default: "ease-out"

      Any valid CSS <timing-function>

    cancellationPeriod

    • type: number

    • default: 75

      The delay, in milliseconds, during which the animation will be canceled by the user moving their figure/pointer (e.g. while scrolling on a mobile phone).

      Note:
      The wave will not appear until after the delay, meaning a delay greater than 100ms can make the site feel sluggish.

    License

    This project is distributed under the MIT License.

    The MIT License (MIT)

    Copyright (c) 2021 Justin Taddei

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i use-wave

    DownloadsWeekly Downloads

    14

    Version

    1.0.0-beta.6

    License

    MIT

    Unpacked Size

    29.2 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar