@ttoss/react-wizard 0.4.8 → 0.4.10

package/dist/index.d.cts

@@ -1,8 +1,9 @@
-import * as React from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 
+import * as React from "react";
+//#region src/Wizard.styles.d.ts
 type WizardVariant = 'spotlight-accent' | 'spotlight-primary' | 'primary' | 'secondary' | 'accent';
-
+//#endregion
+//#region src/types.d.ts
 /**
  * Position of the step list relative to the wizard content.
  */
@@ -15,126 +16,127 @@ type WizardStepStatus = 'completed' | 'active' | 'upcoming';
  * Definition of a single wizard step.
  */
 interface WizardStep {
-    /**
-     * Title displayed in the step list.
-     */
-    title: string;
-    /**
-     * Optional description displayed below the title in the step list.
-     */
-    description?: string;
-    /**
-     * The content rendered when this step is active.
-     */
-    content: React.ReactNode;
-    /**
-     * Called when the user clicks "Next". If it returns false or
-     * a Promise that resolves to false, the wizard will not advance.
-     */
-    onNext?: () => boolean | Promise<boolean>;
+  /**
+   * Title displayed in the step list.
+   */
+  title: string;
+  /**
+   * Optional description displayed below the title in the step list.
+   */
+  description?: string;
+  /**
+   * The content rendered when this step is active.
+   */
+  content: React.ReactNode;
+  /**
+   * Called when the user clicks "Next". If it returns false or
+   * a Promise that resolves to false, the wizard will not advance.
+   */
+  onNext?: () => boolean | Promise<boolean>;
 }
 /**
  * Props for the Wizard component.
  */
 interface WizardProps {
-    /**
-     * Array of steps to display in the wizard.
-     */
-    steps: WizardStep[];
-    /**
-     * Position of the step list. Defaults to 'top'.
-     */
-    layout?: WizardLayout;
-    /**
-     * Visual variant for the wizard shell, step accents, and primary action.
-     * @default 'spotlight-accent'
-     */
-    variant?: WizardVariant;
-    /**
-     * Called when the wizard completes (user clicks "Finish" on the last step).
-     */
-    onComplete?: () => void;
-    /**
-     * Called when the user clicks "Cancel".
-     * If not provided, the Cancel button is not rendered.
-     */
-    onCancel?: () => void;
-    /**
-     * Called whenever the active step changes.
-     */
-    onStepChange?: (params: {
-        stepIndex: number;
-    }) => void;
-    /**
-     * The initially active step index. Defaults to 0.
-     */
-    initialStep?: number;
-    /**
-     * Allow clicking on completed steps to navigate back.
-     * Defaults to true.
-     */
-    allowStepClick?: boolean;
-    /**
-     * Optional custom labels for the navigation buttons.
-     */
-    labels?: Partial<WizardLabels>;
+  /**
+   * Array of steps to display in the wizard.
+   */
+  steps: WizardStep[];
+  /**
+   * Position of the step list. Defaults to 'top'.
+   */
+  layout?: WizardLayout;
+  /**
+   * Visual variant for the wizard shell, step accents, and primary action.
+   * @default 'spotlight-accent'
+   */
+  variant?: WizardVariant;
+  /**
+   * Called when the wizard completes (user clicks "Finish" on the last step).
+   */
+  onComplete?: () => void;
+  /**
+   * Called when the user clicks "Cancel".
+   * If not provided, the Cancel button is not rendered.
+   */
+  onCancel?: () => void;
+  /**
+   * Called whenever the active step changes.
+   */
+  onStepChange?: (params: {
+    stepIndex: number;
+  }) => void;
+  /**
+   * The initially active step index. Defaults to 0.
+   */
+  initialStep?: number;
+  /**
+   * Allow clicking on completed steps to navigate back.
+   * Defaults to true.
+   */
+  allowStepClick?: boolean;
+  /**
+   * Optional custom labels for the navigation buttons.
+   */
+  labels?: Partial<WizardLabels>;
 }
 /**
  * Customizable labels used by the wizard navigation buttons.
  */
 interface WizardLabels {
-    previous: string;
-    next: string;
-    finish: string;
-    cancel: string;
+  previous: string;
+  next: string;
+  finish: string;
+  cancel: string;
 }
 /**
  * Context value exposed by WizardProvider.
  */
 interface WizardContextValue {
-    /**
-     * Current active step index.
-     */
-    currentStep: number;
-    /**
-     * Total number of steps.
-     */
-    totalSteps: number;
-    /**
-     * Navigate to the next step.
-     */
-    goToNext: () => Promise<void>;
-    /**
-     * Navigate to the previous step.
-     */
-    goToPrevious: () => void;
-    /**
-     * Navigate to a specific step (only if it's completed or active).
-     */
-    goToStep: (params: {
-        stepIndex: number;
-    }) => void;
-    /**
-     * Whether the wizard is on the first step.
-     */
-    isFirstStep: boolean;
-    /**
-     * Whether the wizard is on the last step.
-     */
-    isLastStep: boolean;
-    /**
-     * Get the status of a step by index.
-     */
-    getStepStatus: (params: {
-        stepIndex: number;
-    }) => WizardStepStatus;
-    /**
-     * Register a validation function for the current step.
-     * This allows step content components to provide their own validation logic.
-     */
-    setStepValidation: (validate: () => boolean | Promise<boolean>) => void;
+  /**
+   * Current active step index.
+   */
+  currentStep: number;
+  /**
+   * Total number of steps.
+   */
+  totalSteps: number;
+  /**
+   * Navigate to the next step.
+   */
+  goToNext: () => Promise<void>;
+  /**
+   * Navigate to the previous step.
+   */
+  goToPrevious: () => void;
+  /**
+   * Navigate to a specific step (only if it's completed or active).
+   */
+  goToStep: (params: {
+    stepIndex: number;
+  }) => void;
+  /**
+   * Whether the wizard is on the first step.
+   */
+  isFirstStep: boolean;
+  /**
+   * Whether the wizard is on the last step.
+   */
+  isLastStep: boolean;
+  /**
+   * Get the status of a step by index.
+   */
+  getStepStatus: (params: {
+    stepIndex: number;
+  }) => WizardStepStatus;
+  /**
+   * Register a validation function for the current step.
+   * This allows step content components to provide their own validation logic.
+   */
+  setStepValidation: (validate: () => boolean | Promise<boolean>) => void;
 }
