CKEditor Ecosystem Documentation
Search
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 | ClientRect | Rect | function

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

    See source

  • positions : Array.<Function>

    An array of functions which return Position relative to the target, in the order of preference.

    See source

  • target : HTMLElement | Range | ClientRect | Rect | function

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

    See source