@exxatdesignux/ui 0.2.18 → 0.3.0

package/dist/components/templates/list-page.d.ts

@@ -0,0 +1,83 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { DataListViewType } from '../../lib/data-list-view.js';
+import { OpenTablePropertiesHandle } from '../../lib/list-page-table-properties.js';
+import '../../data-list-view-registry-CyBoBML4.js';
+
+type ViewType = DataListViewType;
+/** Same labels/icons as Properties drawer `SelectionTileGrid` — single source in `DATA_LIST_VIEW_TILES`. */
+declare const VIEW_TYPES: {
+    type: ViewType;
+    label: string;
+    icon: string;
+}[];
+interface FilterOption {
+    id: string;
+    label: string;
+}
+interface ViewTab {
+    id: string;
+    label: string;
+    viewType: ViewType;
+    icon: string;
+    /** Optional filter key for lifecycle or category-based filtering */
+    filterId: string;
+}
+interface ListPageTemplateProps {
+    /** Page header — rendered above metrics */
+    header: React.ReactNode;
+    /** Optional metrics strip — rendered below header */
+    metrics?: React.ReactNode;
+    /** Whether to show metrics (controlled externally) */
+    showMetrics?: boolean;
+    /** Initial tabs (uncontrolled mode) */
+    defaultTabs: ViewTab[];
+    /**
+     * Controlled tabs — when all four are provided, tab state is owned by the parent
+     * (e.g. for localStorage). Otherwise `defaultTabs` + internal state are used.
+     */
+    tabs?: ViewTab[];
+    onTabsChange?: (tabs: ViewTab[]) => void;
+    activeTabId?: string;
+    onActiveTabChange?: (id: string) => void;
+    /** Filter options per tab (e.g. All, Upcoming, Ongoing, Completed) */
+    filterOptions?: FilterOption[];
+    /** Label for the filter sub-menu (default: "Filter") */
+    filterLabel?: string;
+    /** Get count for a tab's filter (for badge) */
+    getTabCount?: (filterId: string) => number;
+    /** Render the content for the active tab */
+    renderContent: (tab: ViewTab, updateTab: (patch: Partial<ViewTab>) => void) => React.ReactNode;
+    /** Export drawer props */
+    exportOpen?: boolean;
+    onExportOpenChange?: (open: boolean) => void;
+    /** Row count for export; if omitted, uses `getTabCount(activeTab.filterId)` when provided */
+    exportTotalRows?: number;
+    /**
+     * Tab menu — “Edit” (e.g. open table properties). Parent can switch to table view first, then call ref.
+     * Overrides `tablePropertiesRef` when both are set.
+     */
+    onEditView?: (tab: ViewTab, helpers: {
+        updateTab: (patch: Partial<ViewTab>) => void;
+    }) => void;
+    /**
+     * Ref to the active tab’s table surface (`openPropertiesDrawer`). Wires “View → Edit” to
+     * `TablePropertiesDrawer` when `onEditView` is omitted.
+     */
+    tablePropertiesRef?: React.RefObject<OpenTablePropertiesHandle | null>;
+    /** When true, hide the views tab strip (tabs + add view) — e.g. search landing with a single table surface. */
+    hideViewsToolbar?: boolean;
+    /**
+     * Subset of view types the hub actually implements (e.g. List hub omits Dashboard/Folder).
+     * When set, the Add view menu and ⌘1–9 shortcuts are filtered so users cannot add a view the
+     * hub cannot render. Defaults to all registered view types (`DATA_LIST_VIEW_TILES`).
+     *
+     * Pair with `TablePropertiesDrawerButton.supportedViewTypes` to keep Properties consistent.
+     */
+    supportedViewTypes?: readonly DataListViewType[];
+}
+/** Count pill on the views toolbar — color by lifecycle/status filter (WCAG: dark text on light inactive; light text on solid active). */
+declare function viewToolbarCountBadgeClass(filterId: string, isActive: boolean): string;
+declare function ListPageTemplate({ header, metrics, showMetrics, defaultTabs, tabs: tabsProp, onTabsChange, activeTabId: activeTabIdProp, onActiveTabChange, getTabCount, renderContent, exportOpen, onExportOpenChange, exportTotalRows, onEditView, tablePropertiesRef, hideViewsToolbar, supportedViewTypes, }: ListPageTemplateProps): react_jsx_runtime.JSX.Element;
+
+export { type FilterOption, ListPageTemplate, type ListPageTemplateProps, VIEW_TYPES, type ViewTab, type ViewType, viewToolbarCountBadgeClass };