ui/bindings/submithandler

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

Functions

• submitHandler( [ options ] = { options.view } )module:ui/bindings/submithandler~submitHandler

  A handler useful for views working as HTML forms. It intercepts a native DOM submit event, prevents the default web browser behavior (navigation and page reload) and fires the submit event on a view instead. Such a custom event can be then used by any emitter, e.g. to serialize the form data.

  See source

  import submitHandler from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
  
  // ...
  
  class AnyFormView extends View {
  	constructor() {
  		super();
  
  		// ...
  
  		submitHandler( {
  			view: this
  		} );
  	}
  }
  
  // ...
  
  const view = new AnyFormView();
  
  // A sample listener attached by an emitter working with the view.
  this.listenTo( view, 'submit', () => {
  	saveTheFormData();
  	hideTheForm();
  } );

  Parameters

  [ options ] : Object

  Configuration options.

  Properties

  options.view : View

  The view which DOM submit events should be handled.