mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-19 03:32:21 +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:
@ -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';
|
||||
|
||||
|
Reference in New Issue
Block a user