Skip to main content

Markdown

Struct Markdown 

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

Renders CommonMark / Markdown text as styled terminal output.

Supports headings (bold + underline, no # prefix), bold, italic, inline code (configurable style, no backticks), lists with bullet markers, soft/hard breaks, and raw HTML passthrough. Text is automatically wrapped to the requested width via wrap_text_with_ansi.

Implementations§

Source§

impl Markdown

Source

pub fn new(text: impl Into<String>) -> Self

Create a new Markdown component from the given text.

Defaults: headings are bold+underlined, inline code is cyan, bold is bright white, italic is slanted.

Source

pub fn with_code_style(self, style: fn(&str) -> String) -> Self

Override the inline code styling.

The function receives the raw code text and should return the styled string (including any ANSI reset). Defaults to cyan foreground.

§Example
use photon_ui::components::Markdown;

let md = Markdown::new("`hello`").with_code_style(|s| format!("\x1b[48;5;240m{}\x1b[0m", s));

Trait Implementations§

Source§

impl Component for Markdown

Source§

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width. Read more
Source§

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area. Read more
Source§

fn handle_input(&mut self, _event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.). Read more
Source§

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat. Read more
Source§

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.
Source§

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.

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> 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, 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.