pub struct TextInputOpts<'a> {
pub placeholder: Option<&'a str>,
pub max_length: Option<usize>,
pub mask: MaskMode,
}Expand description
Optional configuration for text_input_with / apply_event_with.
The defaults reproduce text_input / apply_event verbatim, so
callers only set the fields they need.
Fields mirror the corresponding HTML <input> attributes:
placeholder, maxlength, type=password. The same value is
expected to be available both at build-time (so the placeholder
renders, the mask is applied) and at event-time (so max_length
can clip a paste, and Copy / Cut can be suppressed on a masked
field) — that joint availability is why this is a struct the app
holds onto rather than chained modifiers on the returned El.
Fields§
§placeholder: Option<&'a str>Muted hint text shown only while value is empty. Visible even
while the field is focused (matches HTML <input placeholder>).
max_length: Option<usize>Cap on the character count of value after an edit. Inserts
(typing, paste, IME commit) are truncated so the post-edit
length doesn’t exceed this. Existing values longer than the cap
are left alone — the cap only constrains future inserts.
mask: MaskModeVisual masking of the rendered value. See MaskMode.
Implementations§
Source§impl<'a> TextInputOpts<'a>
impl<'a> TextInputOpts<'a>
Sourcepub fn placeholder(self, p: &'a str) -> Self
pub fn placeholder(self, p: &'a str) -> Self
Set the muted hint shown while the value is empty (see
TextInputOpts::placeholder).
Examples found in repository?
194fn dashboard_header() -> El {
195 row([
196 icon_button("menu").ghost(),
197 divider().width(Size::Fixed(1.0)).height(Size::Fixed(22.0)),
198 h3("Documents").key("metric:page.title"),
199 spacer(),
200 text_input_with(
201 "dashboard-search",
202 "",
203 &Selection::default(),
204 TextInputOpts::default().placeholder("Search..."),
205 )
206 .key("metric:command.input")
207 .width(Size::Fixed(260.0)),
208 icon_button("plus").ghost(),
209 icon_button("bell").ghost(),
210 ])
211 .key("metric:header")
212 .gap(tokens::SPACE_3)
213 .height(Size::Fixed(56.0))
214 .padding(Sides::xy(tokens::SPACE_4, 0.0))
215 .align(Align::Center)
216 .stroke(tokens::BORDER)
217}Sourcepub fn max_length(self, n: usize) -> Self
pub fn max_length(self, n: usize) -> Self
Cap the character count of future edits (see
TextInputOpts::max_length).
Sourcepub fn password(self) -> Self
pub fn password(self) -> Self
Mask the rendered value as a password field
(MaskMode::Password).
Trait Implementations§
Source§impl<'a> Clone for TextInputOpts<'a>
impl<'a> Clone for TextInputOpts<'a>
Source§fn clone(&self) -> TextInputOpts<'a>
fn clone(&self) -> TextInputOpts<'a>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl<'a> Copy for TextInputOpts<'a>
Source§impl<'a> Debug for TextInputOpts<'a>
impl<'a> Debug for TextInputOpts<'a>
Source§impl<'a> Default for TextInputOpts<'a>
impl<'a> Default for TextInputOpts<'a>
Source§fn default() -> TextInputOpts<'a>
fn default() -> TextInputOpts<'a>
Auto Trait Implementations§
impl<'a> Freeze for TextInputOpts<'a>
impl<'a> RefUnwindSafe for TextInputOpts<'a>
impl<'a> Send for TextInputOpts<'a>
impl<'a> Sync for TextInputOpts<'a>
impl<'a> Unpin for TextInputOpts<'a>
impl<'a> UnsafeUnpin for TextInputOpts<'a>
impl<'a> UnwindSafe for TextInputOpts<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.