Nri.Ui.HighlighterTool.V1

type Tool kind

= Marker (MarkerModel kind)

| Eraser EraserModel

Tool that can be used on a highlighter

type alias EraserModel =

{ hoverClass : List Style

, hintClass : List Style

, startGroupClass : List Style

, endGroupClass : List Style

}

EraserModel

buildEraser : EraserModel

The default eraser.

type alias MarkerModel kind =

{ hoverClass : List Style

, hintClass : List Style

, startGroupClass : List Style

, endGroupClass : List Style

, highlightClass : List Style

, hoverHighlightClass : List 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 : Color

, hoverColor : Color

, hoverHighlightColor : Color

, kind : kind

, name : Maybe String

}

-> MarkerModel kind

buildMarkerWithBorder :

{ highlightColor : Color

, kind : kind

, name : Maybe String

}

-> MarkerModel kind

Typically, this marker is only used for static highlighters.

NoRedInk/noredink-ui/21.8.0

Nri.Ui.HighlighterTool.V1

Modules