Struct CheckboxProps

Source

pub struct CheckboxProps<T>where
    T: Datatype<Inner = bool>,{
    pub label: TextProp,
    pub bind: QueryString,
    pub debug_value: Option<T>,
    pub value: MaybeProp<T>,
    pub sync: Option<WriteSignal<T>>,
    pub error: MaybeProp<TextProp>,
}

Expand description

Props for the Checkbox component.

A component that renders a checkbox.

§Required Props

label: impl Into<TextProp>
- The label of the input field.
bind: impl Into<QueryString>
- The query string that binds the input field to the form data.

§Optional Props

debug_value: impl Into<T>
- A debug value that is used to autofill the input field in debug mode.
value: impl Into<MaybeProp<T>>
- The initial value of the input field.
sync: impl Into<WriteSignal<T>>
- A write signal that is updated with the parsed value of the input field.
error: impl Into<MaybeProp<TextProp>>
- Set a custom error message for the input field.

Fields§

§label: TextProp

The label of the input field.

§bind: QueryString

The query string that binds the input field to the form data.

§debug_value: Option<T>

A debug value that is used to autofill the input field in debug mode.

§value: MaybeProp<T>

The initial value of the input field.

§sync: Option<WriteSignal<T>>

A write signal that is updated with the parsed value of the input field.

§error: MaybeProp<TextProp>

Set a custom error message for the input field.

Implementations§

Source §

impl<T> CheckboxProps<T>
where T: Datatype<Inner = bool>,

Source

pub fn builder() -> CheckboxPropsBuilder<T, ((), (), (), (), (), ())>

Create a builder for building CheckboxProps. On the builder, call .label(...), .bind(...), .debug_value(...)(optional), .value(...)(optional), .sync(...)(optional), .error(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CheckboxProps.

Trait Implementations§

Source §

impl<T> IntoView for CheckboxProps<T>
where T: Datatype<Inner = bool>,

Source §

fn into_view(self) -> View

Converts the value into View.

Auto Trait Implementations§

§

impl<T> !UnwindSafe for CheckboxProps<T>

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §