Struct ClassesBuilder 

pub struct ClassesBuilder { /* private fields */ }

Builder for Classes.

Implementations

impl ClassesBuilder

pub fn with(self, name: impl Into<ClassName>) -> Self

Adds one always-active class token to the builder.

Validation policy matches Classes::add.

pub fn with_reactive( self, name: impl Into<ClassName>, when: impl Into<ClassCondition>, ) -> Self

Adds one reactive class token, controlled by when.

Validation policy for name matches Classes::add. See Classes::add_reactive for the list of accepted when shapes.

pub fn with_all<I>(self, iter: I) -> Self

where I: IntoIterator, I::Item: Into<ClassName>,

Adds multiple always-active class tokens to the builder. Same short-circuit panic behavior as Classes::add_all.

pub fn with_parsed(self, input: &str) -> Self

Splits input on Unicode whitespace (str::split_whitespace) and adds each non-empty token as an always-active class entry. Empty or whitespace-only input is a no-op. Same duplicate-panic and whitespace-semantic behavior as Classes::add_parsed.

pub fn with_toggle( self, when: impl Into<ClassCondition>, when_true: impl Into<ClassName>, when_false: impl Into<ClassName>, ) -> Self

Adds a pair of mutually exclusive reactive classes. Mirrors Classes::add_toggle.

See Classes::add_reactive for the list of accepted when shapes.

Example

use leptos::prelude::*;
use leptos_classes::Classes;

let (is_active, _) = signal(true);
let classes = Classes::builder()
    .with_toggle(is_active, "active", "inactive")
    .build();

pub fn with_merged(self, other: Classes, strategy: MergeStrategy) -> Self

Merges another Classes value into this builder. See Classes::merge for semantics and the MergeStrategy variants.

Prefer MergeStrategy::default() (which is UnionConditions) unless you specifically need KeepSelf or PanicOnConflict. It is the only strategy that never panics on caller input and never silently discards a caller-supplied condition.

pub fn build(self) -> Classes

Builds the configured Classes.

Trait Implementations

impl Clone for ClassesBuilder

fn clone(&self) -> ClassesBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClassesBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClassesBuilder

fn default() -> ClassesBuilder

Returns the “default value” for a type.