Struct SelectItem 

pub struct SelectItem<V> { /* private fields */ }

One choice in a Select menu.

The value is the item’s identity: it keys the row’s element id, the selection, and the events. The label is what the row and the trigger show. An item can carry a description under its label, an icon or any element before it, extra words the search matches, and a disabled state.

use gpui_cn::{SelectItem, gpui_kit::assets::IconName};

let _ = SelectItem::new("finder", "Finder").icon(IconName::Folder);
let _ = SelectItem::new("never", "Never ask for approval")
    .description("Blocked actions fail instead of requesting approval");
let _ = SelectItem::new("de", "Deutsch").keywords(["german"]);
let _ = SelectItem::new(42, "Item 42");

Implementations

impl<V: SelectValue> SelectItem<V>

pub fn new(value: V, label: impl Into<SharedString>) -> Self

An item with a stable value and the label it shows.

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

A second line under the label, in the muted color.

pub fn icon(self, icon: impl Into<Icon>) -> Self

An icon before the label, at the icon size, in the row’s text color. The trigger shows the selected item’s icon too.

pub fn leading<E: IntoElement>( self, build: impl Fn(&mut Window, &mut App) -> E + Send + Sync + 'static, ) -> Self

Any element before the label, built each frame: a color swatch, an avatar, an application icon. It replaces the icon in the row; the trigger shows it too. The builder is Send + Sync so rows can come from a search on another thread.

pub fn keywords( self, keywords: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

Words the search matches besides the label, such as a language’s English name beside its own.

pub fn disabled(self, disabled: bool) -> Self

Whether the item can be chosen. A disabled item shows in the muted color and the keyboard skips it.

pub fn value(&self) -> &V

The item’s identity.

pub fn key(&self) -> SharedString

The stable name of the item’s row: its value’s key.

pub fn label(&self) -> &SharedString

The text the row and the trigger show.

pub fn description_text(&self) -> Option<&SharedString>

The line under the label, if any.

pub fn icon_source(&self) -> Option<&Icon>

The icon before the label, if the leading element is one.

pub fn is_disabled(&self) -> bool

Whether the item can be chosen.

pub fn matches(&self, query: &str) -> bool

Whether the query matches the label or a keyword, as a fuzzy subsequence ignoring case. An empty query matches everything.

pub fn match_score(&self, query: &str) -> Option<u32>

How well the query matches: the label’s score, or half the best keyword’s score, since a keyword is a weaker hit. None for no match, and 0 for an empty query.

Trait Implementations

impl<V: Clone> Clone for SelectItem<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: SelectValue> Debug for SelectItem<V>

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

Formats the value using the given formatter.

impl<V: SelectValue> From<SelectItem<V>> for SelectEntry<V>

fn from(item: SelectItem<V>) -> Self

Converts to this type from the input type.