wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-15 10:35:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Text input widget enter event

Browse source 
Objective:

* Add an event to single line text input widgets to detect when the enter
  key has been pressed

Changes:

ve.ui.TextInputWidget.js
* Retain value of multiline config option
* Add key press handler to detect pressing of enter key
* Emit 'enter' event when enter key is pressed if input is single line

Bonus:

* Add missing documentation for multiline config option

Change-Id: Id9c64343f4a2ea8f0f45213fd2b59ca87c805b24
This commit is contained in:
Trevor Parscal 2013-06-11 12:12:40 -07:00 committed by Gerrit Code Review
parent 6a3badfcc7
commit c32564f36d
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
modules/ve/ui/widgets/ve.ui.TextInputWidget.js
View file

@ -15,6 +15,7 @@
* @param {Object} [config] Config options * @param {Object} [config] Config options
* @cfg {string} [placeholder] Placeholder text * @cfg {string} [placeholder] Placeholder text
* @cfg {string} [icon] Symbolic name of icon * @cfg {string} [icon] Symbolic name of icon
* @cfg {boolean} [multiline=false] Allow multiple lines of text
*/ */
ve.ui.TextInputWidget = function VeUiTextInputWidget( config ) { ve.ui.TextInputWidget = function VeUiTextInputWidget( config ) {
// Parent constructor // Parent constructor
@ -22,6 +23,10 @@ ve.ui.TextInputWidget = function VeUiTextInputWidget( config ) {
// Properties // Properties
this.pending = 0; this.pending = 0;
this.multiline = !!config.multiline;
// Events
this.$input.on( 'keypress', ve.bind( this.onKeyPress, this ) );
// Initialization // Initialization
this.$.addClass( 've-ui-textInputWidget' ); this.$.addClass( 've-ui-textInputWidget' );
@ -45,8 +50,30 @@ ve.ui.TextInputWidget = function VeUiTextInputWidget( config ) {
ve.inheritClass( ve.ui.TextInputWidget, ve.ui.InputWidget ); ve.inheritClass( ve.ui.TextInputWidget, ve.ui.InputWidget );
/* Events */
/**
* User presses enter inside the text box.
*
* Not called if input is multiline.
*
* @event enter
*/
/* Methods */ /* Methods */
/**
* Handles key press events.
*
* @param {jQuery.Event} e Key press event
* @emits enter If enter key is pressed and input is not multiline
*/
ve.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
if ( e.which === ve.Keys.ENTER && !this.multiline ) {
this.emit( 'enter' );
}
};
/** /**
* Get input element. * Get input element.
* *