CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.menu

class
See source

Filtering

Methods

  • constructor() → menu

    See source

    Returns

    menu

  • add( item )

    See source

    Adds an item.

    Parameters

    item : Object

  • addListener( listenerFn )

    See source

    Adds a callback executed on opening the menu. Items returned by that callback are added to the menu.

    Parameters

    listenerFn : Function

  • since 4.9.0

    findItemByCommandName( commandName ) → Object | null

    See source

    Finds the menu item corresponding to a given command.

    Notice: Keep in mind that the menu is re-rendered on each opening, so caching items (especially DOM elements) may not work. Also executing this method when the menu is not visible may give unexpected results as the items may not be rendered.

    Parameters

    commandName : String

    Returns

    Object | null

    return An object containing a given item. If the item was not found, null is returned.

    Properties
    item : menuItem

    The item definition.

    element : element

    The rendered element representing the item in the menu.

  • hide( [ returnFocus ] )

    See source

    Hides the menu.

    Parameters

    [ returnFocus ] : Boolean

  • removeAll()

    See source

    Removes all items.

  • show( offsetParent, [ corner ], [ offsetX ], [ offsetY ] )

    See source

    Shows the menu in given location.

    Parameters

    offsetParent : element
    [ corner ] : Number
    [ offsetX ] : Number
    [ offsetY ] : Number