-
+//#endregion
+//#region src/Wizard.d.ts
 /**
  * Renders a multi-step wizard with step navigation, localized action labels,
  * and support for completion, cancellation, and step changes.
@@ -146,13 +148,24 @@ interface WizardContextValue {
  * @param props.onStepChange - Called when the current step changes.
  */
 declare const Wizard: {
-    ({ steps, layout, variant, onComplete, onCancel, onStepChange, initialStep, allowStepClick, labels, }: WizardProps): react_jsx_runtime.JSX.Element;
-    displayName: string;
+  ({
+    steps,
+    layout,
+    variant,
+    onComplete,
+    onCancel,
+    onStepChange,
+    initialStep,
+    allowStepClick,
+    labels
+  }: WizardProps): import("react/jsx-runtime").JSX.Element;
+  displayName: string;
 };
-
+//#endregion
+//#region src/WizardContext.d.ts
 /**
  * Hook to access the wizard context from within step content.
  */
 declare const useWizard: () => WizardContextValue;
-
-export { Wizard, type WizardContextValue, type WizardLabels, type WizardLayout, type WizardProps, type WizardStep, type WizardStepStatus, type WizardVariant, useWizard };
+//#endregion
+export { Wizard, type WizardContextValue, type WizardLabels, type WizardLayout, type WizardProps, type WizardStep, type WizardStepStatus, type WizardVariant, useWizard };

package/dist/index.d.mts

