Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Added event documentation to keydown:delete.
Browse files Browse the repository at this point in the history
  • Loading branch information
szymonkups committed Jan 4, 2018
1 parent 6cd5c37 commit bf9fc5e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/deleteobserver.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,13 @@ export default class DeleteObserver extends Observer {
* @param {Number} data.sequence A number describing which subsequent delete event it is without the key being released.
* If it's 2 or more it means that the key was pressed and hold.
*/

/**
* Fired when a keydown event was handled by {@link module:typing/deleteobserver~DeleteObserver}.
* It can be used to determine if the event was handled by {@link module:typing/deleteobserver~DeleteObserver} or it is
* a generic event created by {@link module:engine/view/observer/keyobserver~KeyObserver}.
*
* @see module:engine/view/observer/keyobserver~KeyObserver
* @event module:engine/view/document~Document#event:keydown:delete
* @param {module:engine/view/observer/keyobserver~KeyEventData} keyEventData
*/

0 comments on commit bf9fc5e

Please sign in to comment.