跳到主要内容
版本:v6

ion-input

scoped

输入组件是对 HTML input 元素的封装,具有自定义样式和额外功能。它接受与 HTML input 大多数相同的属性,但在桌面设备上表现出色,并与移动设备上的键盘集成。

基本用法

类型

输入组件仅适用于文本类型输入,例如 "text""password""email""number""search""tel""url"。它支持所有标准文本输入事件,包括 keyupkeydownkeypress 等。默认 type"text"

标签

标签应用于描述输入。它们可以在视觉上使用,当用户聚焦输入时,屏幕阅读器也会将其读出。这使用户能够轻松理解输入的用途。输入有几种分配标签的方式:

  • label 属性:用于纯文本标签
  • label 插槽:用于自定义 HTML 标签(实验性)
  • aria-label:用于为屏幕阅读器提供标签,但不添加可见标签

标签位置

默认情况下,标签将占用其内容的宽度。开发者可以使用 labelPlacement 属性控制标签相对于控件的位置。

标签插槽(实验性)

虽然纯文本标签应通过 label 属性传递,但如果需要自定义 HTML,可以通过 label 插槽传递。

请注意,此功能被认为是实验性的,因为它依赖于 Web Component 插槽的模拟版本。因此,模拟行为可能与原生插槽行为不完全一致。

无可见标签

如果不需要可见标签,开发者仍应提供 aria-label,以便屏幕阅读器可以访问输入。

清除选项

输入提供两种根据交互方式清除输入的选项。第一种是添加 clearInput 属性,当输入有 value 时会显示清除按钮。第二种是 clearOnEdit 属性,它在输入失焦后再次输入时清除输入。type 设置为 "password" 的输入默认启用 clearOnEdit

填充样式输入

Material Design 为输入提供了填充样式。输入上的 fill 属性可以设置为 "solid""outline"

由于 fill 样式在视觉上定义了输入容器,使用 fill 的输入不应在 ion-item 中使用。

填充输入可以通过将输入的 mode 设置为 md 在 iOS 上使用。

帮助和错误文本

可以使用 helperTexterrorText 属性在输入内部使用帮助和错误文本。除非将 ion-invalidion-touched 类添加到 ion-input,否则错误文本不会显示。这确保在用户有机会输入数据之前不会显示错误。

在 Angular 中,这是通过表单验证自动完成的。在 JavaScript、React 和 Vue 中,需要根据你自己的验证手动添加类。

输入计数器

输入计数器是显示在输入下方的文本,用于通知用户已输入了多少字符以及输入总共可以接受多少字符。添加计数器时,默认行为是格式化为 inputLength / maxLength 的显示值。可以通过向 counterFormatter 属性传递格式化函数来自定义此行为。

ion-item 上的 countercounterFormatter 属性已在 Ionic 7 中弃用,应直接用于 ion-input

带有计数器的输入在输入和计数器之间添加了边框,因此不应放置在会在项目下方添加额外边框的 ion-item 内部。可以添加 ion-padding-start 类来使计数器输入与项目内部的输入对齐。

过滤用户输入

开发者可以使用 ionInput 事件根据用户输入(如 keypress)更新输入值。这对于过滤掉无效或不需要的字符非常有用。

将值存储在状态变量中时,我们建议同时更新状态变量和 ion-input 组件值。这可确保状态变量和 ion-input 组件值保持同步。

输入掩码

输入掩码是约束输入以支持有效输入值的表达式。Ionic 建议使用 Maskito 进行输入掩码。Maskito 是一个轻量级、无依赖的用于掩码输入字段的库。它支持广泛的掩码,包括电话号码、信用卡、日期等。

要开始使用 Maskito,请安装该库:

npm install @maskito/core @maskito/{angular,react,vue}
备注

请将 Maskito 的错误报告提交到 Maskito GitHub 仓库。技术支持请使用 Ionic ForumIonic Discord

开始和结束插槽(实验性)

startend 插槽可用于在输入的任一侧放置图标、按钮或前缀/后缀文本。

请注意,此功能被认为是实验性的,因为它依赖于 Web Component 插槽的模拟版本。因此,模拟行为可能与原生插槽行为不完全一致。

