@gemboss/ui 0.2.0 → 0.3.0

package/README.md

@@ -76,10 +76,25 @@ import { AssistantProvider, AssistantHost, useAssistant } from "@gemboss/ui/assi
 </AssistantProvider>
 ```
 
-Four shapes, one mounted subtree: full screen (next to the rail), a popup that floats over every
-screen and survives navigation, a status bar, and hidden-but-still-running. A live run is never
-thrown off screen (`assistant/dock.ts` holds that rule). The popup resizes from its top edge and
-slides along the bottom, by pointer or keyboard, and remembers both under `storagePrefix`.
+Five shapes, one mounted subtree: full screen (next to the rail), a popup that floats over every
+screen and survives navigation, a full-height side panel, a status bar, and hidden-but-still-running.
+A live run is never thrown off screen (`assistant/dock.ts` holds that rule). The popup resizes from
+its top edge and slides along the bottom, by pointer or keyboard, and remembers both under
+`storagePrefix`.
+
+The side panel is opt-in: `<AssistantHost allowSide>` puts a "Pin to the side" button in the popup
+header, and the panel carries "Float as a popup" back. It stands under the topbar on the right, and
+the page moves over for it instead of being covered: the provider puts `<prefix>-side` on `<body>` and
+the width in `--gb-assistant-side-w` (`SIDE_WIDTH_VAR`), and `.gemboss-platform-main` takes that as
+`margin-right`. A surface with its own layout reads the same variable. Its left edge is a
+`.ui-resizer` (drag, or ←/→, Shift for 64px, Home/End), clamped to 380–720px and never leaving the page
+less than 480px; the width is remembered. Panel and page only fit side by side from 1100px (rail 240
++ 380 + 480). Between 761 and 1099 the panel covers the content area and is not offered; on a phone
+it takes the screen. The status bar, a busy ×, leaving full screen mid-run and full
+screen's own way back ("Back to the side panel") all return to whichever shape the person last
+worked in (`floatShape`, remembered across reloads), so a pinned panel never pops back as a popup.
+The host registers `allowSide` with the provider, and every way into the panel checks it, including
+a "side" remembered in storage: a host without it gets the popup.
 
 The rail's way in is a `RailItem` with `className="gnav-assistant"`, linking to your full-screen
 address (the admin puts it in `RailBottom`, above Inbox). That class draws the tinted pill, and the
@@ -93,7 +108,7 @@ is a separate piece you put inside it:
 ```tsx
 import { AssistantWorkspaceLayout, SessionRail, OpenChatTabs } from "@gemboss/ui/assistant";
 
