Typedef

ViewScrollToTheSelectionEvent (engine/view)

@ckeditor/ckeditor5-engine/src/view/view

typedefobject

An event fired at the moment of scrollToTheSelection being called. It carries two objects in its payload (args):

  • The first argument is the object containing data that gets passed down to the scrollViewportToShowTarget helper. If some event listener modifies it, it can adjust the behavior of the scrolling (e.g. include additional viewportOffset).
  • The second argument corresponds to the original arguments passed to scrollViewportToShowTarget. It allows listeners to re-execute the scrollViewportToShowTarget() method with its original arguments if there is such a need, for instance, if the integration requires re–scrolling after certain interaction.

Filtering

Properties

  • args : tuple

  • name : 'scrollToTheSelection'

Fired by