@@ -0,0 +1,172 @@
+
+import * as React from "react";
+
+//#region src/Wizard.styles.d.ts
+type WizardVariant = 'spotlight-accent' | 'spotlight-primary' | 'primary' | 'secondary' | 'accent';
+//#endregion
+//#region src/types.d.ts
+/**
+ * Position of the step list relative to the wizard content.
+ */
+type WizardLayout = 'top' | 'right' | 'bottom' | 'left';
+/**
+ * Status of a wizard step.
+ */
+type WizardStepStatus = 'completed' | 'active' | 'upcoming';
+/**
+ * Definition of a single wizard step.
+ */
+interface WizardStep {
+  /**
+   * Title displayed in the step list.
+   */
+  title: string;
+  /**
+   * Optional description displayed below the title in the step list.
+   */
+  description?: string;
+  /**
+   * The content rendered when this step is active.
+   */
+  content: React.ReactNode;
+  /**
+   * Called when the user clicks "Next". If it returns false or
+   * a Promise that resolves to false, the wizard will not advance.
+   */
+  onNext?: () => boolean | Promise<boolean>;
+}
+/**
+ * Props for the Wizard component.
+ */
+interface WizardProps {
+  /**
+   * Array of steps to display in the wizard.
+   */
+  steps: WizardStep[];
+  /**
+   * Position of the step list. Defaults to 'top'.
+   */
+  layout?: WizardLayout;
+  /**
+   * Visual variant for the wizard shell, step accents, and primary action.
+   * @default 'spotlight-accent'
+   */
+  variant?: WizardVariant;
+  /**
+   * Called when the wizard completes (user clicks "Finish" on the last step).
+   */
+  onComplete?: () => void;
+  /**
+   * Called when the user clicks "Cancel".
+   * If not provided, the Cancel button is not rendered.
+   */
+  onCancel?: () => void;
+  /**
+   * Called whenever the active step changes.
+   */
+  onStepChange?: (params: {
+    stepIndex: number;
+  }) => void;
+  /**
+   * The initially active step index. Defaults to 0.
+   */
+  initialStep?: number;
+  /**
+   * Allow clicking on completed steps to navigate back.
+   * Defaults to true.
+   */
+  allowStepClick?: boolean;
+  /**
+   * Optional custom labels for the navigation buttons.
+   */
+  labels?: Partial<WizardLabels>;
+}
+/**
+ * Customizable labels used by the wizard navigation buttons.
+ */
+interface WizardLabels {
+  previous: string;
+  next: string;
+  finish: string;
+  cancel: string;
+}
+/**
+ * Context value exposed by WizardProvider.
+ */
+interface WizardContextValue {
+  /**
+   * Current active step index.
+   */
+  currentStep: number;
+  /**
+   * Total number of steps.
+   */
+  totalSteps: number;
+  /**
+   * Navigate to the next step.
+   */
+  goToNext: () => Promise<void>;
+  /**
+   * Navigate to the previous step.
+   */
+  goToPrevious: () => void;
+  /**
+   * Navigate to a specific step (only if it's completed or active).
+   */
+  goToStep: (params: {
+    stepIndex: number;
+  }) => void;
+  /**
+   * Whether the wizard is on the first step.
+   */
+  isFirstStep: boolean;
+  /**
+   * Whether the wizard is on the last step.
+   */
+  isLastStep: boolean;
+  /**
+   * Get the status of a step by index.
+   */
+  getStepStatus: (params: {
+    stepIndex: number;
+  }) => WizardStepStatus;
+  /**
+   * Register a validation function for the current step.
+   * This allows step content components to provide their own validation logic.
+   */
+  setStepValidation: (validate: () => boolean | Promise<boolean>) => void;
+}
+//#endregion
+//#region src/Wizard.d.ts
+/**
+ * Renders a multi-step wizard with step navigation, localized action labels,
+ * and support for completion, cancellation, and step changes.
+ *
+ * @param props - Wizard configuration and step content.
+ * @param props.steps - The ordered steps displayed in the wizard.
+ * @param props.onComplete - Called when the user finishes the last step.
+ * @param props.onCancel - Called when the user cancels the wizard.
+ * @param props.onStepChange - Called when the current step changes.
+ */
+declare const Wizard: {
+  ({
+    steps,
+    layout,
+    variant,
+    onComplete,
+    onCancel,
+    onStepChange,
+    initialStep,
+    allowStepClick,
+    labels
+  }: WizardProps): import("react/jsx-runtime").JSX.Element;
+  displayName: string;
+};
+//#endregion
+//#region src/WizardContext.d.ts
+/**
+ * Hook to access the wizard context from within step content.
+ */
+declare const useWizard: () => WizardContextValue;
+//#endregion
+export { Wizard, type WizardContextValue, type WizardLabels, type WizardLayout, type WizardProps, type WizardStep, type WizardStepStatus, type WizardVariant, useWizard };