An HTMLElement type used for the ref required for the transition.
Boolean if the transition should occur immediately once the component
mounts if the TransitionOptions.transitionIn is true
The child element that should have a ref
and the style
, className
and
hidden
props cloned into using the cloneElement
API. If the child is a
custom component, you must use React.forwardRef
and pass the ref
and the other props for the transition to work correctly.
An optional className to be merged with the transition classes.
Boolean if the element should be collapsed.
Boolean if the transition should occur whenever the
TransitionOptions.transitionIn is switch to true
after the
component has been rendered in the DOM.
Boolean if the transition should occur whenever the
TransitionOptions.transitionIn is switch to false
after the
component has been rendered in the DOM.
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.
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.
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.
An optional ref that will be merged with the TransitionHookReturnValue.ref
This function will be called once the TransitionStage has been set
to "enter"
.
This function will be called once the TransitionStage has been set
to "entering"
.
This function will be called once the TransitionStage has been set
to "enter"
.
This function will be called once the TransitionStage has been set
to "entered"
.
This function will be called once the TransitionStage has been set
to "exited"
.
This function will be called once the TransitionStage has been set
to "exiting"
.
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.
Generated using TypeDoc
@since 2.0.0
@since 4.0.0 Updated for the new CSS Transition API.