Skip to main content

Input

Struct Input 

Source
pub struct Input { /* private fields */ }
Expand description

A text input.

let html = render_static(Input![label = "Email", name = "email", kind = "email", required = true]);
assert!(html.contains(r#"<input class="nr-field-input" type="email" placeholder=" " id="#));
assert!(html.contains(r#"data-nr-error="email""#));

Implementations§

Source§

impl Input

Source

pub fn new() -> Self

Source

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

Text of the label.

Source

pub fn placeholder(self, v: impl Into<String>) -> Self

Source

pub fn description(self, v: impl MaybeText) -> Self

Help text under the field.

Source

pub fn error_message(self, v: impl MaybeText) -> Self

Error text under the field; also marks it invalid. error_message = form.error("email") shows server validation errors.

Source

pub fn invalid(self, v: bool) -> Self

Show the field as invalid without a message.

Source

pub fn name(self, v: impl Into<String>) -> Self

Form field name. Server-action validation errors for this name appear under the field automatically.

Source

pub fn id(self, v: impl Into<String>) -> Self

id of the control (generated when not given).

Source

pub fn value(self, v: impl MaybeText) -> Self

Initial value: value = form.value("email").

Source

pub fn required(self, v: bool) -> Self

Source

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

Source

pub fn readonly(self, v: bool) -> Self

Source

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

Color of the focused field.

Source

pub fn size(self, v: Size) -> Self

Source

pub fn variant(self, v: FieldVariant) -> Self

Source

pub fn radius(self, v: Radius) -> Self

Source

pub fn label_placement(self, v: LabelPlacement) -> Self

Source

pub fn start_content(self, v: impl View) -> Self

Content at the start of the box, typically an icon.

Source

pub fn end_content(self, v: impl View) -> Self

Content at the end of the box.

Source

pub fn full_width(self, v: bool) -> Self

Take the full width of the container (the default).

Source

pub fn label_class(self, v: impl Into<String>) -> Self

Extra classes for the label.

Source

pub fn wrapper_class(self, v: impl Into<String>) -> Self

Extra classes for the box around the control.

Source

pub fn input_class(self, v: impl Into<String>) -> Self

Extra classes for the control itself.

Source

pub fn description_class(self, v: impl Into<String>) -> Self

Source

pub fn error_class(self, v: impl Into<String>) -> Self

Source

pub fn class(self, v: impl Into<String>) -> Self

Extra classes for the outer element. They win over the defaults.

Source

pub fn unstyled(self, v: bool) -> Self

Leave out the default classes of the outer element.

Source

pub fn with(self, part: impl Part) -> Self

Add an attribute to the <input> (attr("autocomplete", "email"), aria(..), …); class(..) goes to the outer element.

Source

pub fn kind(self, v: impl Into<String>) -> Self

The input type: "email", "number", "search", … (default "text").

Source

pub fn clearable(self, v: bool) -> Self

A button that clears the value.

Trait Implementations§

Source§

impl Default for Input

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl View for Input

Auto Trait Implementations§

§

impl !RefUnwindSafe for Input

§

impl !Sync for Input

§

impl !UnwindSafe for Input

§

impl Forget for Input

§

impl Freeze for Input

§

impl Move for Input

§

impl Send for Input

§

impl Unpin for Input

§

impl UnsafeUnpin for Input

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, U> Into<U> 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<V, E> IntoViewResult<E> for V
where V: View,

Source§

impl<V> Part for V
where V: View,

Source§

fn apply(self, el: &mut Element)

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.