Skip to content

UI & Interaction ​

Erupt's screens are generated from annotations, but how comfortable they are to use is not. Everything below ships enabled, needs no configuration, and is mostly remembered per user and per model in the browser — reopen a page and it looks the way you left it.

Appearance Settings ​

The ⚙️ button in the top-right opens the Page config drawer; every change applies immediately:

Page config

Appearance ​

SettingWhat it does
Theme color18 presets plus a color picker, and a reset back to the default rgb(22, 119, 255). Brutalist and Terminal bring palettes of their own (pastels / phosphors), each remembered separately, and switching skins swaps the palette in v2.4.0+
Header colorFollow the theme / follow the theme color / a preset / a custom color; the Brutalist and Terminal skins own their top bar, so the picker is not offered there
Color schemeLight / Dark / System (System follows the OS live)
Compact modeTightens spacing to fit more on screen; combines with dark
SkinDefault / Classic / Workspace / Material / Liquid Glass / Brutalist / Terminal — mutually exclusive; since 2.3.0 the picker is a tile grid with a miniature of each shell v2.3.0+
Navigation colorWorkspace skin only: 32 light / dark frame presets v2.3.0+

Besides the default skin, two arrived earlier:

  • Brutalist: neo-brutalism — a warm off-white canvas, thick black outlines, hard offset shadows, square corners and candy color blocks, redrawn in the raft.build style since 2.3.0; it brings its own pastel palette, remembered separately, and its header is part of the skin
  • Liquid Glass: the sidebar is a translucent glass panel with background blur and a highlighted edge, floating over an ambient color field

Two skins are new in 2.3.0 v2.3.0+:

  • Workspace: a Slack / Feishu / DingTalk style shell — header and sidebar share one brand-tinted frame and the content floats on it as a rounded card. The frame comes in 32 light / dark presets (a light frame flips the navigation text to ink); the site default is theme.workspaceFrame, and when unset the frame is derived from the primary color. The login page wears the same frame under this skin
  • Classic: the Ant Design Pro shell — navy sidebar beside a white header; in the top-menu modes the navy moves into the header

Two more arrive in 2.4.0 v2.4.0+:

  • Material: the Material 3 / Google Workspace (Gmail) shell — header, menu column and gutter form one brand-tinted "surface container", and the page is a bright rounded sheet set into it with no borders or seams; menu rows are pills, and every tone is mixed from the runtime primary color, so picking another theme color re-tints the whole shell
  • Terminal: a phosphor console — black canvas, monospace type, square corners, no shadows, surfaces divided by dashed rules. The whole shell uses one color, the theme color, and the skin brings its own CRT phosphor palette (P1 green by default, plus amber, cyan, magenta, white and more) kept in a storage slot of its own so it never leaks into the other skins. The light variant is a paper teletype: a warm paper canvas with the same phosphor darkened to ink; the header color picker is hidden under this skin

The skins:

ClassicWorkspace
Classic skinWorkspace skin
BrutalistLiquid Glass
Brutalist skinLiquid Glass skin

Terminal (dark mode):

Terminal skin

theme.customizable: false in app.js v2.3.0+ hides the branding controls — theme color, header color, skin, navigation color and menu mode — in the settings drawer, the sidebar, the login page and the home page alike, purges choices users saved earlier and forces the configured menu mode, so everyone sees one appearance. Light / dark and compact are personal comfort settings and stay switchable.

SettingWhat it does
Menu modeSingle-column / Grouped (top-level categories as flat group titles) / Dual-column (icon rail plus a submenu column) / Category (top-level categories in the header) / Top (the whole menu in the header, no sidebar, content spans the full width) / Two-row top (categories in the header, their children in a second row, no sidebar). Grouped and Two-row top are new in 2.3.0, and this drawer is now the one place to switch modes v2.3.0+
Show labels when collapsedMenu names under the icons once the sidebar is collapsed
Show labels on the railWhether the icon rail of the dual-column mode shows menu names; only offered in that mode v2.3.0+
Multiple tabsPages are reused as tabs so you can jump back between menus
Breadcrumb navThe path bar at the top (turned off automatically in the category and top menu modes)
Menu section titlesSection titles by module group in the sidebar (business / AI / developer tools / operations / data sources), see Resizable Layout; off joins the sections into one list. The site default is theme.menuGroups v2.4.0+

Table ​

SettingWhat it does
Table borderedWhether cell borders are drawn
Table densityCompact / Middle / Large
Detail panel styleCentered dialog / Side panel / Fullscreen — see Form Panel; replaces the former "Drawer for Details" switch v2.3.0+
Click row to view detailsWhen on, clicking a table row opens that record's detail panel; off by default v2.3.0+

Others ​

