@kerfjs/ui 5.0.0-beta.77 → 5.0.0-beta.79
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -4
- package/ai/application-ui-diagnostic-ids-v1.json +4 -0
- package/ai/compile-time-contracts-v1.json +3 -3
- package/ai/component-catalog.json +152 -31
- package/ai/component-composition-rules.json +6 -14
- package/ai/component-composition.json +123 -29
- package/ai/components/README.md +1 -1
- package/ai/components/document-baseline.md +1 -1
- package/ai/components/nav-stack.md +6 -6
- package/ai/components/pane.md +3 -1
- package/ai/components/surface-scaffold.md +11 -2
- package/ai/components/{tab-scaffold.md → tab-navigator.md} +14 -14
- package/ai/components/token-search-field.md +1 -0
- package/ai/components/toolbar-control-group.md +2 -0
- package/ai/components/toolbar-text.md +2 -0
- package/ai/components/toolbar.md +6 -8
- package/ai/public-api-signatures-v1.md +68 -140
- package/ai/skill.md +15 -4
- package/ai/webawesome-jsx-signatures-v1.md +1 -1
- package/dist/browser/nav-stack.js +2 -0
- package/dist/browser/split-view.js +2 -0
- package/dist/browser/tab-navigator.js +4 -0
- package/dist/catalog-resources.d.ts +3 -3
- package/dist/catalog.d.ts +3 -3
- package/dist/catalog.js +3 -3
- package/dist/{chunk-WJN3V2H5.js → chunk-2GOCOLQL.js} +18 -4
- package/dist/chunk-2GOCOLQL.js.map +1 -0
- package/dist/{chunk-QYXKMLHO.js → chunk-3CXRQAYT.js} +2 -2
- package/dist/chunk-3CXRQAYT.js.map +1 -0
- package/dist/{chunk-G4VKQP7B.js → chunk-3SXWV2IR.js} +5 -1
- package/dist/chunk-3SXWV2IR.js.map +1 -0
- package/dist/{chunk-VLPE6OPN.js → chunk-62VMNBV2.js} +6 -2
- package/dist/chunk-62VMNBV2.js.map +1 -0
- package/dist/{chunk-XIZRXI7N.js → chunk-A7DYEERU.js} +13 -1
- package/dist/chunk-A7DYEERU.js.map +1 -0
- package/dist/{chunk-6VQPLV3O.js → chunk-DSLRNR43.js} +9 -8
- package/dist/chunk-DSLRNR43.js.map +1 -0
- package/dist/{chunk-AOAW55JN.js → chunk-DXQZ3BEO.js} +4 -1
- package/dist/chunk-DXQZ3BEO.js.map +1 -0
- package/dist/chunk-IKCUPTR2.js +170 -0
- package/dist/chunk-IKCUPTR2.js.map +1 -0
- package/dist/{chunk-Z6PE5T7N.js → chunk-JL4BBZP4.js} +4 -3
- package/dist/chunk-JL4BBZP4.js.map +1 -0
- package/dist/collapsible-panel.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +8 -8
- package/dist/nav-stack-B1Qc2e5q.d.ts +101 -0
- package/dist/nav-stack.d.ts +11 -93
- package/dist/nav-stack.js +5 -1
- package/dist/pane.d.ts +5 -2
- package/dist/pane.js +1 -1
- package/dist/split-view.d.ts +9 -4
- package/dist/split-view.js +7 -3
- package/dist/split-view.js.map +1 -1
- package/dist/styles/components/actions/toolbar/toolbar.css +7 -14
- package/dist/styles/components/actions/toolbar-control-group/toolbar-control-group.css +63 -13
- package/dist/styles/components/actions/toolbar-text/toolbar-text.css +8 -1
- package/dist/styles/components/forms/token-search-field/token-search-field.css +12 -1
- package/dist/styles/components/layout/pane/pane.css +18 -1
- package/dist/styles/components/navigation/nav-stack/nav-stack.css +6 -12
- package/dist/styles/components/navigation/tab-scaffold/tab-scaffold.css +18 -1
- package/dist/styles/components/surfaces/surface-scaffold/surface-scaffold.css +55 -0
- package/dist/styles/nav-stack.css +6 -12
- package/dist/styles/pane.css +18 -1
- package/dist/styles/surface-scaffold.css +55 -0
- package/dist/styles/{tab-scaffold.css → tab-navigator.css} +18 -1
- package/dist/styles/token-search-field.css +12 -1
- package/dist/styles/toolbar-control-group.css +63 -13
- package/dist/styles/toolbar-text.css +8 -1
- package/dist/styles/toolbar.css +7 -14
- package/dist/surface-scaffold-register.d.ts +4 -0
- package/dist/surface-scaffold-register.js +59 -0
- package/dist/surface-scaffold-register.js.map +1 -0
- package/dist/surface-scaffold.d.ts +10 -2
- package/dist/surface-scaffold.js +1 -1
- package/dist/{tab-scaffold.d.ts → tab-navigator.d.ts} +12 -10
- package/dist/{tab-scaffold.js → tab-navigator.js} +4 -3
- package/dist/tab-navigator.js.map +1 -0
- package/dist/token-search-field.js +1 -1
- package/dist/wire-catalog.js +1 -1
- package/dist/wire-scroll-dividers.d.ts +3 -3
- package/dist/wire-scroll-dividers.js +1 -1
- package/dist/wire-tab-navigator.d.ts +11 -0
- package/dist/{wire-tab-scaffold.js → wire-tab-navigator.js} +3 -3
- package/dist/wire-tab-navigator.js.map +1 -0
- package/dist/wire-token-search-fields.js +1 -1
- package/dist/wire-toolbar-visibility.js +1 -1
- package/dist/workbench.d.ts +5 -13
- package/dist/workbench.js +1 -1
- package/docs/app-layouts.md +44 -11
- package/docs/component-contract.md +9 -2
- package/docs/component-selection.md +17 -15
- package/docs/design/templates/token-search-field/empty-dark.svg +1 -1
- package/docs/design/templates/token-search-field/empty.svg +1 -1
- package/docs/design/templates/token-search-field-dark.svg +1 -1
- package/docs/design/templates/token-search-field.svg +1 -1
- package/docs/design/templates.md +1 -1
- package/docs/examples/application-ui-profile.json +4 -4
- package/docs/layout.md +31 -8
- package/docs/nav-stack.md +30 -18
- package/docs/recipes.md +6 -2
- package/docs/split-view.md +7 -4
- package/docs/surface-scaffold.md +46 -0
- package/docs/{tab-scaffold.md → tab-navigator.md} +83 -11
- package/docs/type-contracts.md +3 -3
- package/docs/ui-analyzer.md +5 -0
- package/docs/ui-doctor.md +33 -0
- package/docs/workbench.md +3 -2
- package/doctor/component-style-checks.mjs +457 -0
- package/doctor/index.mjs +43 -13
- package/llms.txt +18 -6
- package/package.json +16 -11
- package/ux-demo/recipes/list-detail-dialog.tsx +4 -0
- package/ux-demo/recipes/navigation-stack.tsx +2 -2
- package/dist/browser/tab-scaffold.js +0 -4
- package/dist/chunk-6VQPLV3O.js.map +0 -1
- package/dist/chunk-AOAW55JN.js.map +0 -1
- package/dist/chunk-G4VKQP7B.js.map +0 -1
- package/dist/chunk-QYXKMLHO.js.map +0 -1
- package/dist/chunk-VLPE6OPN.js.map +0 -1
- package/dist/chunk-WJN3V2H5.js.map +0 -1
- package/dist/chunk-XIZRXI7N.js.map +0 -1
- package/dist/chunk-Z4EPMX25.js +0 -123
- package/dist/chunk-Z4EPMX25.js.map +0 -1
- package/dist/chunk-Z6PE5T7N.js.map +0 -1
- package/dist/tab-scaffold.js.map +0 -1
- package/dist/wire-tab-scaffold.d.ts +0 -11
- package/dist/wire-tab-scaffold.js.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Public API signatures for the UI authoring corpus
|
|
2
2
|
|
|
3
|
-
Generated from emitted declarations for `@kerfjs/ui@5.0.0-beta.
|
|
3
|
+
Generated from emitted declarations for `@kerfjs/ui@5.0.0-beta.79` and `kerfjs@5.0.0-beta.79`. This bounded reference covers only APIs used by the seven-task corpus. It is interface evidence, not an implementation or runtime guarantee.
|
|
4
4
|
|
|
5
5
|
## `@kerfjs/ui/css-values`
|
|
6
6
|
|
|
@@ -1238,7 +1238,7 @@ interface WireScrollDividersOptions {
|
|
|
1238
1238
|
/**
|
|
1239
1239
|
* App-owned scroll arrangements to pair beyond the ones found by structure
|
|
1240
1240
|
* (every `Pane`'s header and footer around its content, every `NavStack`'s
|
|
1241
|
-
* and `
|
|
1241
|
+
* and `TabNavigator`'s chrome around its active region, and every `TabBar`
|
|
1242
1242
|
* strip).
|
|
1243
1243
|
*/
|
|
1244
1244
|
targets?: readonly ScrollDividerTarget[];
|
|
@@ -1258,11 +1258,11 @@ type Root = HTMLElement | Document;
|
|
|
1258
1258
|
* - every `Pane` with a header or footer: its header shows a bottom divider and
|
|
1259
1259
|
* its footer a top divider (drawn by the Pane, per its `chromeDividers`);
|
|
1260
1260
|
* - every `NavStack`'s top chrome and bottom toolbar around its active view,
|
|
1261
|
-
* and every `
|
|
1261
|
+
* and every `TabNavigator`'s bar under its active scene: the chrome shows a
|
|
1262
1262
|
* bottom (top chrome) or top (bottom toolbar, bar) divider. The scroller is
|
|
1263
1263
|
* whichever element actually scrolls there: the view or scene itself, or,
|
|
1264
1264
|
* through a sole child with no chrome of its own on that edge, a `Pane`'s
|
|
1265
|
-
* content or a nested `NavStack` / `
|
|
1265
|
+
* content or a nested `NavStack` / `TabNavigator` region (a Pane's own header
|
|
1266
1266
|
* or footer draws that boundary instead);
|
|
1267
1267
|
* - every `TabBar` strip: the bar draws a divider on each side of the strip
|
|
1268
1268
|
* whose tabs are scrolled out of view;
|
|
@@ -1285,101 +1285,19 @@ export { type ScrollDividerTarget, type WireScrollDividersOptions, wireScrollDiv
|
|
|
1285
1285
|
## `@kerfjs/ui/nav-stack`
|
|
1286
1286
|
|
|
1287
1287
|
```ts
|
|
1288
|
-
|
|
1289
|
-
import
|
|
1290
|
-
import
|
|
1291
|
-
import
|
|
1292
|
-
import
|
|
1288
|
+
export { c as NavStack, N as NavStackProps, d as NavStackToolbarConfig, a as NavStackView, e as NavStackViewBottomToolbar, f as NavStackViewToolbar } from './nav-stack-B1Qc2e5q.js';
|
|
1289
|
+
import 'kerfjs';
|
|
1290
|
+
import './semantic-content-BbzjvSu9.js';
|
|
1291
|
+
import './list.js';
|
|
1292
|
+
import './flex-alignment-4ms8ZbV8.js';
|
|
1293
1293
|
import './sides-BPSWde0A.js';
|
|
1294
1294
|
import './css-values.js';
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
/** Stable identity for keyed reconcile and transition direction. */
|
|
1302
|
-
key: string;
|
|
1303
|
-
content: KerfUiContent;
|
|
1304
|
-
/** Background of this view's scrolling work surface. */
|
|
1305
|
-
appearance?: PaneAppearance;
|
|
1306
|
-
/** Title shown in the top toolbar for this view. */
|
|
1307
|
-
title?: string;
|
|
1308
|
-
/** Leading groups for this view's top toolbar, after the back control and before the title. */
|
|
1309
|
-
leading?: KerfUiContent;
|
|
1310
|
-
/** Center content for this view's top toolbar (placed per `toolbarConfig.centerAlign`). */
|
|
1311
|
-
center?: KerfUiContent;
|
|
1312
|
-
/** Trailing actions for this view's top toolbar. */
|
|
1313
|
-
toolbar?: KerfUiContent;
|
|
1314
|
-
/** Fixed chrome below this view's toolbar, above its scrolling content. */
|
|
1315
|
-
header?: KerfUiContent;
|
|
1316
|
-
/** Bottom toolbar for this view. Cross-fades with the top chrome on navigation. */
|
|
1317
|
-
bottomToolbar?: KerfUiContent;
|
|
1318
|
-
}
|
|
1319
|
-
/**
|
|
1320
|
-
* The top toolbar's configuration. Its `ToolbarConfig` forwards to the real
|
|
1321
|
-
* `Toolbar` the stack renders; by default that toolbar draws no divider and
|
|
1322
|
-
* claims the top and side safe-area edges the stack still touches.
|
|
1323
|
-
*/
|
|
1324
|
-
interface NavStackToolbarConfig extends ToolbarConfig {
|
|
1325
|
-
/** Accessible name of the top toolbar (default: none). */
|
|
1326
|
-
label?: string;
|
|
1327
|
-
/** Size of the view title's `ToolbarText` (default `large`). */
|
|
1328
|
-
titleSize?: ToolbarTextSize;
|
|
1329
|
-
/** Expose the view title as a heading at this level (default: a plain span). */
|
|
1330
|
-
headingLevel?: HeadingLevel;
|
|
1331
|
-
}
|
|
1332
|
-
interface NavStackProps {
|
|
1333
|
-
id: string;
|
|
1334
|
-
/** Accessible name for the stack region. */
|
|
1335
|
-
label: string;
|
|
1336
|
-
/** The stack, root first; the last entry is the active top view. */
|
|
1337
|
-
views: NavStackView[];
|
|
1338
|
-
/** Accessible label for the icon-only back control (default "Back"). */
|
|
1339
|
-
backLabel?: string;
|
|
1340
|
-
/** The back control's icon (default a chevron-left `LucideIcon`). */
|
|
1341
|
-
backIcon?: KerfUiContent;
|
|
1342
|
-
/**
|
|
1343
|
-
* Visible text beside the back icon, such as the previous view's title
|
|
1344
|
-
* (default: icon only). When set, the text names the control and
|
|
1345
|
-
* `backLabel` is not used.
|
|
1346
|
-
*/
|
|
1347
|
-
backText?: string;
|
|
1348
|
-
/** The top toolbar's configuration, forwarded to its `Toolbar`. */
|
|
1349
|
-
toolbarConfig?: NavStackToolbarConfig;
|
|
1350
|
-
/** Persistent last group in every view's top toolbar, supplied by a hosting panel. */
|
|
1351
|
-
panelToggle?: KerfUiContent;
|
|
1352
|
-
/** Hide the top toolbar entirely (rare — a fully custom-chrome view). */
|
|
1353
|
-
hideToolbar?: boolean;
|
|
1354
|
-
/** Optional persistent bottom toolbar used when the active view does not provide one. */
|
|
1355
|
-
bottomToolbar?: KerfUiContent;
|
|
1356
|
-
/**
|
|
1357
|
-
* The line under the top chrome and over the bottom toolbar, where they
|
|
1358
|
-
* meet the active view. `scroll` (default) shows the chrome's line only
|
|
1359
|
-
* while the view's content is scrolled beneath it, and the bottom
|
|
1360
|
-
* toolbar's only while more content lies below — never when the content
|
|
1361
|
-
* fits — once `wireScrollDividers` (`@kerfjs/ui/wire-scroll-dividers`) is
|
|
1362
|
-
* wired above the stack; unwired, neither shows. `always` shows both
|
|
1363
|
-
* without the wiring; `none` neither, even when wired. The line is drawn
|
|
1364
|
-
* inside the chrome, so no state moves the chrome or the content. A
|
|
1365
|
-
* `toolbarConfig.dividerSides` edge is the Toolbar's own and is unaffected.
|
|
1366
|
-
*/
|
|
1367
|
-
chromeDividers?: 'scroll' | 'always' | 'none';
|
|
1368
|
-
className?: string;
|
|
1369
|
-
/** Native named-slot assignment when composed inside a web component. */
|
|
1370
|
-
slot?: string;
|
|
1371
|
-
}
|
|
1372
|
-
/**
|
|
1373
|
-
* A navigation stack (iOS-style push/pop). Renders every entry stacked, the last
|
|
1374
|
-
* one active; `@kerfjs/ui/wire-nav-stack`'s `wireNavStack` slides the content and
|
|
1375
|
-
* cross-fades the chrome across a change. Its top chrome is a real `Toolbar`: the
|
|
1376
|
-
* back control and title lead, the active view's `leading` / `center` / `toolbar`
|
|
1377
|
-
* content fills the zones, and `toolbarConfig` configures it. A single-pane
|
|
1378
|
-
* layout is a `NavStack` with one entry. See `docs/23-app-layouts.md` §3.1.
|
|
1379
|
-
*/
|
|
1380
|
-
declare function NavStack({ id, label, views, backLabel, backIcon, backText, toolbarConfig, panelToggle, hideToolbar, bottomToolbar, chromeDividers, className, slot, }: NavStackProps): kerfjs.SafeHtml;
|
|
1381
|
-
|
|
1382
|
-
export { NavStack, type NavStackProps, type NavStackToolbarConfig, type NavStackView };
|
|
1295
|
+
import './pane.js';
|
|
1296
|
+
import './panel-toolbar-CL9tYOkh.js';
|
|
1297
|
+
import './toolbar.js';
|
|
1298
|
+
import './lucide-icon.js';
|
|
1299
|
+
import 'lucide';
|
|
1300
|
+
import './toolbar-text.js';
|
|
1383
1301
|
```
|
|
1384
1302
|
|
|
1385
1303
|
## `@kerfjs/ui/wire-nav-stack`
|
|
@@ -1410,13 +1328,18 @@ export { type WireNavStackOptions, wireNavStack };
|
|
|
1410
1328
|
```ts
|
|
1411
1329
|
import * as kerfjs from 'kerfjs';
|
|
1412
1330
|
import { K as KerfUiContent } from './semantic-content-BbzjvSu9.js';
|
|
1413
|
-
import { NavStackProps, NavStackView } from './nav-stack.js';
|
|
1331
|
+
import { N as NavStackProps, a as NavStackView } from './nav-stack-B1Qc2e5q.js';
|
|
1414
1332
|
import { ResizableRegionProps } from './resizable-region.js';
|
|
1415
|
-
import './
|
|
1333
|
+
import './list.js';
|
|
1334
|
+
import './flex-alignment-4ms8ZbV8.js';
|
|
1416
1335
|
import './sides-BPSWde0A.js';
|
|
1336
|
+
import './css-values.js';
|
|
1417
1337
|
import './pane.js';
|
|
1338
|
+
import './panel-toolbar-CL9tYOkh.js';
|
|
1339
|
+
import './toolbar.js';
|
|
1340
|
+
import './lucide-icon.js';
|
|
1341
|
+
import 'lucide';
|
|
1418
1342
|
import './toolbar-text.js';
|
|
1419
|
-
import './css-values.js';
|
|
1420
1343
|
|
|
1421
1344
|
/**
|
|
1422
1345
|
* The roomy list pane's `ResizableRegion`: its committed `size` and `min` /
|
|
@@ -1431,7 +1354,7 @@ interface SplitViewResizable extends Pick<ResizableRegionProps, 'separator' | 'h
|
|
|
1431
1354
|
max: number;
|
|
1432
1355
|
}
|
|
1433
1356
|
/** One compact view's top- and bottom-toolbar content (see `NavStackView`). */
|
|
1434
|
-
type SplitViewCompactViewToolbars = Pick<NavStackView, '
|
|
1357
|
+
type SplitViewCompactViewToolbars = Pick<NavStackView, 'toolbar' | 'bottomToolbar'>;
|
|
1435
1358
|
/**
|
|
1436
1359
|
* The compact `NavStack`'s configuration: its toolbar configuration, back
|
|
1437
1360
|
* control, persistent bottom toolbar, and chrome dividers forward to the
|
|
@@ -1512,6 +1435,7 @@ type PaneRootAttributes = Readonly<Record<`data-${string}`, string | undefined>
|
|
|
1512
1435
|
'data-chrome-placement'?: never;
|
|
1513
1436
|
'data-chrome-dividers'?: never;
|
|
1514
1437
|
'data-appearance'?: never;
|
|
1438
|
+
'data-deep-inset'?: never;
|
|
1515
1439
|
}>;
|
|
1516
1440
|
/** How a Pane's header and footer relate to its scrolling content. */
|
|
1517
1441
|
type PaneChromePlacement = 'fixed' | 'auto';
|
|
@@ -1551,6 +1475,8 @@ interface PaneProps {
|
|
|
1551
1475
|
chromeDividers?: PaneChromeDividers;
|
|
1552
1476
|
/** Paint the scrolling work surface with the shared lowered-surface color. */
|
|
1553
1477
|
appearance?: PaneAppearance;
|
|
1478
|
+
/** Add an extra 8px inline gutter to scrolling content (default: false). */
|
|
1479
|
+
deepInset?: boolean;
|
|
1554
1480
|
/** Root semantics. Defaults to `div`. */
|
|
1555
1481
|
element?: PaneElement;
|
|
1556
1482
|
/** Scrolling content semantics. Defaults to `div`. */
|
|
@@ -1585,14 +1511,14 @@ interface PaneProps {
|
|
|
1585
1511
|
* or a CollapsiblePanel) forwards, so the app configures that pane instead of
|
|
1586
1512
|
* styling it. An omitted or `undefined` field keeps the composite's default.
|
|
1587
1513
|
*/
|
|
1588
|
-
type PaneConfig = Pick<PaneProps, 'contentElement' | 'contentLabel' | 'separators' | 'safeAreaEdges' | 'chromeDividers' | 'appearance'>;
|
|
1514
|
+
type PaneConfig = Pick<PaneProps, 'contentElement' | 'contentLabel' | 'separators' | 'safeAreaEdges' | 'chromeDividers' | 'appearance' | 'deepInset'>;
|
|
1589
1515
|
/**
|
|
1590
1516
|
* An unpadded application column with optional fixed header/footer slots and one
|
|
1591
1517
|
* scrolling vertical content owner. Separator lines are independently opt-in on
|
|
1592
1518
|
* each logical edge, so the same component works as a sidebar, main area,
|
|
1593
1519
|
* inspector, or dialog column.
|
|
1594
1520
|
*/
|
|
1595
|
-
declare function Pane({ header, children, footer, chromePlacement, chromeDividers, appearance, element, contentElement, separators, safeAreaEdges, id, label, contentLabel, className, headerClassName, contentClassName, footerClassName, rootAttributes, slot, }: PaneProps): kerfjs.SafeHtml;
|
|
1521
|
+
declare function Pane({ header, children, footer, chromePlacement, chromeDividers, appearance, deepInset, element, contentElement, separators, safeAreaEdges, id, label, contentLabel, className, headerClassName, contentClassName, footerClassName, rootAttributes, slot, }: PaneProps): kerfjs.SafeHtml;
|
|
1596
1522
|
|
|
1597
1523
|
export { Pane, type PaneAppearance, type PaneChromeDividers, type PaneChromePlacement, type PaneConfig, type PaneContentElement, type PaneElement, type PaneProps, type PaneSeparatorSide };
|
|
1598
1524
|
```
|
|
@@ -1602,16 +1528,16 @@ export { Pane, type PaneAppearance, type PaneChromeDividers, type PaneChromePlac
|
|
|
1602
1528
|
```ts
|
|
1603
1529
|
import { SafeHtml } from 'kerfjs';
|
|
1604
1530
|
import { K as KerfUiContent } from './semantic-content-BbzjvSu9.js';
|
|
1531
|
+
import { b as NavPane, N as NavStackProps } from './nav-stack-B1Qc2e5q.js';
|
|
1605
1532
|
import { ListConfig } from './list.js';
|
|
1606
|
-
import { NavStackProps } from './nav-stack.js';
|
|
1607
1533
|
import { PaneConfig } from './pane.js';
|
|
1608
1534
|
import { ResizableRegionSeparator, ResizableRegionCollapseMotion, ResizableRegionContentOverflow, ResizableRegionPresentation, ResizableRegionRestorePosition } from './resizable-region.js';
|
|
1609
|
-
import { a as PanelToolbar,
|
|
1535
|
+
import { a as PanelToolbar, c as PanelBottomToolbar, b as PanelChromePlacement, d as PanelToggle } from './panel-toolbar-CL9tYOkh.js';
|
|
1610
1536
|
import { ToolbarConfig } from './toolbar.js';
|
|
1537
|
+
import './toolbar-text.js';
|
|
1538
|
+
import './css-values.js';
|
|
1611
1539
|
import './flex-alignment-4ms8ZbV8.js';
|
|
1612
1540
|
import './sides-BPSWde0A.js';
|
|
1613
|
-
import './css-values.js';
|
|
1614
|
-
import './toolbar-text.js';
|
|
1615
1541
|
import './lucide-icon.js';
|
|
1616
1542
|
import 'lucide';
|
|
1617
1543
|
|
|
@@ -1733,19 +1659,11 @@ interface WorkbenchPanelBase {
|
|
|
1733
1659
|
restorePosition?: ResizableRegionRestorePosition;
|
|
1734
1660
|
}
|
|
1735
1661
|
/** The original static panel body: one toolbar, optional fixed chrome, and one Pane. */
|
|
1736
|
-
interface WorkbenchStaticPanel extends WorkbenchPanelBase {
|
|
1737
|
-
content: KerfUiContent;
|
|
1662
|
+
interface WorkbenchStaticPanel extends WorkbenchPanelBase, NavPane<WorkbenchPanelToolbar, WorkbenchPanelBottomToolbar> {
|
|
1738
1663
|
/** The composed toolbar; marked groups and its toggle relocate on collapse. */
|
|
1739
1664
|
toolbar?: WorkbenchPanelToolbar;
|
|
1740
|
-
header?: KerfUiContent;
|
|
1741
|
-
headerList?: ListConfig;
|
|
1742
1665
|
headerPlacement?: WorkbenchChromePlacement;
|
|
1743
|
-
footer?: KerfUiContent;
|
|
1744
|
-
footerList?: ListConfig;
|
|
1745
|
-
bottomToolbar?: WorkbenchPanelBottomToolbar;
|
|
1746
1666
|
footerPlacement?: WorkbenchChromePlacement;
|
|
1747
|
-
/** Configuration for the static toolbar panel's Pane. */
|
|
1748
|
-
pane?: PaneConfig;
|
|
1749
1667
|
navStack?: never;
|
|
1750
1668
|
}
|
|
1751
1669
|
/** A panel whose active NavStack view supplies the toolbar, fixed header, and scroll body. */
|
|
@@ -2197,14 +2115,14 @@ declare function wireSidebar(root: HTMLElement, { panels, deviceClass, compactPr
|
|
|
2197
2115
|
export { type SidebarStorage, type WireSidebarOptions, type WireSidebarPanel, wireSidebar };
|
|
2198
2116
|
```
|
|
2199
2117
|
|
|
2200
|
-
## `@kerfjs/ui/tab-
|
|
2118
|
+
## `@kerfjs/ui/tab-navigator`
|
|
2201
2119
|
|
|
2202
2120
|
```ts
|
|
2203
2121
|
import { SafeHtml } from 'kerfjs';
|
|
2204
2122
|
import { K as KerfUiContent } from './semantic-content-BbzjvSu9.js';
|
|
2205
2123
|
import { PaneAppearance } from './pane.js';
|
|
2206
2124
|
|
|
2207
|
-
interface
|
|
2125
|
+
interface TabNavigatorTabBase<Id extends string> {
|
|
2208
2126
|
id: Id;
|
|
2209
2127
|
label: string;
|
|
2210
2128
|
/** Decorative icon shown above the label in the bottom bar. */
|
|
@@ -2213,9 +2131,11 @@ interface TabScaffoldTabBase<Id extends string> {
|
|
|
2213
2131
|
content: KerfUiContent;
|
|
2214
2132
|
/** Background of this scene's scrolling work surface. */
|
|
2215
2133
|
appearance?: PaneAppearance;
|
|
2134
|
+
/** Add an extra 8px inline gutter to a plain scene's scrolling content. */
|
|
2135
|
+
deepInset?: boolean;
|
|
2216
2136
|
}
|
|
2217
2137
|
/** A tab with an optional count or short-status badge. */
|
|
2218
|
-
interface
|
|
2138
|
+
interface TabNavigatorTabCountBadge {
|
|
2219
2139
|
/**
|
|
2220
2140
|
* Optional count or short status shown as a solid danger `Badge` at the
|
|
2221
2141
|
* top-trailing corner of the tab icon (the iOS tab-bar badge). Omitted, `''`,
|
|
@@ -2233,7 +2153,7 @@ interface TabScaffoldTabCountBadge {
|
|
|
2233
2153
|
badgeLabel?: string;
|
|
2234
2154
|
}
|
|
2235
2155
|
/** A tab with the text-free dot badge (new content without a count). */
|
|
2236
|
-
interface
|
|
2156
|
+
interface TabNavigatorTabDotBadge {
|
|
2237
2157
|
/**
|
|
2238
2158
|
* `true` shows a solid danger dot `Badge` at the top-trailing corner of the
|
|
2239
2159
|
* tab icon — the iOS tab-bar dot for new content without a count.
|
|
@@ -2247,12 +2167,12 @@ interface TabScaffoldTabDotBadge {
|
|
|
2247
2167
|
badgeLabel: string;
|
|
2248
2168
|
}
|
|
2249
2169
|
/** One bottom-bar destination: its label, optional icon and badge, and content. */
|
|
2250
|
-
type
|
|
2251
|
-
interface
|
|
2170
|
+
type TabNavigatorTab<Id extends string = string> = TabNavigatorTabBase<Id> & (TabNavigatorTabCountBadge | TabNavigatorTabDotBadge);
|
|
2171
|
+
interface TabNavigatorProps<Id extends string = string> {
|
|
2252
2172
|
id: string;
|
|
2253
2173
|
/** Accessible name for the tab bar. */
|
|
2254
2174
|
label: string;
|
|
2255
|
-
tabs: readonly
|
|
2175
|
+
tabs: readonly TabNavigatorTab<Id>[];
|
|
2256
2176
|
/** The controlled active tab id (the app owns selection). */
|
|
2257
2177
|
active: NoInfer<Id>;
|
|
2258
2178
|
/**
|
|
@@ -2270,32 +2190,32 @@ interface TabScaffoldProps<Id extends string = string> {
|
|
|
2270
2190
|
slot?: string;
|
|
2271
2191
|
}
|
|
2272
2192
|
/**
|
|
2273
|
-
* A mobile-first, iOS-like bottom tab
|
|
2193
|
+
* A mobile-first, iOS-like bottom tab navigator: a bottom tab bar that switches
|
|
2274
2194
|
* between major sections, each tab keeping its own content (usually a `NavStack`)
|
|
2275
2195
|
* mounted so its stack and scroll survive a switch. Controlled — the app owns
|
|
2276
|
-
* `active`; wire selection with `@kerfjs/ui/wire-tab-
|
|
2196
|
+
* `active`; wire selection with `@kerfjs/ui/wire-tab-navigator`'s `wireTabNavigator`.
|
|
2277
2197
|
* On larger classes, promote the tabs to a `Workbench` rail or sidebar instead of
|
|
2278
2198
|
* a bottom bar. See `docs/23-app-layouts.md` §3.4.
|
|
2279
2199
|
*/
|
|
2280
|
-
declare function
|
|
2200
|
+
declare function TabNavigator<Id extends string>({ id, label, tabs, active, chromeDividers, className, slot, }: TabNavigatorProps<Id>): SafeHtml;
|
|
2281
2201
|
|
|
2282
|
-
export {
|
|
2202
|
+
export { TabNavigator, type TabNavigatorProps, type TabNavigatorTab };
|
|
2283
2203
|
```
|
|
2284
2204
|
|
|
2285
|
-
## `@kerfjs/ui/wire-tab-
|
|
2205
|
+
## `@kerfjs/ui/wire-tab-navigator`
|
|
2286
2206
|
|
|
2287
2207
|
```ts
|
|
2288
|
-
interface
|
|
2208
|
+
interface WireTabNavigatorOptions {
|
|
2289
2209
|
/** Invoked with the selected tab id when a bottom-bar tab is activated. */
|
|
2290
2210
|
onSelect: (tabId: string) => void;
|
|
2291
2211
|
}
|
|
2292
2212
|
/**
|
|
2293
|
-
* Wire a `
|
|
2213
|
+
* Wire a `TabNavigator`'s bottom tab bar: clicking a tab calls `onSelect` with its
|
|
2294
2214
|
* id (the app then updates its controlled `active`). Returns a disposer.
|
|
2295
2215
|
*/
|
|
2296
|
-
declare function
|
|
2216
|
+
declare function wireTabNavigator(root: Element, options: WireTabNavigatorOptions): () => void;
|
|
2297
2217
|
|
|
2298
|
-
export { type
|
|
2218
|
+
export { type WireTabNavigatorOptions, wireTabNavigator };
|
|
2299
2219
|
```
|
|
2300
2220
|
|
|
2301
2221
|
## `@kerfjs/ui/resizable-region`
|
|
@@ -2455,15 +2375,15 @@ import './toolbar.js';
|
|
|
2455
2375
|
import './sides-BPSWde0A.js';
|
|
2456
2376
|
import './pane.js';
|
|
2457
2377
|
import './workbench.js';
|
|
2378
|
+
import './nav-stack-B1Qc2e5q.js';
|
|
2458
2379
|
import './list.js';
|
|
2459
2380
|
import './flex-alignment-4ms8ZbV8.js';
|
|
2460
2381
|
import './css-values.js';
|
|
2461
|
-
import './nav-stack.js';
|
|
2462
|
-
import './toolbar-text.js';
|
|
2463
|
-
import './resizable-region.js';
|
|
2464
2382
|
import './panel-toolbar-CL9tYOkh.js';
|
|
2465
2383
|
import './lucide-icon.js';
|
|
2466
2384
|
import 'lucide';
|
|
2385
|
+
import './toolbar-text.js';
|
|
2386
|
+
import './resizable-region.js';
|
|
2467
2387
|
|
|
2468
2388
|
/**
|
|
2469
2389
|
* Controlled, stateless component-catalog shell: a `Workbench` whose left rail
|
|
@@ -2550,15 +2470,15 @@ import './semantic-content-BbzjvSu9.js';
|
|
|
2550
2470
|
import './sides-BPSWde0A.js';
|
|
2551
2471
|
import './pane.js';
|
|
2552
2472
|
import './workbench.js';
|
|
2473
|
+
import './nav-stack-B1Qc2e5q.js';
|
|
2553
2474
|
import './list.js';
|
|
2554
2475
|
import './flex-alignment-4ms8ZbV8.js';
|
|
2555
2476
|
import './css-values.js';
|
|
2556
|
-
import './nav-stack.js';
|
|
2557
|
-
import './toolbar-text.js';
|
|
2558
|
-
import './resizable-region.js';
|
|
2559
2477
|
import './panel-toolbar-CL9tYOkh.js';
|
|
2560
2478
|
import './lucide-icon.js';
|
|
2561
2479
|
import 'lucide';
|
|
2480
|
+
import './toolbar-text.js';
|
|
2481
|
+
import './resizable-region.js';
|
|
2562
2482
|
|
|
2563
2483
|
/**
|
|
2564
2484
|
* Standard resource labels for a Kerf catalog detail footer. Keep these labels
|
|
@@ -3358,22 +3278,30 @@ export { wireToolbarVisibility };
|
|
|
3358
3278
|
```ts
|
|
3359
3279
|
import * as kerfjs from 'kerfjs';
|
|
3360
3280
|
import { K as KerfUiContent } from './semantic-content-BbzjvSu9.js';
|
|
3281
|
+
import { CssLength } from './css-values.js';
|
|
3361
3282
|
|
|
3362
3283
|
type DialogSurfaceSize = 'small' | 'medium' | 'large';
|
|
3363
3284
|
type DialogSurfacePresentation = 'modal' | 'side-sheet' | 'fullscreen';
|
|
3364
3285
|
type SurfaceInset = 'none' | 'compact' | 'comfortable';
|
|
3286
|
+
type DialogSurfaceMaxHeight = CssLength | 'viewport';
|
|
3365
3287
|
interface DialogSurfaceProps {
|
|
3366
3288
|
children: KerfUiContent;
|
|
3367
3289
|
size?: DialogSurfaceSize;
|
|
3368
3290
|
presentation?: DialogSurfacePresentation;
|
|
3291
|
+
/** Modal preferred width. Takes precedence over size, within the viewport cap. */
|
|
3292
|
+
preferredWidth?: CssLength;
|
|
3369
3293
|
bodyInset?: SurfaceInset;
|
|
3370
3294
|
footerInset?: SurfaceInset;
|
|
3295
|
+
/** Modal edge clearance. Omit to retain Web Awesome's default viewport cap. */
|
|
3296
|
+
viewportGutter?: CssLength;
|
|
3297
|
+
/** Modal height cap, bounded by the dynamic viewport minus both gutters. */
|
|
3298
|
+
maxHeight?: DialogSurfaceMaxHeight;
|
|
3371
3299
|
className?: string;
|
|
3372
3300
|
/** Native named-slot assignment when composed inside a web component. */
|
|
3373
3301
|
slot?: string;
|
|
3374
3302
|
}
|
|
3375
3303
|
/** Configure recurring Web Awesome dialog geometry without consumer ::part() CSS. */
|
|
3376
|
-
declare function DialogSurface({ children, size, presentation, bodyInset, footerInset, className, slot, }: DialogSurfaceProps): kerfjs.SafeHtml;
|
|
3304
|
+
declare function DialogSurface({ children, size, presentation, preferredWidth, bodyInset, footerInset, viewportGutter, maxHeight, className, slot, }: DialogSurfaceProps): kerfjs.SafeHtml;
|
|
3377
3305
|
type PopupSurfaceInset = 'standard' | 'compact' | 'list-zero';
|
|
3378
3306
|
interface PopupSurfaceProps {
|
|
3379
3307
|
children: KerfUiContent;
|
|
@@ -3385,7 +3313,7 @@ interface PopupSurfaceProps {
|
|
|
3385
3313
|
/** Configure recurring Web Awesome dropdown-menu geometry without consumer ::part() CSS. */
|
|
3386
3314
|
declare function PopupSurface({ children, inset, className, slot, }: PopupSurfaceProps): kerfjs.SafeHtml;
|
|
3387
3315
|
|
|
3388
|
-
export { DialogSurface, type DialogSurfacePresentation, type DialogSurfaceProps, type DialogSurfaceSize, PopupSurface, type PopupSurfaceInset, type PopupSurfaceProps, type SurfaceInset };
|
|
3316
|
+
export { DialogSurface, type DialogSurfaceMaxHeight, type DialogSurfacePresentation, type DialogSurfaceProps, type DialogSurfaceSize, PopupSurface, type PopupSurfaceInset, type PopupSurfaceProps, type SurfaceInset };
|
|
3389
3317
|
```
|
|
3390
3318
|
|
|
3391
3319
|
## `@kerfjs/ui/text`
|
package/ai/skill.md
CHANGED
|
@@ -253,8 +253,8 @@ Hard rules:
|
|
|
253
253
|
15a. Use `Text` from `@kerfjs/ui/text` for ordinary headings, paragraphs, and inline secondary text outside toolbar title zones. Omit `variant` for the default `p`, pass `h1`–`h6` according to the document outline, or use `variant="span"` inside a row, label, or table cell; ordinary native attributes pass through. Express supporting, error, compact, or code text with the independent finite `tone="quiet|danger"`, `size="compact"`, and `font="monospace"` props instead of global utility classes or appearance-only heading choices. Block Text variants own a transparent 1px border and the standard item padding; `span` owns no box geometry. Keep toolbar identity/title content on `ToolbarText` and list-aligned bare prose on `ListInsetText`. `ToolbarText` below `xlarge` is intentionally quiet identity text in default tone; a normal-color subsection title is `Text` with an `h2`–`h6` variant (or `ListHeader` for a list or menu section), never a recolored `ToolbarText`. Use `controlMargins` with canonical physical Sides for an exterior 8px control gutter without a Row wrapper; avoid stacking parent insets, and remember spans retain native inline margin behavior.
|
|
254
254
|
|
|
255
255
|
16. Keep a visible collapsible pane's collapse control in its own toolbar. When hidden, move its restore control into the adjacent main toolbar on the corresponding logical edge: leading for an inline-start sidebar and trailing for an inline-end inspector. Collapse the pane completely; do not preserve an empty icon-only rail.
|
|
256
|
-
16a. Dividers between pinned chrome and scrolling content are component chrome: a `Toolbar` draws none by default (`dividerSides` is for a permanent edge only). Call `wireScrollDividers(appRoot)` from `@kerfjs/ui/wire-scroll-dividers` once and retain its disposer; a plain `Pane` with `chromeDividers="scroll"` draws the line under its header only while content is scrolled beneath it and over its footer only while more content lies below (never when the content fits), every `NavStack`'s top chrome and bottom toolbar and every `
|
|
257
|
-
17.
|
|
256
|
+
16a. Dividers between pinned chrome and scrolling content are component chrome: a `Toolbar` draws none by default (`dividerSides` is for a permanent edge only). Call `wireScrollDividers(appRoot)` from `@kerfjs/ui/wire-scroll-dividers` once and retain its disposer; a plain `Pane` with `chromeDividers="scroll"` draws the line under its header only while content is scrolled beneath it and over its footer only while more content lies below (never when the content fits), every `NavStack`'s top chrome and bottom toolbar and every `TabNavigator` bar do the same around the active view or scene (keyed on whatever actually scrolls there, including a sole `Pane`'s content), and every `TabBar` marks each side of its strip with tabs scrolled out of view. Configure a pane with `chromeDividers` (`scroll` by default for plain panes, `always` by default for sunken panes, or explicit `scroll`, `always`, `none`, also via `PaneConfig`); `always` draws both lines even when content fits. A `NavStack` or `TabNavigator` has its own `chromeDividers` (same values: `always` draws the chrome lines without the wiring, `none` never, even when wired; a `SplitView` forwards it through `compactStack`); a `toolbarConfig.dividerSides` edge stays the Toolbar's own. Name app-owned chrome by id in `targets`. The wiring writes only `data-scroll-overflow` / `data-scroll-divider` state; never write a border onto a component to show a divider.
|
|
257
|
+
17. Each `Toolbar` zone accepts `KerfUiContent` directly, including status content, native controls, and application markup. Put identity/title text directly in the zone as `ToolbarText`; use `ToolbarControlGroup` when related controls need shared toolbar chrome, sizing, hover treatment, or overflow behavior. Bare controls keep their own styling and accessibility responsibilities. A standalone primary `wa-button` in trailing keeps its own Web Awesome chrome. `SegmentedControl`, `Select`, and `TokenSearchField` can live inside a group when they need that shared presentation. Configure zone behavior with `Toolbar.centerAlign` and its `responsive` / `responsiveAt` policy instead of selecting toolbar zone classes. No policy clips an action: trailing (and stacked center) zones wrap whole groups onto another row, and the center zone never compresses below its content (a leading title too long for the row truncates with an ellipsis instead), so never hide or shrink a toolbar control to make it fit; use `responsive="wrap"` for a heading whose title must stay whole, and move genuinely lower-priority commands into an app-owned "More" popup menu. For an ordinary icon/action control inside a group, use a plain `<button>` (the group styles `> button` fully) — that is the default; reach for `wa-button` only when you need a Web Awesome feature. A popup menu in a toolbar is a `PopupMenu` (`@kerfjs/ui/popup-menu`, registered once via `@kerfjs/ui/popup-menu/register`) in a `single` group with `nestedDropdown` and a `menuInset`: give it typed `items` (commands with `action`s, `heading`s, `divider`s) and a trigger `icon` plus visible `text` or an accessible `label`; never hand-write `wa-dropdown` / `wa-dropdown-item` markup for a menu. Let the group size that trigger from its icon, localized text, and caret; do not force a width on the menu or button. By default a group stays on one row: each icon sits beside its label, and the toolbar's `responsive` policy relocates whole groups when needed. Set `overflow="wrap"` only for independent links that should move as whole actions to another row within the group; use `overflow="scroll"` for a bounded one-row action strip. A `ToolbarText` is one line ending in an ellipsis by default; opt into `wrap` (capped by `maxLines`) or `ellipsis={false}` deliberately. Inside a group, a `Select` or `PopupMenu` trigger drops its focus ring while its popup is open (the open popup and its current row show where focus is) and the ring returns when the popup closes; a ring follows the control's shape (a pill for an icon-and-caret trigger, a circle for a compact icon button) — set `focusRingOwner="group"` on a Select whose group paints the composed ring, and never add CSS to show, hide, or reshape a ring. For a compact mixed group, keep the standard item padding and raised selected chrome; the selected item paints over the outer border without an internal separator. For an avatar control, set `content="avatar"` and `avatarImage` on the group instead of inserting an `img`: a lone control paints the contained image on the outer group and a multi-button group paints it only on the pressed selection highlight. Compose panel/dialog/page headings with a direct extra-large `ToolbarText`, optional grouped icon, grouped trailing controls, and app-owned supporting copy below. A non-interactive heading icon is an icon tile: put the `LucideIcon` directly in its `ToolbarControlGroup` (it takes an icon button's 40px slot and centers), never inside a `<button>` that does nothing. A group remains 44px outside (`calc(2px + remify(42px))`) when its border/background are transparent; use 8px between groups and inside items. Each zone item sits in the toolbar's top 44px control band, centered by its own size; a taller item (a wrapped title, a second trailing row) starts at the band's top and grows down without moving the others, so a wrapped `ToolbarText` keeps trailing controls beside its first line — do not add alignment CSS for this. Split dormant and interactive regions: `ListHeader` fills the available inline width by default; set `width="content"` to shrink-wrap while retaining its normal geometry, or `inline` when it belongs in surrounding text without outer margin, border, or padding. It keeps its label and mutually exclusive semantic count or non-count `badge` together, with an independent logical-end action unless disclosure mode makes the title cluster the button. Its action visual defaults to 18px through `--kui-list-header-action-icon-size` inside a fitted 36px hover square whose transparent hit layer keeps the pointer target at least 44px (44px wide by the 36px row in `density="compact"`); never shrink the target to match the visual, and never force the button to 44px. Pass every non-negative safe-integer section quantity through `count` with a localized full spoken `countLabel`; never concatenate it into `label` or put a number in `badge`. `ListItem.trailing` is dormant; use `ListActionRow` when primary and trailing actions need sibling native buttons. Its `label`, `icon`, and `trailingActionIcon` slots are also dormant and cannot contain controls. Let panes relocate at narrow widths instead of shrinking targets. Dividers are chrome and earn their place: a `Toolbar` draws none by default, and the line between pinned chrome and scrolling content comes from scroll state (rule 16a), so never add a border, a permanent `dividerSides`, or a margin to fake or adjust one.
|
|
258
258
|
For a toolbar heading that must remain at the 20px `--kui-font-l` step, use `ToolbarText size="xlarge-fixed"`; `xlarge` retains the responsive page-title clamp. Pass `headingLevel` when it is a section landmark.
|
|
259
259
|
|
|
260
260
|
18. When a recurring concept has no matching export or production recipe, keep its semantics in a thin application adapter while reusing the public layout vocabulary. The composer recipe uses one visible form surface, toolbar title/supporting-copy ids, shared 8px field/action gutters, 24px major rhythm, and a conditional StateBanner as its only nested semantic surface; do not turn every section into a card or double-inset intrinsically bordered controls. For multi-line banner copy use `copyLayout="stacked"`; use `actionPlacement="below"` for an action on its own trailing row. The application-local `../docs/examples/command-palette-adapter.tsx` is reference source for one such missing concept, not an `@kerfjs/ui` runtime export or catalog recipe. The application owns its registration, ranking, history, permissions, availability, shortcut policy, focus policy, dispatch, and copy. If a missing concept recurs across products, open an upstream component or recipe request.
|
|
@@ -267,7 +267,7 @@ For a rail view heading, use `presentation="title"` for the 36px bold,
|
|
|
267
267
|
flush-start trigger and adjacent caret. Set `focusRingInset` when an ancestor
|
|
268
268
|
clips focus painting; never restyle Select shadow parts from application CSS.
|
|
269
269
|
|
|
270
|
-
19. Compose `ValueTable` from typed `ValueTableRow` entries instead of handwritten `dt`/`dd` wrappers. Pass `icon` for the optional 24px leading visual; the row owns 8px of root-scaled top and bottom padding, the 8px iconless or 40px icon-bearing separator start, and the common 8px right inset. 20. Use the standard direct `Toolbar` composition for a panel, dialog, or page heading, not a private wrapper or custom heading row. Put an optional icon in a `ToolbarControlGroup`, the title directly in the leading zone as extra-large `ToolbarText`, and actions in a trailing group. Set `headingLevel` for page/section landmarks. Supporting copy stays below the toolbar as app-owned content. The app owns modal behavior, focus, dismissal, command policy, ids, and action handling. 21. Space with the official five-step scale, picked by how connected two elements are — not by eye. `0` `--kui-space-none` = no separation (one unit); `4px` `--kui-space-2xs` = very minor air on a connected cluster; `8px` `--kui-space-xs` = standard, between elements within a group; `16px` `--kui-space-m` = minor, between homogeneous groups; `24px` `--kui-space-l` = major, between heterogeneous groups (the `.kui-content` rhythm). The 8px-vs-24px distinction is inside-a-group vs between-major-differing-regions. `--kui-space-s` (12px) and `--kui-space-xl` (32px) are off-scale exceptions. For `Row.gap`, `Grid.gap`, or `List.gap`, pass a finite shorthand such as `gap="xs"` or `gap="m"`; use `Spacer` for one intentional typed empty width/height or a flexible main-axis gap. When one token is insufficient, import typed builders from the CSS-free `@kerfjs/ui/css-values` subpath. Preserve property grammar: lengths for gap/Spacer/Skeleton geometry, `flex()` for Row/Grid/List flex, and a foreground color for choice icons: `uiColor()` with a `*-on-*` or text token (`success-on-quiet`, `text-quiet`) or `foregroundColorVar()`. Fill tokens (`*-fill-*`) are backgrounds, not foregrounds, and `SelectChoice.color` rejects them. Never cast between brands or emit raw row `style` declarations. `plus` is not standalone and must be wrapped in `calc`; `remify()` remains source-CSS syntax and is never a runtime prop value. See `docs/layout.md` "Spacing scale". 22. Pick a whole-screen layout from the opt-in, tree-shakeable subpaths by data + interaction + device, and derive responsiveness from `@kerfjs/ui/device-class`'s `deviceClass()` (`compact` = handset or portrait tablet = one pane at a time). Simple/flat → `NavStack` with one entry (single pane), plus `TabScaffold` (`@kerfjs/ui/tab-scaffold`, iOS bottom tabs, each tab its own `NavStack`) for 2–5 co-equal sections on `compact`; show an unread count on a tab with its `badge` (a number or short string, rendered as the top-trailing danger `Badge` on the icon) plus a localized `badgeLabel` ("3 unread", folded into the tab's name as "Inbox, 3 unread"), never by concatenating the count into `label` or restyling the badge; for new content without a count pass `badge: true` (the text-free dot) with its required `badgeLabel` ("New activity"). Drill-down → `NavStack` (`@kerfjs/ui/nav-stack`), upgrading to `SplitView` (`@kerfjs/ui/split-view`, list-detail) once both panes fit (`atLeast('tablet')` landscape); `SplitView` collapses to a `NavStack` on `compact`. Keep each stack's ordered views controlled; put view-specific bottom chrome on `NavStackView.bottomToolbar` (or use the component-level persistent fallback), then call `wireNavStack` so content slides while the active view's top and bottom chrome cross-fade and focus moves into the new top view/restores on pop. Mark a preferred initial heading or control with `data-nav-focus` when DOM order is not sufficient. The stack's top chrome is a real `Toolbar`: put a view's groups on `NavStackView.leading` / `center` / `toolbar` (trailing), and configure the bar through `toolbarConfig` (`ToolbarConfig` plus `label`, `titleSize`, `headingLevel`) and `backIcon` / `backText`, never with CSS. `SplitView` forwards both of its inner components: `resizable` takes the list `ResizableRegion`'s `separator`, `handleIcon`, `contentOverflow`, and collapse props (`collapsed`, `transitioning`, `collapseMotion`, `restoreControl`, `restorePosition`), and `compactStack` takes the compact stack's `toolbarConfig`, `backIcon`, `backText`, `hideToolbar`, `bottomToolbar`, plus `list` / `detail` view toolbars (`leading`, `center`, `toolbar`, `bottomToolbar`). Complex tool with peripheral panels → `Workbench` (`@kerfjs/ui/workbench`, collapsible rails + drawer) `atLeast('desktop')`, degrading to `NavStack`/overlays below. Workbench panels are fixed-size unless a panel opts in with `resizable` (`true` or `{ min, max }`); then render `size={sizeSignal.value}` and call `wireWorkbench(root, { id, panels: { leftRail: { size: sizeSignal, storageKey? } }, deviceClass })` from `@kerfjs/ui/wire-workbench` for pointer drags, arrow/Shift+arrow/Home/End on the separator, persistence, and no resizing on `compact` classes. Inline rails, fixed or resizable, leave the work area `mainMinSize` px of width (a `Workbench` prop, default 320, `0` off), and an inline bottom drawer leaves it `mainMinHeight` px of height (default 120, `0` off): resizable panels stop growing there, rails shrink in proportion when the Workbench narrows and the drawer when it gets shorter, so do not add your own main-area `min-width` / `min-height`. Rails present as overlays below the `narrow` Workbench container breakpoint (704px) by default — `responsiveOverlayAt: "compact"` moves that to 448px and `"never"` keeps a rail inline — and a bottom drawer opts in the same way; do not derive `presentation` from `deviceClass`, and overlays never resize. At compact widths an overlay rail fills the Workbench less a 44px dismiss strip (`--kui-workbench-overlay-dismiss-margin`) on the side away from its edge; `compactOverlay: "full"` makes one rail fill it. Pass each such panel's `collapsed` signal to `wireWorkbench` too (`panels: { leftRail: { collapsed: navCollapsed } }`, `size` optional) so the overlay is transient like `wireSidebar`'s compact overlay: it collapses when the breakpoint begins to apply (the inline state returns when it ends), takes focus on its first control and keeps Tab inside it while open, and closes on Escape or an outside press with focus returned to its toggle (give each toggle `aria-controls` naming its panel's derived id, `<workbench id>-left-rail` / `-right-rail` / `-bottom-drawer`, so a panel open at wire-up has a focus target too); opening one overlay closes the other open overlays, so they never cover each other's controls; do not hand-roll those listeners (`dismissOverlays: false` opts out of all of it, `exclusiveOverlays: false` of exclusivity only). Collapse stays the app's `collapsed` flag and keeps the size, so an expanded panel returns at its last size. Let the Workbench compose panel toolbars: give each panel `toolbar: { label, title?, leading?, center?, trailing?, toggle: { action, name, showLabel?, hideLabel? } }` and the work area `mainToolbar` (and `mainBottomToolbar` for a drawer). Each of these toolbars takes the `Toolbar`'s configuration (`ToolbarConfig`: `dividerSides`, `centerAlign`, `responsive`, `responsiveAt`, `safeAreaEdges`); configure a composed toolbar through those props (for example `dividerSides: ""` to drop its divider), never with CSS. Configure the composed panes and chrome lists the same way: a panel's `pane` (and `CollapsiblePanel`'s `pane`) and the Workbench's `mainPane` take `PaneConfig` (`contentElement`, `contentLabel`, `separators`, `safeAreaEdges` — for example `{ contentElement: "nav", contentLabel: "Files" }` for a navigator rail), and `mainHeaderList` / `mainFooterList` take `ListConfig` (`gap`, `hAlign`, `vAlign`, `dividerSides`, `textInsets`, `controlInsets`). Open, a panel's toolbar places groups in its leading, center, and trailing zones, with the toggle last; mark a ToolbarControlGroup relocateOnCollapse to keep it available when closed (pass marked groups directly or in arrays rather than JSX fragments); closed, marked groups follow zone order into the work area before the toggle — a left rail's lead `mainToolbar`, a right rail's end it, a drawer's trail `mainBottomToolbar` or float in a corner `FloatingToolbar` — and panel-only groups stay behind. A control sits near where its effect appears: a collapsed drawer's restore belongs in the bottom toolbar or a `FloatingToolbar` beside the drawer, not in a distant top toolbar. Do not hand-place panel toggles in the work-area toolbar or render a second copy, and handle only the toggle's `data-action`. A collapsed panel renders `inert` and `aria-hidden` by itself, on the rail/drawer and its content (its `restoreControl` stays outside and reachable), so do not add your own `tabindex`, `aria-hidden`, or `inert` to hide it. These are declarative (the app owns the stack/selection/collapsed/active state as signals) with disposer-returning `wire…` helpers; each stays out of the barrel, and its CSS-aware browser import loads the layout's CSS plus that of every component it renders (`Pane`, `Toolbar`, `List`, …), so do not hand-import `pane.css` or the other internal stylesheets; the companion `.css` subpath is only for pipelines without the `browser` condition. For a standalone collapsible rail or bottom drawer outside a full shell, use `CollapsiblePanel` + `CollapsiblePanelToggle` (`@kerfjs/ui/collapsible-panel`) with `wireSidebar` (`@kerfjs/ui/wire-sidebar`): the standard collapse animation and per-side icon convention (`PanelLeft*`/`PanelRight*`/`PanelBottom*`) plus toggle, focus, compact overlay, and persistence semantics. Give a standalone panel the same `toolbar` roles and render `CollapsiblePanelRelocated` in your work-area toolbar (first in leading for a left rail, last in trailing for a right rail, a bottom toolbar or a `FloatingToolbar` restoreControl for a drawer) instead of hand-placing a second toggle. A collapsed `CollapsiblePanel`, `ResizableRegion`, or Workbench panel renders `inert` and `aria-hidden` by itself, so do not hide collapsed content yourself either. Likewise an open side overlay (a Workbench rail overlay, a `wireSidebar` compact overlay, an overlay `CollapsiblePanel` or horizontal `ResizableRegion`) hides the covered work area's `FloatingToolbar`s and restore corners by itself until it closes, so do not hide them from overlay state. A compact overlay opens only on a user action: wire-up on a compact device and a wide-to-compact crossing collapse every panel, and a wide crossing restores the inline state. Seed the signal with `signal(device.value.compact)` and pass the panel's `inlineCollapsed` default so the first compact render has no overlay. Dialogs pick the same inner layout, then present per device class (full-screen modal on `compact`, inline on desktop). A list-detail dialog is a Workbench-shaped layout on roomy devices: a full-height list sidebar and a full-height main column, each a `Pane` with its own top `Toolbar`; the main column holds the primary xl title, the close control (`data-dialog="close"` in a `without-header` Web Awesome dialog), and the record actions, never a header spanning both columns. A top-level percentage-height shell needs a definite containing height: opt into `@kerfjs/ui/document.css` and put `.kui-app-root` on the one direct mount container, or provide equivalent application-owned geometry. The global baseline is deliberately absent from `styles.css` and component imports. See `docs/app-layouts.md`, `docs/document-baseline.md`, and `docs/collapsible-panel.md`. 23. Layouts and `Pane` are safe-area aware without configuration: backgrounds, separators, and dividers paint through a device's unsafe areas (a collapsible rail or drawer grows by the inset it docks to), content is padded only on the sides a region actually reaches, and block insets are scroll padding inside the scroller so first/last content can always be scrolled clear. Interior edges get nothing, and a collapsed rail hands its edge back to the center. Never add your own `env(safe-area-inset-*)` padding around a kerf layout or pane — that double-insets. In an app-owned arrangement of panes, pass `Pane.safeAreaEdges` (the sides that pane reaches; `[]` opts out); give an app bar or bottom bar that sits at a screen edge outside a Pane header or footer `Toolbar.safeAreaEdges` for the sides it reaches (for example `['block-start', 'inline-start', 'inline-end']`); the Workbench `mainToolbar` / `mainBottomToolbar` and panel `toolbar` configurations forward the same `safeAreaEdges` to their `Toolbar`. Do not set the internal `--kui-edge-inset-*` context yourself. The device insets are `--kui-safe-area-*` (defaulting to `env()`), overridable on `:root`. See `docs/app-layouts.md` "Safe areas".
|
|
270
|
+
19. Compose `ValueTable` from typed `ValueTableRow` entries instead of handwritten `dt`/`dd` wrappers. Pass `icon` for the optional 24px leading visual; the row owns 8px of root-scaled top and bottom padding, the 8px iconless or 40px icon-bearing separator start, and the common 8px right inset. 20. Use the standard direct `Toolbar` composition for a panel, dialog, or page heading, not a private wrapper or custom heading row. Put an optional icon in a `ToolbarControlGroup`, the title directly in the leading zone as extra-large `ToolbarText`, and actions in a trailing group. Set `headingLevel` for page/section landmarks. Supporting copy stays below the toolbar as app-owned content. The app owns modal behavior, focus, dismissal, command policy, ids, and action handling. 21. Space with the official five-step scale, picked by how connected two elements are — not by eye. `0` `--kui-space-none` = no separation (one unit); `4px` `--kui-space-2xs` = very minor air on a connected cluster; `8px` `--kui-space-xs` = standard, between elements within a group; `16px` `--kui-space-m` = minor, between homogeneous groups; `24px` `--kui-space-l` = major, between heterogeneous groups (the `.kui-content` rhythm). The 8px-vs-24px distinction is inside-a-group vs between-major-differing-regions. `--kui-space-s` (12px) and `--kui-space-xl` (32px) are off-scale exceptions. For `Row.gap`, `Grid.gap`, or `List.gap`, pass a finite shorthand such as `gap="xs"` or `gap="m"`; use `Spacer` for one intentional typed empty width/height or a flexible main-axis gap. When one token is insufficient, import typed builders from the CSS-free `@kerfjs/ui/css-values` subpath. Preserve property grammar: lengths for gap/Spacer/Skeleton geometry, `flex()` for Row/Grid/List flex, and a foreground color for choice icons: `uiColor()` with a `*-on-*` or text token (`success-on-quiet`, `text-quiet`) or `foregroundColorVar()`. Fill tokens (`*-fill-*`) are backgrounds, not foregrounds, and `SelectChoice.color` rejects them. Never cast between brands or emit raw row `style` declarations. `plus` is not standalone and must be wrapped in `calc`; `remify()` remains source-CSS syntax and is never a runtime prop value. See `docs/layout.md` "Spacing scale". 22. Pick a whole-screen layout from the opt-in, tree-shakeable subpaths by data + interaction + device, and derive responsiveness from `@kerfjs/ui/device-class`'s `deviceClass()` (`compact` = handset or portrait tablet = one pane at a time). Simple/flat → `NavStack` with one entry (single pane), plus `TabNavigator` (`@kerfjs/ui/tab-navigator`, iOS bottom tabs, each tab its own `NavStack`) for 2–5 co-equal sections on `compact`; show an unread count on a tab with its `badge` (a number or short string, rendered as the top-trailing danger `Badge` on the icon) plus a localized `badgeLabel` ("3 unread", folded into the tab's name as "Inbox, 3 unread"), never by concatenating the count into `label` or restyling the badge; for new content without a count pass `badge: true` (the text-free dot) with its required `badgeLabel` ("New activity"). Drill-down → `NavStack` (`@kerfjs/ui/nav-stack`), upgrading to `SplitView` (`@kerfjs/ui/split-view`, list-detail) once both panes fit (`atLeast('tablet')` landscape); `SplitView` collapses to a `NavStack` on `compact`. Keep each stack's ordered views controlled; put view-specific bottom chrome on `NavStackView.bottomToolbar` (or use the component-level persistent fallback), then call `wireNavStack` so content slides while the active view's top and bottom chrome cross-fade and focus moves into the new top view/restores on pop. Mark a preferred initial heading or control with `data-nav-focus` when DOM order is not sufficient. The stack's top chrome is a real `Toolbar`: put a view's title and groups on `NavStackView.toolbar` (`title`, `leading`, `center`, `trailing`), where its Toolbar configuration overrides stack-wide `toolbarConfig` defaults; configure `backIcon` / `backText` through the stack, never with CSS. Each view and the stack fallback use a structured `bottomToolbar` with an accessible `label`; a view can also provide `header` / `footer`, `headerList` / `footerList`, and `pane` configuration, which render a Pane around that view's scrolling content. `SplitView` forwards both of its inner components: `resizable` takes the list `ResizableRegion`'s `separator`, `handleIcon`, `contentOverflow`, and collapse props (`collapsed`, `transitioning`, `collapseMotion`, `restoreControl`, `restorePosition`), and `compactStack` takes the compact stack's `toolbarConfig`, `backIcon`, `backText`, `hideToolbar`, `bottomToolbar`, plus `list` / `detail` view toolbars (structured `toolbar` and `bottomToolbar`). Complex tool with peripheral panels → `Workbench` (`@kerfjs/ui/workbench`, collapsible rails + drawer) `atLeast('desktop')`, degrading to `NavStack`/overlays below. Workbench panels are fixed-size unless a panel opts in with `resizable` (`true` or `{ min, max }`); then render `size={sizeSignal.value}` and call `wireWorkbench(root, { id, panels: { leftRail: { size: sizeSignal, storageKey? } }, deviceClass })` from `@kerfjs/ui/wire-workbench` for pointer drags, arrow/Shift+arrow/Home/End on the separator, persistence, and no resizing on `compact` classes. Inline rails, fixed or resizable, leave the work area `mainMinSize` px of width (a `Workbench` prop, default 320, `0` off), and an inline bottom drawer leaves it `mainMinHeight` px of height (default 120, `0` off): resizable panels stop growing there, rails shrink in proportion when the Workbench narrows and the drawer when it gets shorter, so do not add your own main-area `min-width` / `min-height`. Rails present as overlays below the `narrow` Workbench container breakpoint (704px) by default — `responsiveOverlayAt: "compact"` moves that to 448px and `"never"` keeps a rail inline — and a bottom drawer opts in the same way; do not derive `presentation` from `deviceClass`, and overlays never resize. At compact widths an overlay rail fills the Workbench less a 44px dismiss strip (`--kui-workbench-overlay-dismiss-margin`) on the side away from its edge; `compactOverlay: "full"` makes one rail fill it. Pass each such panel's `collapsed` signal to `wireWorkbench` too (`panels: { leftRail: { collapsed: navCollapsed } }`, `size` optional) so the overlay is transient like `wireSidebar`'s compact overlay: it collapses when the breakpoint begins to apply (the inline state returns when it ends), takes focus on its first control and keeps Tab inside it while open, and closes on Escape or an outside press with focus returned to its toggle (give each toggle `aria-controls` naming its panel's derived id, `<workbench id>-left-rail` / `-right-rail` / `-bottom-drawer`, so a panel open at wire-up has a focus target too); opening one overlay closes the other open overlays, so they never cover each other's controls; do not hand-roll those listeners (`dismissOverlays: false` opts out of all of it, `exclusiveOverlays: false` of exclusivity only). Collapse stays the app's `collapsed` flag and keeps the size, so an expanded panel returns at its last size. Let the Workbench compose panel toolbars: give each panel `toolbar: { label, title?, leading?, center?, trailing?, toggle: { action, name, showLabel?, hideLabel? } }` and the work area `mainToolbar` (and `mainBottomToolbar` for a drawer). Each of these toolbars takes the `Toolbar`'s configuration (`ToolbarConfig`: `dividerSides`, `centerAlign`, `responsive`, `responsiveAt`, `safeAreaEdges`); configure a composed toolbar through those props (for example `dividerSides: ""` to drop its divider), never with CSS. Configure the composed panes and chrome lists the same way: a panel's `pane` (and `CollapsiblePanel`'s `pane`) and the Workbench's `mainPane` take `PaneConfig` (`contentElement`, `contentLabel`, `separators`, `safeAreaEdges` — for example `{ contentElement: "nav", contentLabel: "Files" }` for a navigator rail), and `mainHeaderList` / `mainFooterList` take `ListConfig` (`gap`, `hAlign`, `vAlign`, `dividerSides`, `textInsets`, `controlInsets`). Open, a panel's toolbar places groups in its leading, center, and trailing zones, with the toggle last; mark a ToolbarControlGroup relocateOnCollapse to keep it available when closed (pass marked groups directly or in arrays rather than JSX fragments); closed, marked groups follow zone order into the work area before the toggle — a left rail's lead `mainToolbar`, a right rail's end it, a drawer's trail `mainBottomToolbar` or float in a corner `FloatingToolbar` — and panel-only groups stay behind. A control sits near where its effect appears: a collapsed drawer's restore belongs in the bottom toolbar or a `FloatingToolbar` beside the drawer, not in a distant top toolbar. Do not hand-place panel toggles in the work-area toolbar or render a second copy, and handle only the toggle's `data-action`. A collapsed panel renders `inert` and `aria-hidden` by itself, on the rail/drawer and its content (its `restoreControl` stays outside and reachable), so do not add your own `tabindex`, `aria-hidden`, or `inert` to hide it. These are declarative (the app owns the stack/selection/collapsed/active state as signals) with disposer-returning `wire…` helpers; each stays out of the barrel, and its CSS-aware browser import loads the layout's CSS plus that of every component it renders (`Pane`, `Toolbar`, `List`, …), so do not hand-import `pane.css` or the other internal stylesheets; the companion `.css` subpath is only for pipelines without the `browser` condition. For a standalone collapsible rail or bottom drawer outside a full shell, use `CollapsiblePanel` + `CollapsiblePanelToggle` (`@kerfjs/ui/collapsible-panel`) with `wireSidebar` (`@kerfjs/ui/wire-sidebar`): the standard collapse animation and per-side icon convention (`PanelLeft*`/`PanelRight*`/`PanelBottom*`) plus toggle, focus, compact overlay, and persistence semantics. Give a standalone panel the same `toolbar` roles and render `CollapsiblePanelRelocated` in your work-area toolbar (first in leading for a left rail, last in trailing for a right rail, a bottom toolbar or a `FloatingToolbar` restoreControl for a drawer) instead of hand-placing a second toggle. A collapsed `CollapsiblePanel`, `ResizableRegion`, or Workbench panel renders `inert` and `aria-hidden` by itself, so do not hide collapsed content yourself either. Likewise an open side overlay (a Workbench rail overlay, a `wireSidebar` compact overlay, an overlay `CollapsiblePanel` or horizontal `ResizableRegion`) hides the covered work area's `FloatingToolbar`s and restore corners by itself until it closes, so do not hide them from overlay state. A compact overlay opens only on a user action: wire-up on a compact device and a wide-to-compact crossing collapse every panel, and a wide crossing restores the inline state. Seed the signal with `signal(device.value.compact)` and pass the panel's `inlineCollapsed` default so the first compact render has no overlay. Dialogs pick the same inner layout, then present per device class (full-screen modal on `compact`, inline on desktop). A list-detail dialog is a Workbench-shaped layout on roomy devices: a full-height list sidebar and a full-height main column, each a `Pane` with its own top `Toolbar`; the main column holds the primary xl title, the close control (`data-dialog="close"` in a `without-header` Web Awesome dialog), and the record actions, never a header spanning both columns. A top-level percentage-height shell needs a definite containing height: opt into `@kerfjs/ui/document.css` and put `.kui-app-root` on the one direct mount container, or provide equivalent application-owned geometry. The global baseline is deliberately absent from `styles.css` and component imports. See `docs/app-layouts.md`, `docs/document-baseline.md`, and `docs/collapsible-panel.md`. 23. Layouts and `Pane` are safe-area aware without configuration: backgrounds, separators, and dividers paint through a device's unsafe areas (a collapsible rail or drawer grows by the inset it docks to), content is padded only on the sides a region actually reaches, and block insets are scroll padding inside the scroller so first/last content can always be scrolled clear. Interior edges get nothing, and a collapsed rail hands its edge back to the center. Never add your own `env(safe-area-inset-*)` padding around a kerf layout or pane — that double-insets. In an app-owned arrangement of panes, pass `Pane.safeAreaEdges` (the sides that pane reaches; `[]` opts out); give an app bar or bottom bar that sits at a screen edge outside a Pane header or footer `Toolbar.safeAreaEdges` for the sides it reaches (for example `['block-start', 'inline-start', 'inline-end']`); the Workbench `mainToolbar` / `mainBottomToolbar` and panel `toolbar` configurations forward the same `safeAreaEdges` to their `Toolbar`. Do not set the internal `--kui-edge-inset-*` context yourself. The device insets are `--kui-safe-area-*` (defaulting to `env()`), overridable on `:root`. See `docs/app-layouts.md` "Safe areas".
|
|
271
271
|
|
|
272
272
|
For application tabs, `AppTab presentation="icon-only"` retains its accessible `name`, `labelMaxWidth` truncates the visible name, and `attention` colors it through `--kui-app-tab-attention-color`. Configure TabBar strip geometry through public `--kui-tab-bar-strip-*` tokens.
|
|
273
273
|
|
|
@@ -312,7 +312,7 @@ Common mistakes:
|
|
|
312
312
|
| Add demo-only markup for a production state | Add the state to the production component, then render that export in the catalog |
|
|
313
313
|
| Choose a listed ecosystem component by default | Apply the component-selection guidance above; catalog coverage means supported and themed, not preferred |
|
|
314
314
|
| Add sidebar-specific wrapper padding | Use the unpadded `.kui-pane`; let `ListHeader`, `ListItem`, and `ContentItem` own their 8/1/8 geometry |
|
|
315
|
-
|
|
|
315
|
+
| Expect a bare toolbar control to receive group chrome automatically | Style and name the direct control itself, or use `ToolbarControlGroup` when controls need shared chrome |
|
|
316
316
|
| Reach for `wa-button` for a plain control inside a `ToolbarControlGroup` | Use a plain `<button>` (the group styles it fully); for a popup menu use `PopupMenu`, which renders its own trigger |
|
|
317
317
|
| Render a `Discouraged` Web Awesome element (`wa-dropdown`, `wa-button-group`, `wa-select`, `wa-tab-group`, `wa-icon`, …) directly | Use the Kerf component that wraps or replaces it (`PopupMenu`, `SegmentedControl`, `Select`, `TabBar`, `LucideIcon`); file a component gap rather than dropping to the raw element. `KUI-L301` (`ui-preferences`, also run by `kerf-ui-doctor`) reports the raw tag and names the replacement |
|
|
318
318
|
| Let a toolbar group wrap, or stack an icon above its label | Keep icon and label on one row and let the group size to its content; relocate whole groups with the toolbar's `responsive` policy |
|
|
@@ -361,6 +361,11 @@ titles at every size; default tone retains existing identity and heading colors.
|
|
|
361
361
|
|
|
362
362
|
Navigation transition continuity: `wireNavStack` slides the incoming view over the preserved previous view on push and the outgoing view off on pop, cross-fades both live chrome surfaces with inert snapshots, and settles/cancels an interrupted transition before starting the next. Reduced motion and duration zero settle immediately.
|
|
363
363
|
|
|
364
|
+
For a tab scene with drill-down, place a `NavStack` directly in `TabNavigatorTab.content`. Give its views structured `toolbar` and `pane` configuration and omit both stack and view `bottomToolbar`; the navigator bar remains the only bottom chrome. Wire the navigator and stack on their respective roots. See `docs/tab-navigator.md` and the catalog's **NavStack inside a tab** example.
|
|
365
|
+
|
|
366
|
+
Use `Pane.deepInset` (also in `PaneConfig`) or `TabNavigatorTab.deepInset` for a plain scene when its scrolling content needs a 16px outer gutter. The extra 8px is applied to the scroll surface, while nested Row/List/Grid item margins stay 8px. When a tab scene is a sole Pane or NavStack, configure deep inset on that child's Pane; the tab bar and top toolbar stay full width.
|
|
367
|
+
An edge-to-edge table or similar Pane child can read `--kui-pane-content-inset-inline-start` and `--kui-pane-content-inset-inline-end`: negate them for the child's logical margins, then add them to the child's text padding. The inherited values include routed safe areas and `deepInset`; keep the child in the Pane's single scroll slot. See `docs/app-layouts.md` for the CSS recipe.
|
|
368
|
+
|
|
364
369
|
Expanded search groups accept `expandedOverflow="visible"` to anchor app-owned suggestion/date/help surfaces below their relative root; collapsed/default groups retain existing clipping. Apps own surface placement/dismissal and use `data-token-search-keep-open` or `collapsible.keepOpenOn` for focus.
|
|
365
370
|
|
|
366
371
|
`ToolbarText` and `ToolbarControlGroup` accept typed `hideBelow`/`showBelow`
|
|
@@ -375,3 +380,9 @@ group. See `docs/component-contract.md` "Toolbar width visibility" for lifecycle
|
|
|
375
380
|
details.
|
|
376
381
|
|
|
377
382
|
Select menus use native viewport shifting with 10px gutters: default menus grow to content (up to 20rem), while `fitMenu` matches trigger width and long labels wrap. Keep popup sizing and position repairs out of consumer CSS.
|
|
383
|
+
|
|
384
|
+
Modal `DialogSurface` accepts a typed `preferredWidth` (`CssLength`) that overrides `size` while retaining the viewport width cap. Typed `viewportGutter` and `maxHeight` (`CssLength` or `"viewport"`) bound the modal; explicit height caps stay within the dynamic viewport minus both gutters. Omitted props preserve Web Awesome defaults. Side-sheet/fullscreen geometry, application responsive choices, and preview layout remain separately owned.
|
|
385
|
+
|
|
386
|
+
Import `@kerfjs/ui/surface-scaffold/register` once when using `DialogSurface`: it registers `wa-dialog` and repairs Web Awesome 3.12 native dialog names before the first modal opening. Headed dialogs reference the rendered title, including live slotted labels; headerless dialogs use the public `label`. Explicit host `aria-label` and pre-existing native names are preserved. Geometry-only markup stays CSS-free and does not register Web Awesome implicitly.
|
|
387
|
+
|
|
388
|
+
Toolbar visibility measurement probes and invisible state children are helper-owned and survive Kerf rerenders through `data-morph-preserve`. Actual CSS visibility stays stable while rendering removes transient parent markers, preventing geometry-driven render feedback and repeated probe recreation. Toolbar replacement, explicit internal-node removal and disposal retain their existing behavior.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Web Awesome JSX signatures for the UI authoring corpus
|
|
2
2
|
|
|
3
|
-
Generated from the emitted `@kerfjs/ui@5.0.0-beta.
|
|
3
|
+
Generated from the emitted `@kerfjs/ui@5.0.0-beta.79` declaration boundary. Import `@kerfjs/ui/webawesome` for type effects when authoring direct `wa-*` JSX. The module emits no runtime behavior and does not register custom elements.
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
import { KerfCustomElement } from 'kerfjs/jsx-runtime';
|
|
@@ -4,6 +4,8 @@ import '../styles/loading-spinner.css';
|
|
|
4
4
|
import '../styles/toolbar-control-group.css';
|
|
5
5
|
import '../styles/skeleton.css';
|
|
6
6
|
import '../styles/toolbar-text.css';
|
|
7
|
+
import '../styles/list.css';
|
|
8
|
+
import '../styles/pane.css';
|
|
7
9
|
import '../styles/lucide-icon.css';
|
|
8
10
|
import '../styles/nav-stack.css';
|
|
9
11
|
export * from '../nav-stack.js';
|
|
@@ -4,6 +4,8 @@ import '../styles/loading-spinner.css';
|
|
|
4
4
|
import '../styles/toolbar-control-group.css';
|
|
5
5
|
import '../styles/skeleton.css';
|
|
6
6
|
import '../styles/toolbar-text.css';
|
|
7
|
+
import '../styles/list.css';
|
|
8
|
+
import '../styles/pane.css';
|
|
7
9
|
import '../styles/lucide-icon.css';
|
|
8
10
|
import '../styles/nav-stack.css';
|
|
9
11
|
import '../styles/resizable-region.css';
|
|
@@ -5,15 +5,15 @@ import './semantic-content-BbzjvSu9.js';
|
|
|
5
5
|
import './sides-BPSWde0A.js';
|
|
6
6
|
import './pane.js';
|
|
7
7
|
import './workbench.js';
|
|
8
|
+
import './nav-stack-B1Qc2e5q.js';
|
|
8
9
|
import './list.js';
|
|
9
10
|
import './flex-alignment-4ms8ZbV8.js';
|
|
10
11
|
import './css-values.js';
|
|
11
|
-
import './nav-stack.js';
|
|
12
|
-
import './toolbar-text.js';
|
|
13
|
-
import './resizable-region.js';
|
|
14
12
|
import './panel-toolbar-CL9tYOkh.js';
|
|
15
13
|
import './lucide-icon.js';
|
|
16
14
|
import 'lucide';
|
|
15
|
+
import './toolbar-text.js';
|
|
16
|
+
import './resizable-region.js';
|
|
17
17
|
|
|
18
18
|
/**
|
|
19
19
|
* Standard resource labels for a Kerf catalog detail footer. Keep these labels
|