Checkbox

切换开关或选择状态。

实时预览

正在加载预览…

参数配置

标签 label颜色 color尺寸 size禁用 disabled否加载中 loading否

全部字段 35

ToggleOptions

Label

Description

ErrorMessage

Disabled

Invalid

Color

Size

Loading

LoadingIcon

CheckedIcon

UncheckedIcon

Variant

Indicator

Highlight

OnChange

UI

Styles · 0

Style

CheckboxTriOptions

Label

Description

ErrorMessage

Disabled

Invalid

Color

Size

Loading

LoadingIcon

CheckedIcon

UncheckedIcon

Variant

Indicator

Highlight

OnChange

UI

Styles · 0

Style

OnStateChange

Go 代码

Go

// Inside a view; c is *ui.Context, t is nui.Theme.
// Keep s (example state) outside the view. See the complete example.
nui.Checkbox(c.Key("toggle"), t, &s.Value, nui.CheckboxOptions{Label: "Enable notifications", Description: "Updates are saved locally in this example.", Color: nui.ColorDefault, Size: nui.SizeDefault, Disabled: false, Loading: false})
ui.Textf(c, "Enabled: %t", s.Value)
nui.CheckboxTri(c.Key("tri"), t, &s.Mixed, nui.CheckboxTriOptions{CheckboxOptions: nui.CheckboxOptions{Label: "Mixed selection", Disabled: false}})

使用说明

点击复选框并观察 Enabled 的值；下方 CheckboxTri 展示混合选择状态。布尔值与三态值分别持久保存，修改颜色或文字不会清除选择。

API 参考

Checkbox

func Checkbox(c *ui.Context, t Theme, value *bool, o CheckboxOptions) ui.Element

CheckboxTri

func CheckboxTri(c *ui.Context, t Theme, value *CheckState, o CheckboxTriOptions) ui.Element

CheckboxOptions

type CheckboxOptions = ToggleOptions

字段	类型	说明
`Label`	`string` Go 零值: `""`	控件标签或可访问名称。
`Description`	`string` Go 零值: `""`	补充说明文字。
`ErrorMessage`	`string` Go 零值: `""`	显式提供的错误说明。
`Disabled`	`bool` Go 零值: `false`	禁用组件及其交互。
`Invalid`	`bool` Go 零值: `false`	使用无效输入的视觉状态。
`Color`	`Color` Go 零值: `ColorDefault`	语义颜色；默认值继承主题或组件配色。
`Size`	`Size` Go 零值: `SizeDefault`	组件尺寸；默认值继承主题或组件尺寸。
`Loading`	`bool` Go 零值: `false`	显示加载状态；是否阻止操作由组件决定。
`LoadingIcon`	`*ui.SVG` Go 零值: `nil`	覆盖默认加载图标。
`CheckedIcon`	`*ui.SVG` Go 零值: `nil`	选中状态的图标。
`UncheckedIcon`	`*ui.SVG` Go 零值: `nil`	未选中状态的图标。
`Variant`	`ChoiceVariant` Go 零值: `zero value`	组件外观样式，支持范围取决于组件。
`Indicator`	`IndicatorPlacement` Go 零值: `zero value`	选择指示器的位置或隐藏策略。
`Highlight`	`bool` Go 零值: `false`	突出显示控件或选中项目。
`OnChange`	`func(bool)` Go 零值: `nil`	值发生变化时通知应用的回调。
`UI`	`Styles` Go 零值: `zero value`	以部件名称为键覆盖外观和间距。
`Style`	`func(Slot, ui.Element)` Go 零值: `nil`	同步配置当前构建的部件；不要保留 Element。

CheckboxTriOptions

type CheckboxTriOptions struct {
	CheckboxOptions
	OnStateChange func(CheckState)
}

字段	类型	说明
`Label`	`string` Go 零值: `""`	控件标签或可访问名称。
`Description`	`string` Go 零值: `""`	补充说明文字。
`ErrorMessage`	`string` Go 零值: `""`	显式提供的错误说明。
`Disabled`	`bool` Go 零值: `false`	禁用组件及其交互。
`Invalid`	`bool` Go 零值: `false`	使用无效输入的视觉状态。
`Color`	`Color` Go 零值: `ColorDefault`	语义颜色；默认值继承主题或组件配色。
`Size`	`Size` Go 零值: `SizeDefault`	组件尺寸；默认值继承主题或组件尺寸。
`Loading`	`bool` Go 零值: `false`	显示加载状态；是否阻止操作由组件决定。
`LoadingIcon`	`*ui.SVG` Go 零值: `nil`	覆盖默认加载图标。
`CheckedIcon`	`*ui.SVG` Go 零值: `nil`	选中状态的图标。
`UncheckedIcon`	`*ui.SVG` Go 零值: `nil`	未选中状态的图标。
`Variant`	`ChoiceVariant` Go 零值: `zero value`	组件外观样式，支持范围取决于组件。
`Indicator`	`IndicatorPlacement` Go 零值: `zero value`	选择指示器的位置或隐藏策略。
`Highlight`	`bool` Go 零值: `false`	突出显示控件或选中项目。
`OnChange`	`func(bool)` Go 零值: `nil`	值发生变化时通知应用的回调。
`UI`	`Styles` Go 零值: `zero value`	以部件名称为键覆盖外观和间距。
`Style`	`func(Slot, ui.Element)` Go 零值: `nil`	同步配置当前构建的部件；不要保留 Element。
`OnStateChange`	`func(CheckState)` Go 零值: `nil`	三态值变化时通知应用的回调。