package virtual_dom

You can search for identifiers within the package.

in-package search v0.2.0

OCaml bindings for the virtual-dom library

Install

Dune Dependency

github.com MIT License Edit opam file Versions (7)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

sha256=7f1fa83287458114c5b0cab8aae00d69972d15e1d20a446ce13f246aacef3216

doc/virtual_dom.css_gen/Css_gen/index.html

Module `Css_gen`Source

A set of functions to generate css declaration lists. This library can be used to programmatically produce strings suitable for the HTML style attribute, e.g. style="display:flex;background-color:red".

Sourcetype css_global_values = [

| `Inherit
| `Initial

]

Sourceval sexp_of_css_global_values : css_global_values -> Sexplib0.Sexp.t

Sourceval css_global_values_of_sexp : Sexplib0.Sexp.t -> css_global_values

Sourceval __css_global_values_of_sexp__ : Sexplib0.Sexp.t -> css_global_values

Sourceval compare_css_global_values : css_global_values -> css_global_values -> int

Sourcemodule Color : sig ... end

Sourcemodule Length : sig ... end

Sourcemodule Auto_or_length : sig ... end

Sourcetype t

include Sexplib0.Sexpable.S with type t := t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

include Ppx_compare_lib.Comparable.S with type t := t

Sourceval compare : t Base__Ppx_compare_lib.compare

include Core.Bin_prot.Binable.S with type t := t

include Bin_prot.Binable.S_only_functions with type t := t

Sourceval bin_size_t : t Bin_prot.Size.sizer

Sourceval bin_write_t : t Bin_prot.Write.writer

Sourceval bin_read_t : t Bin_prot.Read.reader

Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t

Sourceval bin_writer_t : t Bin_prot.Type_class.writer

Sourceval bin_reader_t : t Bin_prot.Type_class.reader

Sourceval bin_t : t Bin_prot.Type_class.t

Sourceval create : field:string -> value:string -> t

Create a single property, value pair (a declaration in CSS parlance). The value must be a valid CSS literal. We do run a simple CSS parser on the value to validate this and will throw an exception if that parser fails. Note that the parser is less forgiving than many browsers. That is browsers will silently accept or drop many illegal constructs. We prefer to raise on them, so that errors are detected earlier.

It is recommended to use one of the other constructors instead if they are available. If they are not, consider adding them to this library.

Sourceval empty : t

Sourceval is_empty : t -> bool

val position : 
  ?top:Length.t ->
  ?bottom:Length.t ->
  ?left:Length.t ->
  ?right:Length.t ->
  [ `Static | `Absolute | `Sticky | `Relative | `Fixed ] ->
  t

Set the position attribute and optionally top, bottom,left,right Note that left and top have no effect when position is `Static.

Sourceval top : Length.t -> t

Add the top property alone.

Sourceval bottom : Length.t -> t

Add the bottom property alone.

Sourceval left : Length.t -> t

Add the left property alone.

Sourceval right : Length.t -> t

Add the right property alone.

Sourceval combine : t -> t -> t

Neither combine nor concat validate that each t is unique. For combine x y, y will override x if they are the same attribute. For concat l, the greatest index of an attribute will prevail.

Sourceval (@>) : t -> t -> t

Sourceval concat : t list -> t

Sourceval to_string_list : t -> (string * string) list

Sourceval to_string_css : t -> string

Sourceval of_string_css_exn : string -> t

The inverse of to_string_css. Primarily useful if you want to reuse a css literal from the web (aka copy paste web design). Raises if the string fails validation. See create for comments on the validation we do.

Sourceval box_sizing : [ `Content_box | `Border_box | css_global_values ] -> t

val display : 
  [ `Inline
  | `Block
  | `Inline_block
  | `List_item
  | `Table
  | `Inline_table
  | `None
  | `Inline_grid
  | css_global_values ] ->
  t

Sourceval visibility : [ `Visible | `Hidden | `Collapse | css_global_values ] -> t

Sourcetype overflow = [

| `Visible
| `Hidden
| `Scroll
| `Auto
| css_global_values

]

Sourceval overflow : overflow -> t

Sourceval overflow_x : overflow -> t

Sourceval overflow_y : overflow -> t

Sourceval z_index : int -> t

Sourceval opacity : float -> t

Sourcetype font_style = [

| `Normal
| `Italic
| `Oblique
| css_global_values

]

Sourcetype font_weight = [

| `Normal
| `Bold
| `Bolder
| `Lighter
| `Number of int
| css_global_values

]

Sourcetype font_variant = [

| `Normal
| `Small_caps
| css_global_values

]

Sourceval font_size : Length.t -> t

Sourceval font_family : string list -> t

Sourceval font_style : font_style -> t

Sourceval font_weight : font_weight -> t

Sourceval font_variant : font_variant -> t

val font : 
  size:Length.t ->
  family:string list ->
  ?style:font_style ->
  ?weight:font_weight ->
  ?variant:font_variant ->
  unit ->
  t

Sourceval bold : t

Sourcetype stops = (Core.Percent.t * Color.t) list

Sourcetype linear_gradient = {

direction : [ `Deg of int ];
stops : stops;

}

Sourcetype radial_gradient = {

stops : stops;

}

