Struct Model 

pub struct Model {

    pub path: String,
    pub current_directory: PathBuf,
    pub allowed_types: Vec<String>,
    pub keymap: FilepickerKeyMap,
    pub show_permissions: bool,
    pub show_size: bool,
    pub show_hidden: bool,
    pub dir_allowed: bool,
    pub file_allowed: bool,
    pub file_selected: String,
    pub height: usize,
    pub auto_height: bool,
    pub cursor: String,
    pub error: Option<String>,
    pub styles: Styles,
    /* private fields */
}

The main file picker model containing all state and configuration.

This struct represents the complete state of the file picker, including the current directory, file list, selection state, and styling configuration. It implements the BubbleTeaModel trait for integration with bubbletea-rs applications.

Examples

use bubbletea_widgets::filepicker::Model;
use bubbletea_rs::Model as BubbleTeaModel;

// Create a new file picker
let mut picker = Model::new();

// Or use the BubbleTeaModel::init() method
let (picker, cmd) = Model::init();

State Management

The model maintains:

• Current directory being browsed
• List of files and directories in the current location
• Currently selected item index
• Last selected file path (if any)
• Styling and key binding configuration
• Navigation history and viewport state

Fields

path: String

Path is the path which the user has selected with the file picker.

current_directory: PathBuf

The directory currently being browsed. This path is updated when navigating into subdirectories or back to parent directories.

allowed_types: Vec<String>

AllowedTypes specifies which file types the user may select. If empty the user may select any file.

keymap: FilepickerKeyMap

Key bindings configuration for navigation and interaction. Can be customized to change keyboard shortcuts.

show_permissions: bool

Whether to show file permissions in the display.

show_size: bool

Whether to show file sizes in the display.

show_hidden: bool

Whether to show hidden files (dotfiles on Unix, Windows FILE_ATTRIBUTE_HIDDEN + dotfiles).

dir_allowed: bool

Whether directories can be selected.

file_allowed: bool

Whether files can be selected.

file_selected: String

The name of the most recently selected file.

height: usize

Height of the picker.

auto_height: bool

Whether height should automatically adjust to terminal size.

cursor: String

The cursor string to display (e.g., “> “).

error: Option<String>

Error message to display when directory operations fail.

styles: Styles

Visual styling configuration for different UI elements. Can be customized to change colors and appearance.

Implementations

impl Model

pub fn new() -> Self

Creates a new file picker model with default settings.

The file picker starts in the current working directory (“.”) and uses default key bindings and styles. The file list is initially empty and will be populated when the model is initialized or when directories are navigated.

Returns

A new Model instance with default settings matching the Go implementation.

Examples

use bubbletea_widgets::filepicker::Model;

let mut picker = Model::new();
assert_eq!(picker.current_directory.as_os_str(), ".");
assert!(picker.path.is_empty());

pub fn set_height(&mut self, height: usize)

Sets the height of the filepicker viewport.

This controls how many file entries are visible at once. The viewport automatically adjusts to show the selected item within the visible range.

Arguments

• height - The number of lines to show in the file list

Examples

use bubbletea_widgets::filepicker::Model;

let mut picker = Model::new();
picker.set_height(10); // Show 10 files at a time

pub fn did_select_file(&self, msg: &Msg) -> (bool, String)

Returns whether a user has selected a file with the given message.

This function checks if the message represents a file selection action and if the selected file is allowed based on the current configuration. It only returns true for files that can actually be selected.

Arguments

• msg - The message to check for file selection

Returns

A tuple containing:

• bool: Whether a valid file was selected
• String: The path of the selected file (empty if no selection)

Examples

use bubbletea_widgets::filepicker::Model;
use bubbletea_rs::Msg;

let picker = Model::new();
// In your application's update loop:
// let (selected, path) = picker.did_select_file(&msg);
// if selected {
//     println!("User selected: {}", path);
// }

pub fn did_select_disabled_file(&self, msg: &Msg) -> (bool, String)

Returns whether a user tried to select a disabled file with the given message.

This function is useful for providing feedback when users attempt to select files that are not allowed based on the current allowed_types configuration. Use this to show warning messages or provide helpful feedback.

Arguments

• msg - The message to check for disabled file selection attempts

Returns

A tuple containing:

• bool: Whether a disabled file selection was attempted
• String: The path of the disabled file (empty if no disabled selection)

Examples

use bubbletea_widgets::filepicker::Model;
use bubbletea_rs::Msg;

let mut picker = Model::new();
picker.allowed_types = vec![".txt".to_string()];

// In your application's update loop:
// let (tried_disabled, path) = picker.did_select_disabled_file(&msg);
// if tried_disabled {
//     eprintln!("Cannot select {}: file type not allowed", path);
// }

pub fn read_dir(&mut self)

Reads the current directory and populates the files list. Clears any existing files and error state before reading.

pub fn read_dir_cmd(&self) -> Cmd

Creates a command to read the current directory.

This method allows external code to trigger a directory read without directly calling the private read_dir method. It’s useful for initializing the filepicker with a specific directory.

Returns

A command that will trigger a ReadDirMsg when executed

Examples

use bubbletea_widgets::filepicker::Model;

let mut picker = Model::new();
picker.current_directory = std::path::PathBuf::from("/home/user");
let cmd = picker.read_dir_cmd();
// This command can be returned from init() or update()

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.

impl Model for Model

fn init() -> (Self, Option<Cmd>)

Initialize the model with its initial state and optional startup command.

fn update(&mut self, msg: Msg) -> Option<Cmd>

Update the model in response to a received message.

fn view(&self) -> String

Render the current model state as a string for terminal display.