toggle class

A series of toggle buttons that the user can select.

See full documentation and examples for this control

Methods

__init__()

__init__(
    value=None,
    theme=False,
    allow_unselect=False,
    unselected_value=None,
    mode=None,
    label=None,
    width=None,
    lov=None,
    adapter=None, # <code>lambda x: str(x)</code>
    type=None, # Type name of the first lov element
    value_by_id=False,
    on_change=None,
    propagate=None, # App config
    active=True,
    id=None,
    properties=None,
    class_name=None,
    hover_text=None,
) -> None

Create a new toggle element.

Parameters:

Name	Type	Description	Default
value	Any dynamic	Bound to the selection value.	None
theme	bool	If set, this toggle control acts as a way to set the application Theme (dark or light).	False
allow_unselect	bool	If set, this allows de-selection and the value is set to unselected_value.	False
unselected_value	Any	Value assigned to value when no item is selected.	None
mode	str	Define the way the toggle is displayed: "theme": synonym for setting the theme property to True	None
label	str	The label associated with the toggle.	None
width	Union[str, int]	The width of the element.	None
lov	dict[str, Any]	The list of values. See the section on List of Values for more details.	None
adapter	Union[str, Callable]	A function or the name of the function that transforms an element of lov into a tuple(id:str, label:Union[str,Icon]). The default value is a function that returns the string representation of the lov element.	<code>lambda x: str(x)</code>
type	str	This property is required if lov contains a non-specific type of data (e.g., a dictionary). Then: value must be of that type lov must be an iterable containing elements of this type The function set to adapter will receive an object of this type. The default value is the type of the first element in lov.	Type name of the first lov element
value_by_id	bool	If False, the selection value (in value) is the selected element in lov. If set to True, then value is set to the id of the selected element in lov.	False
on_change	Union[str, Callable]	A function or the name of a function that is triggered when the value changes. The callback function receives the following parameters: state (State): the state instance. var_name (str): the bound variable name. value (Any): the updated value.	None
propagate	bool	Determines whether the control's value is automatically reflected in the bound application variable. The default value is defined at the application configuration level by the propagate configuration option. If True, any change to the control's value is immediately reflected in the variable.	App config
active	bool dynamic	Indicates if this element is active. If False, the element is disabled, and user interaction is not allowed.	True
id	str	The identifier assigned to the rendered HTML component. This can be used in callbacks or to target the element for styling.	None
properties	dict[str, Any]	A dictionary of additional properties that can be set to the element.	None
class_name	str dynamic	A space-separated list of CSS class names to be applied to the generated HTML element. These classes are added to the default taipy-toggle class.	None
hover_text	str dynamic	The text that is displayed when the user hovers over the element.	None