备注

在大多数情况下,放置在这些插槽中的图标组件应设置 aria-hidden="true"。更多信息请参阅图标无障碍文档

如果插槽内容需要交互,应将其包裹在交互元素中,如按钮。这确保内容可以通过 Tab 键聚焦。

主题

颜色

设置 color 属性会更改每个输入的色调。在 ios 模式下,此属性更改光标颜色。在 md 模式下,此属性更改光标颜色和高亮/下划线颜色。

备注

color 属性_不会_更改输入的文本颜色。为此,请使用 --color CSS 属性

CSS 自定义属性

Input 使用 scoped 封装,这意味着它会在运行时通过为每个样式追加额外类来自动限定 CSS 作用域。在 CSS 中覆盖 scoped 选择器需要更高的特异性选择器。直接定位 ion-input 进行自定义将不起作用;因此我们建议添加一个类并以这种方式进行自定义。

从旧版输入语法迁移

Ionic 7.0 引入了更简单的输入语法。这种新语法减少了设置输入所需的样板代码,解决了无障碍访问问题,并改善了开发者体验。

开发者可以逐个迁移每个输入。虽然开发者可以继续使用旧版语法,但我们建议尽快迁移。

使用现代语法

使用现代语法包括三个步骤:

  1. 移除 ion-label,改用在 ion-input 上使用 label 属性。标签的位置可以使用 ion-input 上的 labelPlacement 属性配置。
  2. 将输入特定的属性从 ion-item 移到 ion-input 上。这包括 countercounterFormatterfillshape 属性。
  3. 移除 ion-item 上的 helpererror 插槽的使用,改用在 ion-input 上使用 helperTexterrorText 属性。
<!-- Label and Label Position -->

<!-- Before -->
<ion-item>
<ion-label position="floating">Email:</ion-label>
<ion-input></ion-input>
</ion-item>

<!-- After -->
<ion-item>
<ion-input label="Email:" label-placement="floating"></ion-input>
</ion-item>


<!-- Fill -->

<!-- Before -->
<ion-item fill="outline" shape="round">
<ion-label position="floating">Email:</ion-label>
<ion-input></ion-input>
</ion-item>

<!-- After -->

<!-- Inputs using `fill` should not be placed in ion-item -->
<ion-input fill="outline" shape="round" label="Email:" label-placement="floating"></ion-input>

<!-- Input-specific features on ion-item -->

<!-- Before -->
<ion-item counter="true">
<ion-label position="floating">Email:</ion-label>
<ion-input maxlength="100"></ion-input>
<div slot="helper">Enter an email</div>
<div slot="error">Please enter a valid email</div>
</ion-item>

<!-- After -->

<!--
Metadata such as counters and helper text should not
be used when an input is in an item/list. If you need to
provide more context on a input, consider using an ion-note
underneath the ion-list.
-->

<ion-input
label="Email:"
counter="true"
maxlength="100"
helper-text="Enter an email"
error-text="Please enter a valid email"
></ion-input>

使用旧版语法

Ionic 使用启发式方法检测应用是否在使用现代输入语法。在某些情况下,继续使用旧版语法可能更可取。开发者可以将 ion-input 上的 legacy 属性设置为 true,以强制该输入实例使用旧版语法。

接口

InputChangeEventDetail

interface InputChangeEventDetail {
value: string | undefined | null;
}

InputCustomEvent

虽然不是必需的,但此接口可以替代 CustomEvent 接口,为此组件发出的 Ionic 事件提供更强的类型支持。

interface InputCustomEvent extends CustomEvent {
detail: InputChangeEventDetail;
target: HTMLIonInputElement;
}

属性

accept (已弃用)

说明This attribute is ignored.

已弃用
属性accept
类型string | undefined
默认值undefined

autocapitalize

说明Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
属性autocapitalize
类型string
默认值'off'

autocomplete

说明Indicates whether the value of the control can be automatically completed by the browser.
属性autocomplete
类型"name" | "email" | "tel" | "url" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo"
默认值'off'

autocorrect

说明Whether auto correction should be enabled when the user is entering/editing the text value.
属性autocorrect
类型"off" | "on"
默认值'off'