Sourcetype background_image = [

| `Url of string
| `Linear_gradient of linear_gradient
| `Radial_gradient of radial_gradient

]

Sourceval create_with_color : field:string -> color:[< Color.t ] -> t

Sourceval color : [< Color.t ] -> t

Sourceval background_color : [< Color.t ] -> t

Sourceval background_image : background_image -> t

Sourceval fill : Color.t -> t

val text_align : 
  [ `Left | `Right | `Center | `Justify | css_global_values ] ->
  t

Sourceval horizontal_align : [ `Left | `Right | `Center | css_global_values ] -> t

val vertical_align : 
  [ `Top | `Bottom | `Middle | `Super | `Sub | css_global_values ] ->
  t

val white_space : 
  [ `Normal | `Nowrap | `Pre | `Pre_line | `Pre_wrap | css_global_values ] ->
  t

Sourceval float : [ `None | `Left | `Right | css_global_values ] -> t

Sourceval width : Length.t -> t

Sourceval min_width : Length.t -> t

Sourceval max_width : Length.t -> t

Sourceval height : Length.t -> t

Sourceval min_height : Length.t -> t

Sourceval max_height : Length.t -> t

Sourceval padding_top : Length.t -> t

Sourceval padding_bottom : Length.t -> t

Sourceval padding_left : Length.t -> t

Sourceval padding_right : Length.t -> t

Sourceval uniform_padding : Length.t -> t

val padding : 
  ?top:Length.t ->
  ?bottom:Length.t ->
  ?left:Length.t ->
  ?right:Length.t ->
  unit ->
  t

Sourceval margin_top : Auto_or_length.t -> t

Sourceval margin_bottom : Auto_or_length.t -> t

Sourceval margin_left : Auto_or_length.t -> t

Sourceval margin_right : Auto_or_length.t -> t

Sourceval uniform_margin : Auto_or_length.t -> t

val margin : 
  ?top:Auto_or_length.t ->
  ?bottom:Auto_or_length.t ->
  ?left:Auto_or_length.t ->
  ?right:Auto_or_length.t ->
  unit ->
  t

Sourcetype border_style = [

| `None
| `Hidden
| `Dotted
| `Dashed
| `Solid
| `Double
| `Groove
| `Ridge
| `Inset
| `Outset
| css_global_values

]

val border_top : 
  ?width:Length.t ->
  ?color:[< Color.t ] ->
  style:border_style ->
  unit ->
  t

val border_bottom : 
  ?width:Length.t ->
  ?color:[< Color.t ] ->
  style:border_style ->
  unit ->
  t

val border_left : 
  ?width:Length.t ->
  ?color:[< Color.t ] ->
  style:border_style ->
  unit ->
  t

val border_right : 
  ?width:Length.t ->
  ?color:[< Color.t ] ->
  style:border_style ->
  unit ->
  t

val border : 
  ?width:Length.t ->
  ?color:[< Color.t ] ->
  style:border_style ->
  unit ->
  t

Sourceval border_radius : Length.t -> t

Sourceval border_collapse : [ `Separate | `Collapse | css_global_values ] -> t

Sourceval border_spacing : Length.t -> t

val outline : 
  ?width:Length.t ->
  ?color:[< Color.t ] ->
  style:border_style ->
  unit ->
  t

Sourcetype text_decoration_line = [

| `None
| `Underline
| `Overline
| `Line_through
| css_global_values

]

Sourcetype text_decoration_style = [

| `Solid
| `Double
| `Dotted
| `Dashed
| `Wavy
| css_global_values

]

val text_decoration : 
  ?style:text_decoration_style ->
  ?color:[< Color.t ] ->
  line:text_decoration_line list ->
  unit ->
  t

Sourcetype item_alignment = [

| `Auto
| `Flex_start
| `Flex_end
| `Center
| `Baseline
| `Stretch

]

Sourcetype justify_content = [

| `Flex_start
| `Flex_end
| `Center
| `Space_between
| `Space_around
| `Space_evenly

]

val flex_container : 
  ?inline:bool ->
  ?direction:[ `Row | `Row_reverse | `Column | `Column_reverse ] ->
  ?wrap:[ `Nowrap | `Wrap | `Wrap_reverse ] ->
  ?align_items:item_alignment ->
  ?justify_content:justify_content ->
  unit ->
  t

val flex_item : 
  ?order:int ->
  ?basis:Auto_or_length.t ->
  ?shrink:float ->
  grow:float ->
  unit ->
  t

Sourceval align_self : item_alignment -> t

val resize : 
  [ `None | `Both | `Horizontal | `Vertical | css_global_values ] ->
  t

val animation : 
  name:string ->
  duration:Core.Time_ns.Span.t ->
  ?delay:Core.Time_ns.Span.t ->
  ?direction:
    [ `Normal
    | `Reverse
    | `Alternate
    | `Alternate_reverse
    | css_global_values ] ->
  ?fill_mode:[ `None | `Forwards | `Backwards | `Both | css_global_values ] ->
  ?iter_count:int ->
  ?timing_function:string ->
  unit ->
  t

Note: You must include the names @keyframes in the stylesheet

Sourcetype user_select = [

| `All
| `Auto
| `None
| `Text

]

Sourceval user_select : user_select -> t

Sourcemodule Stable : sig ... end

Sourcemodule Expert : sig ... end

Sourcemodule Private : sig ... end