@spark-ui/components 10.18.1 → 10.19.0

package/dist/avatar/index.d.mts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
+import * as React$1 from 'react';
 import { ComponentPropsWithoutRef } from 'react';
 
 interface AvatarImageProps$1 extends React.ImgHTMLAttributes<HTMLImageElement> {
@@ -45,7 +45,7 @@ declare const AvatarPlaceholder: {
     displayName: string;
 };
 
-interface AvatarProps extends react.HTMLAttributes<HTMLDivElement> {
+interface AvatarProps extends React$1.HTMLAttributes<HTMLDivElement> {
     size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
     isOnline?: boolean;
     onlineText?: string;

package/dist/avatar/index.d.ts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
+import * as React$1 from 'react';
 import { ComponentPropsWithoutRef } from 'react';
 
 interface AvatarImageProps$1 extends React.ImgHTMLAttributes<HTMLImageElement> {
@@ -45,7 +45,7 @@ declare const AvatarPlaceholder: {
     displayName: string;
 };
 
-interface AvatarProps extends react.HTMLAttributes<HTMLDivElement> {
+interface AvatarProps extends React$1.HTMLAttributes<HTMLDivElement> {
     size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
     isOnline?: boolean;
     onlineText?: string;

package/dist/docgen.json

@@ -43840,6 +43840,362 @@
       }
     }
   },
+  "Toast": {
+    "tags": {},
+    "description": "",
+    "displayName": "Toast",
+    "methods": [],
+    "props": {
+      "toast": {
+        "defaultValue": null,
+        "description": "",
+        "name": "toast",
+        "declarations": [
+          {
+            "fileName": "src/toast/Toast.tsx",
+            "name": "TypeLiteral"
+          }
+        ],
+        "required": true,
+        "type": {
+          "name": "ToastObject"
+        }
+      }
+    }
+  },
+  "ToastProvider": {
+    "tags": {},
+    "description": "",
+    "displayName": "ToastProvider",
+    "methods": [],
+    "props": {
+      "timeout": {
+        "defaultValue": {
+          "value": "5000"
+        },
+        "description": "The default amount of time (in ms) before a toast is auto dismissed.\nA value of `0` will prevent the toast from being dismissed automatically.",
+        "name": "timeout",
+        "parent": {
+          "fileName": "spark-web/node_modules/@base-ui-components/react/toast/provider/ToastProvider.d.ts",
+          "name": "Props"
+        },
+        "declarations": [
+          {
+            "fileName": "spark-web/node_modules/@base-ui-components/react/toast/provider/ToastProvider.d.ts",
+            "name": "Props"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "number"
+        }
+      },
+      "limit": {
+        "defaultValue": {
+          "value": 3
+        },
+        "description": "The maximum number of toasts that can be displayed at once.\nWhen the limit is reached, the oldest toast will be removed to make room for the new one.",
+        "name": "limit",
+        "parent": {
+          "fileName": "spark-web/node_modules/@base-ui-components/react/toast/provider/ToastProvider.d.ts",
+          "name": "Props"
+        },
+        "declarations": [
+          {
+            "fileName": "spark-web/node_modules/@base-ui-components/react/toast/provider/ToastProvider.d.ts",
+            "name": "Props"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "number"
+        }
+      },
+      "toastManager": {
+        "defaultValue": null,
+        "description": "A global manager for toasts to use outside of a React component.",
+        "name": "toastManager",
+        "parent": {
+          "fileName": "spark-web/node_modules/@base-ui-components/react/toast/provider/ToastProvider.d.ts",
+          "name": "Props"
+        },
+        "declarations": [
+          {
+            "fileName": "spark-web/node_modules/@base-ui-components/react/toast/provider/ToastProvider.d.ts",
+            "name": "Props"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "ToastManager"
+        }
+      }
+    }
+  },
+  "ToastTrigger": {
+    "tags": {},
+    "description": "",
+    "displayName": "ToastTrigger",
+    "methods": [],
+    "props": {
+      "asChild": {
+        "defaultValue": {
+          "value": false
+        },
+        "description": "",
+        "name": "asChild",
+        "parent": {
+          "fileName": "src/toast/index.tsx",
+          "name": "ToastTriggerProps"
+        },
+        "declarations": [
+          {
+            "fileName": "src/toast/index.tsx",
+            "name": "ToastTriggerProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "boolean"
+        }
+      },
+      "title": {
+        "defaultValue": null,
+        "description": "",
+        "name": "title",
+        "parent": {
+          "fileName": "src/toast/index.tsx",
+          "name": "ToastTriggerProps"
+        },
+        "declarations": [
+          {
+            "fileName": "src/toast/index.tsx",
+            "name": "ToastTriggerProps"
+          }
+        ],
+        "required": true,
+        "type": {
+          "name": "string"
+        }
+      },
+      "description": {
+        "defaultValue": null,
+        "description": "",
+        "name": "description",
+        "parent": {
+          "fileName": "src/toast/index.tsx",
+          "name": "ToastTriggerProps"
+        },
+        "declarations": [
+          {
+            "fileName": "src/toast/index.tsx",
+            "name": "ToastTriggerProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "string"
+        }
+      },
+      "timeout": {
+        "defaultValue": {
+          "value": 5000
+        },
+        "description": "",
+        "name": "timeout",
+        "parent": {
+          "fileName": "src/toast/index.tsx",
+          "name": "ToastTriggerProps"
+        },
+        "declarations": [
+          {
+            "fileName": "src/toast/index.tsx",
+            "name": "ToastTriggerProps"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "number"
+        }
+      },
+      "priority": {
+        "defaultValue": {
+          "value": "low"
+        },
+        "description": "The priority of the toast.\n- `low` - The toast will be announced politely.\n- `high` - The toast will be announced urgently.",
+        "name": "priority",
+        "parent": {
+          "fileName": "spark-web/node_modules/@base-ui-components/react/toast/useToastManager.d.ts",
+          "name": "ToastObject"
+        },
+        "declarations": [
+          {
+            "fileName": "spark-web/node_modules/@base-ui-components/react/toast/useToastManager.d.ts",
+            "name": "ToastObject"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "enum",
+          "raw": "\"high\" | \"low\"",
+          "value": [
+            {
+              "value": "\"high\""
+            },
+            {
+              "value": "\"low\""
+            }
+          ]
+        }
+      },
+      "design": {
+        "defaultValue": {
+          "value": "filled"
+        },
+        "description": "",
+        "name": "design",
+        "parent": {
+          "fileName": "components/src/toast/types.ts",
+          "name": "ToastData"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/toast/types.ts",
+            "name": "ToastData"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "enum",
+          "raw": "ToastDesign",
+          "value": [
+            {
+              "value": "\"filled\""
+            },
+            {
+              "value": "\"tinted\""
+            }
+          ]
+        }
+      },
+      "intent": {
+        "defaultValue": {
+          "value": "neutral"
+        },
+        "description": "",
+        "name": "intent",
+        "parent": {
+          "fileName": "components/src/toast/types.ts",
+          "name": "ToastData"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/toast/types.ts",
+            "name": "ToastData"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "enum",
+          "raw": "ToastIntent",
+          "value": [
+            {
+              "value": "\"main\""
+            },
+            {
+              "value": "\"alert\""
+            },
+            {
+              "value": "\"support\""
+            },
+            {
+              "value": "\"accent\""
+            },
+            {
+              "value": "\"success\""
+            },
+            {
+              "value": "\"info\""
+            },
+            {
+              "value": "\"neutral\""
+            },
+            {
+              "value": "\"surface\""
+            },
+            {
+              "value": "\"basic\""
+            },
+            {
+              "value": "\"error\""
+            },
+            {
+              "value": "\"surfaceInverse\""
+            }
+          ]
+        }
+      },
+      "icon": {
+        "defaultValue": null,
+        "description": "",
+        "name": "icon",
+        "parent": {
+          "fileName": "components/src/toast/types.ts",
+          "name": "ToastData"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/toast/types.ts",
+            "name": "ToastData"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "ReactNode"
+        }
+      },
+      "isClosable": {
+        "defaultValue": {
+          "value": true
+        },
+        "description": "",
+        "name": "isClosable",
+        "parent": {
+          "fileName": "components/src/toast/types.ts",
+          "name": "ToastData"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/toast/types.ts",
+            "name": "ToastData"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "boolean"
+        }
+      },
+      "action": {
+        "defaultValue": null,
+        "description": "",
+        "name": "action",
+        "parent": {
+          "fileName": "components/src/toast/types.ts",
+          "name": "ToastData"
+        },
+        "declarations": [
+          {
+            "fileName": "components/src/toast/types.ts",
+            "name": "ToastData"
+          }
+        ],
+        "required": false,
+        "type": {
+          "name": "any"
+        }
+      }
+    }
+  },
   "VisuallyHidden": {
     "tags": {},
     "description": "",

package/dist/toast/index.d.mts

@@ -0,0 +1,56 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Toast } from '@base-ui-components/react/toast';
+import * as React from 'react';
+import { ButtonProps } from '../button/index.mjs';
+import 'class-variance-authority/types';
+import 'class-variance-authority';
+
+type ToastIntent = 'main' | 'support' | 'accent' | 'basic' | 'success' | 'alert' | 'error' | 'info' | 'neutral' | 'surface' | 'surfaceInverse';
+type ToastDesign = 'tinted' | 'filled';
+interface ToastData {
+    icon?: React.ReactNode;
+    design?: ToastDesign;
+    intent?: ToastIntent;
+    isClosable?: boolean;
+    closeLabel?: string;
+    action?: {
+        close?: boolean;
+        label: string;
+        onClick: () => void;
+    } & ButtonProps;
+}
+type ToastObject = Toast.Root.ToastObject<ToastData>;
+interface AddOptions extends Omit<ToastObject, 'id' | 'animation' | 'height' | 'ref' | 'limited'> {
+    id?: string;
+}
+type UpdateOptions = Partial<AddOptions>;
+interface PromiseOptions<Value> {
+    loading: string | UpdateOptions;
+    success: string | UpdateOptions | ((result: Value) => string | UpdateOptions);
+    error: string | UpdateOptions | ((error: any) => string | UpdateOptions);
+}
+interface UseToastManagerReturnValue {
+    toasts: ToastObject[];
+    add: (options: AddOptions) => string;
+    update: (toastId: string, options: UpdateOptions) => void;
+    close: (toastId: string) => void;
+    promise: <Value>(promise: Promise<Value>, options: PromiseOptions<Value>) => Promise<Value>;
+    closeAll: () => void;
+}
+
+declare function useToastManager(): UseToastManagerReturnValue;
+
+interface ToastProviderProps extends React.ComponentProps<typeof Toast.Provider> {
+    children: React.ReactNode;
+}
+declare function ToastProvider({ children, limit }: ToastProviderProps): react_jsx_runtime.JSX.Element;
+interface ToastTriggerProps extends React.ComponentPropsWithRef<'button'>, Pick<ToastObject, 'priority'>, Pick<ToastData, 'design' | 'intent' | 'icon' | 'isClosable' | 'action'> {
+    children: React.ReactNode;
+    asChild?: boolean;
+    title: string;
+    description?: string;
+    timeout?: number;
+}
+declare function ToastTrigger({ children, onClick, asChild, title, description, timeout, design, intent, isClosable, icon, action, priority, }: ToastTriggerProps): react_jsx_runtime.JSX.Element;
+
+export { type ToastData, type ToastDesign, type ToastIntent, type ToastObject, ToastProvider, ToastTrigger, type UseToastManagerReturnValue, useToastManager };

package/dist/toast/index.d.ts

@@ -0,0 +1,56 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Toast } from '@base-ui-components/react/toast';
+import * as React from 'react';
+import { ButtonProps } from '../button/index.js';
+import 'class-variance-authority/types';
+import 'class-variance-authority';
+
+type ToastIntent = 'main' | 'support' | 'accent' | 'basic' | 'success' | 'alert' | 'error' | 'info' | 'neutral' | 'surface' | 'surfaceInverse';
+type ToastDesign = 'tinted' | 'filled';
+interface ToastData {
+    icon?: React.ReactNode;
+    design?: ToastDesign;
+    intent?: ToastIntent;
+    isClosable?: boolean;
+    closeLabel?: string;
+    action?: {
+        close?: boolean;
+        label: string;
+        onClick: () => void;
+    } & ButtonProps;
+}
+type ToastObject = Toast.Root.ToastObject<ToastData>;
+interface AddOptions extends Omit<ToastObject, 'id' | 'animation' | 'height' | 'ref' | 'limited'> {
+    id?: string;
+}
+type UpdateOptions = Partial<AddOptions>;
+interface PromiseOptions<Value> {
+    loading: string | UpdateOptions;
+    success: string | UpdateOptions | ((result: Value) => string | UpdateOptions);
+    error: string | UpdateOptions | ((error: any) => string | UpdateOptions);
+}
+interface UseToastManagerReturnValue {
+    toasts: ToastObject[];
+    add: (options: AddOptions) => string;
+    update: (toastId: string, options: UpdateOptions) => void;
+    close: (toastId: string) => void;
+    promise: <Value>(promise: Promise<Value>, options: PromiseOptions<Value>) => Promise<Value>;
+    closeAll: () => void;
+}
+
+declare function useToastManager(): UseToastManagerReturnValue;
+
+interface ToastProviderProps extends React.ComponentProps<typeof Toast.Provider> {
+    children: React.ReactNode;
+}
+declare function ToastProvider({ children, limit }: ToastProviderProps): react_jsx_runtime.JSX.Element;
+interface ToastTriggerProps extends React.ComponentPropsWithRef<'button'>, Pick<ToastObject, 'priority'>, Pick<ToastData, 'design' | 'intent' | 'icon' | 'isClosable' | 'action'> {
+    children: React.ReactNode;
+    asChild?: boolean;
+    title: string;
+    description?: string;
+    timeout?: number;
+}
+declare function ToastTrigger({ children, onClick, asChild, title, description, timeout, design, intent, isClosable, icon, action, priority, }: ToastTriggerProps): react_jsx_runtime.JSX.Element;
+
+export { type ToastData, type ToastDesign, type ToastIntent, type ToastObject, ToastProvider, ToastTrigger, type UseToastManagerReturnValue, useToastManager };