tui-pages 0.8.10

Core for TUI apps with multiple pages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! Built-in fuzzy picker (feature = `tui`).
//!
//! A turnkey fuzzy-search overlay: a list of [`PickerEntry`] rows, a canvas
//! text input with scope (`%token`) parsing and autocompletion, a
//! [`nucleo`](https://docs.rs/nucleo)-backed ranking engine, and a ratatui
//! renderer.
//!
//! [`PickerData`] is generic over an application-owned mode payload `M`
//! (see [`PickerData::set_mode`]) that the library stores but never inspects —
//! mirroring how [`DialogData`](crate::dialog::DialogData) carries an opaque
//! purpose. Use `PickerData<()>` (the default) when you don't need one.
//!
//! ## Scopes
//!
//! A [`PickerScope`] binds a `%token` to a set of entry field keys, so
//! `%profile finance` ranks the `profile` field against `finance`. Scopes can
//! declare aliases, a completion key (for the inline suffix), a value-token
//! limit, and — via [`PickerScope::with_suppressed_value_completion`] — opt out
//! of inline completion for free-form values.
//!
//! ## Ranking
//!
//! Field keys are weighted by [`PickerFieldWeights`]; the default keeps `label`
//! heaviest. Applications layer their own domain keys on top with
//! [`PickerFieldWeights::with_override`] and
//! [`PickerData::with_field_weights`].

mod state;
mod ui;

pub use state::{
    PickerData, PickerEntry, PickerField, PickerFieldWeights, PickerHead, PickerHeadColumn,
    PickerHeadColumnBuilder, PickerInputProvider, PickerLayout, PickerScope,
};
pub use ui::{PickerTheme, centered_picker_area, render_picker, render_picker_with_custom_preview};