javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(): update to latest stencil

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-08-12 12:04:27 +02:00
parent 149039bd12
commit d856ecfbbf
101 changed files with 1098 additions and 8675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

471
core/src/components/input/readme.md
View File

@@ -10,442 +10,49 @@ It is meant for text `type` inputs only, such as `"text"`, `"password"`, `"email
## Properties
#### accept
string
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.
#### autocapitalize
string
Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Defaults to `"none"`.
#### autocomplete
string
Indicates whether the value of the control can be automatically completed by the browser. Defaults to `"off"`.
#### autocorrect
string
Whether autocorrection should be enabled when the user is entering/editing the text value. Defaults to `"off"`.
#### autofocus
boolean
This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
#### clearInput
boolean
If true, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`.
#### clearOnEdit
boolean
If true, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types.
#### color
string
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).
#### debounce
number
Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. Default `0`.
#### disabled
boolean
If true, the user cannot interact with the input. Defaults to `false`.
#### inputmode
string
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"`.
#### max
string
The maximum value, which must not be less than its minimum (min attribute) value.
#### maxlength
number
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.
#### min
string
The minimum value, which must not be greater than its maximum (max attribute) value.
#### minlength
number
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.
#### mode
string
The mode determines which platform styles to use.
Possible values are: `"ios"` or `"md"`.
#### multiple
boolean
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.
#### name
string
The name of the control, which is submitted with the form data.
#### pattern
string
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.
#### placeholder
string
Instructional text that shows before the input has a value.
#### readonly
boolean
If true, the user cannot modify the value. Defaults to `false`.
#### required
boolean
If true, the user must fill in a value before submitting a form.
#### results
number
This is a nonstandard attribute supported by Safari that only applies when the type is `"search"`. Its value should be a nonnegative decimal integer.
#### size
number
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.
#### spellcheck
boolean
If true, the element will have its spelling and grammar checked. Defaults to `false`.
#### step
string
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.
#### type
string
The type of control to display. The default type is text. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`.
#### value
string
The value of the input.
## Attributes
#### accept
string
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.
#### autocapitalize
string
Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Defaults to `"none"`.
#### autocomplete
string
Indicates whether the value of the control can be automatically completed by the browser. Defaults to `"off"`.
#### autocorrect
string
Whether autocorrection should be enabled when the user is entering/editing the text value. Defaults to `"off"`.
#### autofocus
boolean
This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
#### clear-input
boolean
If true, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`.
#### clear-on-edit
boolean
If true, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types.
#### color
string
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).
#### debounce
number
Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. Default `0`.
#### disabled
boolean
If true, the user cannot interact with the input. Defaults to `false`.
#### inputmode
string
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"`.
#### max
string
The maximum value, which must not be less than its minimum (min attribute) value.
#### maxlength
number
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.
#### min
string
The minimum value, which must not be greater than its maximum (max attribute) value.
#### minlength
number
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.
#### mode
string
The mode determines which platform styles to use.
Possible values are: `"ios"` or `"md"`.
#### multiple
boolean
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.
#### name
string
The name of the control, which is submitted with the form data.
#### pattern
string
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.
#### placeholder
string
Instructional text that shows before the input has a value.
#### readonly
boolean
If true, the user cannot modify the value. Defaults to `false`.
#### required
boolean
If true, the user must fill in a value before submitting a form.
#### results
number
This is a nonstandard attribute supported by Safari that only applies when the type is `"search"`. Its value should be a nonnegative decimal integer.
#### size
number
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.
#### spellcheck
boolean
If true, the element will have its spelling and grammar checked. Defaults to `false`.
#### step
string
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.
#### type
string
The type of control to display. The default type is text. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`.
#### value
string
The value of the input.
| 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` |
| `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` |
| `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). | `Color` |
| `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` |
| `max` | `max` | The maximum value, which must not be less than its minimum (min attribute) value. | `string` |
| `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` |
| `min` | `min` | The minimum value, which must not be greater than its maximum (max attribute) value. | `string` |
| `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` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `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` |
| `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` |
| `placeholder` | `placeholder` | Instructional text that shows before the input has a value. | `string` |
| `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` |
| `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` |
| `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` |
| `type` | `type` | The type of control to display. The default type is text. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`. | `TextFieldTypes` |
| `value` | `value` | The value of the input. | `string` |
## Events
#### ionBlur
Emitted when the input loses focus.
#### ionChange
Emitted when the value has changed.
#### ionFocus
Emitted when the input has focus.
#### ionInput
Emitted when a keyboard input ocurred.
#### ionInputDidLoad
Emitted when the input has been created.
#### ionInputDidUnload
Emitted when the input has been removed.
#### ionStyle
Emitted when the styles change.
| Event | Description |
| ------------------- | ---------------------------------------- |
| `ionBlur` | Emitted when the input loses focus. |
| `ionChange` | Emitted when the value has changed. |
| `ionFocus` | Emitted when the input has focus. |
| `ionInput` | Emitted when a keyboard input ocurred. |
| `ionInputDidLoad` | Emitted when the input has been created. |
| `ionInputDidUnload` | Emitted when the input has been removed. |
| `ionStyle` | Emitted when the styles change. |
----------------------------------------------