@rackbops/ui-react 0.2.33 → 0.2.35

package/dist/EmptyState.d.ts

@@ -0,0 +1,38 @@
+import { type ReactNode } from "react";
+import { type CardProps } from "./Card.js";
+export interface EmptyStateProps extends Omit<CardProps, "title"> {
+    /**
+     * A heading naming what is missing ("No cards yet", "Select a panel"), replacing the native
+     * HTML `title` tooltip attribute -- there's no way to set a real tooltip through this
+     * component (same trade-off as `Alert`/`Dialog`'s `title`). Required and typed
+     * `NonNullable<ReactNode>` (not plain `ReactNode`) so passing an optional value straight
+     * through (`title={label}` where `label?: string`) is a compile error rather than a silently
+     * empty, unlabelled heading inside the `role="status"` region -- the one thing this component
+     * exists to avoid. `NonNullable` only catches an explicit `null`/`undefined` reaching the prop
+     * directly: an explicit `false`/`""`/`0`, an empty array, or `undefined` laundered through a
+     * fragment (`title={<>{maybeLabel}</>}`) all still compile and still render an empty heading --
+     * each is the caller's responsibility, same as passing empty `children` anywhere else in this
+     * library.
+     */
+    title: NonNullable<ReactNode>;
+    /** Optional call to action -- a Button or a link -- rendered after the guidance. */
+    action?: ReactNode;
+    /** Heading level for `title`; default 3. Falls back to 3 for a value outside 2-4 reached
+     * through an untyped caller or a cast, so a bad value degrades to a real heading instead of an
+     * invalid tag name. */
+    level?: 2 | 3 | 4;
+}
+/**
+ * An empty-guidance surface: a Card with `role="status"` holding a heading, optional guidance
+ * (`children`) and an optional action. It never renders a spinner or progress indicator -- an
+ * empty state is a fact stated in words, so "still loading" and "genuinely empty" are never
+ * shown the same way as a stalled spinner. Composes `Card` and adds no class of its own (the
+ * LinksIndex precedent); first consumer Rackbops/artifact-console#45.
+ *
+ * `role="status"` is a live region: like any live region it does not announce on first paint
+ * (a page that renders straight into several empty panels announces nothing), and it is meant
+ * for a state that appears or changes after mount (content loading in, then coming back empty),
+ * not for text that changes on every keystroke -- reusing one instance for a live search query
+ * would re-announce the whole card, action button included, on every character.
+ */
+export declare const EmptyState: import("react").ForwardRefExoticComponent<Omit<EmptyStateProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>;

package/dist/EmptyState.js

@@ -0,0 +1,24 @@
+import { jsxs as _jsxs } from "react/jsx-runtime";
+import { createElement, forwardRef } from "react";
+import { Card } from "./Card.js";
+// Must stay in sync with the `level` union below -- a caller relying on this list to guard
+// every valid level would silently stop doing so if the type widened without this following.
+const VALID_LEVELS = [2, 3, 4];
+/**
+ * An empty-guidance surface: a Card with `role="status"` holding a heading, optional guidance
+ * (`children`) and an optional action. It never renders a spinner or progress indicator -- an
+ * empty state is a fact stated in words, so "still loading" and "genuinely empty" are never
+ * shown the same way as a stalled spinner. Composes `Card` and adds no class of its own (the
+ * LinksIndex precedent); first consumer Rackbops/artifact-console#45.
+ *
+ * `role="status"` is a live region: like any live region it does not announce on first paint
+ * (a page that renders straight into several empty panels announces nothing), and it is meant
+ * for a state that appears or changes after mount (content loading in, then coming back empty),
+ * not for text that changes on every keystroke -- reusing one instance for a live search query
+ * would re-announce the whole card, action button included, on every character.
+ */
+export const EmptyState = forwardRef(function EmptyState({ title, action, level = 3, children, ...rest }, ref) {
+    const heading = `h${VALID_LEVELS.includes(level) ? level : 3}`;
+    return (_jsxs(Card, { ref: ref, role: "status", ...rest, children: [createElement(heading, null, title), children, action] }));
+});
+EmptyState.displayName = "EmptyState";

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { Button, type ButtonProps } from "./Button.js";
 export { Card, type CardProps } from "./Card.js";
+export { EmptyState, type EmptyStateProps } from "./EmptyState.js";
 export { NavLink, type NavLinkProps } from "./NavLink.js";
 export { NavRail, type NavRailProps, type NavRailItem } from "./NavRail.js";
 export { Input, Textarea, Select, Label, Field, Checkbox, Radio, Switch, type InputProps, type TextareaProps, type SelectProps, type LabelProps, type FieldProps, type ChoiceProps, } from "./form.js";

package/dist/index.js

@@ -1,5 +1,6 @@
 export { Button } from "./Button.js";
 export { Card } from "./Card.js";
+export { EmptyState } from "./EmptyState.js";
 export { NavLink } from "./NavLink.js";
 export { NavRail } from "./NavRail.js";
 export { Input, Textarea, Select, Label, Field, Checkbox, Radio, Switch, } from "./form.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rackbops/ui-react",
-  "version": "0.2.33",
+  "version": "0.2.35",
   "description": "React components styled by @rackbops/styles rackbops themes.",
   "license": "MIT",
   "repository": {