Struct Checkbox 

pub struct Checkbox { /* private fields */ }

Checkbox

Checkboxes are used for multiple choices, not for mutually exclusive choices. Each checkbox works independently from other checkboxes in the list, therefore checking an additional box does not affect any other selections.

Implementations

impl Checkbox

pub fn new(id: impl Into<ElementId>, checked: ToggleState) -> Self

Creates a new Checkbox.

pub fn tab_index(self, tab_index: isize) -> Self

Enables keyboard focus (tab stop) and shows a primary-color focus ring on keyboard focus, using the same native focus_visible mechanism as Switch::tab_index.

pub fn disabled(self, disabled: bool) -> Self

Sets the disabled state of the Checkbox.

pub fn placeholder(self, placeholder: bool) -> Self

Sets the disabled state of the Checkbox.

pub fn on_click( self, handler: impl Fn(&ToggleState, &mut Window, &mut App) + 'static, ) -> Self

Binds a handler to the Checkbox that will be called when clicked.

pub fn on_click_ext( self, handler: impl Fn(&ToggleState, &ClickEvent, &mut Window, &mut App) + 'static, ) -> Self

pub fn fill(self) -> Self

Sets the fill setting of the checkbox, indicating whether it should be filled.

pub fn visualization_only(self, visualization: bool) -> Self

Makes the checkbox look enabled but without pointer cursor and hover styles. Primarily used for uninteractive markdown previews.

pub fn style(self, style: ToggleStyle) -> Self

Sets the style of the checkbox using the specified ToggleStyle.

pub fn elevation(self, elevation: ElevationIndex) -> Self

Match the style of the checkbox to the current elevation using ToggleStyle::ElevationBased.

pub fn tooltip( self, tooltip: impl Fn(&mut Window, &mut App) -> AnyView + 'static, ) -> Self

Sets the tooltip for the checkbox.

pub fn label(self, label: impl Into<SharedString>) -> Self

Set the label for the checkbox.

pub fn label_size(self, size: LabelSize) -> Self

pub fn label_color(self, color: Color) -> Self

impl Checkbox

pub fn container_size() -> Pixels

Trait Implementations

impl Component for Checkbox

fn scope() -> ComponentScope

Returns the scope of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn name() -> &'static str

The name of the component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

impl IntoElement for Checkbox

type Element = Component<Checkbox>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Checkbox

fn render(self, _: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.