Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CollapseTransitionHookOptions<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

className?: string

An optional className to be merged with the transition classes.

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

minHeight?: string | number

The minimum height that the collapsed element can be which defaults to 0. This can either be a number of pixels or a string CSS height value.

Setting this value to any non-zero value will allow for the element to shrink to the defined min-height, and then expand to the full height once no longer collapsed.

Note: If the minHeight, minPaddingTop, and minPaddingBottom options are all set to 0 (default), the child will be removed from the DOM while collapsed.

see

DEFAULT_COLLAPSE_MIN_HEIGHT

defaultvalue

DEFAULT_COLLAPSE_MIN_HEIGHT

minPaddingBottom?: string | number

The minimum padding-bottom that the collapsed element can be which defaults to 0. This can either be a number of pixels or a string CSS padding-bottom value.

Note: If the minHeight, minPaddingTop, and minPaddingBottom options are all set to 0 (default), the child will be removed from the DOM while collapsed.

see

DEFAULT_COLLAPSE_MIN_PADDING_BOTTOM

defaultvalue

DEFAULT_COLLAPSE_MIN_PADDING_BOTTOM

minPaddingTop?: string | number

The minimum padding-top that the collapsed element can be which defaults to 0. This can either be a number of pixels or a string CSS padding-top value.

Note: If the minHeight, minPaddingTop, and minPaddingBottom options are all set to 0 (default), the child will be removed from the DOM while collapsed.

see

DEFAULT_COLLAPSE_MIN_PADDING_TOP

defaultvalue

DEFAULT_COLLAPSE_MIN_PADDING_TOP

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

style?: CSSProperties

An optional style to merge with the required collapse transition styles.

If any keys from the CollapseStyle are included in this object, these styles will override and possibly break the collapse transition.

temporary?: boolean
defaultvalue

minHeight === 0 && minPaddingTop === 0 && minPaddingBottom === 0

see

DEFAULT_COLLAPSE_TIMEOUT

defaultvalue

DEFAULT_COLLAPSE_TIMEOUT

transitionIn: boolean

{@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn}

Generated using TypeDoc