Struct List

pub struct List {
    pub states: ListStates,
    /* private fields */
}

List

represents a read-only text component without any container.

Fields

states: ListStates

Implementations

impl List

pub fn foreground(self, fg: Color) -> Self

pub fn background(self, bg: Color) -> Self

pub fn modifiers(self, m: TextModifiers) -> Self

pub fn borders(self, b: Borders) -> Self

pub fn title<S: Into<String>>(self, t: S, a: Alignment) -> Self

pub fn inactive(self, s: Style) -> Self

pub fn rewind(self, r: bool) -> Self

pub fn step(self, step: usize) -> Self

pub fn scroll(self, scrollable: bool) -> Self

pub fn highlighted_str<S: Into<String>>(self, s: S) -> Self

pub fn highlighted_color(self, c: Color) -> Self

pub fn rows(self, rows: Table) -> Self

pub fn selected_line(self, line: usize) -> Self

Set initial selected line This method must be called after rows and scrollable in order to work

Trait Implementations

impl Default for List

fn default() -> List

Returns the “default value” for a type.

impl MockComponent for List

fn view(&mut self, render: &mut Frame<'_>, area: Rect)

Based on the current properties and states, renders the component in the provided area frame. Render can also mutate the component state if this is required

fn query(&self, attr: Attribute) -> Option<AttrValue>

Query attribute of component properties.

fn attr(&mut self, attr: Attribute, value: AttrValue)

Set attribute to properties. query describes the name, while attr the value it’ll take

fn state(&self) -> State

Get current state from component

fn perform(&mut self, cmd: Cmd) -> CmdResult

Perform a command on the component. The command will may change the component state. The method returns the result of the command applied (what changed if any)