autofocus

说明Sets the autofocus attribute on the native input element.

This may not be sufficient for the element to be focused on page load. See managing focus for more information.
属性autofocus
类型boolean
默认值false

clearInput

说明If true, a clear icon will appear in the input when there is a value. Clicking it clears the input.
属性clear-input
类型boolean
默认值false

clearOnEdit

说明If true, the value will be cleared after focus upon edit. Defaults to true when type is "password", false for all other types.
属性clear-on-edit
类型boolean | undefined
默认值undefined

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.
属性color
类型"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string | undefined
默认值undefined

counter

说明If true, a character counter will display the ratio of characters used and the total character limit. Developers must also set the maxlength property for the counter to be calculated correctly.
属性counter
类型boolean
默认值false

counterFormatter

说明A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength".

See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access this from within the callback.
属性undefined
类型((inputLength: number, maxLength: number) => string) | undefined
默认值undefined

debounce

说明Set the amount of time, in milliseconds, to wait to trigger the ionInput event after each keystroke.
属性debounce
类型number | undefined
默认值undefined

disabled

说明If true, the user cannot interact with the input.
属性disabled
类型boolean
默认值false

enterkeyhint

说明A hint to the browser for which enter key to display. Possible values: "enter", "done", "go", "next", "previous", "search", and "send".
属性enterkeyhint
类型"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefined
默认值undefined

errorText

说明Text that is placed under the input and displayed when an error is detected.
属性error-text
类型string | undefined
默认值undefined

fill

说明The fill for the item. If "solid" the item will have a background. If "outline" the item will be transparent with a border. Only available in md mode.
属性fill
类型"outline" | "solid" | undefined
默认值undefined

helperText

说明Text that is placed under the input and displayed when no error is detected.
属性helper-text
类型string | undefined
默认值undefined

inputmode

说明A hint to the browser for which keyboard to display. Possible values: "none", "text", "tel", "url", "email", "numeric", "decimal", and "search".
属性inputmode
类型"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | undefined
默认值undefined

label

说明The visible label associated with the input.

Use this if you need to render a plaintext label.

The label property will take priority over the label slot if both are used.
属性label
类型string | undefined
默认值undefined

labelPlacement

说明Where to place the label relative to the input. "start": The label will appear to the left of the input in LTR and to the right in RTL. "end": The label will appear to the right of the input in LTR and to the left in RTL. "floating": The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. "stacked": The label will appear smaller and above the input regardless even when the input is blurred or has no value. "fixed": The label has the same behavior as "start" except it also has a fixed width. Long text will be truncated with ellipses ("...").
属性label-placement
类型"end" | "fixed" | "floating" | "stacked" | "start"
默认值'start'

legacy

说明Set the legacy property to true to forcibly use the legacy form control markup. Ionic will only opt components in to the modern form markup when they are using either the aria-label attribute or the label property. As a result, the legacy property should only be used as an escape hatch when you want to avoid this automatic opt-in behavior. Note that this property will be removed in an upcoming major release of Ionic, and all form components will be opted-in to using the modern form markup.
属性legacy
类型boolean | undefined
默认值undefined

max

说明The maximum value, which must not be less than its minimum (min attribute) value.
属性max
类型number | string | undefined
默认值undefined

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.
属性maxlength
类型number | undefined
默认值undefined

min

说明The minimum value, which must not be greater than its maximum (max attribute) value.

这是一个虚拟属性,在初始化时设置一次,之后更改其值不会更新组件。
属性min
类型number | string | undefined
默认值undefined

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.
属性minlength
类型number | undefined
默认值undefined

mode

说明The mode determines which platform styles to use.

这是一个虚拟属性,在初始化时设置一次,之后更改其值不会更新组件。
属性mode
类型"ios" | "md"
默认值undefined

multiple

说明If true, the user can enter more than one value. This attribute applies when the type attribute is set to "email", otherwise it is ignored.
属性multiple
类型boolean | undefined
默认值undefined

name

