Struct ambient_api::prelude::TextEditor

pub struct TextEditor {
    pub value: String,
    pub on_change: Arc<CbDebuggable<dyn Fn(String) + Sync + Send>>,
    pub on_submit: Option<Arc<CbDebuggable<dyn Fn(String) + Sync + Send>>>,
    pub password: bool,
    pub placeholder: Option<String>,
    pub auto_focus: bool,
}

A text editor.

Fields

value: String

The string to edit.

on_change: Arc<CbDebuggable<dyn Fn(String) + Sync + Send>>

Callback for when the value is changed.

on_submit: Option<Arc<CbDebuggable<dyn Fn(String) + Sync + Send>>>

Callback for when the user presses enter.

password: bool

Whether the text should be obfuscated with ‘*’ characters.

placeholder: Option<String>

The placeholder text to display when the value is empty.

auto_focus: bool

Whether the text editor should be focused when it is created.

Implementations

impl TextEditor

pub fn el( value: String, on_change: Arc<CbDebuggable<dyn Fn(String) + Sync + Send>>, on_submit: Option<Arc<CbDebuggable<dyn Fn(String) + Sync + Send>>>, password: bool, placeholder: Option<String>, auto_focus: bool ) -> Element

Create an Element from this component.

impl TextEditor

pub fn new( value: String, on_change: Arc<CbDebuggable<dyn Fn(String) + Sync + Send>> ) -> TextEditor

Create a new text editor.

pub fn on_submit( self, on_submit: impl Fn(String) + Sync + Send + 'static ) -> TextEditor

Set the on_submit callback.

pub fn placeholder<T>(self, placeholder: Option<T>) -> TextEditor

where T: Into<String>,

Set the placeholder text.

pub fn password(self) -> TextEditor

Set whether or not the text should be hidden.

pub fn auto_focus(self) -> TextEditor

Focus the text box automatically when it’s spawned.

Trait Implementations

impl Clone for TextEditor

fn clone(&self) -> TextEditor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextEditor

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

Formats the value using the given formatter.

impl ElementComponent for TextEditor

fn render(self: Box<TextEditor>, hooks: &mut Hooks<'_>) -> Element

Render the virtual tree for this component.