package mosaic

  1. Overview
  2. Docs
Terminal UI framework for OCaml with The Elm Architecture

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (1)

Authors

  1. Thibaut Mattio

Maintainers

  1. Thibaut Mattio

Sources

mosaic-0.1.0.tbz
sha256=9e4e90d17f9b2af1b07071fe425bc2c519c849c4f1d1ab73cde512be2d874849
sha512=06e9c4a741590942e81a27738d0b5c0413fafec8cf3b7dae047ad69f155e7b718aa4223818dc161b7d028efffcfd3365905e264d6fd31d453910ddfa91dcf9b9

doc/mosaic.ui/Mosaic_ui/Text/index.html

Module Mosaic_ui.Text

Styled text display with wrapping, truncation, and selection.

Rich text rendering with styled fragments.

A text node renders styled content into the grid, handling line breaks and optional word/character wrapping. Content can be plain text (via set_content) or structured rich text with per-run styles (via set_fragments or set_spans).

Internally backed by a Text_buffer.t and Text_surface.t.

Representations

Text supports two content representations:

  • Content: a plain string set via set_content or the content parameter of create. Styled with Default style.
  • Fragments/Spans: structured styled content set via set_fragments or set_spans. Fragments support nested style hierarchies; spans are flat styled text chunks.

Style merging

Styles merge hierarchically: parent styles provide the base and child overrides apply on top, preserving unspecified parent attributes. The text_style parameter provides the base style for all content.

See Text_input for single-line editing and Textarea for multi-line editing.

type t

A text widget.

Types

type fragment =
  1. | Text of {
    1. text : string;
    2. style : Ansi.Style.t option;
    }
  2. | Span of {
    1. style : Ansi.Style.t option;
    2. children : fragment list;
    }
    (*

    Structured text fragments for rich text composition.

    • Text: leaf node with text and optional style override.
    • Span: container applying an optional style to all children.
    *)
type span = {
  1. text : string;
  2. style : Ansi.Style.t option;
}

A flat styled text chunk. style overrides the default text style when Some; None inherits the default.

Fragment builder

Convenience constructors for fragment values.

module Fragment : sig ... end

Construction

val create : parent:Renderable.t -> ?index:int -> ?id:string -> ?style:Toffee.Style.t -> ?visible:bool -> ?z_index:int -> ?opacity:float -> ?content:string -> ?text_style:Ansi.Style.t -> ?wrap:Text_surface.wrap -> ?selectable:bool -> ?selection_bg:Ansi.Color.t -> ?selection_fg:Ansi.Color.t -> ?tab_width:int -> ?truncate:bool -> unit -> t

create ~parent () is a text node attached to parent with:

  • content: plain text content. Defaults to "".
  • text_style: base visual style for all content. Defaults to Ansi.Style.default.
  • wrap: wrapping mode. Defaults to `None.
  • selectable: whether text can be selected. Defaults to true.
  • selection_bg: background color for selected text. Defaults to None.
  • selection_fg: foreground color for selected text. Defaults to None.
  • tab_width: tab stop width. Defaults to 2.
  • truncate: whether to truncate with ellipsis when wrap = `None. Defaults to false.

Accessors

val node : t -> Renderable.t

node t is the underlying renderable.

val buffer : t -> Text_buffer.t

buffer t is the underlying text buffer.

val surface : t -> Text_surface.t

surface t is the underlying text surface.

Props

module Props : sig ... end
val apply_props : t -> Props.t -> unit

apply_props t props applies props to t, triggering the minimum necessary layout and render updates.

Content

val set_content : t -> string -> unit

set_content t s sets plain text content styled with set_text_style. Invalidates display lines and marks layout dirty.

val set_fragments : t -> fragment list -> unit

set_fragments t fragments replaces content with fragments. Normalization merges adjacent text with identical styles, removes empty fragments, and flattens empty spans. No-op if the normalized result equals the current fragments.

val fragments : t -> fragment list

fragments t is the current fragment list.

val fragments_equal : fragment list -> fragment list -> bool

fragments_equal a b is true iff a and b are structurally equal.

val plain_text : t -> string

plain_text t is the concatenation of all fragment texts, without styling.

val spans : t -> span list

spans t is the current fragments as a flat span list. Cached; recomputed on fragment changes.

val set_spans : t -> span list -> unit

set_spans t spans replaces content with flat spans. Converts to fragments internally.

val append_span : t -> span -> unit

append_span t s appends s to the end of the text.

val clear_spans : t -> unit

clear_spans t removes all content.

val set_styled_text : t -> Text_buffer.span list -> unit

set_styled_text t spans sets pre-styled buffer content directly. After calling this, apply_props will not overwrite content from Props.

val set_text_style : t -> Ansi.Style.t -> unit

set_text_style t s changes the base text style. Invalidates the span cache if the style differs.

Wrapping

val set_wrap : t -> Text_surface.wrap -> unit

set_wrap t mode changes the wrapping mode. Delegates to Text_surface.set_wrap.

val set_tab_width : t -> int -> unit

set_tab_width t w changes the tab stop width. Delegates to Text_buffer.set_tab_width.

Selection

val set_selectable : t -> bool -> unit

set_selectable t v enables or disables text selection.

val set_selection_bg : t -> Ansi.Color.t option -> unit

set_selection_bg t color sets the selection background color.

val set_selection_fg : t -> Ansi.Color.t option -> unit

set_selection_fg t color sets the selection foreground color.

val selected_text : t -> string

selected_text t is the currently selected text. Returns "" if no selection is active.

Highlights

val add_highlight : t -> Text_buffer.Highlight.t -> unit

add_highlight t h adds a highlight overlay and requests a render.

val remove_highlights_by_ref : t -> int -> unit

remove_highlights_by_ref t ref_id removes highlights by Text_buffer.Highlight.ref_id and requests a render.

val clear_highlights : t -> unit

clear_highlights t removes all highlights and requests a render.

Query

val line_count : t -> int

line_count t is the number of logical lines.

val display_line_count : t -> int

display_line_count t is the number of wrapped display lines.

Formatting

val pp : Format.formatter -> t -> unit

pp ppf t formats t on ppf for debugging.