use-wave/dist/types/options.d.ts

The material-ripple hook for React that actually works

interface IWaveOptions {
    /**
     * The `background-color` of the wave.
     *
     * @remarks
     * You can set this to `currentColor` to automatically use the text-color of the element.
     *
     * @default
     * 'currentColor'
     */
    color: string;
    /**
     * The opacity of the wave when it first appears.
     *
     * @default
     * 0.2
     */
    initialOpacity: number;
    /**
     * The opacity the wave should be when it has stopped moving.
     *
     * @default
     * 0.1
     */
    finalOpacity: number;
    /**
     * The duration of the wave animation in seconds.
     *
     * @default
     * 0.4
     */
    duration: number;
    /**
     * Any valid CSS `<timing-function>`
     *
     * @default
     * 'ease-out'
     */
    easing: string;
    /**
     * The delay, in milliseconds, during which the animation will be canceled if the user moves their figure/pointer (e.g. while scrolling).
     *
     * @note
     * The wave will not appear until after the delay, meaning a delay greater than 100ms can make the site feel sluggish.
     *
     * @default
     * 75
     */
    cancellationPeriod: number;
}
declare const DEFAULT_OPTIONS: IWaveOptions;
export { DEFAULT_OPTIONS, IWaveOptions };