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/Code/index.html

Module Mosaic_ui.Code

Code display with syntax highlighting, wrapping, and selection.

Syntax-highlighted code display.

A leaf renderable for displaying source code with optional pre-computed syntax highlighting. Uses Text_buffer.t for text storage and Text_surface.t for rendering.

Code differs from Text in its defaults: wrapping defaults to `None, tab width defaults to 4, it accepts pre-computed styled spans, and it registers as a Renderable.line_info provider.

Types

type t

The type for code display renderables.

Props

module Props : sig ... end

Constructors

val create : parent:Renderable.t -> ?index:int -> ?id:string -> ?style:Toffee.Style.t -> ?visible:bool -> ?z_index:int -> ?opacity:float -> ?content:string -> ?spans:Text_buffer.span list -> ?text_style:Ansi.Style.t -> ?wrap:Text_surface.wrap -> ?tab_width:int -> ?truncate:bool -> ?selectable:bool -> ?selection_bg:Ansi.Color.t -> ?selection_fg:Ansi.Color.t -> ?on_selection:((int * int) option -> unit) -> unit -> t

create ~parent () is a new code display renderable attached to parent with:

  • index is the child insertion index in parent.
  • id is an optional identifier for the node.
  • style is the layout style.
  • visible controls initial visibility.
  • z_index is the stacking order.
  • opacity is the opacity. Defaults to 1.0.
  • content is the plain source code text. Defaults to "".
  • spans are pre-computed styled spans. Defaults to [].
  • text_style is the base text style. Defaults to Ansi.Style.default.
  • wrap is the wrapping mode. Defaults to `None.
  • tab_width is the tab stop width in columns. Defaults to 4.
  • truncate controls whether long lines are truncated with an ellipsis. Defaults to false.
  • selectable controls whether text can be selected. Defaults to true.
  • selection_bg is the selection background color.
  • selection_fg is the selection foreground color.

See also Props.make for the code-specific props.

Accessors

val node : t -> Renderable.t

node t is t's underlying Renderable.t node.

val buffer : t -> Text_buffer.t

buffer t is t's backing Text_buffer.t.

val surface : t -> Text_surface.t

surface t is t's Text_surface.t.

Content

val set_content : t -> string -> unit

set_content t s sets the plain code content to s. Clears any existing styled spans.

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

set_spans t spans sets pre-computed styled spans. These override plain content display.

val set_on_selection : t -> ((int * int) option -> unit) option -> unit

set_on_selection t f sets the selection-change callback used when selectable = true. None clears it.

Props application

val apply_props : t -> Props.t -> unit

apply_props t props applies props to t, updating content, spans, style, and wrapping as specified.

Query

val line_count : t -> int

line_count t is the number of logical lines in t.

val display_line_count : t -> int

display_line_count t is the number of display lines in t after wrapping.