@squadbase/vantage 0.6.2-dev1.ac99e02 → 0.6.2-dev1.d7c0911

package/registry/ui/progress.tsx

@@ -1,5 +1,7 @@
 // Copied by `vantage add ui progress`. This file is yours to edit.
-// Generated from @squadbase/vantage src/ui/progress.tsx by `npm run registry` (in Vantage, edit src/, not registry/).
+// Generated from @squadbase/squadkit registry/ui/progress.tsx by `npm run registry` (in Vantage, edit packages/squadkit, not registry/).
+"use client"
+
 import { Progress as ProgressPrimitive } from "@base-ui/react/progress"
 
 import { cn } from "@squadbase/vantage/ui"

package/registry/ui/radio-group.tsx

@@ -1,5 +1,5 @@
 // Copied by `vantage add ui radio-group`. This file is yours to edit.
-// Generated from @squadbase/vantage src/ui/radio-group.tsx by `npm run registry` (in Vantage, edit src/, not registry/).
+// Generated from @squadbase/squadkit registry/ui/radio-group.tsx by `npm run registry` (in Vantage, edit packages/squadkit, not registry/).
 "use client"
 
 import { Radio as RadioPrimitive } from "@base-ui/react/radio"

package/registry/ui/sample-data.tsx

@@ -0,0 +1,86 @@
+// Copied by `vantage add ui sample-data`. This file is yours to edit.
+// Generated from @squadbase/squadkit registry/components/sample-data.tsx by `npm run registry` (in Vantage, edit packages/squadkit, not registry/).
+"use client"
+
+/**
+ * SampleData — marks the values inside it as a sample: they are not connected to real data yet
+ * (a draft laid out before its queries are wired, a screen built from column definitions only).
+ * Not the same as `provisional` on KpiCard and the charts, which means 速報 — real values that are
+ * not final yet. For a single value in running text or a heading, use `Placeholder` instead.
+ *
+ * - **No box of its own.** It renders `display: contents`, so the grid / subgrid of the parent
+ *   still sees the cards inside as its direct children (KpiCard rows keep lining up).
+ * - **The card shows the mark.** The nearest `KpiCard` or `DashboardCardPreset` inside it puts a
+ *   `SampleBadge` in its header, once (also while loading): a card claims the mark, so the parts
+ *   anywhere inside that card (body, actions, footer) do not repeat it. Put a bare chart in a
+ *   `DashboardCardPreset` to have it marked.
+ * - The mark is a word, not only a colour (`--warning` on `--warning-subtle`), and its
+ *   `title` says what it means.
+ *
+ * @example
+ * import { SampleData } from "@/components/sample-data"
+ * // Vantage: import { SampleData } from "@squadbase/vantage/components"
+ * <SampleData>
+ *   <KpiCard label="売上" value={12400000} format={{ type: "currency", currency: "JPY" }} />
+ * </SampleData>
+ */
+import { createContext, useContext, useMemo, type HTMLAttributes, type ReactNode } from "react"
+
+import { cn } from "@squadbase/vantage/ui"
+import { Badge } from "@squadbase/vantage/ui"
+
+export const DEFAULT_SAMPLE_LABEL = "見本の値"
+const SAMPLE_TITLE = "実データにまだつながっていない見本の値です"
+
+interface SampleState {
+  label: string
+}
+
+const SampleContext = createContext<SampleState | null>(null)
+
+/**
+ * The mark a card inside `SampleData` should show, or null. A card that shows it wraps its
+ * content in `<SampleClaim>` so the parts inside do not show it again.
+ */
+export function useSampleMark(): SampleState | null {
+  return useContext(SampleContext)
+}
+
+/** Ends the `SampleData` scope for the parts inside a card that already shows the mark. */
+export function SampleClaim({ children }: { children?: ReactNode }) {
+  return <SampleContext.Provider value={null}>{children}</SampleContext.Provider>
+}
+
+export interface SampleBadgeProps extends HTMLAttributes<HTMLSpanElement> {
+  /** 印の文言。既定「見本の値」。 */
+  label?: string
+}
+
+export function SampleBadge({ label = DEFAULT_SAMPLE_LABEL, className, ...props }: SampleBadgeProps) {
+  return (
+    <Badge
+      data-slot="sample-badge"
+      title={SAMPLE_TITLE}
+      className={cn("border-warning/30 bg-warning-subtle text-warning align-middle", className)}
+      {...props}
+    >
+      {label}
+    </Badge>
+  )
+}
+
+export interface SampleDataProps {
+  /** 印の文言。既定「見本の値」。 */
+  label?: string
+  children?: ReactNode
+}
+
+export function SampleData({ label = DEFAULT_SAMPLE_LABEL, children }: SampleDataProps) {
+  // A stable value, so the cards inside do not re-render when only the parent does.
+  const state = useMemo(() => ({ label }), [label])
+  return (
+    <div data-slot="sample-data" style={{ display: "contents" }}>
+      <SampleContext.Provider value={state}>{children}</SampleContext.Provider>
+    </div>
+  )
+}