@carbon/ibm-products-web-components/es/patterns/step-flow/step-flow-signal.test.js

Carbon for IBM Products Web Components

/**
 * Copyright IBM Corp. 2024
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */

import { describe, it, expect } from 'vitest';
import { StepInstance } from './step-flow-signal.js';

/**
 * Copyright IBM Corp. 2025, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
describe('step flow', () => {
    it('should initial and return default signal state', () => {
        const { totalSteps, formState, currentStep } = new StepInstance().data;
        expect(totalSteps).toEqual(0);
        expect(currentStep).toEqual(0);
        expect(formState).toEqual({});
    });
    it('should update total steps', () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 100;
        expect(myStepInstance.data.totalSteps).toEqual(100);
    });
    it('should increment the current step', async () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 100;
        myStepInstance.handleNext();
        expect(myStepInstance.data.currentStep).toEqual(1);
        myStepInstance.handleNext();
        expect(myStepInstance.data.currentStep).toEqual(2);
    });
    it('should decrement the current step', () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 100;
        myStepInstance.handleNext();
        myStepInstance.handleNext();
        myStepInstance.handlePrevious();
        expect(myStepInstance.data.currentStep).toEqual(1);
    });
    it('should update form state', () => {
        const exampleEmail = 'example@example.com';
        const myStepInstance = new StepInstance();
        const savedFormState = structuredClone(myStepInstance.data.formState);
        savedFormState.email = exampleEmail;
        myStepInstance.updateFormState = savedFormState;
        expect(myStepInstance.data.formState.email).toEqual(exampleEmail);
    });
    it('should jump to a step', () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 100;
        myStepInstance.handleGoToStep = 25;
        expect(myStepInstance.data.currentStep).toEqual(25);
    });
    it('should reset to default state', () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 100;
        myStepInstance.handleGoToStep = 25;
        myStepInstance.reset();
        expect(myStepInstance.data.currentStep).toEqual(0);
        expect(myStepInstance.data.formState).toEqual({});
    });
    it('should remain on last step when handleNext is called from the last step', () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 2;
        myStepInstance.handleNext();
        myStepInstance.handleNext();
        myStepInstance.handleNext();
        expect(myStepInstance.data.currentStep).toEqual(2);
    });
    it('should remain on first step when handlePrevious is called from the first step', () => {
        const myStepInstance = new StepInstance();
        myStepInstance.updateTotalStepCount = 10;
        myStepInstance.handleNext();
        myStepInstance.handleNext();
        myStepInstance.handleNext();
        myStepInstance.handlePrevious();
        myStepInstance.handlePrevious();
        myStepInstance.handlePrevious();
        myStepInstance.handlePrevious();
        expect(myStepInstance.data.currentStep).toEqual(0);
    });
});
//# sourceMappingURL=step-flow-signal.test.js.map