Home/CKEditor 5/API

PositioningFunction (utils/dom)

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

typedeffunction

See source

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Parameters

elementRect : Rect: The rect of the element to be positioned.
targetRect : Rect: The rect of the target the element (its rect) is relatively positioned to.
viewportRect : Rect: The rect of the visual browser viewport.
[ limiterRect ] : Rect

Returns

PositioningFunctionResult | null: When the function returns null, it will not be considered by getOptimalPosition.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.