Struct async_ui_web::components::Dropdown

source ·

pub struct Dropdown<O: Eq + Hash + Clone> { /* private fields */ }

Expand description

A more predictable <select>.

You can always implement your own dropdown menu in Async UI Web with Select and Option.

The Dropdown implementation provided here wraps <select> in a convenient API. You can use Eq + Hash + Clone Rust types as options, and easily update them.

let dropdown = Dropdown::<i32>::new();

// set the options to display
dropdown.update_options([
    (1, "First"),
    (2, "Second"),
    (3, "Third")
]);

join((
    dropdown.render(),
    async {
        loop {
            dropdown.until_change().await;
            let value: Option<i32> = dropdown.value();
        }
    }
)).await;

This type Derefs to Select and HtmlSelectElement, so you can use all the HTML methods (such as set_disabled) on it.

Implementations§

source

pub fn new() -> Self

Create a new, empty Dropdown.

Use update_options to set the options to show.

source

source

pub fn until_change( &self ) -> impl Future<Output = Event> + Stream<Item = Event> + '_

Get a [Stream] that fires every time the selection is changed by the user.

To be precise, this fires every time there is a change event on the <select> tag.

source

pub fn value(&self) -> Option<O>

Get the currently selected option.

Returns None if nothing is currently selected.

Methods from Deref<Target = Select>§

source

pub fn render<F>(&self, c: F) -> ContainerNodeFuture<F>where F: Future,

Put this HTML element on the screen.

The return Future completes when the given argument Future finishes. Anything the argument Future renders will in the HTML tag of this component.

Indexing getter. As in the literal Javascript this[key].

This API requires the following crate features to be activated: HtmlSelectElement

The valueOf() method returns the primitive value of the specified object.

Tests whether this JS value is a JS string.

source

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

source

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

Tests whether the value is “truthy”.

source

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations§

source §

fn default() -> Self

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

source §

fn from(t: T) -> T

Returns the argument unchanged.

Performs the conversion.

source §

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

§

type Error = >::Error

The type returned in the event of a conversion error.

source §

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

Performs the conversion.

Struct async_ui_web::components::Dropdown

Implementations§

impl<O: Eq + Hash + Clone> Dropdown<O>

pub fn new() -> Self

pub fn contains_key<Q>(&self, key: &Q) -> boolwhere O: Borrow<Q>, Q: Hash + Eq + ?Sized,

pub fn set_value(&self, opt: Option<O>)

pub fn update_options<'t>( &'t self, new_opts: impl IntoIterator<Item = (O, &'t str)> )

pub async fn render(&self)

pub fn until_change( &self ) -> impl Future<Output = Event> + Stream<Item = Event> + '_

pub fn value(&self) -> Option<O>

Methods from Deref<Target = Select>§

pub fn render<F>(&self, c: F) -> ContainerNodeFuture<F>where F: Future,

Methods from Deref<Target = HtmlSelectElement>§

pub fn autofocus(&self) -> bool

pub fn set_autofocus(&self, value: bool)

pub fn autocomplete(&self) -> String

pub fn set_autocomplete(&self, value: &str)

pub fn disabled(&self) -> bool

pub fn set_disabled(&self, value: bool)

pub fn form(&self) -> Option<HtmlFormElement>

pub fn multiple(&self) -> bool

pub fn set_multiple(&self, value: bool)

pub fn name(&self) -> String

pub fn set_name(&self, value: &str)

pub fn required(&self) -> bool

pub fn set_required(&self, value: bool)

pub fn size(&self) -> u32

pub fn set_size(&self, value: u32)

pub fn type_(&self) -> String

pub fn length(&self) -> u32

pub fn set_length(&self, value: u32)

pub fn selected_index(&self) -> i32

pub fn set_selected_index(&self, value: i32)

pub fn value(&self) -> String

pub fn set_value(&self, value: &str)

pub fn will_validate(&self) -> bool

pub fn validation_message(&self) -> Result<String, JsValue>

pub fn add_with_html_option_element( &self, element: &HtmlOptionElement ) -> Result<(), JsValue>

pub fn add_with_html_opt_group_element( &self, element: &HtmlOptGroupElement ) -> Result<(), JsValue>

pub fn add_with_html_option_element_and_opt_html_element( &self, element: &HtmlOptionElement, before: Option<&HtmlElement> ) -> Result<(), JsValue>

pub fn add_with_html_opt_group_element_and_opt_html_element( &self, element: &HtmlOptGroupElement, before: Option<&HtmlElement> ) -> Result<(), JsValue>

pub fn add_with_html_option_element_and_opt_i32( &self, element: &HtmlOptionElement, before: Option<i32> ) -> Result<(), JsValue>

pub fn add_with_html_opt_group_element_and_opt_i32( &self, element: &HtmlOptGroupElement, before: Option<i32> ) -> Result<(), JsValue>

pub fn check_validity(&self) -> bool

pub fn item(&self, index: u32) -> Option<Element>

pub fn named_item(&self, name: &str) -> Option<HtmlOptionElement>

pub fn remove_with_index(&self, index: i32)

pub fn remove(&self)

pub fn report_validity(&self) -> bool

pub fn set_custom_validity(&self, error: &str)

pub fn get(&self, index: u32) -> Option<Element>

pub fn set( &self, index: u32, option: Option<&HtmlOptionElement> ) -> Result<(), JsValue>

Methods from Deref<Target = HtmlElement>§

pub fn title(&self) -> String

pub fn set_title(&self, value: &str)

pub fn scroll_height(&self) -> i32

pub fn set_scroll_height(&self, value: i32)

pub fn scroll_top(&self) -> i32

pub fn set_scroll_top(&self, value: i32)

pub fn lang(&self) -> String

pub fn set_lang(&self, value: &str)

pub fn dir(&self) -> String

pub fn set_dir(&self, value: &str)

pub fn inner_text(&self) -> String

pub fn set_inner_text(&self, value: &str)

pub fn hidden(&self) -> bool

pub fn set_hidden(&self, value: bool)

pub fn inert(&self) -> bool

pub fn set_inert(&self, value: bool)

pub fn tab_index(&self) -> i32

pub fn set_tab_index(&self, value: i32)

pub fn access_key(&self) -> String

pub fn set_access_key(&self, value: &str)

pub fn access_key_label(&self) -> String

pub fn draggable(&self) -> bool

pub fn set_draggable(&self, value: bool)

pub fn content_editable(&self) -> String

pub fn set_content_editable(&self, value: &str)

pub fn is_content_editable(&self) -> bool

pub fn spellcheck(&self) -> bool