Skip to main content

SelectList

Struct SelectList 

Source
pub struct SelectList<Item = Line<'static>> { /* private fields */ }
Expand description

A scrollable selection list with keyboard navigation

Handles j/k/up/down for navigation and enter for selection. Generic over item type T - provide a render_item callback to convert to Lines.

Implementations§

Source§

impl<Item> SelectList<Item>

Source

pub fn new() -> Self

Create a new SelectList

Source

pub fn render_widget( &mut self, frame: &mut Frame<'_>, area: Rect, props: SelectListRenderProps<'_, Item>, )

Render the widget without requiring selection callbacks.

Trait Implementations§

Source§

impl<Item, A> Component<A> for SelectList<Item>

Source§

type Props<'a> = SelectListProps<'a, Item, A> where Item: 'a

Data required to render the component (read-only)
Source§

fn handle_event( &mut self, event: &EventKind, props: Self::Props<'_>, ) -> impl IntoIterator<Item = A>

Handle an event and return actions to dispatch Read more
Source§

fn render(&mut self, frame: &mut Frame<'_>, area: Rect, props: Self::Props<'_>)

Render the component to the frame
Source§

impl<Item> ComponentDebugState for SelectList<Item>

Source§

impl<Item> Default for SelectList<Item>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<Item, A, Ctx> InteractiveComponent<A, Ctx> for SelectList<Item>

Source§

type Props<'a> = SelectListProps<'a, Item, A> where Item: 'a

Source§

fn update( &mut self, input: ComponentInput<'_, Ctx>, props: Self::Props<'_>, ) -> HandlerResponse<A>

Source§

fn render(&mut self, frame: &mut Frame<'_>, area: Rect, props: Self::Props<'_>)

Source§

fn subscriptions() -> &'static [EventType]

Event types this component should receive when bound through ComponentHost. Read more

Auto Trait Implementations§

§

impl<Item> Freeze for SelectList<Item>

§

impl<Item> RefUnwindSafe for SelectList<Item>

§

impl<Item> Send for SelectList<Item>

§

impl<Item> Sync for SelectList<Item>

§

impl<Item> Unpin for SelectList<Item>

§

impl<Item> UnsafeUnpin for SelectList<Item>

§

impl<Item> UnwindSafe for SelectList<Item>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.