Struct Select

Source

pub struct Select<V: SelectValue> { /* private fields */ }

Expand description

A shadcn-style select on gpui_base::Select: a trigger that shows the selection and opens a menu of items.

Base owns the combobox role, Tab order, the arrows and Enter that open the menu, Escape that closes it, and the focus transfer between the trigger and the menu. This type owns the look and the menu: the trigger surface, the popover, its rows with icons, descriptions, group labels and separators, the search field, the check beside a selected row, the highlight that follows the keyboard and the pointer, and the virtual list the rows scroll in.

The rows and the selection live in a SelectState the view owns and observes. Both are generic over the item value, any SelectValue: a string or integer, or the application’s own enum or record.

use gpui_cn::{Select, SelectItem, SelectState};
use gpui_kit::{AppContext as _, Context, Entity, IntoElement, Render, Window};

struct Settings {
    shortcut: Entity<SelectState<&'static str>>,
}

impl Settings {
    fn new(cx: &mut Context<Self>) -> Self {
        let shortcut = cx.new(|cx| {
            SelectState::new(
                [
                    SelectItem::new("enter", "Enter"),
                    SelectItem::new("cmd-enter", "Cmd + Enter always"),
                ],
                cx,
            )
            .with_selected(["enter"])
        });
        cx.observe(&shortcut, |_, _, cx| cx.notify()).detach();
        Self { shortcut }
    }
}

impl Render for Settings {
    fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
        Select::new("shortcut", &self.shortcut).accessibility_label("Send shortcut")
    }
}

The id keys focus, motion, and the rows, so it must be stable across frames and unique under the nearest stateful ancestor.

Struct Select Copy item path

Implementations§

impl<V: SelectValue> Select<V>

pub fn new(id: impl Into<ElementId>, state: &Entity<SelectState<V>>) -> Self

pub fn ghost(self) -> Self

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

pub fn size(self, size: ButtonSize) -> Self

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

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

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

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

pub fn menu_width(self, width: impl Into<Length>) -> Self

pub fn align(self, align: Align) -> Self

pub fn format_value( self, format: impl Fn(&[SelectItem<V>]) -> SharedString + 'static, ) -> Self

pub fn render_item<E: IntoElement>( self, render: impl Fn(&SelectItem<V>, SelectRow, &mut Window, &mut App) -> E + 'static, ) -> Self

pub fn render_value<E: IntoElement>( self, render: impl Fn(&[SelectItem<V>], &mut Window, &mut App) -> E + 'static, ) -> Self

pub fn render_label<E: IntoElement>( self, render: impl Fn(&SharedString, &mut Window, &mut App) -> E + 'static, ) -> Self

pub fn render_empty<E: IntoElement>( self, render: impl Fn(&mut Window, &mut App) -> E + 'static, ) -> Self

pub fn render_loading<E: IntoElement>( self, render: impl Fn(&mut Window, &mut App) -> E + 'static, ) -> Self

pub fn search_context_menu( self, build: impl Fn(Vec<MenuEntry>, InputContextMenuCapabilities, &mut Window, &mut App) -> Vec<MenuEntry> + 'static, ) -> Self

pub fn search_context_menu_enabled(self, enabled: bool) -> Self

pub fn tab_index(self, tab_index: isize) -> Self

Trait Implementations§

impl<V: SelectValue> Disableable for Select<V>

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

impl<V: SelectValue> IntoElement for Select<V>

type Element = ViewElement<Select<V>>

fn into_element(self) -> Self::Element

fn into_any_element(self) -> AnyElement

impl<V: SelectValue> RenderOnce for Select<V>

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

impl<V: SelectValue> Styled for Select<V>

fn style(&mut self) -> &mut StyleRefinement

fn w(self, length: impl Clone + Into<Length>) -> Self

fn w_0(self) -> Self

fn w_neg_0(self) -> Self

fn w_0p5(self) -> Self

fn w_neg_0p5(self) -> Self

fn w_1(self) -> Self

fn w_neg_1(self) -> Self

fn w_1p5(self) -> Self

fn w_neg_1p5(self) -> Self

fn w_2(self) -> Self

fn w_neg_2(self) -> Self

fn w_2p5(self) -> Self

fn w_neg_2p5(self) -> Self

fn w_3(self) -> Self

fn w_neg_3(self) -> Self

fn w_3p5(self) -> Self

fn w_neg_3p5(self) -> Self

fn w_4(self) -> Self

fn w_neg_4(self) -> Self

fn w_5(self) -> Self

fn w_neg_5(self) -> Self

fn w_6(self) -> Self

fn w_neg_6(self) -> Self

fn w_7(self) -> Self

fn w_neg_7(self) -> Self

fn w_8(self) -> Self

fn w_neg_8(self) -> Self

fn w_9(self) -> Self

fn w_neg_9(self) -> Self

fn w_10(self) -> Self

fn w_neg_10(self) -> Self

fn w_11(self) -> Self

fn w_neg_11(self) -> Self

fn w_12(self) -> Self

fn w_neg_12(self) -> Self

fn w_16(self) -> Self

fn w_neg_16(self) -> Self

fn w_20(self) -> Self

fn w_neg_20(self) -> Self

fn w_24(self) -> Self

fn w_neg_24(self) -> Self

fn w_32(self) -> Self

fn w_neg_32(self) -> Self

fn w_40(self) -> Self

fn w_neg_40(self) -> Self

fn w_48(self) -> Self

fn w_neg_48(self) -> Self

Struct Select