跳到主要内容
版本:v7

ion-input

scoped

输入框组件是对 HTML input 元素的封装,具有自定义样式和附加功能。它接受与 HTML input 元素大部分相同的属性,在桌面设备上表现优异,并能与移动设备键盘集成。

基本用法

类型

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

标签

标签应用于描述输入框。它们既可用于视觉呈现,当用户聚焦输入框时也会被屏幕阅读器读出。这有助于用户理解输入框的意图。输入框有几种分配标签的方式:

  • label 属性:用于纯文本标签
  • label 插槽(slot):用于自定义 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 中使用。

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

辅助文本与错误文本

可以在输入框内部使用辅助文本和错误文本,分别通过 helperTexterrorText 属性实现。除非向 ion-input 添加了 ion-invalidion-touched 类,否则错误文本不会显示。这确保了在用户有机会输入数据之前不会显示错误。

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

输入计数器

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

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

带有计数器的输入框会在输入框和计数器之间添加边框,因此不应将其放置在 ion-item 内部,因为 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 论坛Ionic Discord

起始与结束插槽(实验性功能)

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

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

备注

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

如果插槽内容需要交互,应将其包装在交互式元素中,例如 Button。这确保了内容可以通过 Tab 键访问。

主题定制

颜色

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

备注

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

CSS 自定义属性

Input 使用作用域封装(scoped encapsulation),这意味着它将在运行时通过向每个样式附加一个额外的类来自动确定其 CSS 的作用域。要覆盖 CSS 中的作用域选择器,需要更高 特异性 的选择器。以 ion-input 为目标进行自定义将不起作用;因此,我们建议添加一个类并通过该类进行自定义。

从旧版输入语法迁移

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

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

使用现代语法

使用现代语法涉及三个步骤:

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

<!-- 之前 -->
<ion-item>
<ion-label position="floating">邮箱:</ion-label>
<ion-input></ion-input>
</ion-item>

<!-- 之后 -->
<ion-item>
<ion-input label="邮箱:" label-placement="floating"></ion-input>
</ion-item>


<!-- 填充样式 (Fill) -->

<!-- 之前 -->
<ion-item fill="outline" shape="round">
<ion-label position="floating">邮箱:</ion-label>
<ion-input></ion-input>
</ion-item>

<!-- 之后 -->

<!-- 使用 `fill` 属性的输入框不应放置在 ion-item 中 -->
<ion-input fill="outline" shape="round" label="邮箱:" label-placement="floating"></ion-input>

<!-- ion-item 上特定于输入框的功能 -->

<!-- 之前 -->
<ion-item counter="true">
<ion-label position="floating">邮箱:</ion-label>
<ion-input maxlength="100"></ion-input>
<div slot="helper">请输入邮箱</div>
<div slot="error">请输入有效的邮箱地址</div>
</ion-item>

<!-- 之后 -->

<!--
当输入框位于 item/list 中时,不应使用计数器 (counter) 和帮助文本 (helper text) 等元数据。
如果你需要为输入框提供更多上下文,请考虑在 ion-list 下方使用 ion-note。
-->

<ion-input
label="邮箱:"
counter="true"
maxlength="100"
helper-text="请输入邮箱"
error-text="请输入有效的邮箱地址"
></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 (deprecated)

DescriptionThis attribute is ignored.

Deprecated
Attributeaccept
Typestring | undefined
Defaultundefined

autocapitalize

DescriptionIndicates 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".
Attributeautocapitalize
Typestring
Default'off'

autocomplete

DescriptionIndicates whether the value of the control can be automatically completed by the browser.
Attributeautocomplete
Type"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"
Default'off'

autocorrect

DescriptionWhether auto correction should be enabled when the user is entering/editing the text value.
Attributeautocorrect
Type"off" | "on"
Default'off'

autofocus

DescriptionSets 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.
Attributeautofocus
Typeboolean
Defaultfalse

clearInput

DescriptionIf true, a clear icon will appear in the input when there is a value. Clicking it clears the input.
Attributeclear-input
Typeboolean
Defaultfalse

clearOnEdit

DescriptionIf true, the value will be cleared after focus upon edit. Defaults to true when type is "password", false for all other types.
Attributeclear-on-edit
Typeboolean | undefined
Defaultundefined

color

DescriptionThe 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.
Attributecolor
Type"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string | undefined
Defaultundefined

