NoRedInk / noredink-ui / Nri.Ui.HighlighterTool.V1

Patch changes


type Tool kind
    = Marker (MarkerModel kind)
    | Eraser EraserModel

Tool that can be used on a highlighter


type alias EraserModel =
{ hoverClass : List Css.Style
, hintClass : List Css.Style
, startGroupClass : List Css.Style
, endGroupClass : List Css.Style 
}

EraserModel

buildEraser : EraserModel

The default eraser.


type alias MarkerModel kind =
{ hoverClass : List Css.Style
, hintClass : List Css.Style
, startGroupClass : List Css.Style
, endGroupClass : List Css.Style
, highlightClass : List Css.Style
, hoverHighlightClass : List Css.Style
, kind : kind
, name : Maybe String 
}

A marker is used to highlight highlightables. A user can define a kind, which contains the meaning of a selection. Marker is also used to define styling of a selection.

buildMarker : { highlightColor : Css.Color, hoverColor : Css.Color, hoverHighlightColor : Css.Color, kind : kind, name : Maybe String } -> MarkerModel kind

buildMarkerWithBorder : { highlightColor : Css.Color, kind : kind, name : Maybe String } -> MarkerModel kind

Typically, this marker is only used for static highlighters.

buildMarkerWithoutRounding : { highlightColor : Css.Color, hoverColor : Css.Color, hoverHighlightColor : Css.Color, kind : kind, name : Maybe String } -> MarkerModel kind

Typically, this style of marker is used for inline comments.