Bladeren bron

Docs: Documentation of the CharacterGridView#tileHover event.

Aleksander Nowodzinski 6 jaren geleden
bovenliggende
commit
559db14a29
1 gewijzigde bestanden met toevoegingen van 10 en 0 verwijderingen
  1. 10 0
      packages/ckeditor5-special-characters/src/ui/charactergridview.js

+ 10 - 0
packages/ckeditor5-special-characters/src/ui/charactergridview.js

@@ -65,6 +65,16 @@ export default class CharacterGridView extends View {
 		 * @param {String} data.name A name of the tile that caused the event (e.g. "greek small letter epsilon").
 		 * @param {String} data.character A human-readable character displayed as label (e.g. "ε").
 		 */
+
+		/**
+		 * Fired when a mouse or other pointing device caused the cursor to move onto any {@link #tiles grid tile}
+		 * (similar to the native `mouseover` DOM event).
+		 *
+		 * @event tileHover
+		 * @param {Object} data Additional information about the event.
+		 * @param {String} data.name A name of the tile that caused the event (e.g. "greek small letter epsilon").
+		 * @param {String} data.character A human-readable character displayed as label (e.g. "ε").
+		 */
 	}
 
 	/**