ui/bindings/clickoutsidehandler

@ckeditor/ckeditor5-ui/src/bindings/clickoutsidehandler

Functions

• clickOutsideHandler( options = { options.emitter, options.activator, options.contextElements, options.callback } )module:ui/bindings/clickoutsidehandler~clickOutsideHandler

  Handles clicking outside of a specified set of elements, then fires an action.

  See source

  Note: Actually, the action is executed upon mousedown, not click. It prevents certain issues when the user keeps holding the mouse button and the UI cannot react properly.

  Parameters

  options : Object

  Configuration options.

  Properties

  options.emitter : Emitter

  The emitter to which this behavior should be added.

  options.activator : function

  Function returning a Boolean, to determine whether the handler is active.

  options.contextElements : Array.<HTMLElement>

  HTML elements that determine the scope of the handler. Clicking any of them or their descendants will not fire the callback.

  options.callback : function

  An action executed by the handler.