CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

PositioningFunctionResult (utils/dom)

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

interface
See source

The result of PositioningFunction.

Filtering

Properties

  • config : object | undefined

    See source

    An optional configuration that will pass-through the getOptimalPosition helper to the DomPoint returned by this helper. This configuration may, for instance, let the user of getOptimalPosition know that this particular position comes with a certain presentation.

  • left : number

    See source

    The left value of the element rect that would represent the position.

  • name : string | undefined

    See source

    The name of the position. It helps the user of the getOptimalPosition helper to recognize different positioning function results. It will pass through to the DomPoint returned by the helper.

  • top : number

    See source

    The top value of the element rect that would represent the position.