Updated on 2025-03-24 GMT+08:00

checkbox

Configuration Item Description

Table 1 Configuration item description

Parameter

Type

Mandatory

Example

Description

type

String

Yes

type: "checkbox"

Configuration item type.

value

Boolean

No

value: true

Default value.

name

String

Yes

name: "commProps.myString"

The value of this field is bidirectionally bound to the value of commProps.myString in advanceEditvm.

label

Object

No

label: {"zh_CN": "Chinese label", "en_US": "En label"}

Label of a configuration item, which needs to be internationalized.

tip

Object

No

tip: {zh_CN: "Chinese tip," en_US: "English tip"}

Tip icon. When a configuration item is complex, you can add some tip content.

noToolTip

Boolean

No

noToolTip: false

Whether the tag has el-tooltip. The default value is false.

disabled

Function | Boolean

No

disabled: true or (data, field, vm) => boolean

Whether to disable the function. You can customize the function to determine whether to disable the function based on the values of other options. If true is returned, the function is disabled.

showFunc

Function

No

showFunc: function(vm) { return vm.commProps.showTitle; }

Whether to display the configuration item. You can customize the function to determine whether to display the configuration item based on the values of other options. If true is returned, the function definition is displayed.

checkLabel

Object

Yes

checkLabel: {"zh_CN": "checkbox type","en_US": "checkbox Type Example"}

Configuration item.

title

Function|Boolean

No

title: "xxx"

Tooltip.

Event

Table 2 Events

Event Name

Method In Configuration Item

Description

Callback Parameter

change

change

Triggered when the value changes.

(value, data, field)

Configuration Example

The following is an example of the checkbox configuration. The configuration effect is shown in Figure 1.

{
	type: 'checkbox',
	name: 'commProps.myCheckbox',
	value: 'checkbox type',
	label: {
		zh_CN: 'checkbox type',
		en_US: 'checkbox Type Example'
	},
	checkLabel: {
		zh_CN: 'checkbox type',
		en_US: 'checkbox Type Example'
	}
}
Figure 1 Effect