跳到主要内容
版本:v8

ion-toggle

shadow

Toggle 是更改单个选项状态的开关。可以通过按压或滑动来打开或关闭它们。Toggle 也可以通过设置 checked 属性以编程方式选中。

基本用法

开 / 关标签

Toggle 可以通过设置 enableOnOffLabels 属性来启用开/关标签。这对无障碍很重要,因为它使区分已选中和未选中的 toggle 更加容易。

列表中的 Toggle

Toggle 也可以通过在列表视图中使用 ItemList 组件来使用。

标签位置

开发者可以使用 labelPlacement 属性来控制标签相对于控件的位置。

对齐

开发者可以使用 alignment 属性来控制标签和控件在交叉轴上的对齐方式。此属性反映了 flexbox 的 align-items 属性。

备注

可以使用 alignment 属性来对齐堆叠的 toggle。当标签和控件需要在水平方向上居中时,这很有用。

排列

开发者可以使用 justify 属性来控制标签和控件在一行上的排列方式。

帮助文本与错误文本

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

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

主题

颜色

CSS 自定义属性

CSS 自定义属性可以与标准 CSS 结合使用,以定位 toggle 的不同部分。我们可以直接修改 toggle 的 widthheight 来更改轨道的大小,同时使用 --handle-width--handle-height 自定义属性来定制手柄的大小。

CSS Shadow Parts

我们可以通过定位暴露的特定阴影部分来进一步定制 toggle。这些部分上的任何 CSS 属性都可以设置样式,并且它们也可以与 CSS 自定义属性结合使用。

接口

ToggleChangeEventDetail

interface ToggleChangeEventDetail<T = any> {
value: T;
checked: boolean;
}

ToggleCustomEvent

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

interface ToggleCustomEvent<T = any> extends CustomEvent {
detail: ToggleChangeEventDetail<T>;
target: HTMLIonToggleElement;
}

属性

alignment

说明How to control the alignment of the toggle and label on the cross axis. "start": The label and control will appear on the left of the cross axis in LTR, and on the right side in RTL. "center": The label and control will appear at the center of the cross axis in both LTR and RTL. Setting this property will change the toggle display to block.
属性alignment
类型"center" | "start" | undefined
默认值undefined

checked

说明If true, the toggle is selected.
属性checked
类型boolean
默认值false

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

disabled

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

enableOnOffLabels

说明Enables the on/off accessibility switch labels within the toggle.
属性enable-on-off-labels
类型boolean | undefined
默认值config.get('toggleOnOffLabels')

errorText

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

helperText

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

justify

说明How to pack the label and toggle within a line. "start": The label and toggle will appear on the left in LTR and on the right in RTL. "end": The label and toggle will appear on the right in LTR and on the left in RTL. "space-between": The label and toggle will appear on opposite ends of the line with space between the two elements. Setting this property will change the toggle display to block.
属性justify
类型"end" | "space-between" | "start" | undefined
默认值undefined

labelPlacement

说明Where to place the label relative to the input. "start": The label will appear to the left of the toggle in LTR and to the right in RTL. "end": The label will appear to the right of the toggle in LTR and to the left in RTL. "fixed": The label has the same behavior as "start" except it also has a fixed width. Long text will be truncated with ellipses ("..."). "stacked": The label will appear above the toggle regardless of the direction. The alignment of the label can be controlled with the alignment property.
属性label-placement
类型"end" | "fixed" | "stacked" | "start"
默认值'start'

mode

说明The mode determines which platform styles to use.

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

name

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

required

说明If true, screen readers will announce it as a required field. This property works only for accessibility purposes, it will not prevent the form from submitting if the value is invalid.
属性required
类型boolean
默认值false

value

说明The value of the toggle does not mean if it's checked or not, use the checked property for that.

The value of a toggle is analogous to the value of a <input type="checkbox">, it's only used when the toggle participates in a native <form>.
属性value
类型null | string | undefined
默认值'on'

事件

Name说明冒泡
ionBlurEmitted when the toggle loses focus.true
ionChangeEmitted when the user switches the toggle on or off.

This event will not emit when programmatically setting the checked property.
true
ionFocusEmitted when the toggle has focus.true

方法

该组件没有可用的公共方法。

CSS Shadow Parts

Name说明
error-textSupporting text displayed beneath the toggle label when the toggle is invalid and touched.
handleThe toggle handle, or knob, used to change the checked state.
helper-textSupporting text displayed beneath the toggle label when the toggle is valid.
labelThe label text describing the toggle.
supporting-textSupporting text displayed beneath the toggle label.
trackThe background track of the toggle.

CSS 自定义属性

Name说明
--border-radiusBorder radius of the toggle track
--handle-backgroundBackground of the toggle handle
--handle-background-checkedBackground of the toggle handle when checked
--handle-border-radiusBorder radius of the toggle handle
--handle-box-shadowBox shadow of the toggle handle
--handle-heightHeight of the toggle handle
--handle-max-heightMaximum height of the toggle handle
--handle-spacingHorizontal spacing around the toggle handle
--handle-transitionTransition of the toggle handle
--handle-widthWidth of the toggle handle
--track-backgroundBackground of the toggle track
--track-background-checkedBackground of the toggle track when checked

插槽

Name说明
The label text to associate with the toggle. Use the "labelPlacement" property to control where the label is placed relative to the toggle.