Options
All
  • Public
  • Public/Protected
  • All
Menu
remarks

@since 2.0.0

remarks

@since 4.0.0 Updated for the new CSS Transition API

Type parameters

  • E: HTMLElement

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

Hierarchy

Index

Properties

Optional appear

appear?: boolean

Unlike the useCrossFadeTransition, the appear value is defaulted to true so that the transition can occur when the key changes.

see

CrossFadeTransitionHookOptions.appear

defaultvalue

true

children

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.

Optional className

className?: string

An optional className to be merged with the transition classes.

Optional classNames

see

CSSTransitionClassNames

see

CROSS_FADE_CLASSNAMES

defaultvalue

CROSS_FADE_CLASSNAMES

Optional enter

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

Optional exit

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

Optional nodeRef

nodeRef?: Ref<E>

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

Optional onEnter

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

see

TransitionEnterHandler

Optional onEntered

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

see

TransitionEnterHandler

Optional onEntering

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

see

TransitionEnterHandler

Optional onExit

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

see

TransitionEnterHandler

Optional onExited

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

see

TransitionExitHandler

Optional onExiting

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

see

TransitionExitHandler

Optional temporary

temporary?: boolean

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

defaultvalue

false

Optional timeout

see

TransitionTimeout

see

CROSS_FADE_TIMEOUT

defaultvalue

CROSS_FADE_TIMEOUT

Optional transitionIn

transitionIn?: boolean

Generated using TypeDoc