JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4927
  • Score
    100M100P100Q155423F
  • License MIT

A react form wizard component with validation and progress bar with no external depenendcies which simplifies tab wizard management.

Package Exports

    Readme

    React Form Wizard Component


    Demo

    A react form wizard component with validation and progress bar with no external dependencies which simplifies tab wizard management.

    version MIT license downloads no dependencies


    ๐Ÿ“šDocument ใƒป ๐Ÿ”Ž Demos ใƒป ๐Ÿ”ฌ Playground . ๐Ÿ“ Blog

    Installation

    To install the package, you can use npm or yarn:

    npm install react-form-wizard-component

    or

    yarn add react-form-wizard-component

    Usage

    Import the FormWizard component and use it in your React application:

    import FormWizard from "react-form-wizard-component";
    import "react-form-wizard-component/dist/style.css";
    
    function App() {
      const handleComplete = () => {
        console.log("Form completed!");
        // Handle form completion logic here
      };
      const tabChanged = ({
        prevIndex,
        nextIndex,
      }: {
        prevIndex: number;
        nextIndex: number;
      }) => {
        console.log("prevIndex", prevIndex);
        console.log("nextIndex", nextIndex);
      };
    
      return (
        <>
          <FormWizard
            shape="circle"
            color="#e74c3c"
            onComplete={handleComplete}
            onTabChange={tabChanged}
          >
            <FormWizard.TabContent title="Personal details" icon="ti-user">
              {/* Add your form inputs and components for the frst step */}
              <h1>First Tab</h1>
              <p>Some content for the first tab</p>
            </FormWizard.TabContent>
            <FormWizard.TabContent title="Additional Info" icon="ti-settings">
              <h1>Second Tab</h1>
              <p>Some content for the second tab</p>
            </FormWizard.TabContent>
            <FormWizard.TabContent title="Last step" icon="ti-check">
              <h1>Last Tab</h1>
              <p>Some content for the last tab</p>
            </FormWizard.TabContent>
          </FormWizard>
          {/* add style */}
          <style>{`
            @import url("https://cdn.jsdelivr.net/gh/lykmapipo/themify-icons@0.1.2/css/themify-icons.css");
          `}</style>
        </>
      );
    }
    
    export default App;

    Examples

    You can find examples of using the react-form-wizard-component in the examples directory.

    License

    This package is licensed under the MIT License. See the LICENSE file for more information.

    Please note that this is a basic README.md template, and you may need to modify it further to match your specific package and requirements.