notation library
The compact notation (docs/design/13-compact-notation.md): the form an agent writes for a small UI, expanded to an ordinary document.
Classes
- NotationIssue
- A problem in the notation's text: where and what.
- NotationOptions
- How the notation expands.
- NotationResult
- What parseNotation gives: the document and what it could not read.
- NotationStream
-
The notation read as it arrives: add takes text in any chunks and
returns the edit operations of the lines completed so far (a
setper node under its parent,varsfor the state a line introduced), ready forapplyOps; close gives the last line's.
Constants
-
Button.<variant>: the button type and props it stands for. -
defaultTextVariants
→ const Map<
String, Object> - SSUI's text looks, written out so a document needs no theme.
-
notationTypes
→ const Map<
String, ({Json node, String type})> - Short names: what an agent writes → the node type and what it implies.
Functions
-
notationPrompt(
{Catalog? catalog, NotationOptions options = const NotationOptions()}) → String -
The prompt for the notation over
catalog(its level 0 and 1 types). -
parseNotation(
String text, {Catalog? catalog, NotationOptions options = const NotationOptions()}) → NotationResult -
textin the compact notation as a layout document. Never throws: what cannot be read is reported and skipped.