CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

Position (utils/dom)

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

interface
See source

A position object which instances are created and used by the getOptimalPosition helper.

top and left properties of the position instance translate directly to the top and left properties in CSS "position: absolute coordinate system". If set on the positioned element in DOM, they will make it display it in the right place in the viewport.

Filtering

Properties

  • readonly

    config : object | undefined

    See source

    Additional position configuration, as passed from the positioning function.

    This object can be use, for instance, to pass through presentation options used by the consumer of the getOptimalPosition helper.

  • readonly

    left : number

    See source

    The left value in pixels in the CSS position: absolute coordinate system. Set it on the positioned element in DOM to move it to the position.

  • readonly

    name : string | undefined

    See source

    Position name.

  • readonly

    top : number

    See source

    The top value in pixels in the CSS position: absolute coordinate system. Set it on the positioned element in DOM to move it to the position.