RichTextMark
A mark on a span of text, Portable Text's decorators.
Text formats; not ordered; since Jadpo 0.1.0.
Make one
Pick one of its variants, RichTextMark.strong.
text.parse(raw, as: RichTextMark) reads one from its text; text that isn't one at all fails malformed, such as bold, em or strike-through.
Variants
5 variants, each written as its own name: strong, emphasis, code, underline, strike_through.
Text, JSON and storage
text.from writes its canonical text, the one form text.parse reads back. JSON sends its canonical text as a string.
| Text | JSON |
|---|---|
strong |
"strong" |
emphasis |
"emphasis" |
code |
"code" |
underline |
"underline" |
strike_through |
"strike_through" |
It is stored in one column named for the field, of type text. code is stored as 'code'.
Shown to people
text.format(value, locale:) shows it to people in their locale.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
strong |
strong |
emphasis |
emphasis |
code |
code |
underline |
underline |
strike_through |
strike_through |
Operations
It has the contract's own operations: text.parse, text.from, text.format, json.read, json.write and ==. It isn't ordered, so < and sorting don't take it. Every standard type meets one contract says how they work.
Markdown for agents: /docs/types/type-rich-text-mark.md.Built from Jadpo main at e00e61f.