Struct vizia_core::views::Dropdown

source ·
pub struct Dropdown;
Expand description

A dropdown is used to display some state with the ability to open a popup with options to change that state.

Usually a dropdown is used in the context of a “combobox” or “picklist” to allow the user to select from one of several discrete options. The dropdown takes two closures, one which shows the current state regardless of whether the dropdown is open or closed, and one which shows the contents while it is open.

§Basic Dropdown

A basic dropdown displaying five options that the user can choose from.

Dropdown::new(
    cx,
    |cx| Label::new(cx, AppData::value),
    |cx| {
        for i in 0..5 {
            Label::new(cx, i)
                .on_press(move |cx| {
                    cx.emit(AppEvent::SetValue(i));
                    cx.emit(PopupEvent::Close); // close the popup
                })
                .width(Stretch(1.0));
        }
    },
)
.width(Pixels(100.0));

The line marked “close the popup” is not required for anything other than closing the popup - if you leave it out, the popup will simply not close until the user clicks out of the dropdown.

§Custom Dropdown

The dropdown doesn’t have to be the current state and then a set of options - it can contain any set of views in either location. Here’s an example where you can use a textbox to filter a list of checkboxes which pop up when you click the textbox:


#[derive(Lens, Clone, PartialEq, Eq)]
struct AppData {
    values: [bool; 6],
    filter: String,
}


Dropdown::new(cx, |cx| {
    Textbox::new(cx, AppData::filter).on_edit(|cx, text| {
        cx.emit(AppEvent::SetFilter(text));
    })
    .width(Pixels(100.0))
    .height(Pixels(30.0))
}, |cx| {
    Binding::new(cx, AppData::root, |cx, lens| {
        let current = lens.get(cx);
        for i in 0..6 {
            if LABELS[i].to_lowercase().contains(&current.filter.to_lowercase()) {
                HStack::new(cx, move |cx| {
                    Checkbox::new(cx, AppData::values.map(move |x| x[i]))
                        .on_toggle(move |cx| {
                            cx.emit(AppEvent::SetValue(i, !current.values[i]));
                        });
                    Label::new(cx, LABELS[i]);
                });
            }
        }
    });
}).width(Pixels(100.0));

Implementations§

source§

impl Dropdown

source

pub fn new<F, L>(cx: &mut Context, trigger: L, content: F) -> Handle<'_, Self>
where L: 'static + Fn(&mut Context), F: 'static + Fn(&mut Context),

Creates a new dropdown.

§Example
Dropdown::new(cx, |cx| Label::new(cx, "Text"), |_| {});

Trait Implementations§

source§

impl View for Dropdown

source§

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css. Read more
source§

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>
where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view. Read more
source§

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view. Read more
source§

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view. Read more
source§

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)

Auto Trait Implementations§

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

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

§

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

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

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

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

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> Same for T

source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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