Color-weak mode, grayscale mode, RTL layout, and a button to clear the local cache.

Defaults vs. personal choice

theme (primaryColor, headerColor, dark, compact, skin, workspaceFrame, menuMode, menuGroups, formPanelMode, loginLayout) and tabReuse in app.js are the system defaults — see Frontend Configuration. What a user picks in this drawer is stored in their browser's localStorage and wins. Clearing the cache returns them to the defaults; with theme.customizable: false the branding items stop accepting user choices at all.

Login Page Layouts v2.3.0+ ​

The login page offers five layouts, switchable from the nav at the top of the page (the choice is saved in localStorage as login-layout; the switch is hidden when theme.customizable is false). The site default is theme.loginLayout in app.js:

LayoutValueWhat it looks like
Centered cardcenterThe card floats on the artwork (default)
Side panelcoverFull-bleed artwork, the form docked right as a 440px panel
Wide cardwideOne 800px card: brand pane on the left (logo top, title bottom), form on the right
WallpaperwallpaperThe picture full screen, a frosted card in the middle
PosterposterThe brand as a poster-sized headline, a small card bottom right

The center and cover layouts, both with a custom theme.loginBackground picture:

Login page: center

Login page: cover

  • Below 992px every layout collapses to the centered card
  • theme.loginBackground swaps the stock artwork for your own picture in every layout (a vignette keeps brand and copyright legible); a URL that fails to load falls back to the stock artwork instead of a blank page
  • Under the Workspace skin the login page wears the same frame colors as the shell
  • With erupt-sso installed, single sign-on buttons appear on the card: up to three providers share a row with their names, more become round icon buttons with a tooltip

Resizable Layout ​

Resizing the sidebar

AreaRangeRemembered
Sidebar menu150px – 400pxGlobally — long menu names fit in one go
Tree panel beside a table120px – 600pxPer model, and collapsible entirely
AI assistant panelDrag to sizeOpen state and width, per model

The sidebar footer carries a small toolbar: refresh the menu, locate current menu (expands and scrolls to the item you are on), recently visited (the same list the home page shows) and an in-place keyword filter of the tree v2.3.0+. Since 2.3.0 the whole tree can no longer be reordered by drag (the menu follows the server order; favorites still drag), and the menu-mode switch has moved into the settings drawer. The search box at the top searches menus, showing matches with their full path — press Enter to jump straight there.

The sidebar titles its sections by module group: the root menus are cut into sections in their sort order, a run of root menus from one module group becomes a section, and the section is headed by the group's name — Business (reports, workflow, notices, printing, files…), AI, Developer tools, Operations, Data sources. Platform modules (users, permissions, security, templates) and the menus you create yourself carry no title; one of yours sorted inside a group's run stays in that section. Sort remains the only order there is: an admin moves a whole section, or a menu into one, by changing sort.

The group comes from the ModuleGroup each module declares when it registers; the installed modules are listed under the same groups on the new Module center page under System, see Menu Management. To drop the titles, switch off "Menu section titles" in the settings drawer, or set theme.menuGroups: false in app.js as the site default.

In the category / dual-column / two-row top modes, expanding a submenu of another category no longer jumps the selection back to the current route's category.

Table Capabilities ​

Table column control

Column control ​

The ▦ button in the toolbar opens the column panel:

  • Visibility: a checkbox per column
  • Order: drag the handle on the left to reorder
  • Pinning: the pin button cycles through pin-left → pin-right → unpinned
  • Width: drag the header divider; "Reset widths" at the bottom of the panel restores the defaults

All of it is saved locally per model, so pages never interfere with each other.

Toolbar ​

ActionWhat it does
Refresh / auto refreshRefresh manually, or every 10s / 30s / 1min / 5min — the button lights up while it is on
FullscreenExpand the table area to the full screen
QueryShow or hide the search area; conditions and operators are remembered per model
SortMulti-field sort configuration
Batch editAppears once several rows are selected: pick a field and a value, written to every selected row — see Batch Edit v2.4.0+
Print / Print layoutWith one row selected, print that record (built-in layout or a template); "Print layout" manages the model's print templates. Shown only to users who may read a record's details, see Print Settings
Import / ExportExcel import and template download (subject to @Power); the export button writes Excel and the dropdown beside it offers the other server formats, see Export Formats and Totals v2.4.0+
Duplicate rowCopy the selected row into a new-record form with the primary key cleared — handy for near-identical entries
ResetClear the search conditions and start over
AIOpens the AI assistant panel on the right, scoped to the current model

Search and views ​

  • Switchable operators: every search field carries an operator dropdown (equals / like / greater than / between / multi-select …), remembered per model; the server can pin one with @Search(lockOperator)
  • Multiple views: besides the table, a model can offer a board, calendar, card or gantt view, switched at the top and remembered per model
  • Tree-driven filtering: with @LinkTree a tree appears on the left; picking a node filters the table, and the panel can be resized or collapsed

