mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
fix(all): docs for all missing props
This commit is contained in:
Manu Mtz.-Almeida
committed by
Manu MA
Manu MA
parent
53305741a0
commit
a72fced6fe
@@ -61,12 +61,12 @@ export class Input implements ComponentInterface {
|
||||
@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. Defaults to `false`.
|
||||
*/
|
||||
@Prop() clearInput = false;
|
||||
|
||||
/**
|
||||
* If true, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types.
|
||||
* If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types.
|
||||
*/
|
||||
@Prop({ mutable: true }) clearOnEdit?: boolean;
|
||||
|
||||
@@ -81,7 +81,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. Defaults to `false`.
|
||||
*/
|
||||
@Prop() disabled = false;
|
||||
|
||||
@@ -116,7 +116,7 @@ export class Input implements ComponentInterface {
|
||||
@Prop() minlength?: number;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* 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.
|
||||
*/
|
||||
@Prop() multiple?: boolean;
|
||||
|
||||
@@ -136,12 +136,12 @@ 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. Defaults to `false`.
|
||||
*/
|
||||
@Prop() readonly = false;
|
||||
|
||||
/**
|
||||
* If true, the user must fill in a value before submitting a form.
|
||||
* If `true`, the user must fill in a value before submitting a form.
|
||||
*/
|
||||
@Prop() required = false;
|
||||
|
||||
@@ -151,7 +151,7 @@ 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. Defaults to `false`.
|
||||
*/
|
||||
@Prop() spellcheck = false;
|
||||
|
||||
@@ -244,6 +244,10 @@ export class Input implements ComponentInterface {
|
||||
this.ionInputDidUnload.emit();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets focus on the specified `ion-input`. Use this method instead of the global
|
||||
* `input.focus()`.
|
||||
*/
|
||||
@Method()
|
||||
setFocus() {
|
||||
if (this.nativeInput) {
|
||||
|
||||
@@ -17,26 +17,26 @@ It is meant for text `type` inputs only, such as `"text"`, `"password"`, `"email
|
||||
| `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` |
|
||||
| `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` |
|
||||
| `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` |
|
||||
| `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` |
|
||||
| `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` |
|
||||
| `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` |
|
||||
@@ -59,7 +59,8 @@ It is meant for text `type` inputs only, such as `"text"`, `"password"`, `"email
|
||||
|
||||
### `setFocus() => void`
|
||||
|
||||
|
||||
Sets focus on the specified `ion-input`. Use this method instead of the global
|
||||
`input.focus()`.
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
Reference in New Issue
Block a user