npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@anivive/vue3-form-wizard

v1.0.1

Published

Vue 3 wizard style json form generator

Downloads

2,008

Readme

Vue 3 Form Wizard

MIT License Vue Typescript Jest Testing Coverage

Introduction

Vue 3 Form Wizard is a JSON configurable, fully customizable, form builder that allows developers to easily create step-based forms.

Form questions can be generated easily by specifying a JSON configuration object. The end result is a step-based form which will display one question at a time.

Support for the most common input types

  • Text Input
  • Textarea
  • Dropdown (filterable)
  • Single and Multi Select Options List
  • Ability to create your own custom input types

Features

  • Fully customizable style
  • Validation of input on a per-step basis
  • Custom validation messages
  • Ability to query API to get list options
  • Callbacks after each question

Table of Contents


Usage

Install the package using the node package manager.

npm install vue3-form-wizard

import onto your component and add to the components key.

import VueFormWizard from 'vue3-form-wizard'

// If you want to use our styling
import 'vue3-form-wizard/dist/index.css'; 

export default {
  components: {
    VueFormWizard
  }
}

You can then add the component to your template, where the form property is an array of objects for generating the form and v-model is where to store the data on your component.

<vue-form-wizard :form="config" v-model="formData" />

The form property can be configured with objects for each input type very easily:

  [
    {
      "property": "text",
      "text": "This is a simple text input question. (Min 3 chars, required)",
      "type": "input",
      "options": {
        "type": "text",
        "validations": {
          "min": {
            "value": 3,
            "message": "Input needs to be at least 3 characters"
          },
        },
        "placeholder": "Enter the text."
      },
      "required": true
    },
    ...
  ]

Documentation

Full documentation can be found here.


Coming Soon

Summary view - Will summarize the user input and allow a quick edit functionality.

Progress indicator - This will visually indicate to the user the progress through the form.

Conditions - An additional configurable item which will allow for dynamic form generation, based on the answers given, new inputs can be added to the sequence.

Custom Components - We also plan to make some out-of-the-box custom components, like a date selector.


Contributing Guidelines

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.


Code Of Conduct

Please read through our code of conduct.


Bugs and Feature Requests

Found a bug or have a feature request? Please first read the issue guidelines and search for existing and closed issues.

If your problem or idea is not addressed yet, please open a new issue.

Thanks

Thank you to all of you who have contributed to this package. [Contribute to the Project]

Copyright and License

Code and documentation copyright 2021 Anivive Lifesciences Code released under the MIT License.

Docs released under Creative Commons.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.


Status badges created using Shields.io.