-<AssistantWorkspaceLayout dock={presentation === "dock"} rail={
+<AssistantWorkspaceLayout dock={presentation === "dock" || presentation === "side"} rail={
   <SessionRail sessions={sessions} activeId={active} busyIds={running}
     collapsed={collapsed} onToggleCollapsed={toggle} onNewChat={newChat}
     onOpen={open} onRename={rename} onTogglePin={pin} onDelete={remove} labels={VI} />
@@ -109,6 +124,54 @@ Its styles are the `gemboss-assistant-*` rules in `packages/ui/src/shell.css` (t
 @imports too), and they reach you through `gemboss-ui.css` together with `gemboss-field.css`. The admin passes a second tab ("Talk to a person", gemcare) through `secondTab` and its button
 through `fullActions`; a surface without those leaves them out.
 
+## The chat body
+
+What an answer looks like, on any surface that puts a chat somewhere: `chat.css` (inside `gemboss-ui.css`;
+the admin `@import`s it, so it is the same file the admin's own chat is drawn with).
+
+| Piece | Classes |
+|---|---|
+| Header | `.gemboss-ec-head` › `.gemboss-ec-title` + `.gemboss-ec-sub` |
+| Message list | `.gemboss-ec-scroll` (thin visible scrollbar) |
+| Messages | `.gemboss-ec-msg.user` / `.gemboss-ec-msg.assistant` › `.gemboss-ec-bubble` |
+| Markdown inside a bubble | `.gemboss-md-p / -h -h1..3 / -list / -quote / -rule / -code / -codeblock / -table(wrap) / -img(link)`, links `.gemboss-ec-md-link` |
+| Steps the assistant took | `ul.gemboss-narr` › `li.gemboss-narr-row.ok|.running|.failed|.thinking|.trace|.steer` › `.gemboss-narr-dot` + `.gemboss-narr-text` (running: `.gemboss-narr-spin`) |
+| Working / streaming | `.gemboss-ec-pending` (`-star`, `-verb`, `-meta`), `.gemboss-ec-cursor` after the streamed text |
+| Suggestions, choices | `.gemboss-ec-starters` › `button.gemboss-ec-starter`; `.gemboss-ec-chips` › `button.gemboss-ec-chip` |
+| Composer | `form.gemboss-ec-input` › `textarea` + `div.gemboss-ec-toolbar` › `div.gemboss-ec-toolbar-lead` (chips; leave it EMPTY for none) + `button[type=submit]` (44px; disabled = grey). An empty lead puts the box and the button on ONE row. Stop while streaming: `button.gemboss-ec-stop` in place of submit |
+
+The toolbar row, the one-row layout, the engine picker's layout and Stop are in a second sheet,
+`chat-composer.css` (also inside `gemboss-ui.css`): the admin imports it from its chat components rather than its
+layout, so screens without a chat never load it. The catalog's "Thân chat" section is the markup to copy. NOT here, on purpose: the panel's own geometry
+(`.gemboss-ec` width, editor columns), attachments, action cards, the engine picker and work mode — those
+are still the admin's. The one exception is the chat panel's touch / mouse target blocks: one rule per pointer
+kind names every control of the panel, admin-only ones included (they match nothing elsewhere). The behaviour (streaming, Stop, Enter to send, IME, scroll-to-bottom) belongs to
+the surface.
+
+## Plain-HTML behaviour: `kit-plain.js` (0.3.0)
+
+Surfaces without React (GemFactory, gemcare, gempress, partner-radar) render the kit's markup on the server and need
+the few behaviours React components carry: a popup that traps Tab and closes on Escape, a toast, menus that close.
+Each surface wrote its own; GemFactory's (reviewed into Tab trap, stacked Escape and the close-while-asking race) is
+now this file. It is a classic script that sets `globalThis.gembossUI`, so a server-rendered page can inline it:
+
+```js
+// server
+const KIT_JS = readFileSync(require.resolve("@gemboss/ui/kit-plain.js"), "utf8");
+html += `<script>${KIT_JS}</script>`;
+// page
+const { openModal, toast, initMenus } = gembossUI;
+initMenus();
+const m = openModal({ title: "Delete #12?", closeLabel: "Đóng", body: '<div class="ui-modal__body">…</div>',
+  foot: '<button class="ui-btn" data-no>Huỷ</button><button class="ui-btn ui-btn--primary" data-yes autofocus>Xoá</button>',
+  onClose: (v) => v && toast("Đã xoá") });
+```
+
+`title`, `body` and `foot` are HTML (escape your text); toast text is text. `beforeClose` may return a promise of
+false to keep the popup open (it gets the close value, and a guard that throws keeps it open). Its behaviour is
+asserted in Chromium by `packages/ui/src/kit-plain.test.ts` (`npm run test:ui-browser`, run by the CI job that has
+Chromium; `test:packages` excludes it); the catalog's "Hộp thoại" section runs it live.
+
 ## Resizable panels
 
 `ui-resizer` is the seam a person drags between two panels; `ui-resizing` on `<body>` is the drag in
@@ -169,6 +232,11 @@ import { AppShell, BrandLockup, AccountMenu, AccountMenuItem, Icon, RailItem } f
   applications that integrate with Shopify. Draw a missing one HERE, not in the surface: every rail
   icon must keep `fill="none"` on its inner `<g>`, because `.gnav-ico svg { fill: currentColor }`
   outranks an attribute on the `<svg>` itself and paints an outline icon solid.
+- `Menu` / `MenuItem` / `MenuSeparator` (0.2.1): the "⋯" action menu. Same `<details>` rule as the account
+  menu (works as plain markup; with React it closes on an outside click, on Escape with focus back on the
+  trigger, and after a button row's handler). Rows share the account menu's row style. `MenuItem` is a link
+  (`href`) or a button; `disabled` on a link drops the href and sets `aria-disabled`; `className` is added
+  to the row's class.
 
 ## The catalog: every token, class and component, with its markup
 
@@ -215,6 +283,8 @@ something the base cannot express, add a token or a prop here, and every surface
 |---|---|
 | `gemboss-ui.css` | built at pack time: `apps/admin/scripts/export-ui-css.mjs` (tokens + kit + field + `packages/ui/src/shell.css`, with Polaris `--p-*` resolved to their fallbacks) + `packages/ui/src/app-shell.css` + `packages/ui/src/auth.css` + `packages/ui/src/assistant.css` |
 | `packages/ui/src/shell.css` | the SHARED SHELL (rail, topbar, main, mobile drawer, the assistant's thread rail, popover surface, account chip). The admin's `gemboss-shell.css` @imports it on line 2; the export refuses a shared-shell rule in the admin's sheet or an admin-only rule here (one owner). |
+| `packages/ui/src/kit-plain.css` | primitives for surfaces that render plain HTML, not React (0.2.1): menu, key/value list, icon button; 0.3.0 adds `ui-link` / `ui-prose`, the media card (`ui-card--media`, `__media`, `__body`, `__foot`) and the popup's `ui-modal__body` / `__foot`. Shipped inside `gemboss-ui.css`; the admin does not import it (its first-load CSS budget has ~0.1 KB headroom). |
+| `packages/ui/src/kit-plain.js` | 0.3.0: the behaviour those surfaces each wrote by hand: `gembossUI.openModal` (Escape, backdrop, Tab trap, stacking, ask-before-close, focus back), `toast` (text, error tone), `initMenus` (outside click, item, blur, Escape closes the menu before the popup). A classic script: inline it or `<script src>`; see "Plain-HTML behaviour" below. |
 | `packages/ui/src/**/*.tsx` | the components, as TypeScript source. Next: add `@gemboss/ui` to `transpilePackages`. Vite compiles it as is. |
 
 `gemboss-ui.css` is never committed and never edited. To change a colour or a radius, change