Skip to main content

Input

Struct Input 

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

Small box to write some text.

§Normal

fn app() -> impl IntoElement {
    let value = use_state(String::new);
    Input::new(value).placeholder("Type here")
}

§Filled

fn app() -> impl IntoElement {
    let value = use_state(String::new);
    Input::new(value).placeholder("Type here").filled()
}

§Flat

fn app() -> impl IntoElement {
    let value = use_state(String::new);
    Input::new(value).placeholder("Type here").flat()
}

§Preview

Input Preview Filled Input Preview Flat Input Preview

Implementations§

Source§

impl Input

Source

pub fn new(value: impl Into<Writable<String>>) -> Input

Source

pub fn enabled(self, enabled: impl Into<bool>) -> Input

Source

pub fn placeholder(self, placeholder: impl Into<Cow<'static, str>>) -> Input

Source

pub fn on_validate( self, on_validate: impl Into<EventHandler<InputValidator>>, ) -> Input

Source

pub fn on_submit(self, on_submit: impl Into<EventHandler<String>>) -> Input

Source

pub fn mode(self, mode: InputMode) -> Input

Source

pub fn auto_focus(self, auto_focus: impl Into<bool>) -> Input

Source

pub fn width(self, width: impl Into<Size>) -> Input

Source

pub fn theme_colors(self, theme: InputColorsThemePartial) -> Input

Source

pub fn theme_layout(self, theme: InputLayoutThemePartial) -> Input

Source

pub fn text_align(self, text_align: impl Into<TextAlign>) -> Input

Source

pub fn style_variant(self, style_variant: impl Into<InputStyleVariant>) -> Input

Source

pub fn layout_variant( self, layout_variant: impl Into<InputLayoutVariant>, ) -> Input

Source

pub fn filled(self) -> Input

Source

pub fn flat(self) -> Input

Source

pub fn compact(self) -> Input

Source

pub fn expanded(self) -> Input

Source

pub fn a11y_id(self, a11y_id: impl Into<NodeId>) -> Input

Source

pub fn leading(self, leading: impl Into<Element>) -> Input

Optional element rendered before the text input.

Source

pub fn trailing(self, trailing: impl Into<Element>) -> Input

Optional element rendered after the text input.

Source

pub fn on_pre_key_down( self, on_pre_key_down: impl Into<Callback<Event<KeyboardEventData>, bool>>, ) -> Input

Sets a pre-handler called for each key event. Return true to let the input process it, false to skip. The callback may call stop_propagation() / prevent_default() directly.

Trait Implementations§

Source§

impl Clone for Input

Source§

fn clone(&self) -> Input

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Component for Input

Source§

impl CornerRadiusExt for Input

Source§

fn with_corner_radius(self, corner_radius: f32) -> Input

Round all four corners to the given radius in pixels.
Source§

fn rounded_none(self) -> Self

Shortcut for corner_radius(0.) - removes border radius.
Source§

fn rounded(self) -> Self

Shortcut for corner_radius(6.) - default border radius.
Source§

fn rounded_sm(self) -> Self

Shortcut for corner_radius(4.) - small border radius.
Source§

fn rounded_md(self) -> Self

Shortcut for corner_radius(6.) - medium border radius.
Source§

fn rounded_lg(self) -> Self

Shortcut for corner_radius(8.) - large border radius.
Source§

fn rounded_xl(self) -> Self

Shortcut for corner_radius(12.) - extra large border radius.
Source§

fn rounded_2xl(self) -> Self

Shortcut for corner_radius(16.) - extra large border radius.
Source§

fn rounded_3xl(self) -> Self

Shortcut for corner_radius(24.) - extra large border radius.
Source§

fn rounded_4xl(self) -> Self

Shortcut for corner_radius(32.) - extra large border radius.
Source§

fn rounded_full(self) -> Self

Shortcut for corner_radius(99.) - fully rounded (pill shape).
Source§

impl InputColorsThemePartialExt for Input

Source§

fn background(self, background: impl Into<Color>) -> Input

Source§

fn focus_background(self, focus_background: impl Into<Color>) -> Input

Source§

fn border_fill(self, border_fill: impl Into<Color>) -> Input

Source§

fn focus_border_fill(self, focus_border_fill: impl Into<Color>) -> Input

Source§

fn color(self, color: impl Into<Color>) -> Input

Source§

fn placeholder_color(self, placeholder_color: impl Into<Color>) -> Input

Source§

impl InputLayoutThemePartialExt for Input

Source§

fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Input

Source§

fn inner_margin(self, inner_margin: impl Into<Gaps>) -> Input

Source§

impl KeyExt for Input

Source§

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.
Source§

fn key(self, key: impl Hash) -> Self
where Self: 'static,

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists. The key is scoped to the element’s type, so the same value used on different element or component types never collides.
Source§

impl PartialEq for Input

Source§

fn eq(&self, other: &Input) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Input

Auto Trait Implementations§

§

impl !RefUnwindSafe for Input

§

impl !Send for Input

§

impl !Sync for Input

§

impl !UnwindSafe for Input

§

impl Freeze 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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ComponentKey for T
where T: Component,

Source§

impl<T> ComponentProps for T
where T: Any + PartialEq,

Source§

fn changed(&self, other: &(dyn ComponentProps + 'static)) -> bool

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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<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<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§

impl<T> IntoElement for T
where T: Into<Element>,

Source§

impl<T> IntoReadable<T> for T
where T: 'static + PartialEq,

Source§

impl<T> MaybeExt for T
where T: Component,

Source§

fn maybe(self, bool: impl Into<bool>, then: impl FnOnce(Self) -> Self) -> Self

Apply then to the element only when the condition is true.
Source§

fn map<T>(self, data: Option<T>, then: impl FnOnce(Self, T) -> Self) -> Self

Apply then to the element only when the Option is Some, passing the inner value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more