@arbidocs/blocks 0.3.185 → 0.4.0

package/dist/shell/Workspace.d.ts

@@ -0,0 +1,90 @@
+import type { ComponentType } from 'react';
+import type { ShellRecentWorkspace, ShellWorkspace, ShellWorkspaceKind } from './types';
+/** The three workspace-kind names (badge title, type glyph name, subtitle). */
+export interface WorkspaceKindLabels {
+    common: string;
+    shared: string;
+    private: string;
+}
+export declare const DEFAULT_WORKSPACE_KIND_LABELS: WorkspaceKindLabels;
+/**
+ * Workspace type drives the initial-badge fill and a quiet secondary glyph:
+ *   private (just you) -> navy, lock      shared (several) -> selection tint, people
+ *   common (public)    -> neutral, globe
+ * Navy is identity and cyan is reserved for ARBI/AI, so "shared" is the selection tint.
+ */
+export declare function workspaceKindMeta(kind: ShellWorkspaceKind, labels?: Partial<WorkspaceKindLabels>): {
+    Icon: ComponentType<{
+        className?: string;
+        'aria-label'?: string;
+        'data-testid'?: string;
+    }>;
+    label: string;
+    fill: string;
+};
+/** The kind's hue as a CSS colour, for glyphs painted by SVG fill (the workspace shield). */
+export declare function workspaceKindColor(kind: ShellWorkspaceKind): string;
+/** Overridable ids of the workspace identity; defaults are the current ids. */
+export type WorkspaceIdentityTestIds = Partial<Record<'initial' | 'type' | 'projectName', string>>;
+export interface WorkspaceIdentityProps {
+    workspace: ShellWorkspace;
+    /** Show name + type/project line beside the badge; otherwise the badge alone. */
+    expanded: boolean;
+    /** Selected (nav-row) styling of the name. */
+    isActive?: boolean;
+    /** Reword the kind names. */
+    labels?: Partial<WorkspaceKindLabels>;
+    /** Part ids; defaults are the current ids. */
+    testIds?: WorkspaceIdentityTestIds;
+}
+/**
+ * Non-interactive guts of the workspace head: the initial badge (with a tiny type glyph) and,
+ * when expanded, the name and the project/type line. Hosted by the switcher trigger and by the
+ * workspace settings header, so it never nests a button.
+ */
+export declare function WorkspaceIdentity({ workspace, expanded, isActive, labels, testIds, }: WorkspaceIdentityProps): import("react").JSX.Element;
+/**
+ * Entity nouns plus the switcher's strings. `plural` arrives lowercased and `singular`
+ * capitalized in the functions below.
+ */
+export interface WorkspaceSwitcherLabels extends WorkspaceKindLabels {
+    /** Entity nouns, e.g. { plural: 'workspaces', singular: 'workspace' }. */
+    plural: string;
+    singular: string;
+    /** The trigger's accessible name. */
+    switchWorkspace: (name: string, plural: string) => string;
+    allWorkspaces: (plural: string) => string;
+    newWorkspace: (singular: string) => string;
+    recentWorkspaces: (plural: string) => string;
+}
+export declare const DEFAULT_WORKSPACE_SWITCHER_LABELS: WorkspaceSwitcherLabels;
+export interface WorkspaceSwitcherProps {
+    workspace: ShellWorkspace;
+    /** Other workspaces to jump to (the app orders and caps them). */
+    recent?: ShellRecentWorkspace[];
+    /** Icon-only trigger (the sidebar rail). */
+    compact?: boolean;
+    /** `appbar`: the phone app bar's title, name + chevron on one line. */
+    variant?: 'sidebar' | 'appbar';
+    onSwitch: (workspace: ShellWorkspace) => void;
+    /** Return to the workspaces list; leaves the workspace open. */
+    onGoToList: () => void;
+    onNewWorkspace: () => void;
+    /** Entity nouns and menu strings; any subset (the nouns default to workspace(s)). */
+    labels?: Partial<WorkspaceSwitcherLabels>;
+    className?: string;
+    /** Trigger id (default `workspace-switcher-trigger`). */
+    testId?: string;
+    /**
+     * Part ids; defaults are the current ids. `switchItem`, `type` and `lastSeen` are prefixes
+     * (`<prefix>-<workspace id>`).
+     */
+    testIds?: Partial<Record<'menu' | 'all' | 'new' | 'switchItem' | 'type' | 'lastSeen', string>>;
+    /** Ids forwarded to the trigger's workspace identity. */
+    identityTestIds?: WorkspaceIdentityTestIds;
+}
+/**
+ * The current-workspace control as a dropdown: "All workspaces", "New workspace", then the
+ * recent workspaces to jump straight into.
+ */
+export declare function WorkspaceSwitcher({ workspace, recent, compact, variant, onSwitch, onGoToList, onNewWorkspace, labels, className, testId, testIds, identityTestIds, }: WorkspaceSwitcherProps): import("react").JSX.Element;

