@vaadin/number-field

{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "vaadin-number-field.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/vaadin-number-field.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-number-field-mixin.js", "declarations": [ { "kind": "mixin", "description": "A mixin providing common number field functionality.", "name": "NumberFieldMixin", "members": [ { "kind": "field", "name": "accessibleName", "privacy": "public", "type": { "text": "string" }, "description": "String used to label the component to screen reader users.", "attribute": "accessible-name", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "accessibleNameRef", "privacy": "public", "type": { "text": "string" }, "description": "Id of the element used as label of the component to screen reader users.", "attribute": "accessible-name-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "allowedCharPattern", "privacy": "public", "type": { "text": "string" }, "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`", "attribute": "allowed-char-pattern", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "autocapitalize", "privacy": "public", "type": { "text": "string" }, "description": "This is a property supported by Safari and Chrome that is used to control whether\nautocapitalization should be enabled when the user is entering/editing the text.\nPossible values are:\ncharacters: Characters capitalization.\nwords: Words capitalization.\nsentences: Sentences capitalization.\nnone: No capitalization.", "attribute": "autocapitalize", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "kind": "field", "name": "autocomplete", "privacy": "public", "type": { "text": "string" }, "description": "Whether the value of the control can be automatically completed by the browser.\nList of available options at:\nhttps://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete", "attribute": "autocomplete", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "kind": "field", "name": "autocorrect", "privacy": "public", "type": { "text": "string" }, "description": "This is a property supported by Safari that is used to control whether\nautocorrection should be enabled when the user is entering/editing the text.\nPossible values are:\non: Enable autocorrection.\noff: Disable autocorrection.", "attribute": "autocorrect", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "kind": "field", "name": "autoselect", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.", "attribute": "autoselect", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "method", "name": "checkValidity", "description": "Override the method from `InputConstraintsMixin`\nto enforce HTML constraint validation even if\nthe user didn't add any constraints explicitly:\nthe field has to be regardless checked for bad input." }, { "kind": "field", "name": "clearButtonVisible", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.", "attribute": "clear-button-visible", "inheritedFrom": { "name": "ClearButtonMixin", "package": "@vaadin/field-base/src/clear-button-mixin.js" } }, { "kind": "field", "name": "errorMessage", "privacy": "public", "type": { "text": "string" }, "description": "Error to show when the field is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "helperText", "privacy": "public", "type": { "text": "string" }, "description": "String used for the helper text.", "attribute": "helper-text", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.", "attribute": "label", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "number" }, "description": "The maximum value of the field.", "attribute": "max" }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "number" }, "description": "The minimum value of the field.", "attribute": "min" }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "The name of this field.", "attribute": "name", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the field.", "attribute": "placeholder", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "attribute": "readonly", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "step", "privacy": "public", "type": { "text": "number" }, "description": "Specifies the allowed number intervals of the field.", "attribute": "step" }, { "kind": "field", "name": "stepButtonsVisible", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to show increase/decrease buttons.", "attribute": "step-buttons-visible" }, { "kind": "field", "name": "title", "privacy": "public", "type": { "text": "string" }, "description": "The text usually displayed in a tooltip popup when the mouse is over the field.", "attribute": "title", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "unparsable-change", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "accessible-name", "type": { "text": "string" }, "description": "String used to label the component to screen reader users.", "fieldName": "accessibleName", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name-ref", "type": { "text": "string" }, "description": "Id of the element used as label of the component to screen reader users.", "fieldName": "accessibleNameRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "allowed-char-pattern", "type": { "text": "string" }, "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`", "fieldName": "allowedCharPattern", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "autocapitalize", "type": { "text": "string" }, "description": "This is a property supported by Safari and Chrome that is used to control whether\nautocapitalization should be enabled when the user is entering/editing the text.\nPossible values are:\ncharacters: Characters capitalization.\nwords: Words capitalization.\nsentences: Sentences capitalization.\nnone: No capitalization.", "fieldName": "autocapitalize", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "name": "autocomplete", "type": { "text": "string" }, "description": "Whether the value of the control can be automatically completed by the browser.\nList of available options at:\nhttps://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete", "fieldName": "autocomplete", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "name": "autocorrect", "type": { "text": "string" }, "description": "This is a property supported by Safari that is used to control whether\nautocorrection should be enabled when the user is entering/editing the text.\nPossible values are:\non: Enable autocorrection.\noff: Disable autocorrection.", "fieldName": "autocorrect", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "name": "autoselect", "type": { "text": "boolean" }, "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.", "fieldName": "autoselect", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "clear-button-visible", "type": { "text": "boolean" }, "description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.", "fieldName": "clearButtonVisible", "inheritedFrom": { "name": "ClearButtonMixin", "package": "@vaadin/field-base/src/clear-button-mixin.js" } }, { "name": "error-message", "type": { "text": "string" }, "description": "Error to show when the field is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "helper-text", "type": { "text": "string" }, "description": "String used for the helper text.", "fieldName": "helperText", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "label", "type": { "text": "string" }, "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.", "fieldName": "label", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "max", "type": { "text": "number" }, "description": "The maximum value of the field.", "fieldName": "max" }, { "name": "min", "type": { "text": "number" }, "description": "The minimum value of the field.", "fieldName": "min" }, { "name": "name", "type": { "text": "string" }, "description": "The name of this field.", "fieldName": "name", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the field.", "fieldName": "placeholder", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "fieldName": "readonly", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "step", "type": { "text": "number" }, "description": "Specifies the allowed number intervals of the field.", "fieldName": "step" }, { "name": "step-buttons-visible", "type": { "text": "boolean" }, "description": "Set to true to show increase/decrease buttons.", "fieldName": "stepButtonsVisible" }, { "name": "title", "type": { "text": "string" }, "description": "The text usually displayed in a tooltip popup when the mouse is over the field.", "fieldName": "title", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } } ], "mixins": [ { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } ], "parameters": [ { "name": "superClass" } ] } ], "exports": [ { "kind": "js", "name": "NumberFieldMixin", "declaration": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } } ] }, { "kind": "javascript-module", "path": "src/vaadin-number-field.js", "declarations": [ { "kind": "class", "description": "`<vaadin-number-field>` is an input field web component that only accepts numeric input.\n\n```html\n<vaadin-number-field label=\"Balance\"></vaadin-number-field>\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------|----------------\n`label` | The label element\n`input-field` | The element that wraps prefix, value and suffix\n`field-button` | Set on clear, decrease and increase buttons\n`clear-button` | The clear button\n`error-message` | The error message element\n`helper-text` | The helper text element wrapper\n`required-indicator` | The `required` state indicator element\n`increase-button` | Increase (\"plus\") button\n`decrease-button` | Decrease (\"minus\") button\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------------|---------------------------------\n`disabled` | Set when the element is disabled\n`has-value` | Set when the element has a value\n`has-label` | Set when the element has a label\n`has-helper` | Set when the element has helper text or slot\n`has-error-message` | Set when the element has an error message\n`has-tooltip` | Set when the element has a slotted tooltip\n`invalid` | Set when the element is invalid\n`input-prevented` | Temporarily set when invalid input is prevented\n`focused` | Set when the element is focused\n`focus-ring` | Set when the element is keyboard focused\n`readonly` | Set when the element is readonly\n\nNote, the `input-prevented` state attribute is only supported when `allowedCharPattern` is set.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Change events\n\nDepending on the nature of the value change that the user attempts to commit e.g. by pressing Enter,\nthe component can fire either a `change` event or an `unparsable-change` event:\n\nValue change | Event\n:------------------------|:------------------\nempty => parsable | change\nempty => unparsable | unparsable-change\nparsable => empty | change\nparsable => parsable | change\nparsable => unparsable | change\nunparsable => empty | unparsable-change\nunparsable => parsable | change\nunparsable => unparsable | -\n\nNote, there is currently no way to detect unparsable => unparsable changes because the browser\ndoesn't provide access to unparsable values of native [type=number] inputs.", "name": "NumberField", "members": [ { "kind": "field", "name": "accessibleName", "privacy": "public", "type": { "text": "string" }, "description": "String used to label the component to screen reader users.", "attribute": "accessible-name", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "accessibleNameRef", "privacy": "public", "type": { "text": "string" }, "description": "Id of the element used as label of the component to screen reader users.", "attribute": "accessible-name-ref", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "allowedCharPattern", "privacy": "public", "type": { "text": "string" }, "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`", "attribute": "allowed-char-pattern", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "autocapitalize", "privacy": "public", "type": { "text": "string" }, "description": "This is a property supported by Safari and Chrome that is used to control whether\nautocapitalization should be enabled when the user is entering/editing the text.\nPossible values are:\ncharacters: Characters capitalization.\nwords: Words capitalization.\nsentences: Sentences capitalization.\nnone: No capitalization.", "attribute": "autocapitalize", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "kind": "field", "name": "autocomplete", "privacy": "public", "type": { "text": "string" }, "description": "Whether the value of the control can be automatically completed by the browser.\nList of available options at:\nhttps://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete", "attribute": "autocomplete", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "kind": "field", "name": "autocorrect", "privacy": "public", "type": { "text": "string" }, "description": "This is a property supported by Safari that is used to control whether\nautocorrection should be enabled when the user is entering/editing the text.\nPossible values are:\non: Enable autocorrection.\noff: Disable autocorrection.", "attribute": "autocorrect", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "kind": "field", "name": "autoselect", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.", "attribute": "autoselect", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "method", "name": "checkValidity", "description": "Override the method from `InputConstraintsMixin`\nto enforce HTML constraint validation even if\nthe user didn't add any constraints explicitly:\nthe field has to be regardless checked for bad input.", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "kind": "field", "name": "clearButtonVisible", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.", "attribute": "clear-button-visible", "inheritedFrom": { "name": "ClearButtonMixin", "package": "@vaadin/field-base/src/clear-button-mixin.js" } }, { "kind": "field", "name": "errorMessage", "privacy": "public", "type": { "text": "string" }, "description": "Error to show when the field is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "helperText", "privacy": "public", "type": { "text": "string" }, "description": "String used for the helper text.", "attribute": "helper-text", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "number" }, "description": "The maximum value of the field.", "attribute": "max", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "number" }, "description": "The minimum value of the field.", "attribute": "min", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "The name of this field.", "attribute": "name", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the field.", "attribute": "placeholder", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "attribute": "readonly", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "kind": "field", "name": "step", "privacy": "public", "type": { "text": "number" }, "description": "Specifies the allowed number intervals of the field.", "attribute": "step", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "kind": "field", "name": "stepButtonsVisible", "privacy": "public", "type": { "text": "boolean" }, "description": "Set to true to show increase/decrease buttons.", "attribute": "step-buttons-visible", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "kind": "field", "name": "title", "privacy": "public", "type": { "text": "string" }, "description": "The text usually displayed in a tooltip popup when the mouse is over the field.", "attribute": "title", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" }, "description": "Fired when the user commits a value change.", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "type": { "text": "Event" }, "description": "Fired when the value is changed by the user: on every typing keystroke, and the value is cleared using the clear button.", "name": "input" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `invalid` property changes.", "name": "invalid-changed" }, { "name": "unparsable-change", "type": { "text": "CustomEvent" }, "description": "Fired when the user commits an unparsable value change and there is no change event.", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "type": { "text": "CustomEvent" }, "description": "Fired whenever the field is validated.", "name": "validated" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the `value` property changes.", "name": "value-changed" } ], "mixins": [ { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" }, { "name": "ThemableMixin", "package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js" }, { "name": "ElementMixin", "package": "@vaadin/component-base/src/element-mixin.js" }, { "name": "PolylitMixin", "package": "@vaadin/component-base/src/polylit-mixin.js" }, { "name": "LumoInjectionMixin", "package": "@vaadin/vaadin-themable-mixin/lumo-injection-mixin.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "vaadin-number-field", "customElement": true, "attributes": [ { "name": "accessible-name", "type": { "text": "string" }, "description": "String used to label the component to screen reader users.", "fieldName": "accessibleName", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "accessible-name-ref", "type": { "text": "string" }, "description": "Id of the element used as label of the component to screen reader users.", "fieldName": "accessibleNameRef", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "allowed-char-pattern", "type": { "text": "string" }, "description": "A pattern matched against individual characters the user inputs.\n\nWhen set, the field will prevent:\n- `keydown` events if the entered key doesn't match `/^allowedCharPattern$/`\n- `paste` events if the pasted text doesn't match `/^allowedCharPattern*$/`\n- `drop` events if the dropped text doesn't match `/^allowedCharPattern*$/`\n\nFor example, to allow entering only numbers and minus signs, use:\n`allowedCharPattern = \"[\\\\d-]\"`", "fieldName": "allowedCharPattern", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "autocapitalize", "type": { "text": "string" }, "description": "This is a property supported by Safari and Chrome that is used to control whether\nautocapitalization should be enabled when the user is entering/editing the text.\nPossible values are:\ncharacters: Characters capitalization.\nwords: Words capitalization.\nsentences: Sentences capitalization.\nnone: No capitalization.", "fieldName": "autocapitalize", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "name": "autocomplete", "type": { "text": "string" }, "description": "Whether the value of the control can be automatically completed by the browser.\nList of available options at:\nhttps://developer.mozilla.org/en/docs/Web/HTML/Element/input#attr-autocomplete", "fieldName": "autocomplete", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "name": "autocorrect", "type": { "text": "string" }, "description": "This is a property supported by Safari that is used to control whether\nautocorrection should be enabled when the user is entering/editing the text.\nPossible values are:\non: Enable autocorrection.\noff: Disable autocorrection.", "fieldName": "autocorrect", "inheritedFrom": { "name": "InputFieldMixin", "package": "@vaadin/field-base/src/input-field-mixin.js" } }, { "name": "autoselect", "type": { "text": "boolean" }, "description": "If true, the input text gets fully selected when the field is focused using click or touch / tap.", "fieldName": "autoselect", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "clear-button-visible", "type": { "text": "boolean" }, "description": "Set to true to display the clear icon which clears the input.\n\nIt is up to the component to choose where to place the clear icon:\nin the Shadow DOM or in the light DOM. In any way, a reference to\nthe clear icon element should be provided via the `clearElement` getter.", "fieldName": "clearButtonVisible", "inheritedFrom": { "name": "ClearButtonMixin", "package": "@vaadin/field-base/src/clear-button-mixin.js" } }, { "name": "error-message", "type": { "text": "string" }, "description": "Error to show when the field is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "helper-text", "type": { "text": "string" }, "description": "String used for the helper text.", "fieldName": "helperText", "inheritedFrom": { "name": "FieldMixin", "package": "@vaadin/field-base/src/field-mixin.js" } }, { "name": "max", "type": { "text": "number" }, "description": "The maximum value of the field.", "fieldName": "max", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "name": "min", "type": { "text": "number" }, "description": "The minimum value of the field.", "fieldName": "min", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "name": "name", "type": { "text": "string" }, "description": "The name of this field.", "fieldName": "name", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "A hint to the user of what can be entered in the field.", "fieldName": "placeholder", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "When present, it specifies that the field is read-only.", "fieldName": "readonly", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } }, { "name": "step", "type": { "text": "number" }, "description": "Specifies the allowed number intervals of the field.", "fieldName": "step", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "name": "step-buttons-visible", "type": { "text": "boolean" }, "description": "Set to true to show increase/decrease buttons.", "fieldName": "stepButtonsVisible", "inheritedFrom": { "name": "NumberFieldMixin", "module": "src/vaadin-number-field-mixin.js" } }, { "name": "title", "type": { "text": "string" }, "description": "The text usually displayed in a tooltip popup when the mouse is over the field.", "fieldName": "title", "inheritedFrom": { "name": "InputControlMixin", "package": "@vaadin/field-base/src/input-control-mixin.js" } } ] } ], "exports": [ { "kind": "js", "name": "NumberField", "declaration": { "name": "NumberField", "module": "src/vaadin-number-field.js" } } ] } ] }