@factorialco/f0-react 8.13.0 → 8.14.0

package/dist/experimental.d.ts

@@ -4364,6 +4364,33 @@ declare type CompareToDef = {
 
 declare type CompareToDefKey = string;
 
+export declare interface ConfettiOptions {
+    preset?: ConfettiPreset;
+    /**
+     * Hex colours. `canvas-confetti` parses these with its own hex reader, so
+     * design tokens and `hsl()` strings are silently mangled.
+     */
+    colors?: string[];
+    particleCount?: number;
+    spread?: number;
+    /** Burst only: rain always falls from a random point along the top edge. */
+    origin?: {
+        x?: number;
+        y?: number;
+    };
+    /** Rain only: how long the fall lasts, in milliseconds. */
+    duration?: number;
+}
+
+/**
+ * `canvas-confetti` reads colours as hex and nothing else, so the design tokens
+ * cannot reach the canvas. These are the paper colours from the celebration
+ * design; pass `colors` to override them.
+ */
+export declare const confettiPalette: string[];
+
+export declare type ConfettiPreset = "burst" | "rain";
+
 /**
  * @experimental This is an experimental component use it at your own risk
  */
@@ -9814,6 +9841,25 @@ export declare interface F0CommunityPostsCarouselProps {
     pagination?: CarouselPaging;
 }
 
+/**
+ * @experimental This is an experimental component, use it at your own risk.
+ */
+export declare const F0Confetti: WithDataTestIdReturnType_2<ForwardRefExoticComponent<F0ConfettiProps & RefAttributes<F0ConfettiHandle>>>;
+
+export declare interface F0ConfettiHandle {
+    fire: (options?: ConfettiOptions) => void;
+    reset: () => void;
+}
+
+export declare interface F0ConfettiProps extends WithDataTestIdProps {
+    /** `container` fills the nearest positioned ancestor, `viewport` the screen. */
+    layer?: "container" | "viewport";
+    /** Fires once when the canvas mounts, never again on re-render. */
+    fireOnMount?: boolean;
+    /** Defaults for the mount burst and for `fire()` calls; `fire(options)` overrides them. */
+    options?: ConfettiOptions;
+}
+
 declare type F0DialogActionItem = {
     value: string;
     label: string;
@@ -19474,6 +19520,11 @@ export declare function useCompactOnScroll({ threshold,
     container: React.RefObject<HTMLElement | null>;
 }): boolean;
 
+export declare const useConfetti: (canvasRef: RefObject<HTMLCanvasElement | null>) => {
+    fire: (options?: ConfettiOptions) => void;
+    reset: () => void;
+};
+
 export declare type UseDataCollectionData<R extends RecordType> = UseDataCollectionDataReturn<R> & {
     summaries?: R;
 };
@@ -20833,9 +20884,11 @@ declare module "@tiptap/core" {
 
 declare module "@tiptap/core" {
     interface Commands<ReturnType> {
-        fontSize: {
-            setFontSize: (fontSize: string) => ReturnType;
-            unsetFontSize: () => ReturnType;
+        enhanceHighlight: {
+            setEnhanceHighlight: (from: number, to: number, options?: {
+                placeholder?: string;
+            }) => ReturnType;
+            clearEnhanceHighlight: () => ReturnType;
         };
     }
 }
@@ -20843,11 +20896,9 @@ declare module "@tiptap/core" {
 
 declare module "@tiptap/core" {
     interface Commands<ReturnType> {
-        enhanceHighlight: {
-            setEnhanceHighlight: (from: number, to: number, options?: {
-                placeholder?: string;
-            }) => ReturnType;
-            clearEnhanceHighlight: () => ReturnType;
+        fontSize: {
+            setFontSize: (fontSize: string) => ReturnType;
+            unsetFontSize: () => ReturnType;
         };
     }
 }