plushie_gleam - v0.6.0

plushie/widget/rich_text

Rich text widget builder. Displays individually styled spans.

Spans are encoded as a “spans” prop (list of maps), not as child nodes. Each span carries its own text content and optional style overrides.

Types

Opt

</>

Option type for rich text properties.

pub type Opt {
  Spans(List(Span))
  Width(length.Length)
  Height(length.Length)
  Size(Float)
  Font(font.Font)
  Color(color.Color)
  LineHeight(line_height.LineHeight)
  Wrapping(wrapping.Wrapping)
  Ellipsis(String)
  A11y(a11y.A11y)
}

Constructors

RichText

opaque </> 
pub opaque type RichText

Span

</>

A single styled span within a rich text widget.

pub type Span {
  Span(
    text: String,
    size: option.Option(Float),
    font: option.Option(font.Font),
    color: option.Option(color.Color),
    line_height: option.Option(line_height.LineHeight),
    link: option.Option(String),
    underline: option.Option(Bool),
    strikethrough: option.Option(Bool),
    padding: option.Option(padding.Padding),
    highlight: option.Option(SpanHighlight),
  )
}

Constructors

SpanHighlight

</>

Highlight behind a span’s text: an optional fill colour and an optional border around the text box.

pub type SpanHighlight {
  SpanHighlight(
    background: option.Option(color.Color),
    border: option.Option(border.Border),
  )
}

Constructors

Values

a11y

</> 
pub fn a11y(rt: RichText, a: a11y.A11y) -> RichText

Set accessibility properties for this widget.

build

</> 
pub fn build(rt: RichText) -> node.Node

Build the rich text into a renderable Node.

color

</> 
pub fn color(rt: RichText, c: color.Color) -> RichText

Set the color.

ellipsis

</> 
pub fn ellipsis(rt: RichText, e: String) -> RichText

Set the text ellipsis mode.

font

</> 
pub fn font(rt: RichText, f: font.Font) -> RichText

Set the font.

height

</> 
pub fn height(rt: RichText, h: length.Length) -> RichText

Set the height.

line_height

</> 
pub fn line_height(
  rt: RichText,
  lh: line_height.LineHeight,
) -> RichText

Set the line height.

new

</> 
pub fn new(id: String) -> RichText

Create a new rich text builder.

size

</> 
pub fn size(rt: RichText, s: Float) -> RichText

Set the size.

span

</> 
pub fn span(text: String) -> Span

Create a span with the given text and no style overrides.

span_color

</> 
pub fn span_color(s: Span, c: color.Color) -> Span

Set the color on a span.

span_font

</> 
pub fn span_font(s: Span, f: font.Font) -> Span

Set the font on a span.

span_highlight

</> 
pub fn span_highlight(s: Span, h: SpanHighlight) -> Span

Set the highlight on a span.

span_line_height

</> 
pub fn span_line_height(
  s: Span,
  lh: line_height.LineHeight,
) -> Span

Set the line height on a span.

</> 
pub fn span_link(s: Span, url: String) -> Span

Set the link on a span.

span_padding

</> 
pub fn span_padding(s: Span, p: padding.Padding) -> Span

Set the padding on a span.

span_size

</> 
pub fn span_size(s: Span, size: Float) -> Span

Set the size on a span.

span_strikethrough

</> 
pub fn span_strikethrough(s: Span, st: Bool) -> Span

Set the strikethrough on a span.

span_to_prop_value

</> 
pub fn span_to_prop_value(s: Span) -> node.PropValue

Encode a single span to a PropValue dict.

span_underline

</> 
pub fn span_underline(s: Span, u: Bool) -> Span

Set the underline on a span.

spans

</> 
pub fn spans(rt: RichText, s: List(Span)) -> RichText

Set the list of styled spans.

width

</> 
pub fn width(rt: RichText, w: length.Length) -> RichText

Set the width.

with_opts

</> 
pub fn with_opts(rt: RichText, opts: List(Opt)) -> RichText

Apply a list of options to a rich text builder.

wrapping

</> 
pub fn wrapping(rt: RichText, w: wrapping.Wrapping) -> RichText

Set the text wrapping mode.

✨ Search Document