Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FixedPosition

Since the position can be "swapped" to help fit the fixed element within the viewport, this interface is used to contain the calculated positions as well as an optional style object to apply.

Hierarchy

  • FixedPosition

Index

Properties

Properties

actualX

The calculated horizontal position that can be used to compare to the provided horizontal position anchor if additional manual updates should be applied.

actualY

The calculated vertical position that can be used to compare to the provided horizontal position anchor if additional manual updates should be applied.

Optional style

style: Coords & { position: "fixed" | "absolute"; transformOrigin?: string }

The style object that should be applied to the fixed element so it will be fixed to the container element. This will be undefined if the container element doesn't exist within the DOM.

Note: The fixed element styles will not contain styles for z-index or background-color so you'll need to add that manually.

Generated using TypeDoc