@gridui/toast 1.0.7 → 1.0.9
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/README.md +2 -0
- package/dist/index.js +3 -4
- package/dist/index.js.map +2 -2
- package/dist/toast-provider/model.d.ts +1 -1
- package/docs/catalog.json +9 -3
- package/docs/reference/README.md +5 -0
- package/docs/reference/toast-provider.md +39 -0
- package/docs/reference/toaster.md +63 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,3 +6,5 @@ Import components from `@gridui/toast` and load `@gridui/toast/styles.css` after
|
|
|
6
6
|
Load styles for any composed dependency used by this family. Applications own routes, labels, state persistence, and branding.
|
|
7
7
|
|
|
8
8
|
See [component ownership](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/docs/component-ownership.md) and [release history](https://github.com/sudo-ui/GridUI-React-Monorepo/tree/main/packages-core/toast/.changeset/history).
|
|
9
|
+
|
|
10
|
+
[Component reference](docs/reference/README.md) contains focused API pages for each public component.
|
package/dist/index.js
CHANGED
|
@@ -4,11 +4,10 @@ var ToastCommands = createContext(null);
|
|
|
4
4
|
var ToastStateContext = createContext(null);
|
|
5
5
|
|
|
6
6
|
// src/toast-provider/model.ts
|
|
7
|
-
var
|
|
7
|
+
var validateToastOptions = (options) => {
|
|
8
8
|
if (options.timeout !== void 0 && (!Number.isFinite(options.timeout) || options.timeout < 0)) {
|
|
9
9
|
throw new RangeError("Toast timeout must be a finite non-negative number.");
|
|
10
10
|
}
|
|
11
|
-
return options;
|
|
12
11
|
};
|
|
13
12
|
|
|
14
13
|
// src/toast-provider/toast-provider.tsx
|
|
@@ -31,7 +30,7 @@ var ToastProvider = (props) => {
|
|
|
31
30
|
setRecords(next);
|
|
32
31
|
}, []);
|
|
33
32
|
const add = useCallback((options) => {
|
|
34
|
-
|
|
33
|
+
validateToastOptions(options);
|
|
35
34
|
const id = options.id ?? `${prefix}-${++sequence.current}`;
|
|
36
35
|
const replaced = current.current.find((record) => {
|
|
37
36
|
return record.id === id;
|
|
@@ -59,7 +58,7 @@ var ToastProvider = (props) => {
|
|
|
59
58
|
publish
|
|
60
59
|
]);
|
|
61
60
|
const update = useCallback((id, options) => {
|
|
62
|
-
|
|
61
|
+
validateToastOptions(options);
|
|
63
62
|
if (!current.current.some((record) => {
|
|
64
63
|
return record.id === id && record.open;
|
|
65
64
|
})) {
|
package/dist/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/shared/context.ts", "../src/toast-provider/model.ts", "../src/toast-provider/toast-provider.tsx", "../src/toaster/context.ts", "../src/toaster/use-toast.ts", "../src/toaster/toast-item.tsx", "../src/toaster/toaster.tsx"],
|
|
4
|
-
"sourcesContent": ["/**\n * @author WMXPY\n * @package Toast\n * @namespace Shared\n * @description Context\n */\n\nimport type { ToastManager, ToastRecord } from \"./types\";\nimport { createContext } from \"react\";\n\nexport type ToastState = {\n readonly records: readonly ToastRecord[];\n readonly timeout: number;\n readonly remove: (id: string, revision: number) => void;\n};\n\nexport const ToastCommands = createContext<ToastManager | null>(null);\n\nexport const ToastStateContext = createContext<ToastState | null>(null);\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace ToastProvider\n * @description Model\n */\n\nimport type { ToastUpdate } from \"../shared/types\";\n\nexport const toastOptions = (options: ToastUpdate): ToastUpdate => {\n if (options.timeout !== undefined && (!Number.isFinite(options.timeout) || options.timeout < 0)) {\n throw new RangeError(\"Toast timeout must be a finite non-negative number.\");\n }\n return options;\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace ToastProvider\n * @description Toast Provider\n */\n\nimport { ToastCommands, ToastStateContext } from \"../shared/context\";\nimport type { ToastOptions, ToastRecord, ToastUpdate } from \"../shared/types\";\nimport { toastOptions } from \"./model\";\nimport { type FC, type ReactNode, useCallback, useId, useMemo, useRef, useState } from \"react\";\n\nexport type ToastProviderProps = {\n readonly children?: ReactNode;\n readonly timeout?: number;\n readonly limit?: number;\n};\n\nexport const ToastProvider: FC<ToastProviderProps> = (props: ToastProviderProps) => {\n const { children, timeout = 5000, limit = 3 } = props;\n if (!Number.isFinite(timeout) || timeout < 0 || !Number.isInteger(limit) || limit < 1) {\n throw new RangeError(\"ToastProvider needs a non-negative timeout and a positive integer limit.\");\n }\n const [\n records,\n setRecords,\n ] = useState<readonly ToastRecord[]>([]);\n const current = useRef(records);\n const sequence = useRef(0);\n const prefix = useId();\n const publish = useCallback((next: readonly ToastRecord[]) => {\n current.current = next;\n setRecords(next);\n }, []);\n const add = useCallback((options: ToastOptions): string => {\n toastOptions(options);\n const id = options.id ?? `${prefix}-${++sequence.current}`;\n const replaced = current.current.find(record => {\n return record.id === id;\n });\n const others = current.current.filter(record => {\n return record.open && record.id !== id;\n });\n const evicted = others.slice(0, Math.max(0, others.length - limit + 1));\n publish([\n ...others.slice(Math.max(0, others.length - limit + 1)),\n {\n ...options,\n id,\n open: true,\n revision: (replaced?.revision ?? 0) + 1,\n },\n ]);\n evicted.forEach(record => {\n record.onClose?.();\n });\n return id;\n }, [\n prefix,\n limit,\n publish,\n ]);\n const update = useCallback((id: string, options: ToastUpdate) => {\n toastOptions(options);\n if (!current.current.some(record => {\n return record.id === id && record.open;\n })) {\n return;\n }\n publish(current.current.map(record => {\n return record.id === id && record.open ? {\n ...record,\n ...options,\n revision: record.revision + 1,\n } : record;\n }));\n }, [publish]);\n const close = useCallback((id?: string) => {\n const closing = current.current.filter(record => {\n return record.open && (id === undefined || record.id === id);\n });\n if (closing.length === 0) {\n return;\n }\n publish(current.current.map(record => {\n return closing.includes(record) ? {\n ...record,\n open: false,\n } : record;\n }));\n closing.forEach(record => {\n record.onClose?.();\n });\n }, [publish]);\n const remove = useCallback((id: string, revision: number) => {\n const next = current.current.filter(record => {\n return record.id !== id || record.revision !== revision || record.open;\n });\n if (next.length !== current.current.length) {\n publish(next);\n }\n }, [publish]);\n const manager = useMemo(() => {\n return {\n add,\n update,\n close,\n };\n }, [\n add,\n update,\n close,\n ]);\n return (<ToastCommands.Provider\n value={manager}\n >\n <ToastStateContext.Provider\n value={{\n records,\n timeout,\n remove,\n }}\n >\n {children}\n </ToastStateContext.Provider>\n </ToastCommands.Provider>);\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Context\n */\n\nimport { type ToastState, ToastStateContext } from \"../shared/context\";\nimport { useContext } from \"react\";\n\nexport const useToastState = (): ToastState => {\n const state = useContext(ToastStateContext);\n if (!state) {\n throw new Error(\"Toasts require a ToastProvider parent.\");\n }\n return state;\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Use Toast\n */\n\nimport { ToastCommands } from \"../shared/context\";\nimport type { ToastManager } from \"../shared/types\";\nimport { useContext } from \"react\";\n\nexport const useToast = (): ToastManager => {\n const manager = useContext(ToastCommands);\n if (!manager) {\n throw new Error(\"Toasts require a ToastProvider parent.\");\n }\n return manager;\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Toast Item\n */\n\nimport type { ToastDismissOptions, ToastRecord } from \"../shared/types\";\nimport { useToastState } from \"./context\";\nimport { useToast } from \"./use-toast\";\nimport { Button } from \"@gridui/button\";\nimport * as Primitive from \"@radix-ui/react-toast\";\nimport { X } from \"lucide-react\";\nimport { type FC, useCallback } from \"react\";\n\nexport type ToastItemProps = ToastDismissOptions & {\n readonly record: ToastRecord;\n};\n\nexport const ToastItem: FC<ToastItemProps> = (props: ToastItemProps) => {\n const { record, closeLabel } = props;\n const { close } = useToast();\n const { remove, timeout } = useToastState();\n const ref = useCallback((node: HTMLLIElement | null) => {\n if (!node) {\n queueMicrotask(() => {\n remove(record.id, record.revision);\n });\n }\n }, [\n remove,\n record.id,\n record.revision,\n ]);\n const duration = record.timeout ?? timeout;\n return (<Primitive.Root\n ref={ref}\n open={record.open}\n onOpenChange={(open) => {\n if (!open) {\n close(record.id);\n }\n }}\n duration={duration === 0 ? Infinity : duration}\n type={record.priority === \"high\" ? \"foreground\" : \"background\"}\n className=\"gridui-toast\"\n data-tone={record.tone ?? \"neutral\"}\n inert={!record.open}\n >\n <div\n className=\"gridui-toast-content\"\n >\n <div\n className=\"gridui-toast-message\"\n >\n <Primitive.Title\n className=\"gridui-toast-title\"\n >\n {record.title}\n </Primitive.Title>\n {record.description && (<Primitive.Description\n className=\"gridui-toast-description\"\n >\n {record.description}\n </Primitive.Description>)}\n </div>\n {record.action && (<Primitive.Action\n asChild\n altText={record.action.altText}\n >\n <Button\n variant=\"secondary\"\n className=\"gridui-toast-action\"\n size=\"small\"\n disabled={record.action.disabled}\n onClick={record.action.onClick}\n >\n {record.action.label}\n </Button>\n </Primitive.Action>)}\n <Primitive.Close\n asChild\n aria-label={closeLabel}\n >\n <Button\n variant=\"quiet\"\n className=\"gridui-toast-close\"\n layout=\"icon\"\n size=\"small\"\n >\n <X\n aria-hidden=\"true\"\n />\n </Button>\n </Primitive.Close>\n </div>\n </Primitive.Root>);\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Toaster\n */\n\nimport type { ToastDismissOptions } from \"../shared/types\";\nimport { useToastState } from \"./context\";\nimport { ToastItem } from \"./toast-item\";\nimport { interactionLayerProps, useInteractionOutline, useScrollbars } from \"@gridui/overlay\";\nimport { cn } from \"@gridui/style-utils\";\nimport * as Primitive from \"@radix-ui/react-toast\";\nimport { type ComponentPropsWithRef, type FC, useEffect, useState } from \"react\";\nimport { createPortal } from \"react-dom\";\n\nexport type ToasterProps = Omit<ComponentPropsWithRef<\"ol\">, \"children\" | \"aria-label\"> & ToastDismissOptions & {\n readonly label: string;\n readonly container?: HTMLElement | undefined;\n};\n\nexport const Toaster: FC<ToasterProps> = (props: ToasterProps) => {\n const { ref: forwardedRef, label, closeLabel, container, className, ...restProps } = props;\n const scrollbarRef = useScrollbars({ ref: forwardedRef });\n const ref = useInteractionOutline({ ref: scrollbarRef });\n const { records, timeout } = useToastState();\n const [\n mounted,\n setMounted,\n ] = useState(false);\n useEffect(() => {\n setMounted(true);\n }, []);\n if (!mounted) {\n return null;\n }\n return createPortal((<Primitive.Provider\n label={label}\n duration={timeout === 0 ? Infinity : timeout}\n swipeDirection=\"down\"\n announcerContainer={container}\n >\n {records.map(record => {\n return (<ToastItem\n key={`${record.id}:${record.revision}`}\n record={record}\n closeLabel={closeLabel}\n />);\n })}\n <Primitive.Viewport\n {...interactionLayerProps}\n {...restProps}\n ref={ref}\n label={label}\n className={cn(\"gridui-toast-viewport\", className)}\n />\n </Primitive.Provider>), container ?? document.body);\n};\n"],
|
|
5
|
-
"mappings": ";AAQA,SAAS,qBAAqB;AAQvB,IAAM,gBAAgB,cAAmC,IAAI;AAE7D,IAAM,oBAAoB,cAAiC,IAAI;;;ACT/D,IAAM,
|
|
4
|
+
"sourcesContent": ["/**\n * @author WMXPY\n * @package Toast\n * @namespace Shared\n * @description Context\n */\n\nimport type { ToastManager, ToastRecord } from \"./types\";\nimport { createContext } from \"react\";\n\nexport type ToastState = {\n readonly records: readonly ToastRecord[];\n readonly timeout: number;\n readonly remove: (id: string, revision: number) => void;\n};\n\nexport const ToastCommands = createContext<ToastManager | null>(null);\n\nexport const ToastStateContext = createContext<ToastState | null>(null);\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace ToastProvider\n * @description Model\n */\n\nimport type { ToastUpdate } from \"../shared/types\";\n\nexport const validateToastOptions = (options: ToastUpdate): void => {\n if (options.timeout !== undefined && (!Number.isFinite(options.timeout) || options.timeout < 0)) {\n throw new RangeError(\"Toast timeout must be a finite non-negative number.\");\n }\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace ToastProvider\n * @description Toast Provider\n */\n\nimport { ToastCommands, ToastStateContext } from \"../shared/context\";\nimport type { ToastOptions, ToastRecord, ToastUpdate } from \"../shared/types\";\nimport { validateToastOptions } from \"./model\";\nimport { type FC, type ReactNode, useCallback, useId, useMemo, useRef, useState } from \"react\";\n\nexport type ToastProviderProps = {\n readonly children?: ReactNode;\n readonly timeout?: number;\n readonly limit?: number;\n};\n\nexport const ToastProvider: FC<ToastProviderProps> = (props: ToastProviderProps) => {\n const { children, timeout = 5000, limit = 3 } = props;\n if (!Number.isFinite(timeout) || timeout < 0 || !Number.isInteger(limit) || limit < 1) {\n throw new RangeError(\"ToastProvider needs a non-negative timeout and a positive integer limit.\");\n }\n const [\n records,\n setRecords,\n ] = useState<readonly ToastRecord[]>([]);\n const current = useRef(records);\n const sequence = useRef(0);\n const prefix = useId();\n const publish = useCallback((next: readonly ToastRecord[]) => {\n current.current = next;\n setRecords(next);\n }, []);\n const add = useCallback((options: ToastOptions): string => {\n validateToastOptions(options);\n const id = options.id ?? `${prefix}-${++sequence.current}`;\n const replaced = current.current.find(record => {\n return record.id === id;\n });\n const others = current.current.filter(record => {\n return record.open && record.id !== id;\n });\n const evicted = others.slice(0, Math.max(0, others.length - limit + 1));\n publish([\n ...others.slice(Math.max(0, others.length - limit + 1)),\n {\n ...options,\n id,\n open: true,\n revision: (replaced?.revision ?? 0) + 1,\n },\n ]);\n evicted.forEach(record => {\n record.onClose?.();\n });\n return id;\n }, [\n prefix,\n limit,\n publish,\n ]);\n const update = useCallback((id: string, options: ToastUpdate) => {\n validateToastOptions(options);\n if (!current.current.some(record => {\n return record.id === id && record.open;\n })) {\n return;\n }\n publish(current.current.map(record => {\n return record.id === id && record.open ? {\n ...record,\n ...options,\n revision: record.revision + 1,\n } : record;\n }));\n }, [publish]);\n const close = useCallback((id?: string) => {\n const closing = current.current.filter(record => {\n return record.open && (id === undefined || record.id === id);\n });\n if (closing.length === 0) {\n return;\n }\n publish(current.current.map(record => {\n return closing.includes(record) ? {\n ...record,\n open: false,\n } : record;\n }));\n closing.forEach(record => {\n record.onClose?.();\n });\n }, [publish]);\n const remove = useCallback((id: string, revision: number) => {\n const next = current.current.filter(record => {\n return record.id !== id || record.revision !== revision || record.open;\n });\n if (next.length !== current.current.length) {\n publish(next);\n }\n }, [publish]);\n const manager = useMemo(() => {\n return {\n add,\n update,\n close,\n };\n }, [\n add,\n update,\n close,\n ]);\n return (<ToastCommands.Provider\n value={manager}\n >\n <ToastStateContext.Provider\n value={{\n records,\n timeout,\n remove,\n }}\n >\n {children}\n </ToastStateContext.Provider>\n </ToastCommands.Provider>);\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Context\n */\n\nimport { type ToastState, ToastStateContext } from \"../shared/context\";\nimport { useContext } from \"react\";\n\nexport const useToastState = (): ToastState => {\n const state = useContext(ToastStateContext);\n if (!state) {\n throw new Error(\"Toasts require a ToastProvider parent.\");\n }\n return state;\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Use Toast\n */\n\nimport { ToastCommands } from \"../shared/context\";\nimport type { ToastManager } from \"../shared/types\";\nimport { useContext } from \"react\";\n\nexport const useToast = (): ToastManager => {\n const manager = useContext(ToastCommands);\n if (!manager) {\n throw new Error(\"Toasts require a ToastProvider parent.\");\n }\n return manager;\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Toast Item\n */\n\nimport type { ToastDismissOptions, ToastRecord } from \"../shared/types\";\nimport { useToastState } from \"./context\";\nimport { useToast } from \"./use-toast\";\nimport { Button } from \"@gridui/button\";\nimport * as Primitive from \"@radix-ui/react-toast\";\nimport { X } from \"lucide-react\";\nimport { type FC, useCallback } from \"react\";\n\nexport type ToastItemProps = ToastDismissOptions & {\n readonly record: ToastRecord;\n};\n\nexport const ToastItem: FC<ToastItemProps> = (props: ToastItemProps) => {\n const { record, closeLabel } = props;\n const { close } = useToast();\n const { remove, timeout } = useToastState();\n const ref = useCallback((node: HTMLLIElement | null) => {\n if (!node) {\n queueMicrotask(() => {\n remove(record.id, record.revision);\n });\n }\n }, [\n remove,\n record.id,\n record.revision,\n ]);\n const duration = record.timeout ?? timeout;\n return (<Primitive.Root\n ref={ref}\n open={record.open}\n onOpenChange={(open) => {\n if (!open) {\n close(record.id);\n }\n }}\n duration={duration === 0 ? Infinity : duration}\n type={record.priority === \"high\" ? \"foreground\" : \"background\"}\n className=\"gridui-toast\"\n data-tone={record.tone ?? \"neutral\"}\n inert={!record.open}\n >\n <div\n className=\"gridui-toast-content\"\n >\n <div\n className=\"gridui-toast-message\"\n >\n <Primitive.Title\n className=\"gridui-toast-title\"\n >\n {record.title}\n </Primitive.Title>\n {record.description && (<Primitive.Description\n className=\"gridui-toast-description\"\n >\n {record.description}\n </Primitive.Description>)}\n </div>\n {record.action && (<Primitive.Action\n asChild\n altText={record.action.altText}\n >\n <Button\n variant=\"secondary\"\n className=\"gridui-toast-action\"\n size=\"small\"\n disabled={record.action.disabled}\n onClick={record.action.onClick}\n >\n {record.action.label}\n </Button>\n </Primitive.Action>)}\n <Primitive.Close\n asChild\n aria-label={closeLabel}\n >\n <Button\n variant=\"quiet\"\n className=\"gridui-toast-close\"\n layout=\"icon\"\n size=\"small\"\n >\n <X\n aria-hidden=\"true\"\n />\n </Button>\n </Primitive.Close>\n </div>\n </Primitive.Root>);\n};\n", "/**\n * @author WMXPY\n * @package Toast\n * @namespace Toaster\n * @description Toaster\n */\n\nimport type { ToastDismissOptions } from \"../shared/types\";\nimport { useToastState } from \"./context\";\nimport { ToastItem } from \"./toast-item\";\nimport { interactionLayerProps, useInteractionOutline, useScrollbars } from \"@gridui/overlay\";\nimport { cn } from \"@gridui/style-utils\";\nimport * as Primitive from \"@radix-ui/react-toast\";\nimport { type ComponentPropsWithRef, type FC, useEffect, useState } from \"react\";\nimport { createPortal } from \"react-dom\";\n\nexport type ToasterProps = Omit<ComponentPropsWithRef<\"ol\">, \"children\" | \"aria-label\"> & ToastDismissOptions & {\n readonly label: string;\n readonly container?: HTMLElement | undefined;\n};\n\nexport const Toaster: FC<ToasterProps> = (props: ToasterProps) => {\n const { ref: forwardedRef, label, closeLabel, container, className, ...restProps } = props;\n const scrollbarRef = useScrollbars({ ref: forwardedRef });\n const ref = useInteractionOutline({ ref: scrollbarRef });\n const { records, timeout } = useToastState();\n const [\n mounted,\n setMounted,\n ] = useState(false);\n useEffect(() => {\n setMounted(true);\n }, []);\n if (!mounted) {\n return null;\n }\n return createPortal((<Primitive.Provider\n label={label}\n duration={timeout === 0 ? Infinity : timeout}\n swipeDirection=\"down\"\n announcerContainer={container}\n >\n {records.map(record => {\n return (<ToastItem\n key={`${record.id}:${record.revision}`}\n record={record}\n closeLabel={closeLabel}\n />);\n })}\n <Primitive.Viewport\n {...interactionLayerProps}\n {...restProps}\n ref={ref}\n label={label}\n className={cn(\"gridui-toast-viewport\", className)}\n />\n </Primitive.Provider>), container ?? document.body);\n};\n"],
|
|
5
|
+
"mappings": ";AAQA,SAAS,qBAAqB;AAQvB,IAAM,gBAAgB,cAAmC,IAAI;AAE7D,IAAM,oBAAoB,cAAiC,IAAI;;;ACT/D,IAAM,uBAAuB,CAAC,YAA+B;AAChE,MAAI,QAAQ,YAAY,WAAc,CAAC,OAAO,SAAS,QAAQ,OAAO,KAAK,QAAQ,UAAU,IAAI;AAC7F,UAAM,IAAI,WAAW,qDAAqD;AAAA,EAC9E;AACJ;;;ACHA,SAAkC,aAAa,OAAO,SAAS,QAAQ,gBAAgB;AA0G/E;AAlGD,IAAM,gBAAwC,CAAC,UAA8B;AAChF,QAAM,EAAE,UAAU,UAAU,KAAM,QAAQ,EAAE,IAAI;AAChD,MAAI,CAAC,OAAO,SAAS,OAAO,KAAK,UAAU,KAAK,CAAC,OAAO,UAAU,KAAK,KAAK,QAAQ,GAAG;AACnF,UAAM,IAAI,WAAW,0EAA0E;AAAA,EACnG;AACA,QAAM;AAAA,IACF;AAAA,IACA;AAAA,EACJ,IAAI,SAAiC,CAAC,CAAC;AACvC,QAAM,UAAU,OAAO,OAAO;AAC9B,QAAM,WAAW,OAAO,CAAC;AACzB,QAAM,SAAS,MAAM;AACrB,QAAM,UAAU,YAAY,CAAC,SAAiC;AAC1D,YAAQ,UAAU;AAClB,eAAW,IAAI;AAAA,EACnB,GAAG,CAAC,CAAC;AACL,QAAM,MAAM,YAAY,CAAC,YAAkC;AACvD,yBAAqB,OAAO;AAC5B,UAAM,KAAK,QAAQ,MAAM,GAAG,MAAM,IAAI,EAAE,SAAS,OAAO;AACxD,UAAM,WAAW,QAAQ,QAAQ,KAAK,YAAU;AAC5C,aAAO,OAAO,OAAO;AAAA,IACzB,CAAC;AACD,UAAM,SAAS,QAAQ,QAAQ,OAAO,YAAU;AAC5C,aAAO,OAAO,QAAQ,OAAO,OAAO;AAAA,IACxC,CAAC;AACD,UAAM,UAAU,OAAO,MAAM,GAAG,KAAK,IAAI,GAAG,OAAO,SAAS,QAAQ,CAAC,CAAC;AACtE,YAAQ;AAAA,MACJ,GAAG,OAAO,MAAM,KAAK,IAAI,GAAG,OAAO,SAAS,QAAQ,CAAC,CAAC;AAAA,MACtD;AAAA,QACI,GAAG;AAAA,QACH;AAAA,QACA,MAAM;AAAA,QACN,WAAW,UAAU,YAAY,KAAK;AAAA,MAC1C;AAAA,IACJ,CAAC;AACD,YAAQ,QAAQ,YAAU;AACtB,aAAO,UAAU;AAAA,IACrB,CAAC;AACD,WAAO;AAAA,EACX,GAAG;AAAA,IACC;AAAA,IACA;AAAA,IACA;AAAA,EACJ,CAAC;AACD,QAAM,SAAS,YAAY,CAAC,IAAY,YAAyB;AAC7D,yBAAqB,OAAO;AAC5B,QAAI,CAAC,QAAQ,QAAQ,KAAK,YAAU;AAChC,aAAO,OAAO,OAAO,MAAM,OAAO;AAAA,IACtC,CAAC,GAAG;AACA;AAAA,IACJ;AACA,YAAQ,QAAQ,QAAQ,IAAI,YAAU;AAClC,aAAO,OAAO,OAAO,MAAM,OAAO,OAAO;AAAA,QACrC,GAAG;AAAA,QACH,GAAG;AAAA,QACH,UAAU,OAAO,WAAW;AAAA,MAChC,IAAI;AAAA,IACR,CAAC,CAAC;AAAA,EACN,GAAG,CAAC,OAAO,CAAC;AACZ,QAAM,QAAQ,YAAY,CAAC,OAAgB;AACvC,UAAM,UAAU,QAAQ,QAAQ,OAAO,YAAU;AAC7C,aAAO,OAAO,SAAS,OAAO,UAAa,OAAO,OAAO;AAAA,IAC7D,CAAC;AACD,QAAI,QAAQ,WAAW,GAAG;AACtB;AAAA,IACJ;AACA,YAAQ,QAAQ,QAAQ,IAAI,YAAU;AAClC,aAAO,QAAQ,SAAS,MAAM,IAAI;AAAA,QAC9B,GAAG;AAAA,QACH,MAAM;AAAA,MACV,IAAI;AAAA,IACR,CAAC,CAAC;AACF,YAAQ,QAAQ,YAAU;AACtB,aAAO,UAAU;AAAA,IACrB,CAAC;AAAA,EACL,GAAG,CAAC,OAAO,CAAC;AACZ,QAAM,SAAS,YAAY,CAAC,IAAY,aAAqB;AACzD,UAAM,OAAO,QAAQ,QAAQ,OAAO,YAAU;AAC1C,aAAO,OAAO,OAAO,MAAM,OAAO,aAAa,YAAY,OAAO;AAAA,IACtE,CAAC;AACD,QAAI,KAAK,WAAW,QAAQ,QAAQ,QAAQ;AACxC,cAAQ,IAAI;AAAA,IAChB;AAAA,EACJ,GAAG,CAAC,OAAO,CAAC;AACZ,QAAM,UAAU,QAAQ,MAAM;AAC1B,WAAO;AAAA,MACH;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ,GAAG;AAAA,IACC;AAAA,IACA;AAAA,IACA;AAAA,EACJ,CAAC;AACD,SAAQ;AAAA,IAAC,cAAc;AAAA,IAAd;AAAA,MACL,OAAO;AAAA,MAEP;AAAA,QAAC,kBAAkB;AAAA,QAAlB;AAAA,UACG,OAAO;AAAA,YACH;AAAA,YACA;AAAA,YACA;AAAA,UACJ;AAAA,UAEC;AAAA;AAAA,MACL;AAAA;AAAA,EACJ;AACJ;;;ACtHA,SAAS,kBAAkB;AAEpB,IAAM,gBAAgB,MAAkB;AAC3C,QAAM,QAAQ,WAAW,iBAAiB;AAC1C,MAAI,CAAC,OAAO;AACR,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC5D;AACA,SAAO;AACX;;;ACPA,SAAS,cAAAA,mBAAkB;AAEpB,IAAM,WAAW,MAAoB;AACxC,QAAM,UAAUA,YAAW,aAAa;AACxC,MAAI,CAAC,SAAS;AACV,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC5D;AACA,SAAO;AACX;;;ACPA,SAAS,cAAc;AACvB,YAAY,eAAe;AAC3B,SAAS,SAAS;AAClB,SAAkB,eAAAC,oBAAmB;AAuCzB,SAGI,OAAAC,MAHJ;AAjCL,IAAM,YAAgC,CAAC,UAA0B;AACpE,QAAM,EAAE,QAAQ,WAAW,IAAI;AAC/B,QAAM,EAAE,MAAM,IAAI,SAAS;AAC3B,QAAM,EAAE,QAAQ,QAAQ,IAAI,cAAc;AAC1C,QAAM,MAAMD,aAAY,CAAC,SAA+B;AACpD,QAAI,CAAC,MAAM;AACP,qBAAe,MAAM;AACjB,eAAO,OAAO,IAAI,OAAO,QAAQ;AAAA,MACrC,CAAC;AAAA,IACL;AAAA,EACJ,GAAG;AAAA,IACC;AAAA,IACA,OAAO;AAAA,IACP,OAAO;AAAA,EACX,CAAC;AACD,QAAM,WAAW,OAAO,WAAW;AACnC,SAAQ,gBAAAC;AAAA,IAAW;AAAA,IAAV;AAAA,MACL;AAAA,MACA,MAAM,OAAO;AAAA,MACb,cAAc,CAAC,SAAS;AACpB,YAAI,CAAC,MAAM;AACP,gBAAM,OAAO,EAAE;AAAA,QACnB;AAAA,MACJ;AAAA,MACA,UAAU,aAAa,IAAI,WAAW;AAAA,MACtC,MAAM,OAAO,aAAa,SAAS,eAAe;AAAA,MAClD,WAAU;AAAA,MACV,aAAW,OAAO,QAAQ;AAAA,MAC1B,OAAO,CAAC,OAAO;AAAA,MAEf;AAAA,QAAC;AAAA;AAAA,UACG,WAAU;AAAA,UAEV;AAAA;AAAA,cAAC;AAAA;AAAA,gBACG,WAAU;AAAA,gBAEV;AAAA,kCAAAA;AAAA,oBAAW;AAAA,oBAAV;AAAA,sBACG,WAAU;AAAA,sBAET,iBAAO;AAAA;AAAA,kBACZ;AAAA,kBACC,OAAO,eAAgB,gBAAAA;AAAA,oBAAW;AAAA,oBAAV;AAAA,sBACrB,WAAU;AAAA,sBAET,iBAAO;AAAA;AAAA,kBACZ;AAAA;AAAA;AAAA,YACJ;AAAA,YACC,OAAO,UAAW,gBAAAA;AAAA,cAAW;AAAA,cAAV;AAAA,gBAChB,SAAO;AAAA,gBACP,SAAS,OAAO,OAAO;AAAA,gBAEvB,0BAAAA;AAAA,kBAAC;AAAA;AAAA,oBACG,SAAQ;AAAA,oBACR,WAAU;AAAA,oBACV,MAAK;AAAA,oBACL,UAAU,OAAO,OAAO;AAAA,oBACxB,SAAS,OAAO,OAAO;AAAA,oBAEtB,iBAAO,OAAO;AAAA;AAAA,gBACnB;AAAA;AAAA,YACJ;AAAA,YACA,gBAAAA;AAAA,cAAW;AAAA,cAAV;AAAA,gBACG,SAAO;AAAA,gBACP,cAAY;AAAA,gBAEZ,0BAAAA;AAAA,kBAAC;AAAA;AAAA,oBACG,SAAQ;AAAA,oBACR,WAAU;AAAA,oBACV,QAAO;AAAA,oBACP,MAAK;AAAA,oBAEL,0BAAAA;AAAA,sBAAC;AAAA;AAAA,wBACG,eAAY;AAAA;AAAA,oBAChB;AAAA;AAAA,gBACJ;AAAA;AAAA,YACJ;AAAA;AAAA;AAAA,MACJ;AAAA;AAAA,EACJ;AACJ;;;ACvFA,SAAS,uBAAuB,uBAAuB,qBAAqB;AAC5E,SAAS,UAAU;AACnB,YAAYC,gBAAe;AAC3B,SAA8C,WAAW,YAAAC,iBAAgB;AACzE,SAAS,oBAAoB;AAsBJ,SAOL,OAAAC,MAPK,QAAAC,aAAA;AAflB,IAAM,UAA4B,CAAC,UAAwB;AAC9D,QAAM,EAAE,KAAK,cAAc,OAAO,YAAY,WAAW,WAAW,GAAG,UAAU,IAAI;AACrF,QAAM,eAAe,cAAc,EAAE,KAAK,aAAa,CAAC;AACxD,QAAM,MAAM,sBAAsB,EAAE,KAAK,aAAa,CAAC;AACvD,QAAM,EAAE,SAAS,QAAQ,IAAI,cAAc;AAC3C,QAAM;AAAA,IACF;AAAA,IACA;AAAA,EACJ,IAAIF,UAAS,KAAK;AAClB,YAAU,MAAM;AACZ,eAAW,IAAI;AAAA,EACnB,GAAG,CAAC,CAAC;AACL,MAAI,CAAC,SAAS;AACV,WAAO;AAAA,EACX;AACA,SAAO,aAAc,gBAAAE;AAAA,IAAW;AAAA,IAAV;AAAA,MAClB;AAAA,MACA,UAAU,YAAY,IAAI,WAAW;AAAA,MACrC,gBAAe;AAAA,MACf,oBAAoB;AAAA,MAEnB;AAAA,gBAAQ,IAAI,YAAU;AACnB,iBAAQ,gBAAAD;AAAA,YAAC;AAAA;AAAA,cAEL;AAAA,cACA;AAAA;AAAA,YAFK,GAAG,OAAO,EAAE,IAAI,OAAO,QAAQ;AAAA,UAGxC;AAAA,QACJ,CAAC;AAAA,QACD,gBAAAA;AAAA,UAAW;AAAA,UAAV;AAAA,YACI,GAAG;AAAA,YACH,GAAG;AAAA,YACJ;AAAA,YACA;AAAA,YACA,WAAW,GAAG,yBAAyB,SAAS;AAAA;AAAA,QACpD;AAAA;AAAA;AAAA,EACJ,GAAwB,aAAa,SAAS,IAAI;AACtD;",
|
|
6
6
|
"names": ["useContext", "useCallback", "jsx", "Primitive", "useState", "jsx", "jsxs"]
|
|
7
7
|
}
|
package/docs/catalog.json
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"name": "@gridui/toast",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.9",
|
|
5
5
|
"category": "core",
|
|
6
6
|
"description": "GridUI React toast",
|
|
7
|
-
"usage": "
|
|
7
|
+
"usage": "Component reference contains focused API pages for each public component.",
|
|
8
8
|
"documentation": [
|
|
9
|
-
"README.md"
|
|
9
|
+
"README.md",
|
|
10
|
+
"docs/reference/README.md",
|
|
11
|
+
"docs/reference/toast-provider.md",
|
|
12
|
+
"docs/reference/toaster.md"
|
|
10
13
|
],
|
|
11
14
|
"exports": [
|
|
12
15
|
{
|
|
@@ -62,6 +65,9 @@
|
|
|
62
65
|
"@gridui/toast/styles.css"
|
|
63
66
|
],
|
|
64
67
|
"examples": [
|
|
68
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/stories/getting-started.mdx",
|
|
69
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/stories/notifications.mdx",
|
|
70
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/stories/ongoing-notifications.mdx",
|
|
65
71
|
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/stories/toast.stories.tsx"
|
|
66
72
|
]
|
|
67
73
|
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# ToastProvider
|
|
3
|
+
|
|
4
|
+
Compose ToastProvider with Toaster inside the same @gridui/toast component family.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/toast`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { ToastProvider } from "@gridui/toast";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/toast/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/stories/toast.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### timeout
|
|
29
|
+
|
|
30
|
+
``number | undefined`` · Optional
|
|
31
|
+
|
|
32
|
+
Default: ``5000``
|
|
33
|
+
|
|
34
|
+
### limit
|
|
35
|
+
|
|
36
|
+
``number | undefined`` · Optional
|
|
37
|
+
|
|
38
|
+
Default: ``3``
|
|
39
|
+
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# Toaster
|
|
3
|
+
|
|
4
|
+
Hosts temporary notifications above the page. Use inline notices for feedback that must remain attached to specific content.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/toast`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { Toaster } from "@gridui/toast";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/toast/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/toast/stories/toast.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### onFocus
|
|
23
|
+
|
|
24
|
+
``(event: FocusEvent<HTMLOListElement, Element>): void`` · Optional
|
|
25
|
+
|
|
26
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
27
|
+
|
|
28
|
+
### onBlur
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLOListElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onChange
|
|
35
|
+
|
|
36
|
+
``(event: ChangeEvent<HTMLOListElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onSubmit
|
|
41
|
+
|
|
42
|
+
``(event: SubmitEvent<HTMLOListElement>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onClick
|
|
47
|
+
|
|
48
|
+
``(event: MouseEvent<HTMLOListElement, MouseEvent>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### closeLabel
|
|
53
|
+
|
|
54
|
+
``string`` · Required
|
|
55
|
+
|
|
56
|
+
### label
|
|
57
|
+
|
|
58
|
+
``string`` · Required
|
|
59
|
+
|
|
60
|
+
### container
|
|
61
|
+
|
|
62
|
+
``HTMLElement | undefined`` · Optional
|
|
63
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gridui/toast",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.9",
|
|
4
4
|
"description": "GridUI React toast",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
@@ -27,10 +27,10 @@
|
|
|
27
27
|
"react-dom": "^19.2.0"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@gridui/button": "^
|
|
31
|
-
"@gridui/overlay": "^2.
|
|
32
|
-
"@gridui/style-utils": "^
|
|
33
|
-
"@gridui/theme": "^2.5.
|
|
30
|
+
"@gridui/button": "^5.0.0",
|
|
31
|
+
"@gridui/overlay": "^2.1.0",
|
|
32
|
+
"@gridui/style-utils": "^4.0.0",
|
|
33
|
+
"@gridui/theme": "^2.5.4",
|
|
34
34
|
"@radix-ui/react-toast": "1.3.1",
|
|
35
35
|
"lucide-react": "1.70.0"
|
|
36
36
|
},
|