Cell rendering ​

Cells render according to @View(type), and several are interactive: images zoom on click, attachments open in a preview dialog with download, plus QR codes, progress bars, color swatches, Markdown / HTML and tags for booleans and choices. Long text is truncated with the full value on hover.

Since 2.3.0 v2.3.0+:

  • Avatar column: @View(type = ViewType.AVATAR) renders a round 32px thumbnail (120px in the detail view) with a silhouette placeholder when empty — the user table shows avatars this way
  • Wrapping cells: with @Layout(tableTruncate = false) overflowing cells wrap instead of ending in an ellipsis, and a crowded operation column keeps every action visible
  • Null booleans: a boolean cell holding null is left blank instead of drawing an empty tag

Bitable-style Editing v2.2.0+ ​

Double-click a cell (or its edit icon) to change one field in place, without opening the row form — editing data the way a spreadsheet lets you.

Cell editing

  • The same control the form uses: the popover hosts the row form's own edit component, so value conversion, validation and reference pickers behave identically — copy button, AI writing assistant and character count included
  • Validated as a whole row: the server patches the stored row with the new value and validates all of it, so a cross-field rule cannot be broken one cell at a time; DataProxy and the operate log match a form submission
  • Two switches: @Power(cellEdit) on the model and @Edit(cellEdit) on the field — accounts, role codes, secrets and the like are opted out by the framework already

See @Power → cellEdit for details.

Batch Edit v2.4.0+ ​

Select several rows and a Batch edit button appears in the toolbar: pick one field in the dialog, enter a value, and on confirm that field is set to the same value on every selected row.

  • The same control: the editor is the row form's own component for that field, so dates, choices, reference pickers and value conversion behave as in the form; it opens empty, and the value you enter replaces whatever each row holds
  • Which fields: the cell-edit rules — fields visible and editable in the form that are not opted out with @Edit(cellEdit = false); dividers, buttons, sub-tables, multi-forms, tab trees and other layout or collection types are not listed, nor are reference pickers that depend on another field
  • Validated per row: the write goes through the batch cell endpoint, so each row passes the same validation, DataProxy and operate log as a cell edit; rows whose row-level __power__ withdrew editing are skipped, and when none may be edited you are told so
  • Switch: on whenever the model is editable, withdrawn with @Power(batchEdit = false) — see @Power → batchEdit

Export Formats and Totals v2.4.0+ ​

  • Export formats: the export button writes Excel; the … dropdown beside it lists every format the server registers — Excel, CSV, JSON, JSON Lines, Markdown — one entry each, and with rows selected only those rows are exported. The import template is always Excel (it carries the validations and hints). To customize the exported content see DataProxy → excelExport
  • Totals bar: when the model has @View(statistic) columns, a totals bar appears under the table with one "column · total" chip per column. The totals are computed on the server for the current query and arrive on a request of their own, so the rows never wait or re-render for them

In-row interaction ​

  • Drag sort: with @DragSort configured, a grip appears at the start of each row — drag to reorder and the new order is saved
  • Row actions: view, edit, delete, and any custom @RowOperation buttons
  • Remembered paging: page size and the active view (table / card / gantt …) are kept per model
What each model remembers locally

Stored in the browser's localStorage under the key erupt.<model name>:

FieldMeaning
columnsPer-column visibility, width and pinning
columnOrderColumn order
treeWidth / treeCollapsedTree panel width and collapsed state
aiPanelOpen / aiPanelWidthAI panel state and width
searchCollapsed / searchFieldsCollapsed / searchOperatorsSearch area state and the operator chosen per field
pageSizeRows per page
visIndexThe active view

This lives only in that browser: nothing is uploaded to the server and no other user is affected.

Dialogs & Forms ​

Draggable dialog

  • Dialogs are draggable: add / edit, reference pickers, sub-tables, attachment pickers — every dialog moves by its title bar, so you can push it aside and read the table underneath while filling it in
  • Step forms: long forms split into a wizard at each DIVIDE
  • Input helpers: copy the current value from the left of the input, draft it with the AI writing assistant on the right, and watch the live character count below
  • Code and rich text: the code editor, Markdown and rich-text fields all support fullscreen editing and copying
  • Attachments: multi-attachment fields reorder by drag

Form Panel v2.3.0+ ​

Add / edit / view forms for a record share one form panel that comes in three modes. Switch from the panel's title bar or the "Detail panel style" setting in the drawer; the loaded form and any unsaved input survive the switch:

