package tw

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

Module Prose.HandlerSource

Sourcetype t

The utility type

Sourceval name : string

Name of this utility handler.

Sourceval to_style : Scheme.t -> t -> Style.t

to_style theme u converts utility u to a style, reading any theme values it needs from theme.

Sourceval priority : t -> int

priority u is the primary ordering key for utility u. Usually a module constant (let priority _ = n); modules whose variants span several canonical families (e.g. layout) return per-variant values.

Sourceval suborder : t -> int

suborder u is the suborder within the same priority.

Sourceval of_class : Scheme.t -> string -> (t, [ `Msg of string ]) result

of_class theme name parses class name into a utility, consulting theme for custom token validation (e.g. named colors and opacities).

Sourceval to_class : t -> string

to_class u is the CSS class name for utility u.

Sourceval examples : t list

A few of this handler's utilities, one per property it can set. order_of_property runs them through to_style to learn which properties belong to which slot, so nothing has to restate the order or pair a property with a variant by hand. Covering a property here is what lets a project's @utility declaring it sort in the right place.