Struct MarkdownView 

pub struct MarkdownView;

A widget for rendering markdown text using MarkdownViewState.

Example

use basalt_core::markdown;
use basalt_widgets::markdown::{MarkdownViewState, MarkdownView};
use ratatui::prelude::*;
use ratatui::widgets::StatefulWidgetRef;

let text = "# Hello, world!\nThis is a test.";
let mut state = MarkdownViewState::new(text);

let area = Rect::new(0, 0, 20, 10);
let mut buffer = Buffer::empty(area);

MarkdownView.render_ref(area, &mut buffer, &mut state);

let expected = [
  "╭──────────────────▲",
  "│█ Hello, world!   █",
  "│                  █",
  "│This is a test.   █",
  "│                  █",
  "│                  █",
  "│                  █",
  "│                  ║",
  "│                  ║",
  "╰──────────────────▼",
];

// FIXME: Take styles into account
// assert_eq!(buffer, Buffer::with_lines(expected));

Trait Implementations

impl Clone for MarkdownView

fn clone(&self) -> MarkdownView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownView

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

Formats the value using the given formatter.

impl PartialEq for MarkdownView

fn eq(&self, other: &MarkdownView) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StatefulWidgetRef for MarkdownView

type State = MarkdownViewState

State associated with the stateful widget.

fn render_ref(&self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl StructuralPartialEq for MarkdownView