A Highlightable comes in two flavors:

• Highlightable | Interactive piece of text.

• Static | Non-interactive piece of text. Gets highlighted grudgingly if the UI is going to get unintuitive otherwise. i.e. does not get highlighted when hovered etc.

  Data for a Highlightable:

• text: String to display.

• uiState: How the user is currently interacting with the Highlightable.

• customAttributes: User-supplied attributes that do not change once a Highlightable is initialized.

• marked: Current highlight.

• groupIndex: Index that identifies the fragment this Highlightable belongs to.

UIState connects user-behavior to the highlightable.

State transitions:

• None → (mouse over) → Hovered
• None → (click & drag over highlightables) → Hinted
• Hovered → (mouse out) → None
• Hovered → (mouse down) → Hinted
• Hinted → (mouse out) → None
• Hinted → (mouse up while on a different Highlightable) → None
• Hinted → (mouse up while on me) → Hovered

Custom attributes that do not change after initialization.

• Class: add a class to the highlight
• Data: add a data-X to the highlight (you don't need to prepend data- to this name.)

Split a multi-word string into multiple single-word highlights. This is to deal with the highlighter not doing line breaks within a highlight group, which can look funny if a highlight contains longer text.

Similar to initFragment but each word is treated as a fragment, instead of treating the whole string as a fragment.

Note that we're transforming all whitespace to spaces, so newlines are not preserved as me move to and from fragments

How do we know which elements should be marked, if all we have is a markdown string?

We do some funky parsing to interpret empty anchor tags and tagged spans as highlighted!

fromMarkdown "for example, [this phrase]() will show as highlighted"

will result in a list of highlightables where "this phrase" is marked with the default marker.

Split a highlightable into one highlightable per word.

Create list of words intersperse with spaces.

A Sorter for Attributes

Get a list of fragment texts and whether or not they are marked. Useful for encoding answers.

Get unique markers that have been used.

Fetch the text from a series of highlightables.