Function useEasing

  • useEasing(easingString, options?): string

  • Accepts either a preset easing string or a CSS <easing-function> string and returns an <easing-function>

    Parameters

    • easingString: EasingString

      preset easing string or a CSS string

    • options: {
          inverted: boolean;
      } = ...

      options affecting the output based on easingString

      • inverted: boolean

        If true, the returned easing function will be inverted.

        Default Value

        false

    Returns string

    An <easing-string> corresponding to the provided easingString.

    • If easingString is a preset easing string (such as "power1-in" or "bounce-out"), the returned <easing-function> will be a custom <linear-easing-function> coming from a map of preset strings to linear easing functions.
    • If easingString is a standard <easing-function> string (such as "ease-in" or "cubic-bezier(...)"), the string itself will be returned with no modifications since it is obviously already a valid CSS easing function string.

    See

    <easing-function>

Settings

Member Visibility