@hakit/components
Version:
A series of components to work with @hakit/core
20 lines • 1.12 kB
TypeScript
import { CSSProperties } from 'react';
export interface RipplesProps extends React.ComponentPropsWithoutRef<"div"> {
/** the animation duration of the ripple @default 600 */
duration?: number;
/** the color of the ripple, @default rgba(0, 0, 0, .3) */
color?: string;
/** click even to bind to the ripple, @default void */
onClick?: (ev: React.MouseEvent<HTMLDivElement>) => void;
/** the children of the ripple */
children: React.ReactNode;
/** the css border radius of the ripple, @default none */
borderRadius?: CSSProperties["borderRadius"];
/** disable the ripple */
disabled?: boolean;
/** prevent propagation on ripples */
preventPropagation?: boolean;
}
/** Ripples is a component that can easily add an interactive ripple effect when clicked, simply wrap your component in Ripples and you're good to go! If your component has a border radius, simply pass the same value as a prop to ripples to mask the effect */
export declare function Ripples(props: RipplesProps): import("@emotion/react/jsx-runtime").JSX.Element;
//# sourceMappingURL=index.d.ts.map