@yamada-ui/react/dist/types/components/ripple/ripple.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { ThemeProps } from "../../core/system/index.types.js";
import { Component } from "../../core/components/index.types.js";
import "../../core/index.js";
import { HTMLMotionProps } from "../motion/index.types.js";
import { RippleStyle } from "./ripple.style.js";
import { RippleOptions } from "./use-ripple.js";
import "../../index.js";
import * as react87 from "react";
import { Key } from "react";

//#region src/components/ripple/ripple.d.ts
interface RippleProps extends HTMLMotionProps<"span">, ThemeProps<RippleStyle> {
  /**
   * The ripples to use.
   */
  ripples: RippleOptions[];
  /**
   * The callback invoked when a ripple is cleared.
   */
  onClear: (key: Key) => void;
  /**
   * If `true`, disable ripple effects when pressing a element.
   *
   * @default false
   */
  disabled?: boolean;
}
declare const RipplePropsContext: react87.Context<Partial<RippleProps> | undefined>, useRipplePropsContext: () => Partial<RippleProps> | undefined;
/**
 * `Ripple` is a component that adds a ripple effect to elements, allowing users to recognize when they have clicked.
 *
 * @see https://yamada-ui.com/docs/components/ripple
 */
declare const Ripple: Component<"span", RippleProps>;
//#endregion
export { Ripple, RippleProps, RipplePropsContext, useRipplePropsContext };
//# sourceMappingURL=ripple.d.ts.map