Struct MultiSelect 

pub struct MultiSelect { /* private fields */ }

Rows show a check for on and a dash for mixed. Taking a row clears the query. The Create row sits first and is active while it shows. Escape in the manage pane returns to the list. The list shows twelve rows and scrolls past that.

Implementations

impl MultiSelect

pub fn new(choices: Vec<Choice>, cx: &mut Context<'_, Self>) -> Self

pub fn with_create( self, normalize: impl Fn(&str) -> Option<SharedString> + 'static, ) -> Self

Offer a “Create” row for a query that names no choice. normalize turns the query into the name it would create, or None for one that cannot be a name; the row shows, and MultiSelectEvent::Created carries, what it answers. Choices are matched against it as given.

pub fn with_plain_rows(self) -> Self

Paint each row’s name as text rather than as a chip, for choices that are not labels. The choices that are on stay chips over the query.

pub fn with_search(self) -> Self

Let the host search: each change of the query is a MultiSelectEvent::Searched, and the rows are the choices that are off, in the order Self::set_choices answers them, unfiltered. The choices that are on show only as chips. An empty query shows no rows.

pub fn with_placeholder(self, placeholder: impl Into<SharedString>) -> Self

What the empty query field says. Left out, it is “Search…”, or “Search or create…” with Self::with_create.

pub fn with_manage(self) -> Self

Give each row a ··· opening a pane to rename or delete its choice.

pub fn with_tint(self, tint: impl Fn(&str, &Theme) -> Hsla + 'static) -> Self

Colour each name with tint instead of tint.

pub fn with_width(self, min: Pixels, max: Pixels) -> Self

Size the card to its widest row, from min up to max. Equal bounds fix the width. A name wider than max is cut at the card’s edge.

pub fn choices(&self) -> &[Choice]

pub fn set_choices(&mut self, choices: Vec<Choice>, cx: &mut Context<'_, Self>)

Replace the choices — the host’s answer to an event. The query and the open pane stay; a pane whose choice is gone closes.

pub fn reset(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Start a fresh pick: an empty query, the list pane, and focus in the query. Call it as the popover opens: the builders’ placeholder takes effect here.

Trait Implementations

impl EventEmitter<MultiSelectEvent> for MultiSelect

impl Focusable for MultiSelect

fn focus_handle(&self, _: &App) -> FocusHandle

The context around the fields; one of them holds focus while it is open — see MultiSelect::reset.

impl Render for MultiSelect

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.