Besides the built-in widgets, your organisation can keep its own. The simplest way is to save a card you configured as a widget. Administrators can also author widgets from an HTML template, with their own settings form and data slots, and publish versions of them. Widgets live in the widget library.
The widget library
Open Widgets in the menu (under Configuration). “Everything that can be placed on a dashboard.”
| Shelf | Holds |
|---|---|
| System | The built-in widgets and those the modules add (“Modules contribute widgets as they are enabled.”) |
| Tenant | Widgets shared with the whole organisation |
| My widgets | Your private widgets (“Widgets you create appear on this shelf.”) |
| Favourites | The widgets you starred, from any shelf |
The table shows Name, Category and Used by (how many cards use it), with a Kind filter: Built in, HTML template, Plugin frame. Edit opens a widget you may change.
| Who | May |
|---|---|
| Every member (Create and edit your own private widgets) | Create private widgets for themselves |
| Administrators (Create and edit widgets, Publish widget versions) | Create, edit and publish widgets for everyone |
Your plan sets how many shared custom widgets your organisation may have. Each member’s private widgets count against their own allowance under the same limit, so private widgets never use up the shared ones.
Save a card as a widget
- Configure a card on a board the way you want it.
- In its settings, select Save as widget… (“Saves this card’s current settings and data as a reusable widget in your library.”).
- The widget appears under My widgets: “Saved as a widget in your library.” Place it on any board from Add widget > My widgets.
Create a widget
- In the widget library, select New widget.
- Choose how to start: From a ready chart (a built-in chart with your defaults) or From an HTML template.
- Enter a Name and a Category, and choose Only me or Everyone (admin only).
- Select Create. The widget editor opens.
The widget editor
The editor shows a Live preview on the left and the Settings form on the right. The preview is drawn by the same sandboxed frame a board uses, so what you see is what boards get. The tabs:
| Tab | Holds |
|---|---|
| Template | The HTML of an HTML template widget. A built-in or plugin widget says it “is rendered by code we ship, so there is no template to edit here”. |
| Schema | The settings fields: Key, Label, Type. “Every field you add here appears in the panel on the right — and in the drawer an operator opens on a placement.” Removing a field removes its default too. |
| Data | Up to 6 data slots: Slot key, Label, Shape (scalar, series, table, record), Required. “A slot says what the widget NEEDS — a scalar, a series — never where it comes from.” Each card chooses the source. |
| Actions | Read-only: actions are set per card, in the board’s settings drawer. |
Use these as defaults writes the settings on screen into the widget’s defaults.
Writing an HTML template
- A settings field is a token: a field
titleis{{title}}. - A scalar data slot
mainis{{data_main}}. Richer shapes are inwindow.WIDGET_DATA.<slot>for the template’s own script. - To make something clickable, call
window.widgetAction()or give an elementdata-widget-action. The card then runs the actions its board configured; the template never names a destination.
<div style="font: 600 32px system-ui">{{data_main}} {{unit}}</div>
<div style="color: #666">{{caption}}</div>
<button data-widget-action>Details</button>The template runs in a frame with no access to Hermetry, your session or other cards, under its own content security policy. Template widgets show on display screens.
Drafts, versions and publishing
A widget has a status: Draft, Published or Archived. Your edits go into the draft and are saved as you type (also Ctrl+S); the header says “unsaved…” then Saved. Undo and redo (Ctrl+Z, Ctrl+Shift+Z) work while you edit. Boards only see published versions, so a draft never changes a board.
| Action | Effect |
|---|---|
| Publish | Makes the draft a new version (from Draft or Published). Cards on boards follow it. |
| Unpublish | Sets a published widget back to Draft. |
| Archive | Retires a draft or published widget (Archived). |
| Restore | Brings an archived widget back as a Draft. |
The editor offers only the moves the widget’s status allows.
When a publish changes settings that cards already use, the dialog Settings changes since the last publish lists them: renamed, removed, retyped, narrowed or deprecated fields. If a new field replaces a removed one, say so (“
If two people edit one widget, the second save is refused rather than silently overwriting the first.
System widgets
A system widget ships with the platform. Editing one shows “This is a system widget. It ships with the platform, so edits here are not what an upgrade will keep.” A shared widget of your own cannot take the type name of a platform widget.
Moving widgets
A board file names the widgets its cards use but does not carry their definitions. Before you import a board that uses your own widgets into another organisation, recreate those widgets there. See Board templates and board files.