Skip to content
Navigation

Primary

A note next to the page outline

On the right, under the page outline, there is a warning the reader sees while scrolling the page. It suits rules that must not be missed.

Click “Check responsive preview” above the example and choose a phone. There is no right column there, and the note is not shown with it. Put a warning that everyone must see in the page text.

How it works

  1. The outline region is the right column. The first part, docara.outline, builds the outline from the page headings.
  2. The second part holds the SIMAI Framework ui.alert alert. Docara checks its parameters during the build.
  3. The alert follows the site theme: in the dark theme it is dark too.
region-aside.page.json
{  "id": "signature",  "block": "shell.smart",  "slot": "content",  "smart": "ui.alert",  "view": "default",  "props": {    "type": "warning",    "variant": "outlined",    "title": "Check the signature",    "supporting-text": "Without it, anyone can forge a notification.",    "closable": false,    "aria-label": "Check the notification signature"  }}

What you can change

Parameter What it changes
type The alert meaning: info, success, warning, danger or clear
variant The look: default filled, flat, or outlined with a border
title Title, up to 160 characters
supporting-text Text, up to 500 characters
closable Whether the alert can be closed
aria-label The alert name for screen readers

See also