Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScaleTransitionHookOptions<E>

remarks

@since 4.0.0

Type parameters

  • E: HTMLElement

    The HTMLElement type used or the ref required for the transition.

Hierarchy

Index

Properties

Optional appear

appear?: boolean

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

defaultvalue

false

Optional className

className?: string

An optional className to be merged with the transition classes.

Optional classNames

see

vertical

see

SCALE_CLASSNAMES

see

SCALE_Y_CLASSNAMES

defaultvalue

vertical ? SCALE_Y_CLASSNAMES : SCALE_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

Optional timeout

{@inheritDoc TransitionTimeout}

transitionIn

transitionIn: boolean

{@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn}

Optional vertical

vertical?: boolean

Boolean if the scale transition should be vertical instead of horizontal. This really only changes the default value for the classNames.

defaultvalue

false

Generated using TypeDoc