Source: forms/common-fields/text-field.js

import {gettext}        from '$qui/base/i18n.js'

import JQueryUIField from './jquery-ui-field.js'


/**
 * A simple text field. The value data type is `String`.
 * @alias qui.forms.commonfields.TextField
 * @extends qui.forms.commonfields.JQueryUIField
 */
class TextField extends JQueryUIField {

    static WIDGET_CLASS = 'textinput'


    /**
     * @constructs
     * @param {?String} [placeholder] an empty-text placeholder
     * @param {Boolean} [clearPlaceholder] set to `true` to clear the placeholder on first change (defaults to `false`)
     * @param {Boolean|String} [autocomplete] enables or disables field autocomplete (disabled by default); if a string
     * value is given, it will be used to set the `autocomplete` element attribute
     * @param {?Number} [minLength] minimum required text length
     * @param {?Number} [maxLength] maximum allowed text length
     * @param {?String|RegExp} [pattern] a regular expression used to validate the value
     * @param {Boolean} [continuousChange] set to `false` to prevent triggering change events at each key stroke
     * @param {Object} [widgetAttrs] extra attributes to pass to underlying JQueryUI widget
     * @param {...*} args parent class parameters
     */
    constructor({
        placeholder = null,
        clearPlaceholder = false,
        autocomplete = false,
        minLength = null,
        maxLength = null,
        pattern = null,
        continuousChange = true,
        widgetAttrs = {},
        ...args
    }) {
        Object.assign(widgetAttrs, {
            placeholder: placeholder,
            clearPlaceholder: clearPlaceholder,
            autocomplete: autocomplete,
            minLength: minLength,
            maxLength: maxLength,
            continuousChange: continuousChange
        })

        super({widgetAttrs: widgetAttrs, ...args})

        if (typeof pattern === 'string') {
            pattern = new RegExp(pattern)
        }

        this._pattern = pattern
    }

    validateWidget(value) {
        let error = super.validateWidget(value)
        if (error) {
            return error
        }

        if (!this.isRequired() && !value) {
            return
        }

        /* Apply pattern validation, if supplied */
        if (this._pattern) {
            let match = value.match(this._pattern)
            if (match == null) {
                return gettext('Value does not match required pattern.')
            }
        }
    }

    getInputElement() {
        return this.getWidget().children('input')
    }

    getFocusableElement() {
        return this.getInputElement()
    }

}


export default TextField