@k2b/ui 0.21.0 → 0.22.0

package/dist/types/layout/PageTitle.d.ts

@@ -0,0 +1,64 @@
+import { type JSX } from "solid-js";
+/** A page above the current one. Only pages someone can go back to are levels, so each has a link. */
+export type PageTrailLink = {
+    title: string;
+    href: string;
+};
+/** The current page and the pages above it, nearest last. */
+export type PageTrailState = {
+    title: string;
+    ancestors: PageTrailLink[];
+};
+export type PageTitleProps = {
+    trail: PageTrailState;
+    /** Quiet text after the title, for example a count. */
+    subtitle?: JSX.Element;
+    /** Defaults to `"h1"`. Chrome that repeats a title the page already shows uses `"p"`. */
+    as?: "h1" | "h2" | "p";
+    /**
+     * Marks a title drawn by surrounding chrome, such as the workspace head or a
+     * host shell. It steps back when the page renders its own `PageTitle`, so a
+     * page has one title with one way up.
+     */
+    fallback?: boolean;
+    class?: string;
+};
+/** Window event a host dispatches after publishing a new page trail. */
+export declare const PAGE_TRAIL_EVENT = "k2b:page-trail";
+/** The trail a host published for this document, or `undefined` outside a browser or without one. */
+export declare const readPageTrail: () => PageTrailState | undefined;
+/**
+ * Publishes a new trail for the document in the browser, for example after an
+ * in-page navigation. Workspace heads and page titles that read the host's
+ * trail follow it.
+ */
+export declare const setPageTrail: (trail: PageTrailState) => void;
+/**
+ * Gives a host's page trail to everything below it. During server rendering
+ * the context carries it; the provider also publishes it into the document,
+ * where browser-rendered parts such as islands read it. Below a provider that
+ * renders in the browser, its `trail` prop is the source: update the prop.
+ */
+export declare function PageTrailProvider(props: {
+    trail: PageTrailState | undefined;
+    children: JSX.Element;
+}): JSX.Element;
+/** The host's page trail: from the provider while rendering below it, otherwise from the document. */
+export declare const usePageTrail: () => (() => PageTrailState | undefined);
+/**
+ * A page title with its way up. The number of pages above decides the form:
+ * none shows the title alone; one puts "‹ Parent" above it; more put a path
+ * row above it whose middle collapses into "…" only when it does not fit.
+ * Both rows share the same height, so the title never moves between depths.
+ * On phones a back arrow left of the title replaces the row above.
+ */
+export declare function PageTitle(props: PageTitleProps): JSX.Element;
+/**
+ * Keeps server-rendered titles of the host's trail current: a workspace head
+ * that never hydrates, and an app's own header title from the host's trail.
+ * When the host publishes a new trail, for example after `setPageTrail()`,
+ * each such title is replaced in place by a live one with the same element,
+ * class, and subtitle, and a head learns whether it now has a page above it.
+ * Titles inside islands render in the browser anyway. Returns the disposer.
+ */
+export declare const followPageTrail: (root?: ParentNode) => (() => void);

package/dist/types/layout/app-workspace-controller.d.ts

