Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CSSTransitionProps<E>

remarks

@since 4.0.0

Type parameters

  • E: HTMLElement

    An HTMLElement type used for the ref required for the transition.

Hierarchy

Index

Properties

appear?: boolean

Boolean if the transition should occur immediately once the component mounts if the TransitionOptions.transitionIn is true

defaultvalue

false

children: ReactElement<{ className: undefined | string; ref: Ref<E> }, string | JSXElementConstructor<any>>

The child element that should have a ref and className cloned into using the cloneElement API. If the child is a custom component, you must use React.forwardRef and pass both of these to a DOM element for the transition to work.

className?: string

An optional className to be merged with the transition classes.

{@inheritDoc CSSTransitionClassNames}

enter?: boolean

Boolean if the transition should occur whenever the TransitionOptions.transitionIn is switch to true after the component has been rendered in the DOM.

defaultvalue

true

exit?: boolean

Boolean if the transition should occur whenever the TransitionOptions.transitionIn is switch to false after the component has been rendered in the DOM.

defaultvalue

true

nodeRef?: Ref<E>

An optional ref that will be merged with the TransitionHookReturnValue.ref

This function will be called once the TransitionStage has been set to "enter".

see

TransitionEnterHandler

This function will be called once the TransitionStage has been set to "entering".

see

TransitionEnterHandler

This function will be called once the TransitionStage has been set to "enter".

see

TransitionEnterHandler

This function will be called once the TransitionStage has been set to "entered".

see

TransitionEnterHandler

This function will be called once the TransitionStage has been set to "exited".

see

TransitionExitHandler

This function will be called once the TransitionStage has been set to "exiting".

see

TransitionExitHandler

temporary?: boolean

Boolean if the element should mount and unmount based on the transitionIn value.

defaultvalue

false

{@inheritDoc TransitionTimeout}

transitionIn: boolean

{@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn}

Generated using TypeDoc