package mosaic

  1. Overview
  2. Docs
package mosaic
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Scroll_box.Props

type t

The type for scroll box property bundles used for reconciler diffing.

val make : ?scroll_x:bool -> ?scroll_y:bool -> ?sticky_scroll:bool -> ?sticky_start:[ `Top | `Bottom | `Left | `Right ] -> ?background:Ansi.Color.t -> ?scrollbar_props:Scroll_bar.Props.t -> ?vertical_bar_props:Scroll_bar.Props.t -> ?horizontal_bar_props:Scroll_bar.Props.t -> unit -> t

make () is a scroll box property bundle with:

  • scroll_x enables horizontal scrolling. Defaults to false.
  • scroll_y enables vertical scrolling. Defaults to true.
  • sticky_scroll sticks to an edge as content grows. Defaults to false.
  • sticky_start selects the sticky edge. Defaults to `Bottom.
  • background fills the container background with a color.
  • scrollbar_props is applied to both scroll bars.
  • vertical_bar_props overrides scrollbar_props for the vertical bar.
  • horizontal_bar_props overrides scrollbar_props for the horizontal bar.

See also default.

val default : t

default is make ().

val equal : t -> t -> bool

equal a b is true iff a and b describe identical properties.