CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

ui/panel/balloon/balloonpanelview

@ckeditor/ckeditor5-ui/src/panel/balloon/balloonpanelview

module

Filtering

Classes

Functions

  • internal

    generatePositions( options = { [options.config], [options.heightOffset], [options.sideOffset], [options.stickyVerticalOffset] } ) → Record<string, PositioningFunction>

    See source

    Returns available BalloonPanelView positioning functions adjusted by the specific offsets.

    Parameters

    options : object

    Options to generate positions. If not specified, this helper will simply return defaultPositions.

    Properties
    [ options.config ] : object

    Additional configuration of the balloon balloon panel view. Currently only withArrow is supported. Learn more about positioning functions.

    [ options.heightOffset ] : number

    A custom height offset (in pixels) of each position. If not specified, the default value will be used.

    [ options.sideOffset ] : number

    A custom side offset (in pixels) of each position. If not specified, the default value will be used.

    [ options.stickyVerticalOffset ] : number

    A custom offset (in pixels) of the viewportStickyNorth positioning function. If not specified, the default value will be used.

    Defaults to {}

    Returns

    Record<string, PositioningFunction>