Struct FolderPicker 

pub struct FolderPicker { /* private fields */ }

A dialog to choose a folder on a FolderPickerState, as in the reference app: an Up button and the path field, a row that chooses the folder shown, a bordered list of its folders, and Cancel and “Use folder” in the footer.

use gpui_cn::{FolderPicker, FolderPickerState};
use gpui_kit::{Entity, IntoElement};

fn picker(state: &Entity<FolderPickerState>, open: bool) -> impl IntoElement {
    FolderPicker::new("source-folder", state)
        .open(open)
        .title("Choose a source folder")
}

The application owns the open state: open sets it, and it closes the picker when the state reports FolderPickerEvent::Chosen or FolderPickerEvent::Cancelled. The id must be stable across frames.

Implementations

impl FolderPicker

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

A closed picker on state, with a stable id.

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

Shows or hides the picker.

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

The title. The default is “Choose a folder”.

pub fn on_open_change( self, handler: impl Fn(bool, &mut Window, &mut App) + 'static, ) -> Self

Called when Escape, a press on the backdrop, the close button, or Cancel asks to close the picker, after the state reports FolderPickerEvent::Cancelled.

Trait Implementations

impl IntoElement for FolderPicker

type Element = ViewElement<FolderPicker>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for FolderPicker

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

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.