ModeValueNotes
Centered dialogcenterA floating, draggable dialog (default)
Side panelsideDocked on the right; drag the edge to size it and the width is remembered (full-line forms remember their own). In view mode clicks still reach the list, and the panel is recycled for the next record
FullscreenfullFills the window — for long forms and forms with sub-tables

The site default is theme.formPanelMode in app.js; the user's own choice is stored in the browser and wins.

The title bar gathers the actions on the current record:

  • Previous / next: step through the list with an "n / total" readout, paging automatically at the edges
  • View ↔ edit: switch in place instead of closing and reopening
  • Copy link: copies a deep link with ?id=<pk>; opening the table route with it pops up that record's panel (also when tab reuse reattaches an already open tab)
  • Delete: after a popconfirm, removes the record and moves the panel to its neighbour or closes it
  • AI assistant: opens the chat primed with the module context and the record's current values (needs erupt-ai)
  • History: every change of the record in a drawer, with rollback (needs erupt-revision and a model that has not set @Power(revision = false); table rows carry no such entry) v2.4.0+
  • More: print (needs erupt-print, a model that has not set @Power(print = false), and the edit or viewDetails permission), see Print Settings below
  • Comments: the record's comment stream (needs erupt-comment)

Closing the panel, stepping to another record or leaving edit mode asks before discarding unsaved changes. Click row to view details is off by default — a whole row is a large target that also carries links, buttons and editable cells. Turn it on in the settings drawer and clicking a row opens that record's detail panel; rows then show a pointer cursor while links, buttons and editable cells keep their own behavior.

With erupt-print installed, a record can be printed from the table toolbar and from the record panel's "More" menu. A model without print templates opens the built-in print preview, headed by a settings bar; every change shows in the preview at once and is remembered in the browser, so the next print of any model starts from it, and the default print of a flow approval shares the same settings:

SettingNotes
Form styleLabel above / label left
Columns1 – 4; a full-line model (FormSize.FULL_LINE) defaults to 1, every other to 3
Border / border colorCell borders on or off, and their color
Font size10 – 24 px
TitleWhether a title is printed above the form (the current menu name by default)
Paper size / orientationA4 / A3 / A5 / Letter / auto, portrait or landscape
Margin0 – 50 mm

In the preview, one-to-many, many-to-many and multi-form fields print as a sub-table built from their table columns, a tab tree prints the names of its checked nodes, and a combine field is a titled section. Printing writes the page into a hidden iframe that carries the site styles minus the dark / compact theme, so the layout reflows to the paper width instead of keeping the on-screen pixels. When print templates exist a "Select print layout" list comes first: "Default layout" is the built-in preview, the rest render through a template.

Drawers v2.3.0+ ​

Every drawer in the app now shares one 44px header (the page header's height): title on the left, a small square close button on the right. The AI chat, notice center, Cube drill-down, flow launch, flow diagram, TPL and approval-detail drawers can be resized by dragging their inner edge, and each remembers its last width.

Lock Screen and Profile v2.3.0+ ​

The avatar menu in the header gains three entries: Profile (change your own avatar and display name; the header updates in place), Two-factor auth (enrol a TOTP authenticator) and Lock screen (a full-window cover over the running page — tabs stay put, your password unlocks it, and a refresh keeps it locked). Profile and Lock screen are shown for platform accounts only, not for tenant sessions. See User Management → Profile and Lock Screen.

Lock screen

The corner of the lock cover carries a set of appearance controls v2.4.0+: a light / dark toggle, a skin picker and the theme color (preset swatches, a custom color and a reset). They share the saved choices with the settings drawer, so the appearance stays after unlocking; skin and theme color are branding and hide under theme.customizable: false, leaving only the light / dark toggle.

Install as a Desktop App (PWA) v2.3.0+ ​

Erupt installs as a progressive web app: the manifest is generated from the site config, the header doubles as the draggable window title bar, and pwa.icon / pwa.shortcuts / faviconPath are configurable. See Install as a Desktop App (PWA).

Elsewhere in the Shell ​

CapabilityNotes
WatermarkTiles "nickname-custom text-date" across the screen to discourage screenshots — see Configuration
NotificationsThe bell in the header receives in-app notices live (requires erupt-notice)
Help entryThe question mark can point at your own docs site, via erupt-app.show-help-entry / help-doc-url
Languages12 built in, switchable from the login page and the header
FullscreenOne click to take the browser fullscreen
CopyEvery copy button also works on a plain http deployment: navigator.clipboard exists only in a secure context, so the shell falls back to selection copy when it is missing v2.4.0+
MobileThe layout adapts; the tab bar and some toolbar buttons hide on narrow screens

Contributors

The avatar of contributor named as YuePeng YuePeng

Changelog

Released under the Apache-2.0 License.