@@ -9,4 +9,8 @@ export type AppWorkspaceControllerOptions = {
  * stays application state, so the controller only requests the change.
  */
 export declare const APP_WORKSPACE_SIDEBAR_HIDE_EVENT = "k2b-app-workspace-sidebar-hide";
+/** Asks the owning `AppWorkspace.Detail` to close; its `onClose` decides. */
+export declare const APP_WORKSPACE_DETAIL_CLOSE_EVENT = "k2b-app-workspace-detail-close";
+/** Asks the owning `AppWorkspace.Detail` for the previous or next item, as `detail.direction` of `-1` or `1`. */
+export declare const APP_WORKSPACE_DETAIL_STEP_EVENT = "k2b-app-workspace-detail-step";
 export declare const installAppWorkspaceController: (options?: AppWorkspaceControllerOptions) => (() => void);

package/dist/types/layout/app-workspace-state.d.ts

@@ -11,8 +11,9 @@ export declare const APP_WORKSPACE_SIDEBAR_COLLAPSED = 64;
 export declare const APP_WORKSPACE_SIDEBAR_COLLAPSE_THRESHOLD = 128;
 export declare const APP_WORKSPACE_SIDEBAR_MIN = 176;
 export declare const APP_WORKSPACE_SIDEBAR_MAX = 360;
-export declare const APP_WORKSPACE_DETAIL_DEFAULT = 384;
-export declare const APP_WORKSPACE_DETAIL_MIN = 288;
+/** The floating detail panel starts at 26 rem and keeps between 20 and 40 rem. */
+export declare const APP_WORKSPACE_DETAIL_DEFAULT = 416;
+export declare const APP_WORKSPACE_DETAIL_MIN = 320;
 export declare const APP_WORKSPACE_DETAIL_MAX = 640;
 export declare const APP_WORKSPACE_DRAWER_DEFAULT = 240;
 export declare const APP_WORKSPACE_DRAWER_MIN = 160;

package/dist/types/layout/floating-window-messages.d.ts

@@ -0,0 +1,12 @@
+declare const floatingWindowMessages: import("@k2b/stdlib").Catalog<{
+    closeWindow: string;
+    moveWindow: ({ title }: {
+        title: string;
+    }) => string;
+    resizeWindow: string;
+}>;
+export type FloatingWindowMessages = ReturnType<(typeof floatingWindowMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const useFloatingWindowMessages: () => (() => FloatingWindowMessages);
+export declare const checkFloatingWindowMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/layout/index.d.ts

@@ -19,6 +19,8 @@ export type { MobileShellHeaderProps, MobileShellProps } from "./MobileShell";
 export { default as MobileShell, observeMobileShell } from "./MobileShell";
 export { default as Navigation, type NavigationProps } from "./Navigation";
 export { createNavigation, findNavigationItem, type NavigationController, type NavigationItem, type NavigationOptions, type NavigationStatus, } from "./navigation-model";
+export type { PageTitleProps, PageTrailLink, PageTrailState } from "./PageTitle";
+export { followPageTrail, PAGE_TRAIL_EVENT, PageTitle, PageTrailProvider, readPageTrail, setPageTrail, usePageTrail } from "./PageTitle";
 export type { PanelDialogBodyProps, PanelDialogFooterProps, PanelDialogHeaderProps, PanelDialogProps, PanelDialogSectionProps, PanelDialogSurface, PanelDialogTabOption, PanelDialogTabsProps, } from "./PanelDialog";
 export { confirmDiscardIfDirty, default as PanelDialog, panelDialogFixedOptions, panelDialogFixedPanelClass, panelDialogOptions, panelDialogPanelClass, panelDialogWideOptions, panelDialogWidePanelClass, panelDialogWorkspaceOptions, panelDialogWorkspacePanelClass, } from "./PanelDialog";
 export type { PanelHeaderProps } from "./PanelHeader";
@@ -27,6 +29,7 @@ export type { PanesItem, PanesProps } from "./Panes";
 export { default as Panes } from "./Panes";
 export type { PullToRefreshProps, PullToRefreshState } from "./PullToRefresh";
 export { default as PullToRefresh } from "./PullToRefresh";
+export { installPageTitleController } from "./page-title-controller";
 export type { AddPanesItemOptions, PanesDirection, PanesGroup, PanesIntent, PanesLayout, PanesNode, PanesPath, PanesPathSegment, PanesSide, PanesSplit, } from "./panes-layout";
 export { activatePanesItem, addPanesItem, applyPanesIntent, createPanesLayout, isPanesItemVisible, PANES_LAYOUT_VERSION, parsePanesLayout, reconcilePanesLayout, removePanesItem, resizePanesSplit, } from "./panes-layout";
 export type { ScrollAreaProps } from "./ScrollArea";

package/dist/types/layout/navigation-model.d.ts

@@ -48,17 +48,24 @@ export type NavigationItem = NavigationEntry & ({
     navigation?: "document" | "enhanced";
     scroll?: NavigationScrollMode;
     section?: never;
+    keepOpen?: never;
 } | {
     action: string;
     href?: never;
     navigation?: never;
     scroll?: never;
     section?: never;
+    /**
+     * Runs the action while the host's menu stays open, without `beforeSelect`. Only for an action that changes
+     * what the menu shows, such as a filter or a sort order; an action that opens something lets the menu close.
+     */
+    keepOpen?: boolean;
 } | {
     href?: never;
     action?: never;
     navigation?: never;
     scroll?: never;
+    keepOpen?: never;
     children: readonly NavigationItem[];
     /** Shows the group as a plain heading over its rows, always open and not indented, instead of a disclosure. */
     section?: boolean;

package/dist/types/layout/page-title-controller.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Marks the root of a controller. A controller owns the titles whose nearest
+ * marked ancestor is its root, so a title that installed its own controller
+ * before the document's keeps it, and a title inside a marked root installs
+ * none.
+ */
+export declare const PAGE_TITLE_CONTROLLER_ATTRIBUTE = "data-k2b-page-title-controller";
+/**
+ * Collapses every page title path under `root` to the space it has and runs
+ * the "…" menu of the hidden levels. Titles that appear later, for example
+ * when an island renders, are picked up as well. Returns the disposer.
+ */
+export declare const installPageTitleController: (root?: Element | Document) => (() => void);

package/dist/types/layout/panel-dialog-messages.d.ts

@@ -0,0 +1,8 @@
+declare const panelDialogMessages: import("@k2b/stdlib").Catalog<{
+    dialogTabs: string;
+}>;
+export type PanelDialogMessages = ReturnType<(typeof panelDialogMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const usePanelDialogMessages: () => (() => PanelDialogMessages);
+export declare const checkPanelDialogMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/layout/panes-messages.d.ts

@@ -0,0 +1,22 @@
+declare const panesMessages: import("@k2b/stdlib").Catalog<{
+    addPane: string;
+    addToNamed: ({ name }: {
+        name: string;
+    }) => string;
+    insertBeforeNamed: ({ name }: {
+        name: string;
+    }) => string;
+    insertAtEnd: string;
+    addPaneSide: ({ side, name }: {
+        side: "left" | "right" | "top" | "bottom";
+        name: string;
+    }) => string;
+    paneTabs: string;
+    paneWorkspace: string;
+    resizePanes: string;
+}>;
+export type PanesMessages = ReturnType<(typeof panesMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const usePanesMessages: () => (() => PanesMessages);
+export declare const checkPanesMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/layout/refresh-messages.d.ts

@@ -0,0 +1,8 @@
+declare const refreshMessages: import("@k2b/stdlib").Catalog<{
+    refreshing: string;
+}>;
+export type RefreshMessages = ReturnType<(typeof refreshMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const useRefreshMessages: () => (() => RefreshMessages);
+export declare const checkRefreshMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/layout/settings-messages.d.ts

@@ -0,0 +1,25 @@
+declare const settingsMessages: import("@k2b/stdlib").Catalog<{
+    sectionsLabel: ({ title }: {
+        title: string;
+    }) => string;
+    moveDown: string;
+    moveUp: string;
+    moveNamedDown: ({ label }: {
+        label: string;
+    }) => string;
+    moveNamedUp: ({ label }: {
+        label: string;
+    }) => string;
+    saveChanges: string;
+    saving: string;
+    unsaved: string;
+    unsavedChangeLabel: ({ count }: {
+        count: number;
+    }) => string;
+    noUnsavedChanges: string;
+}>;
+export type SettingsMessages = ReturnType<(typeof settingsMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const useSettingsMessages: () => (() => SettingsMessages);
+export declare const checkSettingsMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/layout/workspace-messages.d.ts

@@ -0,0 +1,26 @@
+declare const workspaceMessages: import("@k2b/stdlib").Catalog<{
+    rowAction: string;
+    sidebarUnread: ({ count }: {
+        count: number;
+    }) => string;
+    sidebarUnreadMany: string;
+    sidebarNewActivity: string;
+    sidebarMentioned: string;
+    sidebarMuted: string;
+    resizeNavigation: string;
+    resizeWorkspacePane: string;
+    resizeDetailPanel: string;
+    detailFullHeight: string;
+    resizeBottomDrawer: string;
+    showNavigation: string;
+    backTo: ({ page }: {
+        page: string;
+    }) => string;
+    path: string;
+    moreLevels: string;
+}>;
+export type WorkspaceMessages = ReturnType<(typeof workspaceMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const useWorkspaceMessages: () => (() => WorkspaceMessages);
+export declare const checkWorkspaceMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/surfaces/avatar-messages.d.ts

@@ -0,0 +1,11 @@
+declare const avatarMessages: import("@k2b/stdlib").Catalog<{
+    avatarLabel: ({ name }: {
+        name: string;
+    }) => string;
+    unknownUser: string;
+}>;
+export type AvatarMessages = ReturnType<(typeof avatarMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const useAvatarMessages: () => (() => AvatarMessages);
+export declare const checkAvatarMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/surfaces/resource-messages.d.ts

@@ -0,0 +1,11 @@
+declare const resourceMessages: import("@k2b/stdlib").Catalog<{
+    resourceUntitled: string;
+    resourceNoAccess: string;
+    resourceDeleted: string;
+    resourceUnavailable: string;
+}>;
+export type ResourceMessages = ReturnType<(typeof resourceMessages)["resolve"]>["t"];
+/** Resolved from the inherited render locale. */
+export declare const useResourceMessages: () => (() => ResourceMessages);
+export declare const checkResourceMessages: () => import("@k2b/stdlib").CatalogIssue[];
+export {};

package/dist/types/widgets/Widget.d.ts

@@ -1,5 +1,9 @@
 import { type JSX } from "solid-js";
-export type WidgetSize = "content" | "compact" | "standard";
+/**
+ * `standard` is 25rem high and `compact` 14rem; `fill` takes the height its container gives it, such as a grid cell,
+ * and `content` has no fixed height. Every size except `content` scrolls body content taller than itself.
+ */
+export type WidgetSize = "content" | "compact" | "standard" | "fill";
 export type WidgetProps = {
     title: string;
     icon?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k2b/ui",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "Production-ready components for SolidJS applications.",
   "repository": {
     "type": "git",