5 UI Component - Toggle Component

The component provides checkbox style, toggle button style, and switch style. It can contain child components only when ToggleType is Button.

5.1 Definition and Parameters

Toggle(options: { type: ToggleType, isOn?: boolean })

Parameter description:

• type: The toggle type, such as Switch (switch), Checkbox (checkbox), or Button (button).
• isOn: The current state (true or false)

5.2 Usage Example

A simple example is as follows:

// xxx.ets
@Entry
@Component
struct ToggleExample {
    build() {
        Column({ space: 10 }) {
            Text('type: Switch').fontSize(12).fontColor(0xcccccc).width('90%')
            Flex({ justifyContent: FlexAlign.SpaceEvenly, alignItems: ItemAlign.Center }) {
                Toggle({ type: ToggleType.Switch, isOn: false })
                .selectedColor('#007DFF')
                .switchPointColor('#FFFFFF')
                .onChange((isOn: boolean) => {
                    console.info('Component status:' + isOn)
                })

                Toggle({ type: ToggleType.Switch, isOn: true })
                .selectedColor('#007DFF')
                .switchPointColor('#FFFFFF')
                .onChange((isOn: boolean) => {
                    console.info('Component status:' + isOn)
                })
            }

            Text('type: Checkbox').fontSize(12).fontColor(0xcccccc).width('90%')
            Flex({ justifyContent: FlexAlign.SpaceEvenly, alignItems: ItemAlign.Center }) {
                Toggle({ type: ToggleType.Checkbox, isOn: false })
                .size({ width: 20, height: 20 })
                .selectedColor('#007DFF')
                .onChange((isOn: boolean) => {
                    console.info('Component status:' + isOn)
                })

                Toggle({ type: ToggleType.Checkbox, isOn: true })
                .size({ width: 20, height: 20 })
                .selectedColor('#007DFF')
                .onChange((isOn: boolean) => {
                    console.info('Component status:' + isOn)
                })
            }

            Text('type: Button').fontSize(12).fontColor(0xcccccc).width('90%')
            Flex({ justifyContent: FlexAlign.SpaceEvenly, alignItems: ItemAlign.Center }) {
                Toggle({ type: ToggleType.Button, isOn: false }) {
                    Text('status button').fontColor('#182431').fontSize(12)
                }.width(106)
                .selectedColor('rgba(0,125,255,0.20)')
                .onChange((isOn: boolean) => {
                    console.info('Component status:' + isOn)
                })

                Toggle({ type: ToggleType.Button, isOn: true }) {
                    Text('status button').fontColor('#182431').fontSize(12)
                }.width(106)
                .selectedColor('rgba(0,125,255,0.20)')
                .onChange((isOn: boolean) => {
                    console.info('Component status:' + isOn)
                })
            }.width('100%').padding(24)
        }
    }
}