@northstar-js/react 0.0.0-stage → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/actions.d.ts +99 -0
- package/dist/actions.d.ts.map +1 -0
- package/dist/actions.js +61 -0
- package/dist/actions.js.map +1 -0
- package/dist/backdrops/StarBackdrop.d.ts +31 -0
- package/dist/backdrops/StarBackdrop.d.ts.map +1 -0
- package/dist/backdrops/StarBackdrop.js +84 -0
- package/dist/backdrops/StarBackdrop.js.map +1 -0
- package/dist/backdrops/index.d.ts +7 -0
- package/dist/backdrops/index.d.ts.map +1 -0
- package/dist/backdrops/index.js +8 -0
- package/dist/backdrops/index.js.map +1 -0
- package/dist/backdrops/math.d.ts +39 -0
- package/dist/backdrops/math.d.ts.map +1 -0
- package/dist/backdrops/math.js +44 -0
- package/dist/backdrops/math.js.map +1 -0
- package/dist/backdrops/scenes.d.ts +20 -0
- package/dist/backdrops/scenes.d.ts.map +1 -0
- package/dist/backdrops/scenes.js +417 -0
- package/dist/backdrops/scenes.js.map +1 -0
- package/dist/backdrops.css +141 -0
- package/dist/data.d.ts +91 -0
- package/dist/data.d.ts.map +1 -0
- package/dist/data.js +69 -0
- package/dist/data.js.map +1 -0
- package/dist/effects/actions.d.ts +48 -0
- package/dist/effects/actions.d.ts.map +1 -0
- package/dist/effects/actions.js +80 -0
- package/dist/effects/actions.js.map +1 -0
- package/dist/effects/controls.d.ts +84 -0
- package/dist/effects/controls.d.ts.map +1 -0
- package/dist/effects/controls.js +121 -0
- package/dist/effects/controls.js.map +1 -0
- package/dist/effects/display.d.ts +92 -0
- package/dist/effects/display.d.ts.map +1 -0
- package/dist/effects/display.js +138 -0
- package/dist/effects/display.js.map +1 -0
- package/dist/effects/hooks.d.ts +13 -0
- package/dist/effects/hooks.d.ts.map +1 -0
- package/dist/effects/hooks.js +68 -0
- package/dist/effects/hooks.js.map +1 -0
- package/dist/effects/index.d.ts +14 -0
- package/dist/effects/index.d.ts.map +1 -0
- package/dist/effects/index.js +12 -0
- package/dist/effects/index.js.map +1 -0
- package/dist/effects/loaders.d.ts +67 -0
- package/dist/effects/loaders.d.ts.map +1 -0
- package/dist/effects/loaders.js +73 -0
- package/dist/effects/loaders.js.map +1 -0
- package/dist/effects/math.d.ts +23 -0
- package/dist/effects/math.d.ts.map +1 -0
- package/dist/effects/math.js +56 -0
- package/dist/effects/math.js.map +1 -0
- package/dist/effects/navigation.d.ts +55 -0
- package/dist/effects/navigation.d.ts.map +1 -0
- package/dist/effects/navigation.js +103 -0
- package/dist/effects/navigation.js.map +1 -0
- package/dist/effects/overlays.d.ts +34 -0
- package/dist/effects/overlays.d.ts.map +1 -0
- package/dist/effects/overlays.js +56 -0
- package/dist/effects/overlays.js.map +1 -0
- package/dist/effects.css +1659 -0
- package/dist/feedback.d.ts +55 -0
- package/dist/feedback.d.ts.map +1 -0
- package/dist/feedback.js +60 -0
- package/dist/feedback.js.map +1 -0
- package/dist/flow.d.ts +70 -0
- package/dist/flow.d.ts.map +1 -0
- package/dist/flow.js +118 -0
- package/dist/flow.js.map +1 -0
- package/dist/forms.d.ts +130 -0
- package/dist/forms.d.ts.map +1 -0
- package/dist/forms.js +241 -0
- package/dist/forms.js.map +1 -0
- package/dist/glass.d.ts +74 -0
- package/dist/glass.d.ts.map +1 -0
- package/dist/glass.js +139 -0
- package/dist/glass.js.map +1 -0
- package/dist/illustrations/data.d.ts +103 -0
- package/dist/illustrations/data.d.ts.map +1 -0
- package/dist/illustrations/data.js +3 -0
- package/dist/illustrations/data.js.map +1 -0
- package/dist/illustrations/index.d.ts +110 -0
- package/dist/illustrations/index.d.ts.map +1 -0
- package/dist/illustrations/index.js +54 -0
- package/dist/illustrations/index.js.map +1 -0
- package/dist/illustrations/types.d.ts +30 -0
- package/dist/illustrations/types.d.ts.map +1 -0
- package/dist/illustrations/types.js +2 -0
- package/dist/illustrations/types.js.map +1 -0
- package/dist/index.d.ts +27 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +13 -0
- package/dist/index.js.map +1 -0
- package/dist/internal/expand.d.ts +17 -0
- package/dist/internal/expand.d.ts.map +1 -0
- package/dist/internal/expand.js +23 -0
- package/dist/internal/expand.js.map +1 -0
- package/dist/internal/icons.d.ts +9 -0
- package/dist/internal/icons.d.ts.map +1 -0
- package/dist/internal/icons.js +12 -0
- package/dist/internal/icons.js.map +1 -0
- package/dist/internal/interaction.d.ts +21 -0
- package/dist/internal/interaction.d.ts.map +1 -0
- package/dist/internal/interaction.js +129 -0
- package/dist/internal/interaction.js.map +1 -0
- package/dist/internal/layers.d.ts +12 -0
- package/dist/internal/layers.d.ts.map +1 -0
- package/dist/internal/layers.js +108 -0
- package/dist/internal/layers.js.map +1 -0
- package/dist/internal/util.d.ts +9 -0
- package/dist/internal/util.d.ts.map +1 -0
- package/dist/internal/util.js +33 -0
- package/dist/internal/util.js.map +1 -0
- package/dist/layout.d.ts +34 -0
- package/dist/layout.d.ts.map +1 -0
- package/dist/layout.js +27 -0
- package/dist/layout.js.map +1 -0
- package/dist/motion.d.ts +36 -0
- package/dist/motion.d.ts.map +1 -0
- package/dist/motion.js +80 -0
- package/dist/motion.js.map +1 -0
- package/dist/navigation.d.ts +100 -0
- package/dist/navigation.d.ts.map +1 -0
- package/dist/navigation.js +154 -0
- package/dist/navigation.js.map +1 -0
- package/dist/northstar/BriefForm.d.ts +23 -0
- package/dist/northstar/BriefForm.d.ts.map +1 -0
- package/dist/northstar/BriefForm.js +40 -0
- package/dist/northstar/BriefForm.js.map +1 -0
- package/dist/northstar/ExportMenu.d.ts +16 -0
- package/dist/northstar/ExportMenu.d.ts.map +1 -0
- package/dist/northstar/ExportMenu.js +11 -0
- package/dist/northstar/ExportMenu.js.map +1 -0
- package/dist/northstar/PopulationPanel.d.ts +30 -0
- package/dist/northstar/PopulationPanel.d.ts.map +1 -0
- package/dist/northstar/PopulationPanel.js +18 -0
- package/dist/northstar/PopulationPanel.js.map +1 -0
- package/dist/northstar/ResearchBuilder.d.ts +26 -0
- package/dist/northstar/ResearchBuilder.d.ts.map +1 -0
- package/dist/northstar/ResearchBuilder.js +81 -0
- package/dist/northstar/ResearchBuilder.js.map +1 -0
- package/dist/northstar/ResponsesView.d.ts +20 -0
- package/dist/northstar/ResponsesView.d.ts.map +1 -0
- package/dist/northstar/ResponsesView.js +42 -0
- package/dist/northstar/ResponsesView.js.map +1 -0
- package/dist/northstar/Run.d.ts +37 -0
- package/dist/northstar/Run.d.ts.map +1 -0
- package/dist/northstar/Run.js +32 -0
- package/dist/northstar/Run.js.map +1 -0
- package/dist/northstar/StudyShell.d.ts +50 -0
- package/dist/northstar/StudyShell.d.ts.map +1 -0
- package/dist/northstar/StudyShell.js +18 -0
- package/dist/northstar/StudyShell.js.map +1 -0
- package/dist/northstar/StudyStatus.d.ts +17 -0
- package/dist/northstar/StudyStatus.d.ts.map +1 -0
- package/dist/northstar/StudyStatus.js +26 -0
- package/dist/northstar/StudyStatus.js.map +1 -0
- package/dist/northstar/index.d.ts +10 -0
- package/dist/northstar/index.d.ts.map +1 -0
- package/dist/northstar/index.js +10 -0
- package/dist/northstar/index.js.map +1 -0
- package/dist/northstar/messages.d.ts +84 -0
- package/dist/northstar/messages.d.ts.map +1 -0
- package/dist/northstar/messages.js +107 -0
- package/dist/northstar/messages.js.map +1 -0
- package/dist/overlays.d.ts +136 -0
- package/dist/overlays.d.ts.map +1 -0
- package/dist/overlays.js +447 -0
- package/dist/overlays.js.map +1 -0
- package/dist/provider.d.ts +82 -0
- package/dist/provider.d.ts.map +1 -0
- package/dist/provider.js +128 -0
- package/dist/provider.js.map +1 -0
- package/dist/styles.css +2033 -0
- package/dist/surface.d.ts +58 -0
- package/dist/surface.d.ts.map +1 -0
- package/dist/surface.js +39 -0
- package/dist/surface.js.map +1 -0
- package/package.json +81 -3
- package/README.md +0 -3
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { type Material } from './provider.js';
|
|
2
|
+
import { type Tone } from './internal/util.js';
|
|
3
|
+
export interface ToastOptions {
|
|
4
|
+
title: React.ReactNode;
|
|
5
|
+
description?: React.ReactNode;
|
|
6
|
+
tone?: Tone;
|
|
7
|
+
/** ms before auto-dismiss; 0 keeps it until dismissed. Default 5000. */
|
|
8
|
+
duration?: number;
|
|
9
|
+
action?: {
|
|
10
|
+
label: string;
|
|
11
|
+
onClick: () => void;
|
|
12
|
+
};
|
|
13
|
+
id?: string;
|
|
14
|
+
/** `glass` or `solid`. Defaults to the provider's material. */
|
|
15
|
+
material?: Material;
|
|
16
|
+
}
|
|
17
|
+
export interface ToastRecord extends ToastOptions {
|
|
18
|
+
id: string;
|
|
19
|
+
}
|
|
20
|
+
/** Imperative toaster. Render one <Toaster /> near the root. */
|
|
21
|
+
export declare const toast: ((options: ToastOptions) => string) & {
|
|
22
|
+
dismiss(id?: string): void;
|
|
23
|
+
};
|
|
24
|
+
export declare function useToasts(): ToastRecord[];
|
|
25
|
+
export interface ToastProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
|
|
26
|
+
title: React.ReactNode;
|
|
27
|
+
description?: React.ReactNode;
|
|
28
|
+
tone?: Tone;
|
|
29
|
+
action?: {
|
|
30
|
+
label: string;
|
|
31
|
+
onClick: () => void;
|
|
32
|
+
};
|
|
33
|
+
onDismiss?: () => void;
|
|
34
|
+
/** `glass` or `solid`. Defaults to the provider's material. */
|
|
35
|
+
material?: Material;
|
|
36
|
+
}
|
|
37
|
+
/** One toast surface. Usually rendered by <Toaster />. */
|
|
38
|
+
export declare function Toast({ title, description, tone, action, onDismiss, material, className, ...rest }: ToastProps): import("react/jsx-runtime").JSX.Element;
|
|
39
|
+
export interface ToasterProps {
|
|
40
|
+
position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | 'bottom-center';
|
|
41
|
+
}
|
|
42
|
+
/** Polite live region that shows toasts queued with `toast()`. */
|
|
43
|
+
export declare function Toaster({ position }: ToasterProps): import("react/jsx-runtime").JSX.Element;
|
|
44
|
+
export interface BannerProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
|
|
45
|
+
title?: React.ReactNode;
|
|
46
|
+
tone?: Tone;
|
|
47
|
+
/** Urgent banners interrupt the screen reader (role="alert"). */
|
|
48
|
+
urgent?: boolean;
|
|
49
|
+
icon?: React.ReactNode;
|
|
50
|
+
actions?: React.ReactNode;
|
|
51
|
+
onDismiss?: () => void;
|
|
52
|
+
}
|
|
53
|
+
/** Page- or section-level message. Status is told by label and shape, never by red or green. */
|
|
54
|
+
export declare function Banner({ title, tone, urgent, icon, actions, onDismiss, className, children, ...rest }: BannerProps): import("react/jsx-runtime").JSX.Element;
|
|
55
|
+
//# sourceMappingURL=feedback.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../src/feedback.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAM,KAAK,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAKnD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,EAAE,EAAE,MAAM,CAAC;CACZ;AASD,gEAAgE;AAChE,eAAO,MAAM,KAAK,aACN,YAAY,KAAG,MAAM;iBAOhB,MAAM;CAKtB,CAAC;AAOF,wBAAgB,SAAS,IAAI,WAAW,EAAE,CAEzC;AAED,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IACrF,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC;IAChD,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,0DAA0D;AAC1D,wBAAgB,KAAK,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,UAAU,2CAoB1H;AAmBD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,cAAc,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,GAAG,eAAe,CAAC;CACxF;AAED,kEAAkE;AAClE,wBAAgB,OAAO,CAAC,EAAE,QAAyB,EAAE,EAAE,YAAY,2CAgBlE;AAID,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IACtF,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,iEAAiE;IACjE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAED,gGAAgG;AAChG,wBAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,IAAgB,EAAE,MAAc,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,WAAW,2CAiBtI"}
|
package/dist/feedback.js
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
3
|
+
import { useEffect, useRef, useSyncExternalStore } from 'react';
|
|
4
|
+
import { Portal, useNorthstar } from './provider.js';
|
|
5
|
+
import { cx } from './internal/util.js';
|
|
6
|
+
import { Close } from './internal/icons.js';
|
|
7
|
+
let toasts = [];
|
|
8
|
+
const listeners = new Set();
|
|
9
|
+
let seq = 0;
|
|
10
|
+
const emit = () => listeners.forEach((l) => l());
|
|
11
|
+
const EMPTY = [];
|
|
12
|
+
/** Imperative toaster. Render one <Toaster /> near the root. */
|
|
13
|
+
export const toast = Object.assign((options) => {
|
|
14
|
+
const id = options.id ?? `ns-toast-${++seq}`;
|
|
15
|
+
toasts = [...toasts.filter((t) => t.id !== id), { ...options, id }];
|
|
16
|
+
emit();
|
|
17
|
+
return id;
|
|
18
|
+
}, {
|
|
19
|
+
dismiss(id) {
|
|
20
|
+
toasts = id ? toasts.filter((t) => t.id !== id) : [];
|
|
21
|
+
emit();
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
function subscribe(l) {
|
|
25
|
+
listeners.add(l);
|
|
26
|
+
return () => listeners.delete(l);
|
|
27
|
+
}
|
|
28
|
+
export function useToasts() {
|
|
29
|
+
return useSyncExternalStore(subscribe, () => toasts, () => EMPTY);
|
|
30
|
+
}
|
|
31
|
+
/** One toast surface. Usually rendered by <Toaster />. */
|
|
32
|
+
export function Toast({ title, description, tone = 'neutral', action, onDismiss, material, className, ...rest }) {
|
|
33
|
+
const { messages, material: fallback } = useNorthstar();
|
|
34
|
+
return (_jsxs("div", { ...rest, className: cx('ns-toast', `ns-material--${material ?? fallback}`, tone === 'signal' && 'ns-tone-signal', className), children: [_jsxs("div", { className: "ns-toast__text", children: [_jsx("div", { className: "ns-toast__title", children: title }), description && _jsx("div", { className: "ns-toast__description", children: description })] }), action && (_jsx("button", { type: "button", className: "ns-button ns-button--secondary ns-size-sm", onClick: action.onClick, children: action.label })), onDismiss && (_jsx("button", { type: "button", className: "ns-button ns-button--ghost ns-size-sm ns-icon-button", "aria-label": messages.dismiss, onClick: onDismiss, children: _jsx(Close, {}) }))] }));
|
|
35
|
+
}
|
|
36
|
+
function TimedToast({ record }) {
|
|
37
|
+
const { id, duration = 5000, ...rest } = record;
|
|
38
|
+
const timer = useRef(undefined);
|
|
39
|
+
const start = () => {
|
|
40
|
+
if (duration > 0)
|
|
41
|
+
timer.current = setTimeout(() => toast.dismiss(id), duration);
|
|
42
|
+
};
|
|
43
|
+
useEffect(() => {
|
|
44
|
+
start();
|
|
45
|
+
return () => clearTimeout(timer.current);
|
|
46
|
+
}, [id, duration]);
|
|
47
|
+
return (_jsx("li", { className: "ns-toaster__item", onPointerEnter: () => clearTimeout(timer.current), onPointerLeave: start, children: _jsx(Toast, { ...rest, onDismiss: () => toast.dismiss(id) }) }));
|
|
48
|
+
}
|
|
49
|
+
/** Polite live region that shows toasts queued with `toast()`. */
|
|
50
|
+
export function Toaster({ position = 'bottom-right' }) {
|
|
51
|
+
const list = useToasts();
|
|
52
|
+
const { messages } = useNorthstar();
|
|
53
|
+
return (_jsx(Portal, { children: _jsx("section", { "aria-label": messages.notifications, className: cx('ns-toaster', `ns-toaster--${position}`), children: _jsx("div", { role: "status", "aria-live": "polite", children: _jsx("ol", { className: "ns-toaster__list", children: list.map((t) => (_jsx(TimedToast, { record: t }, t.id))) }) }) }) }));
|
|
54
|
+
}
|
|
55
|
+
/** Page- or section-level message. Status is told by label and shape, never by red or green. */
|
|
56
|
+
export function Banner({ title, tone = 'neutral', urgent = false, icon, actions, onDismiss, className, children, ...rest }) {
|
|
57
|
+
const { messages } = useNorthstar();
|
|
58
|
+
return (_jsxs("div", { role: urgent ? 'alert' : 'status', ...rest, className: cx('ns-banner', tone === 'signal' && 'ns-tone-signal', className), children: [icon && _jsx("span", { className: "ns-banner__icon", "aria-hidden": "true", children: icon }), _jsxs("div", { className: "ns-banner__text", children: [title && _jsx("strong", { className: "ns-banner__title", children: title }), children && _jsx("div", { className: "ns-banner__body", children: children })] }), actions && _jsx("div", { className: "ns-banner__actions", children: actions }), onDismiss && (_jsx("button", { type: "button", className: "ns-button ns-button--ghost ns-size-sm ns-icon-button", "aria-label": messages.dismiss, onClick: onDismiss, children: _jsx(Close, {}) }))] }));
|
|
59
|
+
}
|
|
60
|
+
//# sourceMappingURL=feedback.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feedback.js","sourceRoot":"","sources":["../src/feedback.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AACb,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAiB,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,EAAE,EAAa,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAqB5C,IAAI,MAAM,GAAkB,EAAE,CAAC;AAC/B,MAAM,SAAS,GAAG,IAAI,GAAG,EAAY,CAAC;AACtC,IAAI,GAAG,GAAG,CAAC,CAAC;AACZ,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AACjD,MAAM,KAAK,GAAkB,EAAE,CAAC;AAEhC,gEAAgE;AAChE,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAChC,CAAC,OAAqB,EAAU,EAAE;IAChC,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,IAAI,YAAY,EAAE,GAAG,EAAE,CAAC;IAC7C,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IACpE,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;AACZ,CAAC,EACD;IACE,OAAO,CAAC,EAAW;QACjB,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,IAAI,EAAE,CAAC;IACT,CAAC;CACF,CACF,CAAC;AAEF,SAAS,SAAS,CAAC,CAAW;IAC5B,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,OAAO,oBAAoB,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAYD,0DAA0D;AAC1D,MAAM,UAAU,KAAK,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,GAAG,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,EAAc;IACzH,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IACxD,OAAO,CACL,kBAAS,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,UAAU,EAAE,gBAAgB,QAAQ,IAAI,QAAQ,EAAE,EAAE,IAAI,KAAK,QAAQ,IAAI,gBAAgB,EAAE,SAAS,CAAC,aAChI,eAAK,SAAS,EAAC,gBAAgB,aAC7B,cAAK,SAAS,EAAC,iBAAiB,YAAE,KAAK,GAAO,EAC7C,WAAW,IAAI,cAAK,SAAS,EAAC,uBAAuB,YAAE,WAAW,GAAO,IACtE,EACL,MAAM,IAAI,CACT,iBAAQ,IAAI,EAAC,QAAQ,EAAC,SAAS,EAAC,2CAA2C,EAAC,OAAO,EAAE,MAAM,CAAC,OAAO,YAChG,MAAM,CAAC,KAAK,GACN,CACV,EACA,SAAS,IAAI,CACZ,iBAAQ,IAAI,EAAC,QAAQ,EAAC,SAAS,EAAC,sDAAsD,gBAAa,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,YACrI,KAAC,KAAK,KAAG,GACF,CACV,IACG,CACP,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,EAAE,MAAM,EAA2B;IACrD,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IAChD,MAAM,KAAK,GAAG,MAAM,CAA4C,SAAS,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,IAAI,QAAQ,GAAG,CAAC;YAAE,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,EAAE,CAAC;QACR,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;IACnB,OAAO,CACL,aAAI,SAAS,EAAC,kBAAkB,EAAC,cAAc,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,KAAK,YACvG,KAAC,KAAK,OAAK,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,GAAI,GACpD,CACN,CAAC;AACJ,CAAC;AAMD,kEAAkE;AAClE,MAAM,UAAU,OAAO,CAAC,EAAE,QAAQ,GAAG,cAAc,EAAgB;IACjE,MAAM,IAAI,GAAG,SAAS,EAAE,CAAC;IACzB,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IACpC,OAAO,CACL,KAAC,MAAM,cACL,gCAAqB,QAAQ,CAAC,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,YAAY,EAAE,eAAe,QAAQ,EAAE,CAAC,YACjG,cAAK,IAAI,EAAC,QAAQ,eAAW,QAAQ,YACnC,aAAI,SAAS,EAAC,kBAAkB,YAC7B,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CACf,KAAC,UAAU,IAAY,MAAM,EAAE,CAAC,IAAf,CAAC,CAAC,EAAE,CAAe,CACrC,CAAC,GACC,GACD,GACE,GACH,CACV,CAAC;AACJ,CAAC;AAcD,gGAAgG;AAChG,MAAM,UAAU,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAe;IACrI,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IACpC,OAAO,CACL,eAAK,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,KAAM,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,WAAW,EAAE,IAAI,KAAK,QAAQ,IAAI,gBAAgB,EAAE,SAAS,CAAC,aAC3H,IAAI,IAAI,eAAM,SAAS,EAAC,iBAAiB,iBAAa,MAAM,YAAE,IAAI,GAAQ,EAC3E,eAAK,SAAS,EAAC,iBAAiB,aAC7B,KAAK,IAAI,iBAAQ,SAAS,EAAC,kBAAkB,YAAE,KAAK,GAAU,EAC9D,QAAQ,IAAI,cAAK,SAAS,EAAC,iBAAiB,YAAE,QAAQ,GAAO,IAC1D,EACL,OAAO,IAAI,cAAK,SAAS,EAAC,oBAAoB,YAAE,OAAO,GAAO,EAC9D,SAAS,IAAI,CACZ,iBAAQ,IAAI,EAAC,QAAQ,EAAC,SAAS,EAAC,sDAAsD,gBAAa,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,YACrI,KAAC,KAAK,KAAG,GACF,CACV,IACG,CACP,CAAC;AACJ,CAAC"}
|
package/dist/flow.d.ts
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { type ButtonProps } from './actions.js';
|
|
2
|
+
export interface FlowStepProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
|
|
3
|
+
value: string;
|
|
4
|
+
title: React.ReactNode;
|
|
5
|
+
/** Plain-text title for announcements; defaults to `title` when it is a string. */
|
|
6
|
+
textTitle?: string;
|
|
7
|
+
description?: React.ReactNode;
|
|
8
|
+
icon?: React.ReactNode;
|
|
9
|
+
/** Marks the step done even when it is not behind the current one. */
|
|
10
|
+
complete?: boolean;
|
|
11
|
+
/** Blocks NextAction from leaving this step. */
|
|
12
|
+
blocked?: boolean | undefined;
|
|
13
|
+
}
|
|
14
|
+
interface FlowContextValue {
|
|
15
|
+
value: string;
|
|
16
|
+
index: number;
|
|
17
|
+
count: number;
|
|
18
|
+
steps: FlowStepProps[];
|
|
19
|
+
baseId: string;
|
|
20
|
+
go: (value: string) => void;
|
|
21
|
+
next: () => void;
|
|
22
|
+
back: () => void;
|
|
23
|
+
onComplete?: (() => void) | undefined;
|
|
24
|
+
}
|
|
25
|
+
/** The current flow, or null outside one. */
|
|
26
|
+
export declare function useFlow(): FlowContextValue | null;
|
|
27
|
+
export interface FlowStepsProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'defaultValue' | 'onChange'> {
|
|
28
|
+
value?: string;
|
|
29
|
+
defaultValue?: string;
|
|
30
|
+
onValueChange?: (value: string) => void;
|
|
31
|
+
/** Called when NextAction is pressed on the last step. */
|
|
32
|
+
onComplete?: (() => void) | undefined;
|
|
33
|
+
/** Only completed steps and the next one can be jumped to. Default true. */
|
|
34
|
+
linear?: boolean;
|
|
35
|
+
/** Accessible name of the step list. */
|
|
36
|
+
label?: string;
|
|
37
|
+
/** Hide the step list and show only the progress rail. */
|
|
38
|
+
compact?: boolean;
|
|
39
|
+
children: React.ReactNode;
|
|
40
|
+
}
|
|
41
|
+
export declare function FlowSteps({ value, defaultValue, onValueChange, onComplete, linear, label, compact, className, children, ...rest }: FlowStepsProps): import("react/jsx-runtime").JSX.Element;
|
|
42
|
+
/** One step. Renders only while it is the current step. */
|
|
43
|
+
export declare function FlowStep({ value, title, textTitle, description, icon, complete, blocked, className, children, ...rest }: FlowStepProps): import("react/jsx-runtime").JSX.Element;
|
|
44
|
+
export interface NextActionProps extends Omit<ButtonProps, 'variant'> {
|
|
45
|
+
/** Shows a quiet Back button before the next action. Default true inside a flow. */
|
|
46
|
+
showBack?: boolean;
|
|
47
|
+
/** Label on the last step. */
|
|
48
|
+
finishLabel?: React.ReactNode | undefined;
|
|
49
|
+
/** Secondary content between Back and the next action (a hint, a cost). */
|
|
50
|
+
hint?: React.ReactNode | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* Back is icon-first: the arrow shows and "Back" eases open on hover and
|
|
53
|
+
* focus (always on touch). `always` keeps the word; false shows it plainly.
|
|
54
|
+
* The next action itself always shows its full label. Default true.
|
|
55
|
+
*/
|
|
56
|
+
backExpand?: boolean | 'always';
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* The one clear next action. Inside FlowSteps it advances (and names the step
|
|
60
|
+
* it leads to); on the last step it calls `onComplete`. Outside a flow it is a
|
|
61
|
+
* primary button with a trailing arrow that slides on hover.
|
|
62
|
+
*/
|
|
63
|
+
export declare function NextAction({ showBack, backExpand, finishLabel, hint, children, onClick, className, disabled, ...rest }: NextActionProps): import("react/jsx-runtime").JSX.Element;
|
|
64
|
+
export declare const Flow: {
|
|
65
|
+
Steps: typeof FlowSteps;
|
|
66
|
+
Step: typeof FlowStep;
|
|
67
|
+
Next: typeof NextAction;
|
|
68
|
+
};
|
|
69
|
+
export {};
|
|
70
|
+
//# sourceMappingURL=flow.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../src/flow.tsx"],"names":[],"mappings":"AAOA,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAKxD,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IACxF,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,mFAAmF;IACnF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gDAAgD;IAChD,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAED,UAAU,gBAAgB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,UAAU,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;CACvC;AAID,6CAA6C;AAC7C,wBAAgB,OAAO,IAAI,gBAAgB,GAAG,IAAI,CAEjD;AAED,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC;IAC7G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,0DAA0D;IAC1D,UAAU,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IACtC,4EAA4E;IAC5E,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAMD,wBAAgB,SAAS,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAa,EAAE,KAAK,EAAE,OAAe,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,cAAc,2CA2GhK;AAED,2DAA2D;AAC3D,wBAAgB,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa,2CAmBtI;AAED,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC;IACnE,oFAAoF;IACpF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;IAC1C,2EAA2E;IAC3E,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;IACnC;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;CACjC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,EAAE,QAAe,EAAE,UAAiB,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,eAAe,2CA+BrJ;AAED,eAAO,MAAM,IAAI;;;;CAAyD,CAAC"}
|
package/dist/flow.js
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { createElement as _createElement } from "react";
|
|
3
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
4
|
+
// Flow: a guided sequence of steps with one clear next action. The header
|
|
5
|
+
// shows where you are (a sliding marker over the step list and a progress
|
|
6
|
+
// rail); the content changes with a view transition where supported and a
|
|
7
|
+
// directional CSS slide elsewhere; NextAction is the single primary button.
|
|
8
|
+
import { Children, createContext, isValidElement, useContext, useEffect, useId, useRef, useState } from 'react';
|
|
9
|
+
import { useNorthstar } from './provider.js';
|
|
10
|
+
import { Button } from './actions.js';
|
|
11
|
+
import { canViewTransition, withViewTransition } from './motion.js';
|
|
12
|
+
import { cx, useControllable } from './internal/util.js';
|
|
13
|
+
import { Check, ChevronLeft, ChevronRight } from './internal/icons.js';
|
|
14
|
+
const FlowContext = createContext(null);
|
|
15
|
+
/** The current flow, or null outside one. */
|
|
16
|
+
export function useFlow() {
|
|
17
|
+
return useContext(FlowContext);
|
|
18
|
+
}
|
|
19
|
+
function stepTitle(s) {
|
|
20
|
+
return s.textTitle ?? (typeof s.title === 'string' ? s.title : s.value);
|
|
21
|
+
}
|
|
22
|
+
export function FlowSteps({ value, defaultValue, onValueChange, onComplete, linear = true, label, compact = false, className, children, ...rest }) {
|
|
23
|
+
const { messages } = useNorthstar();
|
|
24
|
+
const steps = Children.toArray(children)
|
|
25
|
+
.filter((c) => isValidElement(c) && typeof c.props.value === 'string')
|
|
26
|
+
.map((c) => c.props);
|
|
27
|
+
const [v, setV] = useControllable(value, defaultValue ?? steps[0]?.value ?? '', onValueChange);
|
|
28
|
+
const index = Math.max(0, steps.findIndex((s) => s.value === v));
|
|
29
|
+
const prev = useRef(index);
|
|
30
|
+
const stage = useRef(null);
|
|
31
|
+
const [dir, setDir] = useState('forward');
|
|
32
|
+
const [vt, setVt] = useState(false);
|
|
33
|
+
useEffect(() => setVt(canViewTransition()), []);
|
|
34
|
+
const baseId = `ns-flow-${useId().replace(/:/g, '')}`;
|
|
35
|
+
const go = (target) => {
|
|
36
|
+
const to = steps.findIndex((s) => s.value === target);
|
|
37
|
+
if (to < 0 || target === v)
|
|
38
|
+
return;
|
|
39
|
+
const d = to > prev.current ? 'forward' : 'back';
|
|
40
|
+
prev.current = to;
|
|
41
|
+
if (typeof document !== 'undefined')
|
|
42
|
+
document.documentElement.setAttribute('data-ns-flow-dir', d);
|
|
43
|
+
withViewTransition(() => {
|
|
44
|
+
setDir(d);
|
|
45
|
+
setV(target);
|
|
46
|
+
}, stage.current);
|
|
47
|
+
};
|
|
48
|
+
const first = useRef(true);
|
|
49
|
+
useEffect(() => {
|
|
50
|
+
prev.current = index;
|
|
51
|
+
if (first.current) {
|
|
52
|
+
first.current = false;
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
// The step that held focus has gone; hand focus to the new step's title.
|
|
56
|
+
const active = typeof document !== 'undefined' ? document.activeElement : null;
|
|
57
|
+
if (!active || active === document.body || !active.isConnected || stage.current?.contains(active)) {
|
|
58
|
+
stage.current?.querySelector('.ns-flow__title')?.focus({ preventScroll: true });
|
|
59
|
+
}
|
|
60
|
+
}, [index]);
|
|
61
|
+
const ctx = {
|
|
62
|
+
value: steps[index]?.value ?? v,
|
|
63
|
+
index,
|
|
64
|
+
count: steps.length,
|
|
65
|
+
steps,
|
|
66
|
+
baseId,
|
|
67
|
+
go,
|
|
68
|
+
next: () => {
|
|
69
|
+
if (steps[index]?.blocked)
|
|
70
|
+
return;
|
|
71
|
+
if (index < steps.length - 1)
|
|
72
|
+
go(steps[index + 1].value);
|
|
73
|
+
else
|
|
74
|
+
onComplete?.();
|
|
75
|
+
},
|
|
76
|
+
back: () => index > 0 && go(steps[index - 1].value),
|
|
77
|
+
onComplete,
|
|
78
|
+
};
|
|
79
|
+
const current = steps[index];
|
|
80
|
+
const progress = steps.length > 1 ? index / (steps.length - 1) : 1;
|
|
81
|
+
return (_jsx(FlowContext.Provider, { value: ctx, children: _jsxs("div", { ...rest, className: cx('ns-flow', vt && 'ns-flow--vt', compact && 'ns-flow--compact', className), "data-direction": dir, children: [_jsxs("div", { className: "ns-flow__head", children: [!compact && (_jsx("ol", { className: "ns-flow__steps", "aria-label": label ?? messages.flowSteps, children: steps.map((s, i) => {
|
|
82
|
+
const done = s.complete || i < index;
|
|
83
|
+
const reachable = !linear || done || i <= index + 1;
|
|
84
|
+
const state = i === index ? 'current' : done ? 'complete' : 'upcoming';
|
|
85
|
+
return (_jsx("li", { className: "ns-flow__item", "data-state": state, children: _jsxs("button", { type: "button", className: "ns-flow__step", "aria-current": i === index ? 'step' : undefined, disabled: !reachable || (i === index + 1 && !!steps[index]?.blocked), onClick: () => go(s.value), children: [_jsx("span", { className: "ns-flow__mark", "aria-hidden": "true", children: done && i !== index ? _jsx(Check, {}) : s.icon ?? _jsx("span", { className: "ns-flow__num", children: i + 1 }) }), _jsx("span", { className: "ns-flow__label", children: s.title }), _jsx("span", { className: "ns-visually-hidden", children: state === 'complete' ? `, ${messages.flowComplete}` : '' })] }) }, s.value));
|
|
86
|
+
}) })), _jsx("div", { className: "ns-flow__rail", role: "progressbar", "aria-label": messages.flowProgress, "aria-valuemin": 1, "aria-valuemax": steps.length, "aria-valuenow": index + 1, "aria-valuetext": current ? `${messages.step(index + 1, steps.length)}: ${stepTitle(current)}` : undefined, children: _jsx("span", { className: "ns-flow__fill", style: { transform: `scaleX(${progress})` } }) })] }), _jsx("div", { ref: stage, className: "ns-flow__stage", children: Children.toArray(children).map((c) => isValidElement(c) && c.props.value === ctx.value ? c : null) })] }) }));
|
|
87
|
+
}
|
|
88
|
+
/** One step. Renders only while it is the current step. */
|
|
89
|
+
export function FlowStep({ value, title, textTitle, description, icon, complete, blocked, className, children, ...rest }) {
|
|
90
|
+
const ctx = useFlow();
|
|
91
|
+
void icon;
|
|
92
|
+
void complete;
|
|
93
|
+
void blocked;
|
|
94
|
+
void textTitle;
|
|
95
|
+
const id = `${ctx?.baseId ?? 'ns-flow'}-${value}-title`;
|
|
96
|
+
return (_createElement("section", { ...rest, key: value, "aria-labelledby": id, className: cx('ns-flow__panel', className), "data-step": value },
|
|
97
|
+
_jsxs("header", { className: "ns-flow__panel-head", children: [ctx && _jsx("span", { className: "ns-flow__eyebrow", children: `${ctx.index + 1} / ${ctx.count}` }), _jsx("h3", { id: id, className: "ns-flow__title", tabIndex: -1, children: title }), description && _jsx("p", { className: "ns-flow__description", children: description })] }),
|
|
98
|
+
_jsx("div", { className: "ns-flow__body", children: children })));
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* The one clear next action. Inside FlowSteps it advances (and names the step
|
|
102
|
+
* it leads to); on the last step it calls `onComplete`. Outside a flow it is a
|
|
103
|
+
* primary button with a trailing arrow that slides on hover.
|
|
104
|
+
*/
|
|
105
|
+
export function NextAction({ showBack = true, backExpand = true, finishLabel, hint, children, onClick, className, disabled, ...rest }) {
|
|
106
|
+
const ctx = useFlow();
|
|
107
|
+
const { messages } = useNorthstar();
|
|
108
|
+
const last = ctx ? ctx.index >= ctx.count - 1 : false;
|
|
109
|
+
const nextStep = ctx && !last ? ctx.steps[ctx.index + 1] : undefined;
|
|
110
|
+
const label = children ?? (last ? finishLabel ?? messages.flowFinish : nextStep ? messages.flowNext(stepTitle(nextStep)) : messages.flowFinish);
|
|
111
|
+
return (_jsxs("div", { className: "ns-next-action", children: [ctx && showBack && ctx.index > 0 && (_jsx(Button, { variant: "ghost", onClick: ctx.back, icon: _jsx(ChevronLeft, {}), expand: backExpand || 'always', className: "ns-next-action__back", children: messages.flowBack })), hint && _jsx("span", { className: "ns-next-action__hint", children: hint }), _jsxs(Button, { ...rest, variant: "primary", disabled: disabled || (ctx ? !!ctx.steps[ctx.index]?.blocked : false), className: cx('ns-next-action__go', className), onClick: (e) => {
|
|
112
|
+
onClick?.(e);
|
|
113
|
+
if (!e.defaultPrevented)
|
|
114
|
+
ctx?.next();
|
|
115
|
+
}, children: [label, _jsx("span", { className: "ns-next-action__arrow", "aria-hidden": "true", children: last ? _jsx(Check, {}) : _jsx(ChevronRight, {}) })] })] }));
|
|
116
|
+
}
|
|
117
|
+
export const Flow = { Steps: FlowSteps, Step: FlowStep, Next: NextAction };
|
|
118
|
+
//# sourceMappingURL=flow.js.map
|
package/dist/flow.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"flow.js","sourceRoot":"","sources":["../src/flow.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AACb,0EAA0E;AAC1E,0EAA0E;AAC1E,0EAA0E;AAC1E,4EAA4E;AAC5E,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAChH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAoB,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AA2BvE,MAAM,WAAW,GAAG,aAAa,CAA0B,IAAI,CAAC,CAAC;AAEjE,6CAA6C;AAC7C,MAAM,UAAU,OAAO;IACrB,OAAO,UAAU,CAAC,WAAW,CAAC,CAAC;AACjC,CAAC;AAiBD,SAAS,SAAS,CAAC,CAAgB;IACjC,OAAO,CAAC,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAkB;IAC/J,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC;SACrC,MAAM,CAAC,CAAC,CAAC,EAA0C,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,OAAQ,CAAC,CAAC,KAAuB,CAAC,KAAK,KAAK,QAAQ,CAAC;SAChI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,eAAe,CAAC,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/F,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAqB,SAAS,CAAC,CAAC;IAC9D,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpC,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,WAAW,KAAK,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;IAEtD,MAAM,EAAE,GAAG,CAAC,MAAc,EAAE,EAAE;QAC5B,MAAM,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC;QACtD,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,KAAK,CAAC;YAAE,OAAO;QACnC,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,OAAO,QAAQ,KAAK,WAAW;YAAE,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;QAClG,kBAAkB,CAAC,GAAG,EAAE;YACtB,MAAM,CAAC,CAAC,CAAC,CAAC;YACV,IAAI,CAAC,MAAM,CAAC,CAAC;QACf,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;YACtB,OAAO;QACT,CAAC;QACD,yEAAyE;QACzE,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,IAAI,CAAC,MAAM,IAAI,MAAM,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAClG,KAAK,CAAC,OAAO,EAAE,aAAa,CAAc,iBAAiB,CAAC,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEZ,MAAM,GAAG,GAAqB;QAC5B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC;QAC/B,KAAK;QACL,KAAK,EAAE,KAAK,CAAC,MAAM;QACnB,KAAK;QACL,MAAM;QACN,EAAE;QACF,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO;gBAAE,OAAO;YAClC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAE,CAAC,KAAK,CAAC,CAAC;;gBACrD,UAAU,EAAE,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAE,CAAC,KAAK,CAAC;QACpD,UAAU;KACX,CAAC;IACF,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnE,OAAO,CACL,KAAC,WAAW,CAAC,QAAQ,IAAC,KAAK,EAAE,GAAG,YAC9B,kBAAS,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,EAAE,IAAI,aAAa,EAAE,OAAO,IAAI,kBAAkB,EAAE,SAAS,CAAC,oBAAkB,GAAG,aACzH,eAAK,SAAS,EAAC,eAAe,aAC3B,CAAC,OAAO,IAAI,CACX,aAAI,SAAS,EAAC,gBAAgB,gBAAa,KAAK,IAAI,QAAQ,CAAC,SAAS,YACnE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gCAClB,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,GAAG,KAAK,CAAC;gCACrC,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;gCACpD,MAAM,KAAK,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC;gCACvE,OAAO,CACL,aAAkB,SAAS,EAAC,eAAe,gBAAa,KAAK,YAC3D,kBACE,IAAI,EAAC,QAAQ,EACb,SAAS,EAAC,eAAe,kBACX,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAC9C,QAAQ,EAAE,CAAC,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,EACpE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAE1B,eAAM,SAAS,EAAC,eAAe,iBAAa,MAAM,YAC/C,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,KAAC,KAAK,KAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,eAAM,SAAS,EAAC,cAAc,YAAE,CAAC,GAAG,CAAC,GAAQ,GACrF,EACP,eAAM,SAAS,EAAC,gBAAgB,YAAE,CAAC,CAAC,KAAK,GAAQ,EACjD,eAAM,SAAS,EAAC,oBAAoB,YAAE,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,GAAQ,IAC/F,IAbF,CAAC,CAAC,KAAK,CAcX,CACN,CAAC;4BACJ,CAAC,CAAC,GACC,CACN,EACD,cACE,SAAS,EAAC,eAAe,EACzB,IAAI,EAAC,aAAa,gBACN,QAAQ,CAAC,YAAY,mBAClB,CAAC,mBACD,KAAK,CAAC,MAAM,mBACZ,KAAK,GAAG,CAAC,oBACR,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,YAExG,eAAM,SAAS,EAAC,eAAe,EAAC,KAAK,EAAE,EAAE,SAAS,EAAE,UAAU,QAAQ,GAAG,EAAE,GAAI,GAC3E,IACF,EACN,cAAK,GAAG,EAAE,KAAK,EAAE,SAAS,EAAC,gBAAgB,YACxC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACpC,cAAc,CAAC,CAAC,CAAC,IAAK,CAAC,CAAC,KAAuB,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAC/E,GACG,IACF,GACe,CACxB,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAiB;IACrI,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,KAAK,IAAI,CAAC;IACV,KAAK,QAAQ,CAAC;IACd,KAAK,OAAO,CAAC;IACb,KAAK,SAAS,CAAC;IACf,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,MAAM,IAAI,SAAS,IAAI,KAAK,QAAQ,CAAC;IACxD,OAAO,CACL,+BAAa,IAAI,EAAE,GAAG,EAAE,KAAK,qBAAmB,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,gBAAgB,EAAE,SAAS,CAAC,eAAa,KAAK;QAC9G,kBAAQ,SAAS,EAAC,qBAAqB,aACpC,GAAG,IAAI,eAAM,SAAS,EAAC,kBAAkB,YAAE,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,EAAE,GAAQ,EACrF,aAAI,EAAE,EAAE,EAAE,EAAE,SAAS,EAAC,gBAAgB,EAAC,QAAQ,EAAE,CAAC,CAAC,YAChD,KAAK,GACH,EACJ,WAAW,IAAI,YAAG,SAAS,EAAC,sBAAsB,YAAE,WAAW,GAAK,IAC9D;QACT,cAAK,SAAS,EAAC,eAAe,YAAE,QAAQ,GAAO,CACvC,CACX,CAAC;AACJ,CAAC;AAiBD;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,UAAU,GAAG,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAmB;IACpJ,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACtD,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrE,MAAM,KAAK,GAAG,QAAQ,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChJ,OAAO,CACL,eAAK,SAAS,EAAC,gBAAgB,aAC5B,GAAG,IAAI,QAAQ,IAAI,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,CACnC,KAAC,MAAM,IAAC,OAAO,EAAC,OAAO,EAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,KAAC,WAAW,KAAG,EAAE,MAAM,EAAE,UAAU,IAAI,QAAQ,EAAE,SAAS,EAAC,sBAAsB,YAC/H,QAAQ,CAAC,QAAQ,GACX,CACV,EACA,IAAI,IAAI,eAAM,SAAS,EAAC,sBAAsB,YAAE,IAAI,GAAQ,EAC7D,MAAC,MAAM,OACD,IAAI,EACR,OAAO,EAAC,SAAS,EACjB,QAAQ,EAAE,QAAQ,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EACrE,SAAS,EAAE,EAAE,CAAC,oBAAoB,EAAE,SAAS,CAAC,EAC9C,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;oBACb,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;oBACb,IAAI,CAAC,CAAC,CAAC,gBAAgB;wBAAE,GAAG,EAAE,IAAI,EAAE,CAAC;gBACvC,CAAC,aAEA,KAAK,EACN,eAAM,SAAS,EAAC,uBAAuB,iBAAa,MAAM,YACvD,IAAI,CAAC,CAAC,CAAC,KAAC,KAAK,KAAG,CAAC,CAAC,CAAC,KAAC,YAAY,KAAG,GAC/B,IACA,IACL,CACP,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
|
package/dist/forms.d.ts
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { type Size } from './internal/util.js';
|
|
2
|
+
export interface FieldProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children' | 'id'> {
|
|
3
|
+
label: React.ReactNode;
|
|
4
|
+
description?: React.ReactNode;
|
|
5
|
+
error?: React.ReactNode;
|
|
6
|
+
required?: boolean;
|
|
7
|
+
disabled?: boolean;
|
|
8
|
+
/** Override the generated control id. */
|
|
9
|
+
id?: string;
|
|
10
|
+
children: React.ReactNode;
|
|
11
|
+
}
|
|
12
|
+
/** Label, description and error for one control; wires ids and aria-* to the control inside. */
|
|
13
|
+
export declare function Field({ label, description, error, required, disabled, id, className, children, ...rest }: FieldProps): import("react/jsx-runtime").JSX.Element;
|
|
14
|
+
interface FieldInput {
|
|
15
|
+
id?: string | undefined;
|
|
16
|
+
disabled?: boolean | undefined;
|
|
17
|
+
required?: boolean | undefined;
|
|
18
|
+
invalid?: boolean | undefined;
|
|
19
|
+
'aria-describedby'?: string | undefined;
|
|
20
|
+
}
|
|
21
|
+
/** Field wiring for a control: id, aria-describedby, aria-invalid, required, disabled. */
|
|
22
|
+
export declare function useFieldProps(props: FieldInput): {
|
|
23
|
+
aria: {
|
|
24
|
+
id: string | undefined;
|
|
25
|
+
disabled: boolean | undefined;
|
|
26
|
+
required: boolean | undefined;
|
|
27
|
+
'aria-describedby': string | undefined;
|
|
28
|
+
'aria-invalid': true | undefined;
|
|
29
|
+
};
|
|
30
|
+
invalid: boolean;
|
|
31
|
+
};
|
|
32
|
+
interface ValueProps<T> {
|
|
33
|
+
value?: T;
|
|
34
|
+
defaultValue?: T;
|
|
35
|
+
onValueChange?: (value: T) => void;
|
|
36
|
+
}
|
|
37
|
+
export interface InputProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'size' | 'value' | 'defaultValue'>, ValueProps<string> {
|
|
38
|
+
size?: Size;
|
|
39
|
+
invalid?: boolean;
|
|
40
|
+
/** Content drawn inside the start edge (an icon, a unit). */
|
|
41
|
+
start?: React.ReactNode;
|
|
42
|
+
end?: React.ReactNode;
|
|
43
|
+
ref?: React.Ref<HTMLInputElement>;
|
|
44
|
+
}
|
|
45
|
+
export declare function Input({ size, invalid, start, end, className, value, defaultValue, onValueChange, onChange, style, ...rest }: InputProps): import("react/jsx-runtime").JSX.Element;
|
|
46
|
+
export interface TextareaProps extends Omit<React.TextareaHTMLAttributes<HTMLTextAreaElement>, 'value' | 'defaultValue'>, ValueProps<string> {
|
|
47
|
+
invalid?: boolean;
|
|
48
|
+
ref?: React.Ref<HTMLTextAreaElement>;
|
|
49
|
+
}
|
|
50
|
+
export declare function Textarea({ invalid, className, value, defaultValue, onValueChange, onChange, ...rest }: TextareaProps): import("react/jsx-runtime").JSX.Element;
|
|
51
|
+
export interface Option {
|
|
52
|
+
value: string;
|
|
53
|
+
label: string;
|
|
54
|
+
disabled?: boolean;
|
|
55
|
+
}
|
|
56
|
+
export interface SelectProps extends Omit<React.SelectHTMLAttributes<HTMLSelectElement>, 'size' | 'value' | 'defaultValue'>, ValueProps<string> {
|
|
57
|
+
options: Option[];
|
|
58
|
+
placeholder?: string;
|
|
59
|
+
size?: Size;
|
|
60
|
+
invalid?: boolean;
|
|
61
|
+
ref?: React.Ref<HTMLSelectElement>;
|
|
62
|
+
}
|
|
63
|
+
/** A styled native select: platform keyboard and screen-reader behaviour for free. */
|
|
64
|
+
export declare function Select({ options, placeholder, size, invalid, className, value, defaultValue, onValueChange, onChange, style, ...rest }: SelectProps): import("react/jsx-runtime").JSX.Element;
|
|
65
|
+
export interface ComboboxProps extends ValueProps<string | null> {
|
|
66
|
+
options: Option[];
|
|
67
|
+
placeholder?: string;
|
|
68
|
+
size?: Size;
|
|
69
|
+
invalid?: boolean;
|
|
70
|
+
disabled?: boolean;
|
|
71
|
+
required?: boolean;
|
|
72
|
+
id?: string;
|
|
73
|
+
className?: string;
|
|
74
|
+
'aria-label'?: string;
|
|
75
|
+
'aria-describedby'?: string;
|
|
76
|
+
/** Custom filter; defaults to a case-insensitive substring match on the label. */
|
|
77
|
+
filter?: (option: Option, query: string) => boolean;
|
|
78
|
+
}
|
|
79
|
+
export declare function Combobox({ options, placeholder, size, invalid, className, value, defaultValue, onValueChange, filter, ...rest }: ComboboxProps): import("react/jsx-runtime").JSX.Element;
|
|
80
|
+
export interface CheckboxProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'type' | 'checked' | 'defaultChecked'> {
|
|
81
|
+
checked?: boolean;
|
|
82
|
+
defaultChecked?: boolean;
|
|
83
|
+
indeterminate?: boolean;
|
|
84
|
+
onCheckedChange?: (checked: boolean) => void;
|
|
85
|
+
children?: React.ReactNode;
|
|
86
|
+
ref?: React.Ref<HTMLInputElement>;
|
|
87
|
+
}
|
|
88
|
+
/** Native checkbox with rounded corners. */
|
|
89
|
+
export declare function Checkbox({ checked, defaultChecked, indeterminate, onCheckedChange, onChange, className, children, ref, style, ...rest }: CheckboxProps): import("react/jsx-runtime").JSX.Element;
|
|
90
|
+
export interface RadioGroupProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'defaultValue' | 'onChange'>, ValueProps<string> {
|
|
91
|
+
name?: string;
|
|
92
|
+
disabled?: boolean;
|
|
93
|
+
orientation?: 'horizontal' | 'vertical';
|
|
94
|
+
label?: string;
|
|
95
|
+
}
|
|
96
|
+
export declare function RadioGroup({ name, value, defaultValue, onValueChange, disabled, orientation, label, className, children, ...rest }: RadioGroupProps): import("react/jsx-runtime").JSX.Element;
|
|
97
|
+
export interface RadioProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'type' | 'value'> {
|
|
98
|
+
value: string;
|
|
99
|
+
children?: React.ReactNode;
|
|
100
|
+
}
|
|
101
|
+
export declare function Radio({ value, children, className, disabled, style, onChange, ...rest }: RadioProps): import("react/jsx-runtime").JSX.Element;
|
|
102
|
+
export interface SwitchProps extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onChange'> {
|
|
103
|
+
checked?: boolean;
|
|
104
|
+
defaultChecked?: boolean;
|
|
105
|
+
onCheckedChange?: (checked: boolean) => void;
|
|
106
|
+
children?: React.ReactNode;
|
|
107
|
+
}
|
|
108
|
+
export declare function Switch({ checked, defaultChecked, onCheckedChange, className, children, onClick, ...rest }: SwitchProps): import("react/jsx-runtime").JSX.Element;
|
|
109
|
+
export interface SliderProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'type' | 'value' | 'defaultValue' | 'min' | 'max' | 'step'>, ValueProps<number> {
|
|
110
|
+
min?: number;
|
|
111
|
+
max?: number;
|
|
112
|
+
step?: number;
|
|
113
|
+
ref?: React.Ref<HTMLInputElement>;
|
|
114
|
+
}
|
|
115
|
+
/** Native range input: arrow keys, Page Up/Down, Home and End work as on the platform. */
|
|
116
|
+
export declare function Slider({ min, max, step, value, defaultValue, onValueChange, onChange, className, style, ...rest }: SliderProps): import("react/jsx-runtime").JSX.Element;
|
|
117
|
+
export interface NumberInputProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'size' | 'value' | 'defaultValue' | 'type' | 'min' | 'max' | 'step'>, ValueProps<number | null> {
|
|
118
|
+
min?: number;
|
|
119
|
+
max?: number;
|
|
120
|
+
step?: number;
|
|
121
|
+
size?: Size;
|
|
122
|
+
invalid?: boolean;
|
|
123
|
+
}
|
|
124
|
+
export declare function NumberInput({ min, max, step, size, invalid, value, defaultValue, onValueChange, className, style, onKeyDown, onBlur, ...rest }: NumberInputProps): import("react/jsx-runtime").JSX.Element;
|
|
125
|
+
export interface SearchInputProps extends Omit<InputProps, 'type' | 'start' | 'end'> {
|
|
126
|
+
onClear?: () => void;
|
|
127
|
+
}
|
|
128
|
+
export declare function SearchInput({ value, defaultValue, onValueChange, onClear, placeholder, ref, onKeyDown, ...rest }: SearchInputProps): import("react/jsx-runtime").JSX.Element;
|
|
129
|
+
export {};
|
|
130
|
+
//# sourceMappingURL=forms.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"forms.d.ts","sourceRoot":"","sources":["../src/forms.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAkC,KAAK,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAc/E,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC/F,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yCAAyC;IACzC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,gGAAgG;AAChG,wBAAgB,KAAK,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,QAAgB,EAAE,QAAgB,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,UAAU,2CAkCpI;AAED,UAAU,UAAU;IAClB,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU;;;;;;;;;EAa9C;AAID,UAAU,UAAU,CAAC,CAAC;IACpB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,YAAY,CAAC,EAAE,CAAC,CAAC;IACjB,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,UACf,SAAQ,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,CAAC,EAC1F,UAAU,CAAC,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6DAA6D;IAC7D,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACtB,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;CACnC;AAED,wBAAgB,KAAK,CAAC,EAAE,IAAW,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,UAAU,2CAmB9I;AAED,MAAM,WAAW,aACf,SAAQ,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC,EACvF,UAAU,CAAC,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;CACtC;AAED,wBAAgB,QAAQ,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa,2CAepH;AAID,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,WACf,SAAQ,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,CAAC,EAC5F,UAAU,CAAC,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;CACpC;AAED,sFAAsF;AACtF,wBAAgB,MAAM,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,IAAW,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,WAAW,2CA+B1J;AAID,MAAM,WAAW,aAAc,SAAQ,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;IAC9D,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kFAAkF;IAClF,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;CACrD;AAED,wBAAgB,QAAQ,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,IAAW,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa,2CA8GrJ;AAID,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAC7H,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC7C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;CACnC;AAED,4CAA4C;AAC5C,wBAAgB,QAAQ,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,aAAqB,EAAE,eAAe,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa,2CAyB9J;AAYD,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,EAC7E,UAAU,CAAC,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAgB,EAAE,WAAwB,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,eAAe,2CAQxK;AAED,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACrG,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED,wBAAgB,KAAK,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,UAAU,2CAsBnG;AAID,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC;IAClG,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC7C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED,wBAAgB,MAAM,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,WAAW,2CA2BtH;AAID,MAAM,WAAW,WACf,SAAQ,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,EACnH,UAAU,CAAC,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;CACnC;AAED,0FAA0F;AAC1F,wBAAgB,MAAM,CAAC,EAAE,GAAO,EAAE,GAAS,EAAE,IAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,WAAW,2CAqB5I;AAID,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,EAC5H,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAQD,wBAAgB,WAAW,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAQ,EAAE,IAAW,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,gBAAgB,2CAsE3K;AAID,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAClF,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,wBAAgB,WAAW,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,gBAAgB,2CA2ClI"}
|