Skip to content

heading

Names a section of a screen in a few words, so a person scanning the page finds it.

text is the heading's words (up to 200 characters); level is 2 for a section and 3 for a sub-section. Level 1 is the screen's own title, written by the page head from the screen's title, so a block never uses it. The Markdown rendering writes ## or ###; the HTML writes h2 or h3.

When to use

Use it when

  • A screen has more than one part, such as the policies and then the evidence for the auditor.

  • A part has a sub-part a person should find on its own, such as this week's hand-offs under the agents.

  • An agent reading the Markdown needs a section to anchor to.

Use another block when

A section of the compliance screen

Evidence for the auditor

heading: { text: Evidence for the auditor }
<a id="heading-1"></a>

## Evidence for the auditor

A sub-section

This week

heading: { text: This week, level: 3 }
<a id="heading-1"></a>

### This week

A heading with an id for its anchor

Tickets handed to a person

heading: { id: hand-offs, text: Tickets handed to a person }
<a id="hand-offs"></a>

## Tickets handed to a person

States

  • ready

    always drawn; it reads no data

This block offers no actions; it only shows.

JSON Schema

Search

esc

Go to