DomOptimalPositionOptions
The getOptimalPosition()
helper options.
Properties
-
element : HTMLElement
readonlymodule:utils/dom/position~DomOptimalPositionOptions#element
Element that is to be positioned.
-
fitInViewport : boolean | undefined
readonlymodule:utils/dom/position~DomOptimalPositionOptions#fitInViewport
When set, the algorithm will chose such a position which fits
element
the most inside visible viewport. -
limiter : null | RectSource | () => ( RectSource | null ) | undefined
readonlymodule:utils/dom/position~DomOptimalPositionOptions#limiter
When set, the algorithm will chose position which fits the most in the limiter's bounding rect.
-
positions : readonly Array<PositioningFunction>
readonlymodule:utils/dom/position~DomOptimalPositionOptions#positions
An array of positioning functions.
Note: Positioning functions are processed in the order of preference. The first function that works in the current environment (e.g. offers the complete fit in the viewport geometry) will be picked by
getOptimalPosition()
.Note: Any positioning function returning
null
is ignored. -
target : RectSource | () => RectSource
readonlymodule:utils/dom/position~DomOptimalPositionOptions#target
Target with respect to which the
element
is to be positioned. -
viewportOffsetConfig : object | undefined
readonlymodule:utils/dom/position~DomOptimalPositionOptions#viewportOffsetConfig
Viewport offset config object. It restricts the visible viewport available to the
getOptimalPosition()
from each side.{ top: 50, right: 50, bottom: 50, left: 50 }