counter

DescriptionIf 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.
Attributecounter
Typeboolean
Defaultfalse

counterFormatter

DescriptionA 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.
Attributeundefined
Type((inputLength: number, maxLength: number) => string) | undefined
Defaultundefined

debounce

DescriptionSet the amount of time, in milliseconds, to wait to trigger the ionInput event after each keystroke.
Attributedebounce
Typenumber | undefined
Defaultundefined

disabled

DescriptionIf true, the user cannot interact with the input.
Attributedisabled
Typeboolean
Defaultfalse

enterkeyhint

DescriptionA hint to the browser for which enter key to display. Possible values: "enter", "done", "go", "next", "previous", "search", and "send".
Attributeenterkeyhint
Type"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefined
Defaultundefined

errorText

DescriptionText that is placed under the input and displayed when an error is detected.
Attributeerror-text
Typestring | undefined
Defaultundefined

fill

DescriptionThe 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.
Attributefill
Type"outline" | "solid" | undefined
Defaultundefined

helperText

DescriptionText that is placed under the input and displayed when no error is detected.
Attributehelper-text
Typestring | undefined
Defaultundefined

inputmode

DescriptionA hint to the browser for which keyboard to display. Possible values: "none", "text", "tel", "url", "email", "numeric", "decimal", and "search".
Attributeinputmode
Type"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | undefined
Defaultundefined

label

DescriptionThe 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.
Attributelabel
Typestring | undefined
Defaultundefined

labelPlacement

DescriptionWhere 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 ("...").
Attributelabel-placement
Type"end" | "fixed" | "floating" | "stacked" | "start"
Default'start'

legacy

DescriptionSet 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.
Attributelegacy
Typeboolean | undefined
Defaultundefined

max

DescriptionThe maximum value, which must not be less than its minimum (min attribute) value.
Attributemax
Typenumber | string | undefined
Defaultundefined

maxlength

DescriptionIf 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.
Attributemaxlength
Typenumber | undefined
Defaultundefined

min

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

This is a virtual property that is set once during initialization and will not update if you change its value after the initial render.
Attributemin
Typenumber | string | undefined
Defaultundefined

minlength

DescriptionIf 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.
Attributeminlength
Typenumber | undefined
Defaultundefined

mode

DescriptionThe mode determines which platform styles to use.

This is a virtual property that is set once during initialization and will not update if you change its value after the initial render.
Attributemode
Type"ios" | "md"
Defaultundefined

multiple

DescriptionIf true, the user can enter more than one value. This attribute applies when the type attribute is set to "email", otherwise it is ignored.
Attributemultiple
Typeboolean | undefined
Defaultundefined

name

DescriptionThe name of the control, which is submitted with the form data.
Attributename
Typestring
Defaultthis.inputId

pattern

DescriptionA 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.
Attributepattern
Typestring | undefined
Defaultundefined

placeholder

DescriptionInstructional 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.
Attributeplaceholder
Typestring | undefined
Defaultundefined

readonly

DescriptionIf true, the user cannot modify the value.
Attributereadonly
Typeboolean
Defaultfalse

required

DescriptionIf true, the user must fill in a value before submitting a form.
Attributerequired
Typeboolean
Defaultfalse

shape

DescriptionThe shape of the input. If "round" it will have an increased border radius.
Attributeshape
Type"round" | undefined
Defaultundefined

size

Description
Attributesize
Typenumber | undefined
Defaultundefined

spellcheck

DescriptionIf true, the element will have its spelling and grammar checked.
Attributespellcheck
Typeboolean
Defaultfalse

step

DescriptionWorks 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.
Attributestep
Typestring | undefined
Defaultundefined

type

DescriptionThe type of control to display. The default type is text.
Attributetype
Type"date" | "datetime-local" | "email" | "month" | "number" | "password" | "search" | "tel" | "text" | "time" | "url" | "week"
Default'text'

value

DescriptionThe value of the input.
Attributevalue
Typenull | number | string | undefined
Default''

事件

NameDescriptionBubbles
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

DescriptionReturns the native <input> element used under the hood.
SignaturegetInputElement() => Promise<HTMLInputElement>

setFocus

DescriptionSets 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.
SignaturesetFocus() => Promise<void>

CSS 阴影部件

No CSS shadow parts available for this component.

CSS 自定义属性

NameDescription
--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

插槽

NameDescription
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)