@elemental/ui / TypeAlias

LmnRippleGlobalOptions

Configurable options for lmnRipple.

Presentation

type LmnRippleGlobalOptions = {
  /**
   * Whether ripples should be disabled. Ripples can be still launched manually by using
   * the `launch()` method. Therefore, focus indicators will still show up.
   */
  disabled?: boolean;

  /**
   * Default configuration for the animation duration of the ripples. There are two phases with
   * different durations for the ripples: `enter` and `leave`. The durations will be overwritten
   * by the value of `lmnRippleAnimation` or if the `NoopAnimationsModule` is included.
   */
  animation?: LmnRippleAnimationConfig;

  /**
   * Whether ripples should start fading out immediately after the mouse or touch is released. By
   * default, ripples will wait for the enter animation to complete and for mouse or touch release.
   */
  terminateOnPointerUp?: boolean;
};