An HTMLElement type for the static element.
An HTMLElement type for the fixed element.
The configuration to anchor the fixed element to the container element.
Boolean if the auto-swapping behavior should be disabled. It's normally recommended to not disable this since it'll allow elements to appear off screen.
Boolean if the fixed positioning should no longer prevent the fixed element to be positioned within the viewport. This is nice if you want to allow for full page scrolling instead and manually set a max-height on your element.
A ref pointing to an element that another element should be fixed to. This must be provided for the positioning to work.
The initial x value to use when calculating the position instead of finding the container element to determine the the correct position. All the other positioning logic will still be in effect to ensure the element will be visible within the viewport.
The initial y value to use when calculating the position instead of finding the container element to determine the the correct position. All the other positioning logic will still be in effect to ensure the element will be visible within the viewport.
{@inheritDoc TransitionOptions.nodeRef}
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 "exited".
An optional function to call if the page resizes while the {@link FixedElement} is visible.
{@inheritDoc TransitionScrollCallback}
Boolean if the fixed element should no longer be able to overlap the container element. This is useful for autocomplete menus or other components that retain focus on the container element while the fixed element becomes visible.
An optional style that will be merged with the fixed positioning required styles.
Boolean if the style object should include the transformOrigin value
based on the x and y positions.
The viewwidth margin to apply so that the element doesn't need to be directly on the screen edge.
The viewwidth margin to apply so that the element doesn't need to be directly on the screen edge.
{@inheritDoc PositionWidth}
The container width margin to apply so that the element doesn't need to be directly on the container's edge.
The container height margin to apply so that the element doesn't need to be directly on the container's edge
An optional function that can be used to override positioning options if some options require the element to be in the DOM for specific calculations.
Generated using TypeDoc
@since 4.0.0