Skip to main content

FileBrowser

Struct FileBrowser 

Source
pub struct FileBrowser { /* private fields */ }
Expand description

An explorer of folders and files: a breadcrumb that goes back, a header that sorts, and a list of any length with icon, name, size and date. The entries are data from the app, which answers on_navigate and on_open with another folder; it never touches the file system, so it serves a backup on a server as well as a disk. A click selects alone, Ctrl or Cmd adds, and Shift takes a range. The arrows, Home and End move, Space adds, Enter opens, and Backspace goes up.

use ravenrs_widgets::{FileBrowser, FileEntry, Ui};

let browser = FileBrowser::new(
    ["Backups", "2026"],
    vec![FileEntry::folder("October"), FileEntry::file("notes.txt", 2048)],
)
.on_open(|entry| println!("{}", entry.name))
.on_navigate(|depth| println!("{depth}"));
let mut ui = Ui::new(browser, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations§

Source§

impl FileBrowser

Source

pub fn new( path: impl IntoIterator<Item = impl Into<String>>, entries: impl Into<Rc<[FileEntry]>>, ) -> Self

The folder at path, from the root, with entries inside it. Keep the entries in an Rc between builds when they are many: they are sorted again only when they are not the same ones.

Source

pub fn selection(self, selection: Binding<BTreeSet<String>>) -> Self

The ids of the selected entries, to read and to change from outside.

Source

pub fn sort(self, sort: Binding<FileSort>) -> Self

The order, to keep or to set from outside.

Source

pub fn mode(self, mode: SelectionMode) -> Self

How entries can be selected (SelectionMode::Multiple by default).

Source

pub fn on_navigate(self, handler: impl Fn(usize) + 'static) -> Self

Called with the depth of the place to go back to, 0 being the root.

Source

pub fn on_open(self, handler: impl Fn(&FileEntry) + 'static) -> Self

Called with an entry on a double click or on Enter.

Source

pub fn height(self, height: f32) -> Self

A fixed height. It takes the height its parent gives it by default.

Source

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

What screen readers call it, instead of the name in Labels.

Trait Implementations§

Source§

impl Debug for FileBrowser

Source§

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

Formats the value using the given formatter. Read more
Source§

impl View for FileBrowser

Source§

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.
Source§

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.

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> ErasedDestructor for T
where T: 'static,

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

impl<V> ViewExt for V
where V: View,

Source§

fn padding(self, padding: impl Into<Insets>) -> Styled<Self>

Adds padding inside the box, in logical pixels.
Source§

fn background(self, fill: impl Into<Fill>) -> Styled<Self>

Paints a background behind the content.
Source§

fn frame(self, width: Option<f32>, height: Option<f32>) -> Styled<Self>

Fixes the width and/or height in logical pixels; None keeps the content size.
Source§

fn width(self, width: f32) -> Styled<Self>

Fixes the width in logical pixels.
Source§

fn height(self, height: f32) -> Styled<Self>

Fixes the height in logical pixels.
Source§

fn grow(self, grow: f32) -> Styled<Self>

Takes a share of the free space in the parent stack.
Source§

fn stretch(self) -> Styled<Self>

Stretches across the parent stack’s cross axis.
Source§

fn centered(self) -> Styled<Self>

Centers the content inside the box.
Source§

fn tooltip(self, text: impl Into<String>) -> Tooltip<Self>

Shows text above the view while the pointer is over it; see Tooltip.
Source§

fn opacity(self, opacity: f32) -> Faded<Self>

Draws the view and everything in it at this opacity, from 0.0 to 1.0, easing to it when it changes. Layout and input stay as they are; see Faded.
§

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