Toggle

What It Does

Switches a boolean state with a more app-like visual treatment.

Signature

db.Toggle(name: 'str', label: 'str', checked: 'bool' = False, on_change: 'Optional[Callable[[bool], None]]' = None, disabled: 'bool' = False, loading: 'bool' = False, animated: 'bool' = False, animation: 'Optional[str]' = None, animation_delay: 'Optional[float]' = None) -> 'VNode'

Parameters

Name	Type	Default	Notes
name	str	required
label	str	required
checked	bool	False
on_change	Optional[Callable[[bool], None]]	None
disabled	bool	False
loading	bool	False
animated	bool	False
animation	Optional[str]	None
animation_delay	Optional[float]	None

Example

import brickflowui as db

node = db.Toggle(name="dark_mode", label="Dark mode", checked=True, on_change=lambda value: None)

Integration Notes

• This component composes cleanly with layout primitives such as Card, Grid, Row, and Column.
• Prefer controlled state from Python when the value matters to your business logic or backend query layer.

Responsive Notes

Check the component inside a realistic layout, not only in isolation, so spacing, overflow, and action density stay comfortable on smaller screens.

Accessibility Notes

Prefer Toggle for app-like settings and live feature switches, but keep the label explicit because the visual control alone is ambiguous.