rsuite/lib/Animation/Animation.d.ts

A suite of react components

import * as React from 'react';

import { AnimationEventProps } from '../@types/common';

export interface TransitionProps extends AnimationEventProps {
  animation?: boolean;

  /** Primary content */
  children?: React.ReactNode | ((props: any, ref: any) => React.ReactNode);

  /** Additional classes */
  className?: string;

  /** Show the component; triggers the enter or exit animation */
  in?: boolean;

  /** Unmount the component (remove it from the DOM) when it is not shown */
  unmountOnExit?: boolean;

  /** Run the enter animation when the component mounts, if it is initially shown */
  transitionAppear?: boolean;

  /** A Timeout for the animation */
  timeout?: number;

  /** CSS class or classes applied when the component is exited */
  exitedClassName?: string;

  /** CSS class or classes applied while the component is exiting */
  exitingClassName?: string;

  /** CSS class or classes applied when the component is entered */
  enteredClassName?: string;

  /** CSS class or classes applied while the component is entering */
  enteringClassName?: string;
}

export type CollapseDimension = 'height' | 'width';

export interface CollapseProps extends TransitionProps {
  /** The dimension used when collapsing */
  dimension?: CollapseDimension | (() => CollapseDimension);

  /** Function that returns the height or width of the animating DOM node */
  getDimensionValue?: (dimension: CollapseDimension, elem: Element) => number;

  /** ARIA role of collapsible element */
  role?: string;
}

export interface SlideProps extends TransitionProps {
  placement?: 'top' | 'right' | 'bottom' | 'left';
}

export interface AnimationAPI {
  Fade: React.FunctionComponent<TransitionProps>;
  Collapse: React.FunctionComponent<CollapseProps>;
  Transition: React.FunctionComponent<TransitionProps>;
  Bounce: React.FunctionComponent<TransitionProps>;
  Slide: React.FunctionComponent<SlideProps>;
}

declare const Animation: AnimationAPI;

export default Animation;