Skip to main content

SplitPreviewRenderer

Struct SplitPreviewRenderer 

Source
pub struct SplitPreviewRenderer { /* private fields */ }
Expand description

Split command palette renderer with a preview pane.

The split renderer renders search results on the left and selected-row details on the right. It uses only PaletteView data, so applications can replace this preview with richer domain-specific rendering later. See the render module for the renderer contract shared by all built-in renderers.

Implementations§

Source§

impl SplitPreviewRenderer

Source

pub fn new() -> Self

Creates a split preview renderer with default titles.

Source

pub fn title(self, title: impl Into<String>) -> Self

Sets the palette pane title.

§Examples
use ratatui_command_palette::render::SplitPreviewRenderer;

let renderer = SplitPreviewRenderer::new().title("Commands");

assert!(format!("{renderer:?}").contains("Commands"));
Source

pub fn preview_title(self, title: impl Into<String>) -> Self

Sets the preview pane title.

§Examples
use ratatui_command_palette::render::SplitPreviewRenderer;

let renderer = SplitPreviewRenderer::new().preview_title("Details");

assert!(format!("{renderer:?}").contains("Details"));

Trait Implementations§

Source§

impl Clone for SplitPreviewRenderer

Source§

fn clone(&self) -> SplitPreviewRenderer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SplitPreviewRenderer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SplitPreviewRenderer

Source§

fn default() -> Self

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

impl PaletteRenderer for SplitPreviewRenderer

Source§

fn render(&self, area: Rect, buf: &mut Buffer, view: &PaletteView)

Draws view into buf within area.

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.