ILocationStrategyProps

interface
Layout & Sizing

Full positioning contract for floating elements — extends IDimensionProps with strategy selection, anchor/origin pair, pixel offset and viewport margin. Consumed by Menu, Select, Tooltip and any component using the connected or static location strategies.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

locationStrategy
TLocationStrategy | TLocationStrategyFn
Named strategy ("connected" | "static") or a custom strategy function. The connected strategy aligns the floating panel to the activator; static keeps it in place.
location
TAnchor
Side and alignment where the floating content appears relative to the activator (e.g. "bottom start", "top end").
origin
TAnchor | 'auto' | 'overlap'
The anchor point on the floating content itself. "auto" mirrors the location; "overlap" places the panel over the activator.
offset
number | string | Array<number>
Gap in pixels between the activator and the floating content. An array of two values sets [main-axis, cross-axis] offsets independently.
viewportMargin
number
12
Minimum breathing room in pixels between the floating content and each viewport edge. Defaults to 12 so panels never overlap browser chrome.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Extending the interface for a dropdown component

typescript