Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FixedPositionOptions

Hierarchy

Index

Properties

The configuration to anchor the fixed element to the container element.

defaultvalue

BELOW_CENTER_ANCHOR

container: null | HTMLElement

The container element that the element should be fixed to.

disableSwapping?: boolean

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.

defaultvalue

false

remarks

@since 5.0.0 This will always be true if the FixedPositionOptions.container is null. @remarks @since 5.1.6 Allow this to be false while the container is null. I can't figure out why I prevented that.

disableVHBounds?: boolean

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.

defaultvalue

false

element: null | HTMLElement

The element that is fixed to a container element.

initialX?: number

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.

initialY?: number

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.

preventOverlap?: boolean

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.

defaultvalue

false

transformOrigin?: boolean

Boolean if the style object should include the transformOrigin value based on the x and y positions.

defaultvalue

false

vhMargin?: number

The viewwidth margin to apply so that the element doesn't need to be directly on the screen edge.

defaultvalue

16

vwMargin?: number

The viewwidth margin to apply so that the element doesn't need to be directly on the screen edge.

defaultvalue

16

{@inheritDoc PositionWidth}

xMargin?: number

The container width margin to apply so that the element doesn't need to be directly on the container's edge.

defaultvalue

0

yMargin?: number

The container height margin to apply so that the element doesn't need to be directly on the container's edge

defaultvalue

0

Generated using TypeDoc