CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Interface

Options (utils/dom)

@ckeditor/ckeditor5-utils/src/dom/position

interface
See source

The getOptimalPosition() helper options.

Filtering

Properties

  • element : HTMLElement

    Element that is to be positioned.

    See source

  • fitInViewport : Boolean

    When set, the algorithm will chose such a position which fits element the most inside visible viewport.

    See source

  • limiter : HTMLElement | Range | Window | ClientRect | DOMRect | Rect | Object | function

    When set, the algorithm will chose position which fits the most in the limiter's bounding rect.

    See source

  • positions : Array.<positioningFunction>

    An array of positioning functions.

    See source

    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 : HTMLElement | Range | Window | ClientRect | DOMRect | Rect | Object | function

    Target with respect to which the element is to be positioned.

    See source

  • viewportOffsetConfig : Object

    Viewport offset config object. It restricts the visible viewport available to the getOptimalPosition() from each side.

    See source
    {
	top: 50,
	right: 50,
	bottom: 50,
	left: 50
}