Struct DefaultItem 

pub struct DefaultItem {
    pub title: String,
    pub desc: String,
}

A simple list item with title and description text.

This struct represents a basic list item that can be used with the DefaultDelegate for rendering in list components. It provides a straightforward implementation of the Item trait with built-in support for filtering and display formatting.

Structure

Each DefaultItem contains:

• A title: The primary text displayed prominently
• A description: Secondary text shown below the title (when enabled)

Both fields are always present but the description display can be controlled by the delegate’s show_description setting.

Usage

DefaultItem is designed to work seamlessly with DefaultDelegate and provides sensible defaults for most list use cases. For more complex item types with custom data, implement the Item trait directly.

Examples

use bubbletea_widgets::list::DefaultItem;

// Create a simple item
let item = DefaultItem::new("Task 1", "Complete the documentation");
println!("{}", item); // Displays: "Task 1"

// Create items for a todo list
let todos = vec![
    DefaultItem::new("Buy groceries", "Milk, bread, eggs"),
    DefaultItem::new("Write code", "Implement the new feature"),
    DefaultItem::new("Review PRs", "Check team submissions"),
];

Fields

title: String

Main item text.

desc: String

Secondary item text (optional display).

Implementations

impl DefaultItem

pub fn new(title: &str, desc: &str) -> Self

Creates a new default item with the specified title and description.

This constructor creates a new DefaultItem with the provided title and description text. Both parameters are converted to owned String values for storage.

Arguments

• title - The primary text to display for this item. This will be shown prominently and is used for filtering operations.
• desc - The secondary descriptive text. This provides additional context and is displayed below the title when show_description is enabled.

Returns

A new DefaultItem instance with the specified title and description.

Examples

use bubbletea_widgets::list::DefaultItem;

// Create a task item
let task = DefaultItem::new("Review code", "Check the pull request from yesterday");

// Create a menu item
let menu_item = DefaultItem::new("Settings", "Configure application preferences");

// Create an item with empty description
let simple_item = DefaultItem::new("Simple Item", "");

Trait Implementations

impl Clone for DefaultItem

fn clone(&self) -> DefaultItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultItem

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

Formats the value using the given formatter.

impl Display for DefaultItem

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

Formats the item for display, showing only the title.

This implementation provides a string representation of the item using only the title field. The description is not included in the display output, following the pattern where descriptions are shown separately in list rendering.

Examples

use bubbletea_widgets::list::DefaultItem;

let item = DefaultItem::new("My Task", "This is a description");
assert_eq!(format!("{}", item), "My Task");

impl Item for DefaultItem

fn filter_value(&self) -> String

Returns the text used for filtering this item.

This implementation returns the item’s title, which means that filtering operations will search and match against the title text. The description is not included in filtering to keep the search focused on the primary item identifier.

Returns

A clone of the item’s title string that will be used for fuzzy matching during filtering operations.

Examples

use bubbletea_widgets::list::{DefaultItem, Item};

let item = DefaultItem::new("Buy groceries", "Milk, bread, eggs");
assert_eq!(item.filter_value(), "Buy groceries");

// The filter will match against "Buy groceries", not the description