package/dist/shell/index.cjs

@@ -0,0 +1,187 @@
+"use client";
+'use strict';
+
+var chunk7G3JNSJB_cjs = require('../chunk-7G3JNSJB.cjs');
+require('../chunk-OB5F4577.cjs');
+require('../chunk-SCFYPAG6.cjs');
+var chunk5B4PXAKI_cjs = require('../chunk-5B4PXAKI.cjs');
+require('../chunk-PPCATBOY.cjs');
+require('../chunk-C54XEN5T.cjs');
+require('../chunk-MHVNT4J3.cjs');
+
+
+
+Object.defineProperty(exports, "ActionCluster", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.ActionCluster; }
+});
+Object.defineProperty(exports, "AskField", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.AskField; }
+});
+Object.defineProperty(exports, "AskRow", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.AskRow; }
+});
+Object.defineProperty(exports, "AskTrigger", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.AskTrigger; }
+});
+Object.defineProperty(exports, "DEFAULT_ASK_FIELD_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_ASK_FIELD_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_MOBILE_BARS_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_MOBILE_BARS_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_OFFLINE_PILL_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_OFFLINE_PILL_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_OVERLAY_ZONE_ID", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_OVERLAY_ZONE_ID; }
+});
+Object.defineProperty(exports, "DEFAULT_PAGE_CONTAINER_PADDING", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_PAGE_CONTAINER_PADDING; }
+});
+Object.defineProperty(exports, "DEFAULT_REMOTE_CONTROL_PILL_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_REMOTE_CONTROL_PILL_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_SIDEBAR_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_SIDEBAR_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_SIDEBAR_TOGGLE_BUTTON_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_SIDEBAR_TOGGLE_BUTTON_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_TIP_CARD_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_TIP_CARD_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_WORKSPACE_KIND_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_WORKSPACE_KIND_LABELS; }
+});
+Object.defineProperty(exports, "DEFAULT_WORKSPACE_SWITCHER_LABELS", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.DEFAULT_WORKSPACE_SWITCHER_LABELS; }
+});
+Object.defineProperty(exports, "InfoBar", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.InfoBar; }
+});
+Object.defineProperty(exports, "MobileAppBar", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.MobileAppBar; }
+});
+Object.defineProperty(exports, "MobileTabBar", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.MobileTabBar; }
+});
+Object.defineProperty(exports, "NotificationBell", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.NotificationBell; }
+});
+Object.defineProperty(exports, "OfflinePill", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.OfflinePill; }
+});
+Object.defineProperty(exports, "PageContainer", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.PageContainer; }
+});
+Object.defineProperty(exports, "RemoteControlPill", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.RemoteControlPill; }
+});
+Object.defineProperty(exports, "Shell", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.Shell; }
+});
+Object.defineProperty(exports, "Sidebar", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.Sidebar; }
+});
+Object.defineProperty(exports, "SidebarBadgeRow", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.SidebarBadgeRow; }
+});
+Object.defineProperty(exports, "SidebarRowAction", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.SidebarRowAction; }
+});
+Object.defineProperty(exports, "SidebarRowHoverContext", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.SidebarRowHoverContext; }
+});
+Object.defineProperty(exports, "SidebarToggleButton", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.SidebarToggleButton; }
+});
+Object.defineProperty(exports, "StatusRow", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.StatusRow; }
+});
+Object.defineProperty(exports, "TipCard", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.TipCard; }
+});
+Object.defineProperty(exports, "ToolButton", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.ToolButton; }
+});
+Object.defineProperty(exports, "UserMenu", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.UserMenu; }
+});
+Object.defineProperty(exports, "WorkspaceIdentity", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.WorkspaceIdentity; }
+});
+Object.defineProperty(exports, "WorkspaceSwitcher", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.WorkspaceSwitcher; }
+});
+Object.defineProperty(exports, "resolveSidebarLayout", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.resolveSidebarLayout; }
+});
+Object.defineProperty(exports, "useDrawerBehavior", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.useDrawerBehavior; }
+});
+Object.defineProperty(exports, "useOverlayZoneId", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.useOverlayZoneId; }
+});
+Object.defineProperty(exports, "useSidebarContext", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.useSidebarContext; }
+});
+Object.defineProperty(exports, "useSidebarSettle", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.useSidebarSettle; }
+});
+Object.defineProperty(exports, "workspaceKindColor", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.workspaceKindColor; }
+});
+Object.defineProperty(exports, "workspaceKindMeta", {
+  enumerable: true,
+  get: function () { return chunk7G3JNSJB_cjs.workspaceKindMeta; }
+});
+Object.defineProperty(exports, "DEFAULT_TAB_HEADER_LABELS", {
+  enumerable: true,
+  get: function () { return chunk5B4PXAKI_cjs.DEFAULT_TAB_HEADER_LABELS; }
+});
+Object.defineProperty(exports, "TabHeader", {
+  enumerable: true,
+  get: function () { return chunk5B4PXAKI_cjs.TabHeader; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/shell/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/shell/index.d.ts

@@ -0,0 +1,20 @@
+export { Shell, PageContainer, SidebarToggleButton, DEFAULT_SIDEBAR_TOGGLE_BUTTON_LABELS, DEFAULT_OVERLAY_ZONE_ID, DEFAULT_PAGE_CONTAINER_PADDING, useOverlayZoneId, type ShellRootProps, type ShellContentProps, type ShellTopbarProps, type ShellDockProps, type PageContainerProps, type SidebarToggleButtonProps, type SidebarToggleButtonLabels, } from './Shell';
+export { Sidebar, SidebarRowHoverContext, DEFAULT_SIDEBAR_LABELS, useSidebarContext, type SidebarRootProps, type SidebarNavProps, type SidebarNavItemProps, type SidebarSectionProps, type SidebarGroupProps, type SidebarPinToggleProps, type SidebarDrawerHeaderProps, type SidebarLabels, } from './Sidebar';
+export { SidebarBadgeRow, type SidebarBadgeRowProps } from './SidebarBadgeRow';
+export { SidebarRowAction, type SidebarRowActionProps, type SidebarRowActionPulse, } from './SidebarRowAction';
+export { WorkspaceSwitcher, WorkspaceIdentity, workspaceKindMeta, workspaceKindColor, DEFAULT_WORKSPACE_KIND_LABELS, DEFAULT_WORKSPACE_SWITCHER_LABELS, type WorkspaceSwitcherProps, type WorkspaceIdentityProps, type WorkspaceKindLabels, type WorkspaceSwitcherLabels, } from './Workspace';
+export { AskField, AskTrigger, AskRow, DEFAULT_ASK_FIELD_LABELS, type AskFieldLabels, type AskFieldProps, type AskTriggerProps, type AskRowProps, } from './AskField';
+export { MobileAppBar, MobileTabBar, DEFAULT_MOBILE_BARS_LABELS, type MobileBarsLabels, type MobileAppBarProps, type MobileTabBarProps, } from './MobileBars';
+export { ActionCluster, type ActionClusterProps } from './ActionCluster';
+export { ToolButton, type ToolButtonProps } from './ToolButton';
+export { StatusRow, type StatusRowProps, type StatusRowTone } from './StatusRow';
+export { OfflinePill, DEFAULT_OFFLINE_PILL_LABELS, type OfflinePillLabels, type OfflinePillProps, type OfflinePillTone, } from './OfflinePill';
+export { RemoteControlPill, DEFAULT_REMOTE_CONTROL_PILL_LABELS, type RemoteControlPillLabels, type RemoteControlPillProps, } from './RemoteControlPill';
+export { TipCard, DEFAULT_TIP_CARD_LABELS, type TipCardLabels, type TipCardProps } from './TipCard';
+export { TabHeader, DEFAULT_TAB_HEADER_LABELS, type Tab, type TabHeaderLabels, type TabHeaderProps, } from './TabHeader';
+export type { NavItem, ShellActionLayout, ShellRecentWorkspace, ShellWorkspace, ShellWorkspaceKind, } from './types';
+export { useDrawerBehavior } from '../lib/use-drawer';
+export { resolveSidebarLayout, useSidebarSettle, type SidebarLayout, type SidebarMode, type SidebarModeInput, } from '../lib/sidebar-mode';
+export { InfoBar, type InfoBarProps, type InfoBarVariant } from './InfoBar';
+export { UserMenu, type UserMenuProps, type UserMenuItem, type UserMenuStatus, } from '@arbidocs/react/ui';
+export { NotificationBell, type NotificationBellProps } from '@arbidocs/react/shell';

package/dist/shell/index.js

@@ -0,0 +1,10 @@
+"use client";
+export { ActionCluster, AskField, AskRow, AskTrigger, DEFAULT_ASK_FIELD_LABELS, DEFAULT_MOBILE_BARS_LABELS, DEFAULT_OFFLINE_PILL_LABELS, DEFAULT_OVERLAY_ZONE_ID, DEFAULT_PAGE_CONTAINER_PADDING, DEFAULT_REMOTE_CONTROL_PILL_LABELS, DEFAULT_SIDEBAR_LABELS, DEFAULT_SIDEBAR_TOGGLE_BUTTON_LABELS, DEFAULT_TIP_CARD_LABELS, DEFAULT_WORKSPACE_KIND_LABELS, DEFAULT_WORKSPACE_SWITCHER_LABELS, InfoBar, MobileAppBar, MobileTabBar, NotificationBell, OfflinePill, PageContainer, RemoteControlPill, Shell, Sidebar, SidebarBadgeRow, SidebarRowAction, SidebarRowHoverContext, SidebarToggleButton, StatusRow, TipCard, ToolButton, UserMenu, WorkspaceIdentity, WorkspaceSwitcher, resolveSidebarLayout, useDrawerBehavior, useOverlayZoneId, useSidebarContext, useSidebarSettle, workspaceKindColor, workspaceKindMeta } from '../chunk-5TYEJOXY.js';
+import '../chunk-S7PSMMRG.js';
+import '../chunk-YDHO4AVL.js';
+export { DEFAULT_TAB_HEADER_LABELS, TabHeader } from '../chunk-UBNVIIBT.js';
+import '../chunk-NPLYHR2E.js';
+import '../chunk-76JDDMSP.js';
+import '../chunk-7F6CBP3Z.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/shell/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/shell/sidebar-context.d.ts

@@ -0,0 +1,19 @@
+/** Fixed strings of the sidebar family. Set once on `Sidebar.Root`; parts read them from context. */
+export interface SidebarLabels {
+    /** The sidebar's accessible name (the Root `aria-label` prop wins). */
+    mainNavigation: string;
+    hideSidebar: string;
+    showSidebar: string;
+    /** The drawer's close button (the `closeLabel` prop wins). */
+    closeNavigationMenu: string;
+}
+export declare const DEFAULT_SIDEBAR_LABELS: SidebarLabels;
+export interface SidebarContextValue {
+    /** Labels are visible (full width), as opposed to the icon-only rail. */
+    expanded: boolean;
+    labels: SidebarLabels;
+}
+export declare const SidebarContext: import("react").Context<SidebarContextValue>;
+export declare const useSidebarContext: () => SidebarContextValue;
+/** True while the surrounding row is hovered/focused; trailing controls may brighten on it. */
+export declare const SidebarRowHoverContext: import("react").Context<boolean>;

package/dist/shell/types.d.ts

@@ -0,0 +1,48 @@
+import type { ReactNode } from 'react';
+/**
+ * One destination in the sidebar rail/drawer or the phone tab bar. Plain data: the app decides
+ * which items exist, which is active and what selecting one does (router, store, panels).
+ */
+export interface NavItem {
+    /** Stable key; also the suffix of the mobile tab test id (`mobile-tab-{id}`). */
+    id: string;
+    label: string;
+    /** Glyph (compose any status dot into it). */
+    icon: ReactNode;
+    active?: boolean;
+    onSelect: () => void;
+    /**
+     * Real link target. The row renders as an anchor (ctrl-click / new tab, in-SPA through
+     * `BlocksProvider`'s `linkComponent`); `onSelect` still fires on a plain click. Ignored while
+     * `disabled`.
+     */
+    href?: string;
+    /** Quiet number shown at the row's right edge (0 is shown; `undefined` hides it). */
+    count?: number;
+    /** Glyph rendered beside the count (e.g. a members icon). */
+    countIcon?: ReactNode;
+    /** `data-testid` of the sidebar row. */
+    testId?: string;
+    disabled?: boolean;
+    /** Inline control after the count; may be interactive (the row is not a native button). */
+    trailing?: ReactNode;
+}
+export type ShellActionLayout = 'bar' | 'sidebar' | 'rail' | 'drawer';
+/** Workspace visibility: drives the initial-badge tone and the small type glyph. */
+export type ShellWorkspaceKind = 'private' | 'shared' | 'common';
+/** The slice of a workspace the shell shows (the app adapts its API type to this). */
+export interface ShellWorkspace {
+    id: string;
+    name: string;
+    kind: ShellWorkspaceKind;
+    description?: string | null;
+    /** Owning project name; when set, replaces the kind line under the name. */
+    projectName?: string | null;
+    /** Rendered project pill (the app supplies its own entity pill). */
+    projectLine?: ReactNode;
+}
+/** A recently opened workspace offered in the switcher menu. */
+export interface ShellRecentWorkspace extends ShellWorkspace {
+    /** Pre-formatted "last seen" text. */
+    lastSeen?: string;
+}