Struct ambient_api::prelude::Prompt

pub struct Prompt {
    pub title: String,
    pub placeholder: Option<String>,
    pub on_ok: Arc<CbDebuggable<dyn Fn(&mut World, String) + Sync + Send>>,
    pub on_cancel: Option<Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>>,
}

A full-screen prompt dialog that the user must acknowledge.

Fields

title: String

The title of the prompt.

placeholder: Option<String>

The placeholder text to display in the text editor.

on_ok: Arc<CbDebuggable<dyn Fn(&mut World, String) + Sync + Send>>

The callback to run when the user clicks “Ok”.

on_cancel: Option<Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>>

The callback to run when the user clicks “Cancel”.

Implementations

impl Prompt

pub fn el( title: String, placeholder: Option<String>, on_ok: Arc<CbDebuggable<dyn Fn(&mut World, String) + Sync + Send>>, on_cancel: Option<Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>> ) -> Element

Create an Element from this component.

impl Prompt

pub fn new( title: impl Into<String>, set_screen: Arc<CbDebuggable<dyn Fn(Option<Element>) + Sync + Send>>, on_ok: impl Fn(&mut World, String) + Sync + Send + 'static ) -> Prompt

Creates a new Prompt with the given title and callback.

pub fn new_cancelable( title: impl Into<String>, set_screen: Arc<CbDebuggable<dyn Fn(Option<Element>) + Sync + Send>>, on_ok: impl Fn(&mut World, String) + Sync + Send + 'static ) -> Prompt

Creates a new Prompt with the given title and callback, and a “Cancel” button that exits the prompt.

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

Sets the placeholder text to display in the text editor.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl ElementComponent for Prompt

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

Render the virtual tree for this component.