@frigade/react 1.32.77 → 1.32.78

package/lib/index.d.ts

@@ -117,6 +117,9 @@ interface DefaultFrigadeFlowProps {
     style?: CSSProperties;
     className?: string;
     appearance?: Appearance;
+    /**
+     * Dynamic variables to use in flow-data.yml. See https://docs.frigade.com/flows/dynamic-variables
+     */
     customVariables?: {
         [key: string]: string | number | boolean;
     };
@@ -448,28 +451,50 @@ interface ToolTipData extends StepData {
     titleStyle?: CSSProperties;
     buttonStyle?: CSSProperties;
 }
-interface ToolTipProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
+
+interface FrigadeTourProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
+    /**
+     * @ignore
+     */
     steps?: ToolTipData[];
     onDismiss?: () => void;
     onComplete?: () => void;
     tooltipPosition?: ToolTipPosition;
+    /**
+     * Whether to show the highlight (the small circle/ping) or not. Defaults to true.
+     */
     showHighlight?: boolean;
+    /**
+     * Whether to show more than one tooltip at a time. Defaults to false.
+     */
     showTooltipsSimultaneously?: boolean;
+    /**
+     * @ignore
+     */
     buttonStyle?: CSSProperties;
+    /**
+     * Offset to apply to all tooltips.
+     */
     offset?: {
         x: number;
         y: number;
     };
     visible?: boolean;
+    /**
+     * @ignore
+     */
     containerStyle?: CSSProperties;
     customVariables?: {
         [key: string]: string | number | boolean;
     };
+    /**
+     * @ignore
+     */
     selectedStep?: number;
     customStepTypes?: Record<string, (stepData: StepData) => React__default.ReactNode>;
     appearance?: Appearance;
     /**
-     * Shows a close button in the top right corner of the tooltip. This will end the flow.
+     * Shows a close button in the top right corner of the tooltip. Depending on dismissBehavior, it will either end the entire flow or just the current step.
      */
     dismissible?: boolean;
     primaryColor?: string;
@@ -483,14 +508,16 @@ interface ToolTipProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
      */
     showStepCount?: boolean;
     /**
-     * 'complete-flow' (default): Completes the entire flow/tour when a single tooltip is dismissed.
-     * 'complete-step': Completes the current step when a tooltip is dismissed.
+     * `complete-flow` (default): Completes the entire flow/tour when a single tooltip is dismissed.
+     * `complete-step`: Completes the current step when a tooltip is dismissed.
      */
     dismissBehavior?: 'complete-flow' | 'complete-step';
+    /**
+     * @ignore
+     */
     showFrigadeBranding?: boolean;
 }
-
-declare const FrigadeTour: FC<ToolTipProps & {
+declare const FrigadeTour: FC<FrigadeTourProps & {
     flowId: string;
     initialSelectedStep?: number;
 }>;