Struct Paginator 

pub struct Paginator {
    pub display_type: Type,
    pub active_dot: String,
    pub inactive_dot: String,
    pub arabic_format: String,
    pub key_map: KeyMap,
    /* private fields */
}

Pagination model.

Fields

display_type: Type

Display type (Arabic or Dots).

active_dot: String

Character for active page in Dots mode.

inactive_dot: String

Character for inactive pages in Dots mode.

arabic_format: String

Format string for Arabic mode.

key_map: KeyMap

Key bindings.

Implementations

impl Paginator

pub fn new() -> Self

Creates a new paginator with default settings.

pub fn display_type(self, t: Type) -> Self

Sets the display type.

pub fn per_page(self, n: usize) -> Self

Sets the number of items per page.

pub fn total_pages(self, n: usize) -> Self

Sets the total number of pages.

pub fn page(&self) -> usize

Returns the current page (0-indexed).

pub fn set_page(&mut self, page: usize)

Sets the current page.

pub fn get_per_page(&self) -> usize

Returns the items per page.

pub fn get_total_pages(&self) -> usize

Returns the total number of pages.

pub fn set_total_pages_from_items(&mut self, items: usize) -> usize

Calculates and sets the total pages from item count.

Returns the calculated total pages.

pub fn items_on_page(&self, total_items: usize) -> usize

Returns the number of items on the current page.

pub fn get_slice_bounds(&self, length: usize) -> (usize, usize)

Returns slice bounds for the current page.

Use this to get the start and end indices for slicing a collection.

Example

use bubbles::paginator::Paginator;

let items = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
let mut paginator = Paginator::new().per_page(3);
paginator.set_total_pages_from_items(items.len());

let (start, end) = paginator.get_slice_bounds(items.len());
assert_eq!(&items[start..end], &[1, 2, 3]);

pub fn prev_page(&mut self)

Navigates to the previous page.

pub fn next_page(&mut self)

Navigates to the next page.

pub fn on_last_page(&self) -> bool

Returns whether we’re on the last page.

pub fn on_first_page(&self) -> bool

Returns whether we’re on the first page.

pub fn init(&self) -> Option<Cmd>

Initializes the paginator.

Paginators don’t require initialization commands.

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

Updates the paginator based on key input.

pub fn view(&self) -> String

Renders the pagination display.

Trait Implementations

impl Clone for Paginator

fn clone(&self) -> Paginator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Paginator

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

Formats the value using the given formatter.

impl Default for Paginator

fn default() -> Self

Returns the “default value” for a type.

impl Model for Paginator

Implement the Model trait for standalone bubbletea usage.

fn init(&self) -> Option<Cmd>

Initialize the model and return an optional startup command.

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

Process a message and return a new command.

fn view(&self) -> String

Render the model as a string for display.