@mieweb/ui 0.10.0-dev.11 → 0.10.0-dev.12

package/dist/index-DoYYWsNc.d.ts

@@ -0,0 +1,127 @@
+import * as class_variance_authority_types from 'class-variance-authority/types';
+import * as React from 'react';
+import { VariantProps } from 'class-variance-authority';
+
+/**
+ * The contract every component in the `Modules/Views` family reads through.
+ *
+ * A page describes its collection once — which field is the id, the title, the
+ * status, the start date — and every view understands it. That is the whole
+ * reason the family exists: without it each view needs its own adapter and you
+ * end up re-implementing the same board per entity.
+ *
+ * Views are headless. Nothing here fetches, subscribes, or navigates.
+ * See CONTRIBUTING → "Modules: headless data components".
+ */
+
+/**
+ * Which layout is on screen. `overview` and `table` are rendered by the host
+ * through `ViewSet` slots rather than by a component in this family — a tabular
+ * collection is `DataVisNitroGrid`, and an overview is domain content.
+ */
+type ViewId = 'overview' | 'list' | 'board' | 'calendar' | 'gantt' | 'roadmap' | 'table';
+/**
+ * A semantic colour name, resolved to `--mieweb-*` tokens by each view.
+ *
+ * Accessors return one of these rather than a class string so a caller cannot
+ * hardcode a palette that breaks under another brand or in dark mode.
+ */
+type Accent = 'primary' | 'success' | 'warning' | 'destructive' | 'info' | 'neutral';
+/** A named stage: a board column, and the segments of a stage bar. */
+interface Stage {
+    id: string;
+    label: string;
+    accent?: Accent;
+}
+/**
+ * How a view reads one item. Only `getId` and `getTitle` are always required;
+ * each view documents which of the rest it needs (a board needs `getStatus`, a
+ * Gantt needs `getStart`) and renders an explanatory empty state without them.
+ */
+interface ViewAccessors<T> {
+    getId: (item: T) => string;
+    getTitle: (item: T) => string;
+    /** Secondary line under the title. */
+    getSubtitle?: (item: T) => string | undefined;
+    /** Board column and list group; matched against `Stage['id']`. */
+    getStatus?: (item: T) => string;
+    /** Gantt bar start, calendar placement. */
+    getStart?: (item: T) => Date | string | null | undefined;
+    /** Gantt bar end, calendar span. Falls back to the start when absent. */
+    getEnd?: (item: T) => Date | string | null | undefined;
+    /** Swimlane in a roadmap, row group in a Gantt. */
+    getGroup?: (item: T) => string | undefined;
+    getAccent?: (item: T) => Accent;
+}
+/** Strings a view renders. Every one is overridable; the defaults are English. */
+interface ViewLabels {
+    /** Accessible name of the view switcher group. */
+    viewSwitcher: string;
+    loading: string;
+    empty: string;
+    error: string;
+    /** Action on the error state. */
+    retry: string;
+    /** Heading for the group a record with no status or group falls into. */
+    ungrouped: string;
+}
+/**
+ * Props every view accepts. Views are controlled: selection, the active view and
+ * filter state live in the page, and every change is handed back.
+ */
+interface ViewBaseProps<T> {
+    items: T[];
+    accessors: ViewAccessors<T>;
+    loading?: boolean;
+    error?: Error | null;
+    selectedId?: string | null;
+    /** Called when the user activates an item. */
+    onOpen?: (id: string, item: T) => void;
+    /** Return a URL to render each item as a real anchor — middle-clickable and crawlable. */
+    getHref?: (id: string, item: T) => string;
+    /** Render one item. Receives the active view so one function can serve several. */
+    renderItem?: (item: T, context: {
+        view: ViewId;
+    }) => React.ReactNode;
+    /** Replaces the built-in empty state. */
+    emptyState?: React.ReactNode;
+    labels?: Partial<ViewLabels>;
+    /** Pins "today" so stories, tests and visual snapshots stay deterministic. */
+    now?: Date;
+    className?: string;
+}
+
+interface ViewOption {
+    id: ViewId;
+    /** Overrides the built-in English label. */
+    label?: string;
+    /** Overrides the built-in icon. */
+    icon?: React.ComponentType<{
+        className?: string;
+        'aria-hidden'?: boolean;
+    }>;
+    disabled?: boolean;
+}
+interface ViewSwitcherProps extends VariantProps<typeof viewSwitcherVariants> {
+    /** Views to offer, in order. Accepts bare ids or `ViewOption`s. */
+    views: readonly (ViewId | ViewOption)[];
+    value: ViewId;
+    onValueChange: (view: ViewId) => void;
+    /** Accessible name of the group. */
+    label?: string;
+    /** Show labels beside the icons. `responsive` hides them below `sm`. */
+    showLabels?: boolean | 'responsive';
+    className?: string;
+    classNames?: Partial<Record<'option' | 'activeOption', string>>;
+}
+declare const viewSwitcherVariants: (props?: ({
+    size?: "sm" | "md" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+/**
+ * Keyboard model is a radio group: one tab stop, arrows move *and* select.
+ * Every option is visible, so moving the selection is the whole interaction —
+ * there is nothing to "commit" afterwards.
+ */
+declare const ViewSwitcher: React.ForwardRefExoticComponent<ViewSwitcherProps & React.RefAttributes<HTMLDivElement>>;
+
+export { type Stage as S, type ViewBaseProps as V, type ViewLabels as a, type ViewId as b, type ViewOption as c, ViewSwitcher as d, type ViewSwitcherProps as e, viewSwitcherVariants as v };