Enum FilterState 

pub enum FilterState {
    Unfiltered,
    Filtering,
    FilterApplied,
}

Core traits and types for list functionality.

These are the fundamental building blocks for creating custom list items and delegates:

• Item: Trait for displayable and filterable list items
• ItemDelegate: Trait for customizing item rendering and behavior
• FilterState: Enum representing the current filtering state
• FilterStateInfo: Detailed information about filter status

Examples

use bubbletea_widgets::list::{Item, ItemDelegate, FilterState, Model};
use std::fmt::Display;

#[derive(Clone)]
struct MyItem {
    name: String,
    value: i32,
}

impl Display for MyItem {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}: {}", self.name, self.value)
    }
}

impl Item for MyItem {
    fn filter_value(&self) -> String {
        format!("{} {}", self.name, self.value)
    }
}

Represents the current filtering state of the list.

This enum tracks the three distinct phases of the filtering process:

• Unfiltered: No filtering active, all items visible
• Filtering: User actively typing, live filter preview
• FilterApplied: Filter accepted and applied, only matches visible

The transitions between states are:

Unfiltered → Filtering (user presses '/' to start filtering)
Filtering → FilterApplied (user presses Enter to accept filter)
Filtering → Unfiltered (user presses Esc to cancel, filter becomes empty)
FilterApplied → Filtering (user presses '/' to modify filter)
FilterApplied → Unfiltered (user clears filter)

Examples

use bubbletea_widgets::list::FilterState;

let state = FilterState::Unfiltered;
assert_eq!(state, FilterState::Unfiltered);

Variants

Unfiltered

No filtering is active; all items are shown normally.

In this state:

• All items in the list are visible
• The list title is shown in the header
• No filter input box is displayed
• Navigation keys work normally

Filtering

User is actively typing a filter term; live filtering UI is shown.

In this state:

• A “Filter: > ___” input box replaces the header
• Items are filtered in real-time as the user types
• Only matching items are visible with character-level highlighting
• Most navigation keys are disabled; typing adds to filter
• Enter accepts the filter, Escape cancels it

FilterApplied

A filter term has been applied; only matching items are shown.

In this state:

• Only items matching the filter are visible
• The header shows “Title (filtered: N)” format
• Navigation keys work normally on the filtered items
• Character-level highlighting shows matched characters
• Pressing ‘/’ allows modifying the filter

Trait Implementations

impl Clone for FilterState

fn clone(&self) -> FilterState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterState

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

Formats the value using the given formatter.

impl PartialEq for FilterState

fn eq(&self, other: &FilterState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FilterState

impl StructuralPartialEq for FilterState