ls-stack utils

Appearance

@ls-stack/react-utils / useAnimateMountUnmount

useAnimateMountUnmount ​

Type Aliases ​

MountAnimStates ​

ts
type MountAnimStates = "from" | "enter" | "leave" | "unmounted";

Defined in: packages/react-utils/src/useAnimateMountUnmount.ts:5

Functions ​

useAnimateMountUnmount() ​

ts
function useAnimateMountUnmount(show, animationMaxDurationMs): [MountAnimStates, boolean];

Defined in: packages/react-utils/src/useAnimateMountUnmount.ts:18

React hook to manage mount/unmount animation states for a component.

Returns the current animation state and a boolean indicating whether the element should be rendered.

Parameters ​

show ​

boolean

Whether the component should be shown (mounted)

animationMaxDurationMs ​

number

Maximum duration (ms) for the leave animation before unmounting

Returns ​

[MountAnimStates, boolean]

[animState, renderElement]

  • animState: 'from' | 'enter' | 'leave' | 'unmounted'
  • renderElement: boolean (true if the element should be rendered)