说明The name of the control, which is submitted with the form data.
属性name
类型string
默认值this.inputId

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", "date", or "password", otherwise it is ignored. When the type attribute is "date", pattern will only be used in browsers that do not support the "date" input type natively. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date for more information.
属性pattern
类型string | undefined
默认值undefined

placeholder

说明Instructional text that shows before the input has a value. This property applies only when the type property is set to "email", "number", "password", "search", "tel", "text", or "url", otherwise it is ignored.
属性placeholder
类型string | undefined
默认值undefined

readonly

说明If true, the user cannot modify the value.
属性readonly
类型boolean
默认值false

required

说明If true, the user must fill in a value before submitting a form.
属性required
类型boolean
默认值false

shape

说明The shape of the input. If "round" it will have an increased border radius.
属性shape
类型"round" | undefined
默认值undefined

size

说明
属性size
类型number | undefined
默认值undefined

spellcheck

说明If true, the element will have its spelling and grammar checked.
属性spellcheck
类型boolean
默认值false

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.
属性step
类型string | undefined
默认值undefined

type

说明The type of control to display. The default type is text.
属性type
类型"date" | "datetime-local" | "email" | "month" | "number" | "password" | "search" | "tel" | "text" | "time" | "url" | "week"
默认值'text'

value

说明The value of the input.
属性value
类型null | number | string | undefined
默认值''

事件

Name说明冒泡
ionBlurEmitted when the input loses focus.true
ionChangeThe ionChange event is fired when the user modifies the input's value. Unlike the ionInput event, the ionChange event is only fired when changes are committed, not as the user types.

Depending on the way the users interacts with the element, the ionChange event fires at a different moment: - When the user commits the change explicitly (e.g. by selecting a date from a date picker for <ion-input type="date">, pressing the "Enter" key, etc.). - When the element loses focus after its value has changed: for elements where the user's interaction is typing.
true
ionFocusEmitted when the input has focus.true
ionInputThe ionInput event is fired each time the user modifies the input's value. Unlike the ionChange event, the ionInput event is fired for each alteration to the input's value. This typically happens for each keystroke as the user types.

For elements that accept text input (type=text, type=tel, etc.), the interface is InputEvent; for others, the interface is Event. If the input is cleared on edit, the type is null.
true

方法

getInputElement

说明Returns the native <input> element used under the hood.
签名getInputElement() => Promise<HTMLInputElement>

setFocus

说明Sets focus on the native input in ion-input. Use this method instead of the global input.focus().

Developers who wish to focus an input when a page enters should call setFocus() in the ionViewDidEnter() lifecycle method.

Developers who wish to focus an input when an overlay is presented should call setFocus after didPresent has resolved.

See managing focus for more information.
签名setFocus() => Promise<void>

CSS 阴影部分

该组件没有可用的 CSS 阴影部分。

CSS 自定义属性

Name说明
--backgroundBackground of the input
--border-colorColor of the border below the input when using helper text, error text, or counter
--border-radiusRadius of the input. A large radius may display unevenly when using fill="outline"; if needed, use shape="round" instead or increase --padding-start.
--border-styleStyle of the border below the input when using helper text, error text, or counter
--border-widthWidth of the border below the input when using helper text, error text, or counter
--colorColor of the input text
--highlight-color-focusedThe color of the highlight on the input when focused
--highlight-color-invalidThe color of the highlight on the input when invalid
--highlight-color-validThe color of the highlight on the input when valid
--padding-bottomBottom padding of the input
--padding-endRight padding if direction is left-to-right, and left padding if direction is right-to-left of the input
--padding-startLeft padding if direction is left-to-right, and right padding if direction is right-to-left of the input
--padding-topTop padding of the input
--placeholder-colorColor of the input placeholder text
--placeholder-font-styleFont style of the input placeholder text
--placeholder-font-weightFont weight of the input placeholder text
--placeholder-opacityOpacity of the input placeholder text

插槽

Name说明
endContent to display at the trailing edge of the input. (EXPERIMENTAL)
labelThe label text to associate with the input. Use the labelPlacement property to control where the label is placed relative to the input. Use this if you need to render a label with custom HTML. (EXPERIMENTAL)
startContent to display at the leading edge of the input. (EXPERIMENTAL)