react-transition-state/types/index.d.ts

Zero dependency React transition state machine.

export type TransitionStatus =
  | 'preEnter'
  | 'entering'
  | 'entered'
  | 'preExit'
  | 'exiting'
  | 'exited'
  | 'unmounted';

export type TransitionState = Readonly<{
  status: TransitionStatus;
  isMounted: boolean;
  isEnter: boolean;
  isResolved: boolean;
}>;

export interface TransitionOptions {
  initialEntered?: boolean;
  mountOnEnter?: boolean;
  unmountOnExit?: boolean;
  preEnter?: boolean;
  preExit?: boolean;
  enter?: boolean;
  exit?: boolean;
  timeout?: number | { enter?: number; exit?: number };
  onStateChange?: (event: { current: TransitionState }) => void;
}

export interface TransitionItemOptions {
  initialEntered?: boolean;
}

export interface TransitionMapOptions<K> extends Omit<TransitionOptions, 'onStateChange'> {
  allowMultiple?: boolean;
  onStateChange?: (event: { key: K; current: TransitionState }) => void;
}

export type TransitionResult = [TransitionState, (toEnter?: boolean) => void, () => void];

export interface TransitionMapResult<K> {
  stateMap: ReadonlyMap<K, TransitionState>;
  toggle: (key: K, toEnter?: boolean) => void;
  toggleAll: (toEnter?: boolean) => void;
  endTransition: (key: K) => void;
  setItem: (key: K, options?: TransitionItemOptions) => void;
  deleteItem: (key: K) => boolean;
}

export const useTransitionState: (options?: TransitionOptions) => TransitionResult;

export const useTransitionMap: <K>(options?: TransitionMapOptions<K>) => TransitionMapResult<K>;

export {
  /**
   * @deprecated The `useTransition` alias will be removed in v3.0.0. Use `useTransitionState` instead.
   */
  useTransitionState as useTransition
};

/**
 * @deprecated The default export will be removed in v3.0.0. Use the named export `useTransitionState` instead.
 */
export default useTransitionState;