@poupe/vue
Version:
Vue component library for Poupe UI framework with theme customization and accessibility support
39 lines (38 loc) • 823 B
text/typescript
import { type MaybeRefOrGetter, type Ref } from "vue";
export interface RippleOptions {
/**
* Whether the ripple is bounded by the container
* @defaultValue `true`
*/
bounded?: boolean;
/**
* Ripple color (CSS color value)
* @defaultValue `'currentColor'`
*/
color?: string;
/**
* Disable ripple effect
* @defaultValue `false`
*/
disabled?: MaybeRefOrGetter<boolean>;
/**
* Duration in milliseconds
* @defaultValue `600`
*/
duration?: number;
/**
* Ripple opacity
* @defaultValue `0.12`
*/
opacity?: number;
}
export interface Ripple {
id: number;
size: number;
x: number;
y: number;
}
export declare function useRipple(elementReference: Ref<HTMLElement | undefined>, options?: RippleOptions): {
getRippleStyle: (ripple: Ripple) => Record<string, number | string>;
ripples: Ref<Ripple[]>;
};