9 * @class Roo.bootstrap.Input
10 * @extends Roo.bootstrap.Component
11 * Bootstrap Input class
12 * @cfg {Boolean} disabled is it disabled
13 * @cfg {String} inputType button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text
14 * @cfg {String} name name of the input
15 * @cfg {string} fieldLabel - the label associated
16 * @cfg {string} placeholder - placeholder to put in text.
17 * @cfg {string} before - input group add on before
18 * @cfg {string} after - input group add on after
19 * @cfg {string} size - (lg|sm) or leave empty..
20 * @cfg {Number} xs colspan out of 12 for mobile-sized screens
21 * @cfg {Number} sm colspan out of 12 for tablet-sized screens
22 * @cfg {Number} md colspan out of 12 for computer-sized screens
23 * @cfg {Number} lg colspan out of 12 for large computer-sized screens
24 * @cfg {string} value default value of the input
25 * @cfg {Number} labelWidth set the width of label
26 * @cfg {Number} labellg set the width of label (1-12)
27 * @cfg {Number} labelmd set the width of label (1-12)
28 * @cfg {Number} labelsm set the width of label (1-12)
29 * @cfg {Number} labelxs set the width of label (1-12)
30 * @cfg {String} labelAlign (top|left)
31 * @cfg {Boolean} readOnly Specifies that the field should be read-only
32 * @cfg {String} autocomplete - default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en
33 * @cfg {String} indicatorpos (left|right) default left
34 * @cfg {String} capture (user|camera) use for file input only. (default empty)
35 * @cfg {String} accept (image|video|audio) use for file input only. (default empty)
36 * @cfg {Boolean} preventMark Do not show tick or cross if error/success
38 * @cfg {String} align (left|center|right) Default left
39 * @cfg {Boolean} forceFeedback (true|false) Default false
43 * @param {Object} config The config object
46 Roo.bootstrap.Input = function(config){
48 Roo.bootstrap.Input.superclass.constructor.call(this, config);
53 * Fires when this field receives input focus.
54 * @param {Roo.form.Field} this
59 * Fires when this field loses input focus.
60 * @param {Roo.form.Field} this
65 * Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
66 * {@link Roo.EventObject#getKey} to determine which key was pressed.
67 * @param {Roo.form.Field} this
68 * @param {Roo.EventObject} e The event object
73 * Fires just before the field blurs if the field value has changed.
74 * @param {Roo.form.Field} this
75 * @param {Mixed} newValue The new value
76 * @param {Mixed} oldValue The original value
81 * Fires after the field has been marked as invalid.
82 * @param {Roo.form.Field} this
83 * @param {String} msg The validation message
88 * Fires after the field has been validated with no errors.
89 * @param {Roo.form.Field} this
94 * Fires after the key up
95 * @param {Roo.form.Field} this
96 * @param {Roo.EventObject} e The event Object
102 Roo.extend(Roo.bootstrap.Input, Roo.bootstrap.Component, {
104 * @cfg {String/Boolean} validationEvent The event that should initiate field validation. Set to false to disable
105 automatic validation (defaults to "keyup").
107 validationEvent : "keyup",
109 * @cfg {Boolean} validateOnBlur Whether the field should validate when it loses focus (defaults to true).
111 validateOnBlur : true,
113 * @cfg {Number} validationDelay The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
115 validationDelay : 250,
117 * @cfg {String} focusClass The CSS class to use when the field receives focus (defaults to "x-form-focus")
119 focusClass : "x-form-focus", // not needed???
123 * @cfg {String} invalidClass DEPRICATED - code uses BS4 - is-valid / is-invalid
125 invalidClass : "has-warning",
128 * @cfg {String} validClass DEPRICATED - code uses BS4 - is-valid / is-invalid
130 validClass : "has-success",
133 * @cfg {Boolean} hasFeedback (true|false) default true
138 * @cfg {String} invalidFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid")
140 invalidFeedbackClass : "glyphicon-warning-sign",
143 * @cfg {String} validFeedbackIcon The CSS class to use when create feedback icon (defaults to "x-form-invalid")
145 validFeedbackClass : "glyphicon-ok",
148 * @cfg {Boolean} selectOnFocus True to automatically select any existing field text when the field receives input focus (defaults to false)
150 selectOnFocus : false,
153 * @cfg {String} maskRe An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
157 * @cfg {String} vtype A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)
162 * @cfg {Boolean} disableKeyFilter True to disable input keystroke filtering (defaults to false)
164 disableKeyFilter : false,
167 * @cfg {Boolean} disabled True to disable the field (defaults to false).
171 * @cfg {Boolean} allowBlank False to validate that the value length > 0 (defaults to true)
175 * @cfg {String} blankText Error text to display if the allow blank validation fails (defaults to "This field is required")
177 blankText : "Please complete this mandatory field",
180 * @cfg {Number} minLength Minimum input field length required (defaults to 0)
184 * @cfg {Number} maxLength Maximum input field length allowed (defaults to Number.MAX_VALUE)
186 maxLength : Number.MAX_VALUE,
188 * @cfg {String} minLengthText Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")
190 minLengthText : "The minimum length for this field is {0}",
192 * @cfg {String} maxLengthText Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")
194 maxLengthText : "The maximum length for this field is {0}",
198 * @cfg {Function} validator A custom validation function to be called during field validation (defaults to null).
199 * If available, this function will be called only after the basic validators all return true, and will be passed the
200 * current field value and expected to return boolean true if the value is valid or a string error message if invalid.
204 * @cfg {RegExp} regex A JavaScript RegExp object to be tested against the field value during validation (defaults to null).
205 * If available, this regex will be evaluated only after the basic validators all return true, and will be passed the
206 * current field value. If the test fails, the field will be marked invalid using {@link #regexText}.
210 * @cfg {String} regexText -- Depricated - use Invalid Text
215 * @cfg {String} invalidText The error text to display if {@link #validator} test fails during validation (defaults to "")
240 formatedValue : false,
241 forceFeedback : false,
243 indicatorpos : 'left',
253 parentLabelAlign : function()
256 while (parent.parent()) {
257 parent = parent.parent();
258 if (typeof(parent.labelAlign) !='undefined') {
259 return parent.labelAlign;
266 getAutoCreate : function()
268 var align = (!this.labelAlign) ? this.parentLabelAlign() : this.labelAlign;
274 if(this.inputType != 'hidden'){
275 cfg.cls = 'form-group' //input-group
281 type : this.inputType,
283 cls : 'form-control',
284 placeholder : this.placeholder || '',
285 autocomplete : this.autocomplete || 'new-password'
288 if(this.capture.length){
289 input.capture = this.capture;
292 if(this.accept.length){
293 input.accept = this.accept + "/*";
297 input.style = (typeof(input.style) == 'undefined') ? ('text-align:' + this.align) : (input.style + 'text-align:' + this.align);
300 if(this.maxLength && this.maxLength != Number.MAX_VALUE){
301 input.maxLength = this.maxLength;
313 input.name = this.name;
317 input.cls += ' input-' + this.size;
321 ['xs','sm','md','lg'].map(function(size){
322 if (settings[size]) {
323 cfg.cls += ' col-' + size + '-' + settings[size];
327 var inputblock = input;
331 cls: 'glyphicon form-control-feedback'
334 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
337 cls : 'has-feedback',
345 if (this.before || this.after) {
352 if (this.before && typeof(this.before) == 'string') {
356 cls : 'roo-input-before input-group-addon input-group-prepend input-group-text',
360 if (this.before && typeof(this.before) == 'object') {
361 this.before = Roo.factory(this.before);
365 cls : 'roo-input-before input-group-prepend input-group-text input-group-' +
366 (this.before.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought?
370 inputblock.cn.push(input);
372 if (this.after && typeof(this.after) == 'string') {
375 cls : 'roo-input-after input-group-append input-group-text input-group-addon',
379 if (this.after && typeof(this.after) == 'object') {
380 this.after = Roo.factory(this.after);
384 cls : 'roo-input-after input-group-append input-group-text input-group-' +
385 (this.after.xtype == 'Button' ? 'btn' : 'addon') //?? what about checkboxes - that looks like a bit of a hack thought?
389 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
390 inputblock.cls += ' has-feedback';
391 inputblock.cn.push(feedback);
396 cls : 'roo-required-indicator ' + (this.indicatorpos == 'right' ? 'right' : 'left') +'-indicator text-danger fa fa-lg fa-star',
397 tooltip : 'This field is required'
399 if (Roo.bootstrap.version == 4) {
402 style : 'display-none'
405 if (align ==='left' && this.fieldLabel.length) {
407 cfg.cls += ' roo-form-group-label-left' + (Roo.bootstrap.version == 4 ? ' row' : '');
414 cls : 'control-label col-form-label',
415 html : this.fieldLabel
426 var labelCfg = cfg.cn[1];
427 var contentCfg = cfg.cn[2];
429 if(this.indicatorpos == 'right'){
434 cls : 'control-label col-form-label',
438 html : this.fieldLabel
452 labelCfg = cfg.cn[0];
453 contentCfg = cfg.cn[1];
457 if(this.labelWidth > 12){
458 labelCfg.style = "width: " + this.labelWidth + 'px';
461 if(this.labelWidth < 13 && this.labelmd == 0){
462 this.labelmd = this.labelWidth;
465 if(this.labellg > 0){
466 labelCfg.cls += ' col-lg-' + this.labellg;
467 contentCfg.cls += ' col-lg-' + (12 - this.labellg);
470 if(this.labelmd > 0){
471 labelCfg.cls += ' col-md-' + this.labelmd;
472 contentCfg.cls += ' col-md-' + (12 - this.labelmd);
475 if(this.labelsm > 0){
476 labelCfg.cls += ' col-sm-' + this.labelsm;
477 contentCfg.cls += ' col-sm-' + (12 - this.labelsm);
480 if(this.labelxs > 0){
481 labelCfg.cls += ' col-xs-' + this.labelxs;
482 contentCfg.cls += ' col-xs-' + (12 - this.labelxs);
486 } else if ( this.fieldLabel.length) {
491 cls : 'roo-required-indicator left-indicator text-danger fa fa-lg fa-star',
492 tooltip : 'This field is required'
496 //cls : 'input-group-addon',
497 html : this.fieldLabel
505 if(this.indicatorpos == 'right'){
510 //cls : 'input-group-addon',
511 html : this.fieldLabel
516 cls : 'roo-required-indicator right-indicator text-danger fa fa-lg fa-star',
517 tooltip : 'This field is required'
537 if (this.parentType === 'Navbar' && this.parent().bar) {
538 cfg.cls += ' navbar-form';
541 if (this.parentType === 'NavGroup' && !(Roo.bootstrap.version == 4 && this.parent().form)) {
542 // on BS4 we do this only if not form
543 cfg.cls += ' navbar-form';
551 * return the real input element.
555 return this.el.select('input.form-control',true).first();
558 tooltipEl : function()
560 return this.inputEl();
563 indicatorEl : function()
565 if (Roo.bootstrap.version == 4) {
566 return false; // not enabled in v4 yet.
569 var indicator = this.el.select('i.roo-required-indicator',true).first();
579 setDisabled : function(v)
581 var i = this.inputEl().dom;
583 i.removeAttribute('disabled');
587 i.setAttribute('disabled','true');
589 initEvents : function()
592 this.inputEl().on("keydown" , this.fireKey, this);
593 this.inputEl().on("focus", this.onFocus, this);
594 this.inputEl().on("blur", this.onBlur, this);
596 this.inputEl().relayEvent('keyup', this);
598 this.indicator = this.indicatorEl();
601 this.indicator.addClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible'); // changed from invisible??? -
604 // reference to original value for reset
605 this.originalValue = this.getValue();
606 //Roo.form.TextField.superclass.initEvents.call(this);
607 if(this.validationEvent == 'keyup'){
608 this.validationTask = new Roo.util.DelayedTask(this.validate, this);
609 this.inputEl().on('keyup', this.filterValidation, this);
611 else if(this.validationEvent !== false){
612 this.inputEl().on(this.validationEvent, this.validate, this, {buffer: this.validationDelay});
615 if(this.selectOnFocus){
616 this.on("focus", this.preFocus, this);
619 if(this.maskRe || (this.vtype && this.disableKeyFilter !== true && (this.maskRe = Roo.form.VTypes[this.vtype+'Mask']))){
620 this.inputEl().on("keypress", this.filterKeys, this);
622 this.inputEl().relayEvent('keypress', this);
625 this.el.on("keyup", this.onKeyUp, this, {buffer:50});
626 this.el.on("click", this.autoSize, this);
629 if(this.inputEl().is('input[type=password]') && Roo.isSafari){
630 this.inputEl().on('keydown', this.SafariOnKeyDown, this);
633 if (typeof(this.before) == 'object') {
634 this.before.render(this.el.select('.roo-input-before',true).first());
636 if (typeof(this.after) == 'object') {
637 this.after.render(this.el.select('.roo-input-after',true).first());
640 this.inputEl().on('change', this.onChange, this);
643 filterValidation : function(e){
644 if(!e.isNavKeyPress()){
645 this.validationTask.delay(this.validationDelay);
649 * Validates the field value
650 * @return {Boolean} True if the value is valid, else false
652 validate : function(){
653 //if(this.disabled || this.validateValue(this.processValue(this.getRawValue()))){
654 if(this.disabled || this.validateValue(this.getRawValue())){
665 * Validates a value according to the field's validation rules and marks the field as invalid
666 * if the validation fails
667 * @param {Mixed} value The value to validate
668 * @return {Boolean} True if the value is valid, else false
670 validateValue : function(value)
672 if(this.getVisibilityEl().hasClass('hidden')){
676 if(value.length < 1) { // if it's blank
683 if(value.length < this.minLength){
686 if(value.length > this.maxLength){
690 var vt = Roo.form.VTypes;
691 if(!vt[this.vtype](value, this)){
695 if(typeof this.validator == "function"){
696 var msg = this.validator(value);
700 if (typeof(msg) == 'string') {
701 this.invalidText = msg;
705 if(this.regex && !this.regex.test(value)){
713 fireKey : function(e){
714 //Roo.log('field ' + e.getKey());
715 if(e.isNavKeyPress()){
716 this.fireEvent("specialkey", this, e);
719 focus : function (selectText){
721 this.inputEl().focus();
722 if(selectText === true){
723 this.inputEl().dom.select();
729 onFocus : function(){
730 if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
731 // this.el.addClass(this.focusClass);
734 this.hasFocus = true;
735 this.startValue = this.getValue();
736 this.fireEvent("focus", this);
740 beforeBlur : Roo.emptyFn,
746 if(!Roo.isOpera && this.focusClass){ // don't touch in Opera
747 //this.el.removeClass(this.focusClass);
749 this.hasFocus = false;
750 if(this.validationEvent !== false && this.validateOnBlur && this.validationEvent != "blur"){
753 var v = this.getValue();
754 if(String(v) !== String(this.startValue)){
755 this.fireEvent('change', this, v, this.startValue);
757 this.fireEvent("blur", this);
760 onChange : function(e)
762 var v = this.getValue();
763 if(String(v) !== String(this.startValue)){
764 this.fireEvent('change', this, v, this.startValue);
770 * Resets the current field value to the originally loaded value and clears any validation messages
773 this.setValue(this.originalValue);
777 * Returns the name of the field
778 * @return {Mixed} name The name field
784 * Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.
785 * @return {Mixed} value The field value
787 getValue : function(){
789 var v = this.inputEl().getValue();
794 * Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.
795 * @return {Mixed} value The field value
797 getRawValue : function(){
798 var v = this.inputEl().getValue();
804 * Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.
805 * @param {Mixed} value The value to set
807 setRawValue : function(v){
808 return this.inputEl().dom.value = (v === null || v === undefined ? '' : v);
811 selectText : function(start, end){
812 var v = this.getRawValue();
814 start = start === undefined ? 0 : start;
815 end = end === undefined ? v.length : end;
816 var d = this.inputEl().dom;
817 if(d.setSelectionRange){
818 d.setSelectionRange(start, end);
819 }else if(d.createTextRange){
820 var range = d.createTextRange();
821 range.moveStart("character", start);
822 range.moveEnd("character", v.length-end);
829 * Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.
830 * @param {Mixed} value The value to set
832 setValue : function(v){
835 this.inputEl().dom.value = (v === null || v === undefined ? '' : v);
841 processValue : function(value){
842 if(this.stripCharsRe){
843 var newValue = value.replace(this.stripCharsRe, '');
844 if(newValue !== value){
845 this.setRawValue(newValue);
852 preFocus : function(){
854 if(this.selectOnFocus){
855 this.inputEl().dom.select();
858 filterKeys : function(e){
860 if(!Roo.isIE && (e.isNavKeyPress() || k == e.BACKSPACE || (k == e.DELETE && e.button == -1))){
863 var c = e.getCharCode(), cc = String.fromCharCode(c);
864 if(Roo.isIE && (e.isSpecialKey() || !cc)){
867 if(!this.maskRe.test(cc)){
872 * Clear any invalid styles/messages for this field
874 clearInvalid : function(){
876 if(!this.el || this.preventMark){ // not rendered
881 this.el.removeClass([this.invalidClass, 'is-invalid']);
883 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
885 var feedback = this.el.select('.form-control-feedback', true).first();
888 this.el.select('.form-control-feedback', true).first().removeClass(this.invalidFeedbackClass);
894 this.indicator.removeClass('visible');
895 this.indicator.addClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible');
898 this.fireEvent('valid', this);
902 * Mark this field as valid
904 markValid : function()
906 if(!this.el || this.preventMark){ // not rendered...
910 this.el.removeClass([this.invalidClass, this.validClass]);
911 this.inputEl().removeClass(['is-valid', 'is-invalid']);
913 var feedback = this.el.select('.form-control-feedback', true).first();
916 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
920 this.indicator.removeClass('visible');
921 this.indicator.addClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible');
930 if(this.allowBlank && !this.getRawValue().length){
933 if (Roo.bootstrap.version == 3) {
934 this.el.addClass(this.validClass);
936 this.inputEl().addClass('is-valid');
939 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank && (this.getValue().length || this.forceFeedback)){
941 var feedback = this.el.select('.form-control-feedback', true).first();
944 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
945 this.el.select('.form-control-feedback', true).first().addClass([this.validFeedbackClass]);
950 this.fireEvent('valid', this);
954 * Mark this field as invalid
955 * @param {String} msg The validation message
957 markInvalid : function(msg)
959 if(!this.el || this.preventMark){ // not rendered
963 this.el.removeClass([this.invalidClass, this.validClass]);
964 this.inputEl().removeClass(['is-valid', 'is-invalid']);
966 var feedback = this.el.select('.form-control-feedback', true).first();
969 this.el.select('.form-control-feedback', true).first().removeClass(
970 [this.invalidFeedbackClass, this.validFeedbackClass]);
977 if(this.allowBlank && !this.getRawValue().length){
982 this.indicator.removeClass(this.indicatorpos == 'right' ? 'hidden' : 'invisible');
983 this.indicator.addClass('visible');
985 if (Roo.bootstrap.version == 3) {
986 this.el.addClass(this.invalidClass);
988 this.inputEl().addClass('is-invalid');
993 if(this.hasFeedback && this.inputType != 'hidden' && !this.allowBlank){
995 var feedback = this.el.select('.form-control-feedback', true).first();
998 this.el.select('.form-control-feedback', true).first().removeClass([this.invalidFeedbackClass, this.validFeedbackClass]);
1000 if(this.getValue().length || this.forceFeedback){
1001 this.el.select('.form-control-feedback', true).first().addClass([this.invalidFeedbackClass]);
1008 this.fireEvent('invalid', this, msg);
1011 SafariOnKeyDown : function(event)
1013 // this is a workaround for a password hang bug on chrome/ webkit.
1014 if (this.inputEl().dom.type != 'password') {
1018 var isSelectAll = false;
1020 if(this.inputEl().dom.selectionEnd > 0){
1021 isSelectAll = (this.inputEl().dom.selectionEnd - this.inputEl().dom.selectionStart - this.getValue().length == 0) ? true : false;
1023 if(((event.getKey() == 8 || event.getKey() == 46) && this.getValue().length ==1)){ // backspace and delete key
1024 event.preventDefault();
1029 if(isSelectAll && event.getCharCode() > 31 && !event.ctrlKey) { // not backspace and delete key (or ctrl-v)
1031 event.preventDefault();
1032 // this is very hacky as keydown always get's upper case.
1034 var cc = String.fromCharCode(event.getCharCode());
1035 this.setValue( event.shiftKey ? cc : cc.toLowerCase());
1039 adjustWidth : function(tag, w){
1040 tag = tag.toLowerCase();
1041 if(typeof w == 'number' && Roo.isStrict && !Roo.isSafari){
1042 if(Roo.isIE && (tag == 'input' || tag == 'textarea')){
1046 if(tag == 'textarea'){
1049 }else if(Roo.isOpera){
1053 if(tag == 'textarea'){
1061 setFieldLabel : function(v)
1067 if(this.indicatorEl()){
1068 var ar = this.el.select('label > span',true);
1070 if (ar.elements.length) {
1071 this.el.select('label > span',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v);
1072 this.fieldLabel = v;
1076 var br = this.el.select('label',true);
1078 if(br.elements.length) {
1079 this.el.select('label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v);
1080 this.fieldLabel = v;
1084 Roo.log('Cannot Found any of label > span || label in input');
1088 this.el.select('label',true).first().dom.innerHTML = (v === null || v === undefined ? '' : v);
1089 this.fieldLabel = v;