mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
docs(all): possible values are extracted by stencil (#16190)
* docs(all): possible values are extracted by stencil * add defaults * remove all hardcoded defaults * update stencil
This commit is contained in:
Manu MA
@@ -31,7 +31,6 @@ export class Input implements ComponentInterface {
|
||||
|
||||
/**
|
||||
* The mode determines which platform styles to use.
|
||||
* Possible values are: `"ios"` or `"md"`.
|
||||
*/
|
||||
@Prop() mode!: Mode;
|
||||
|
||||
@@ -41,27 +40,27 @@ export class Input implements ComponentInterface {
|
||||
@Prop() accept?: string;
|
||||
|
||||
/**
|
||||
* Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Defaults to `"none"`.
|
||||
* Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.
|
||||
*/
|
||||
@Prop() autocapitalize = 'none';
|
||||
@Prop() autocapitalize: 'on' | 'off' | 'words' | 'characters' = 'off';
|
||||
|
||||
/**
|
||||
* Indicates whether the value of the control can be automatically completed by the browser. Defaults to `"off"`.
|
||||
* Indicates whether the value of the control can be automatically completed by the browser.
|
||||
*/
|
||||
@Prop() autocomplete = 'off';
|
||||
@Prop() autocomplete: 'on' | 'off' = 'off';
|
||||
|
||||
/**
|
||||
* Whether autocorrection should be enabled when the user is entering/editing the text value. Defaults to `"off"`.
|
||||
* Whether autocorrection should be enabled when the user is entering/editing the text value.
|
||||
*/
|
||||
@Prop() autocorrect = 'off';
|
||||
@Prop() autocorrect: 'on' | 'off' = 'off';
|
||||
|
||||
/**
|
||||
* This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
|
||||
* This Boolean attribute lets you specify that a form control should have input focus when the page loads.
|
||||
*/
|
||||
@Prop() autofocus = false;
|
||||
|
||||
/**
|
||||
* If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`.
|
||||
* If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input.
|
||||
*/
|
||||
@Prop() clearInput = false;
|
||||
|
||||
@@ -71,7 +70,7 @@ export class Input implements ComponentInterface {
|
||||
@Prop({ mutable: true }) clearOnEdit?: boolean;
|
||||
|
||||
/**
|
||||
* Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. Default `0`.
|
||||
* Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke.
|
||||
*/
|
||||
@Prop() debounce = 0;
|
||||
|
||||
@@ -81,7 +80,7 @@ export class Input implements ComponentInterface {
|
||||
}
|
||||
|
||||
/**
|
||||
* If `true`, the user cannot interact with the input. Defaults to `false`.
|
||||
* If `true`, the user cannot interact with the input.
|
||||
*/
|
||||
@Prop() disabled = false;
|
||||
|
||||
@@ -91,7 +90,8 @@ export class Input implements ComponentInterface {
|
||||
}
|
||||
|
||||
/**
|
||||
* A hint to the browser for which keyboard to display. This attribute applies when the value of the type attribute is `"text"`, `"password"`, `"email"`, or `"url"`. Possible values are: `"verbatim"`, `"latin"`, `"latin-name"`, `"latin-prose"`, `"full-width-latin"`, `"kana"`, `"katakana"`, `"numeric"`, `"tel"`, `"email"`, `"url"`.
|
||||
* A hint to the browser for which keyboard to display.
|
||||
* This attribute applies when the value of the type attribute is `"text"`, `"password"`, `"email"`, or `"url"`. Possible values are: `"verbatim"`, `"latin"`, `"latin-name"`, `"latin-prose"`, `"full-width-latin"`, `"kana"`, `"katakana"`, `"numeric"`, `"tel"`, `"email"`, `"url"`.
|
||||
*/
|
||||
@Prop() inputmode?: string;
|
||||
|
||||
@@ -136,7 +136,7 @@ export class Input implements ComponentInterface {
|
||||
@Prop() placeholder?: string;
|
||||
|
||||
/**
|
||||
* If `true`, the user cannot modify the value. Defaults to `false`.
|
||||
* If `true`, the user cannot modify the value.
|
||||
*/
|
||||
@Prop() readonly = false;
|
||||
|
||||
@@ -151,12 +151,13 @@ export class Input implements ComponentInterface {
|
||||
@Prop() results?: number;
|
||||
|
||||
/**
|
||||
* If `true`, the element will have its spelling and grammar checked. Defaults to `false`.
|
||||
* If `true`, the element will have its spelling and grammar checked.
|
||||
*/
|
||||
@Prop() spellcheck = false;
|
||||
|
||||
/**
|
||||
* Works with the min and max attributes to limit the increments at which a value can be set. Possible values are: `"any"` or a positive floating point number.
|
||||
* Works with the min and max attributes to limit the increments at which a value can be set.
|
||||
* Possible values are: `"any"` or a positive floating point number.
|
||||
*/
|
||||
@Prop() step?: string;
|
||||
|
||||
@@ -166,7 +167,7 @@ export class Input implements ComponentInterface {
|
||||
@Prop() size?: number;
|
||||
|
||||
/**
|
||||
* The type of control to display. The default type is text. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`.
|
||||
* The type of control to display. The default type is text.
|
||||
*/
|
||||
@Prop() type: TextFieldTypes = 'text';
|
||||
|
||||
|
||||
@@ -10,49 +10,49 @@ It is meant for text `type` inputs only, such as `"text"`, `"password"`, `"email
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Attribute | Description | Type |
|
||||
| ---------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `accept` | `accept` | If the value of the type attribute is `"file"`, then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers. | `string \| undefined` |
|
||||
| `autocapitalize` | `autocapitalize` | Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Defaults to `"none"`. | `string` |
|
||||
| `autocomplete` | `autocomplete` | Indicates whether the value of the control can be automatically completed by the browser. Defaults to `"off"`. | `string` |
|
||||
| `autocorrect` | `autocorrect` | Whether autocorrection should be enabled when the user is entering/editing the text value. Defaults to `"off"`. | `string` |
|
||||
| `autofocus` | `autofocus` | This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`. | `boolean` |
|
||||
| `clearInput` | `clear-input` | If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`. | `boolean` |
|
||||
| `clearOnEdit` | `clear-on-edit` | If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types. | `boolean \| undefined` |
|
||||
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `string \| undefined` |
|
||||
| `debounce` | `debounce` | Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. Default `0`. | `number` |
|
||||
| `disabled` | `disabled` | If `true`, the user cannot interact with the input. Defaults to `false`. | `boolean` |
|
||||
| `inputmode` | `inputmode` | A hint to the browser for which keyboard to display. This attribute applies when the value of the type attribute is `"text"`, `"password"`, `"email"`, or `"url"`. Possible values are: `"verbatim"`, `"latin"`, `"latin-name"`, `"latin-prose"`, `"full-width-latin"`, `"kana"`, `"katakana"`, `"numeric"`, `"tel"`, `"email"`, `"url"`. | `string \| undefined` |
|
||||
| `max` | `max` | The maximum value, which must not be less than its minimum (min attribute) value. | `string \| undefined` |
|
||||
| `maxlength` | `maxlength` | If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter. | `number \| undefined` |
|
||||
| `min` | `min` | The minimum value, which must not be greater than its maximum (max attribute) value. | `string \| undefined` |
|
||||
| `minlength` | `minlength` | If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter. | `number \| undefined` |
|
||||
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `"ios" \| "md"` |
|
||||
| `multiple` | `multiple` | If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `"email"` or `"file"`, otherwise it is ignored. | `boolean \| undefined` |
|
||||
| `name` | `name` | The name of the control, which is submitted with the form data. | `string` |
|
||||
| `pattern` | `pattern` | A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. | `string \| undefined` |
|
||||
| `placeholder` | `placeholder` | Instructional text that shows before the input has a value. | `string \| undefined` |
|
||||
| `readonly` | `readonly` | If `true`, the user cannot modify the value. Defaults to `false`. | `boolean` |
|
||||
| `required` | `required` | If `true`, the user must fill in a value before submitting a form. | `boolean` |
|
||||
| `results` | `results` | This is a nonstandard attribute supported by Safari that only applies when the type is `"search"`. Its value should be a nonnegative decimal integer. | `number \| undefined` |
|
||||
| `size` | `size` | The initial size of the control. This value is in pixels unless the value of the type attribute is `"text"` or `"password"`, in which case it is an integer number of characters. This attribute applies only when the `type` attribute is set to `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. | `number \| undefined` |
|
||||
| `spellcheck` | `spellcheck` | If `true`, the element will have its spelling and grammar checked. Defaults to `false`. | `boolean` |
|
||||
| `step` | `step` | Works with the min and max attributes to limit the increments at which a value can be set. Possible values are: `"any"` or a positive floating point number. | `string \| undefined` |
|
||||
| `type` | `type` | The type of control to display. The default type is text. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`. | `"date" \| "email" \| "number" \| "password" \| "search" \| "tel" \| "text" \| "url"` |
|
||||
| `value` | `value` | The value of the input. | `null \| string \| undefined` |
|
||||
| Property | Attribute | Description | Type | Default |
|
||||
| ---------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -------------- |
|
||||
| `accept` | `accept` | If the value of the type attribute is `"file"`, then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers. | `string \| undefined` | `undefined` |
|
||||
| `autocapitalize` | `autocapitalize` | Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. | `"characters" \| "off" \| "on" \| "words"` | `'off'` |
|
||||
| `autocomplete` | `autocomplete` | Indicates whether the value of the control can be automatically completed by the browser. | `"off" \| "on"` | `'off'` |
|
||||
| `autocorrect` | `autocorrect` | Whether autocorrection should be enabled when the user is entering/editing the text value. | `"off" \| "on"` | `'off'` |
|
||||
| `autofocus` | `autofocus` | This Boolean attribute lets you specify that a form control should have input focus when the page loads. | `boolean` | `false` |
|
||||
| `clearInput` | `clear-input` | If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. | `boolean` | `false` |
|
||||
| `clearOnEdit` | `clear-on-edit` | If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types. | `boolean \| undefined` | `undefined` |
|
||||
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `string \| undefined` | `undefined` |
|
||||
| `debounce` | `debounce` | Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. | `number` | `0` |
|
||||
| `disabled` | `disabled` | If `true`, the user cannot interact with the input. | `boolean` | `false` |
|
||||
| `inputmode` | `inputmode` | A hint to the browser for which keyboard to display. This attribute applies when the value of the type attribute is `"text"`, `"password"`, `"email"`, or `"url"`. Possible values are: `"verbatim"`, `"latin"`, `"latin-name"`, `"latin-prose"`, `"full-width-latin"`, `"kana"`, `"katakana"`, `"numeric"`, `"tel"`, `"email"`, `"url"`. | `string \| undefined` | `undefined` |
|
||||
| `max` | `max` | The maximum value, which must not be less than its minimum (min attribute) value. | `string \| undefined` | `undefined` |
|
||||
| `maxlength` | `maxlength` | If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter. | `number \| undefined` | `undefined` |
|
||||
| `min` | `min` | The minimum value, which must not be greater than its maximum (max attribute) value. | `string \| undefined` | `undefined` |
|
||||
| `minlength` | `minlength` | If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter. | `number \| undefined` | `undefined` |
|
||||
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
|
||||
| `multiple` | `multiple` | If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `"email"` or `"file"`, otherwise it is ignored. | `boolean \| undefined` | `undefined` |
|
||||
| `name` | `name` | The name of the control, which is submitted with the form data. | `string` | `this.inputId` |
|
||||
| `pattern` | `pattern` | A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. | `string \| undefined` | `undefined` |
|
||||
| `placeholder` | `placeholder` | Instructional text that shows before the input has a value. | `string \| undefined` | `undefined` |
|
||||
| `readonly` | `readonly` | If `true`, the user cannot modify the value. | `boolean` | `false` |
|
||||
| `required` | `required` | If `true`, the user must fill in a value before submitting a form. | `boolean` | `false` |
|
||||
| `results` | `results` | This is a nonstandard attribute supported by Safari that only applies when the type is `"search"`. Its value should be a nonnegative decimal integer. | `number \| undefined` | `undefined` |
|
||||
| `size` | `size` | The initial size of the control. This value is in pixels unless the value of the type attribute is `"text"` or `"password"`, in which case it is an integer number of characters. This attribute applies only when the `type` attribute is set to `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. | `number \| undefined` | `undefined` |
|
||||
| `spellcheck` | `spellcheck` | If `true`, the element will have its spelling and grammar checked. | `boolean` | `false` |
|
||||
| `step` | `step` | Works with the min and max attributes to limit the increments at which a value can be set. Possible values are: `"any"` or a positive floating point number. | `string \| undefined` | `undefined` |
|
||||
| `type` | `type` | The type of control to display. The default type is text. | `"date" \| "email" \| "number" \| "password" \| "search" \| "tel" \| "text" \| "url"` | `'text'` |
|
||||
| `value` | `value` | The value of the input. | `null \| string \| undefined` | `''` |
|
||||
|
||||
|
||||
## Events
|
||||
|
||||
| Event | Detail | Description |
|
||||
| ------------------- | -------------------- | ---------------------------------------- |
|
||||
| `ionBlur` | | Emitted when the input loses focus. |
|
||||
| `ionChange` | TextInputChangeEvent | Emitted when the value has changed. |
|
||||
| `ionFocus` | | Emitted when the input has focus. |
|
||||
| `ionInput` | KeyboardEvent | Emitted when a keyboard input ocurred. |
|
||||
| `ionInputDidLoad` | | Emitted when the input has been created. |
|
||||
| `ionInputDidUnload` | | Emitted when the input has been removed. |
|
||||
| `ionStyle` | StyleEvent | Emitted when the styles change. |
|
||||
| Event | Description | Detail |
|
||||
| ------------------- | ---------------------------------------- | -------------------- |
|
||||
| `ionBlur` | Emitted when the input loses focus. | void |
|
||||
| `ionChange` | Emitted when the value has changed. | TextInputChangeEvent |
|
||||
| `ionFocus` | Emitted when the input has focus. | void |
|
||||
| `ionInput` | Emitted when a keyboard input ocurred. | KeyboardEvent |
|
||||
| `ionInputDidLoad` | Emitted when the input has been created. | void |
|
||||
| `ionInputDidUnload` | Emitted when the input has been removed. | void |
|
||||
| `ionStyle` | Emitted when the styles change. | StyleEvent |
|
||||
|
||||
|
||||
## Methods
|
||||
|
||||
Reference in New Issue
Block a user