A dynamic form wizard to split your forms easier
Vue-form-wizard is a vue based component with no external depenendcies which simplifies tab wizard management and allows you to focus on the functional part of your app rather than wasting time on details. Just forget about id's, external scripts and jQuery dependencies
In browser playground
Basic demo
Other demos:
- Squared steps
- Tabbed steps
- Step index Start at any step. Note: start-index is zero-based and the count starts at 0
- Custom button and title text
- Custom title slot
- Customized buttons with slots Replace stuff you don't like
- Call a function before tab switch
- Complete form example integrated with vue-form-generator
- Element UI form integration
- Vue router integration You can place a
router-view
inside the wizard and have a separate page per tab. Aroute
prop must be passed to the tabs you want to handle certain tabs - Async validation with error message
before-change
prop can accept a promise that is resolved withtrue
which will execute the promise before switching to another step/tab (NOTE: This feature is not present in the npm package yet)
npm install vue-form-wizard
Download the css and js files from dist
folder or reference them directly from github (check jsfiddle links)
<link rel="stylesheet" href="https://unpkg.com/vue-form-wizard/dist/vue-form-wizard.min.css">
<script src="https://unpkg.com/vue-form-wizard/dist/vue-form-wizard.js"></script>
//global registration
import VueFormWizard from 'vue-form-wizard'
import 'vue-form-wizard/dist/vue-form-wizard.min.css'
Vue.use(VueFormWizard)
//local registration
import {FormWizard, TabContent} from 'vue-form-wizard'
import 'vue-formwizard/dist/vue-form-wizard.min.css'
//component code
components: {
FormWizard,
TabContent
}
<form-wizard>
<tab-content title="Personal details">
My first tab content
</tab-content>
<tab-content title="Additional Info">
My second tab content
</tab-content>
<tab-content title="Last step">
Yuhuuu! This seems pretty damn simple
</tab-content>
</form-wizard>
props: {
title: {
type: String,
default: 'Awesome Wizard'
},
subtitle: {
type: String,
default: 'Split a complicated flow in multiple steps'
},
nextButtonText: {
type: String,
default: 'Next'
},
backButtonText: {
type: String,
default: 'Back'
},
finishButtonText: {
type: String,
default: 'Finish'
},
/***
* Sets validation (on/off) for back button. By default back button ignores validation
*/
validateOnBack: Boolean,
/***
* Applies to text, border and circle
*/
color: {
type: String,
default: '#e74c3c' //circle, border and text color
},
/***
* Is set to current step and text when beforeChange function fails
*/
errorColor: {
type: String,
default: '#8b0000'
},
/**
* Can take one of the following values: 'circle|square|tab`
*/
shape: {
type: String,
default: 'circle'
},
/**
* name of the transition when transition between steps
*/
transition: {
type: String,
default: '' //name of the transition when transition between steps
},
/***
* Index of the initial tab to display
*/
startIndex: {
type: Number,
default: 0
}
}
props: {
title: {
type: String,
default: ''
},
/***
* Icon name for the upper circle corresponding to the tab
* Supports themify icons only for now.
*/
icon: {
type: String,
default: ''
},
/***
* Function to execute before tab switch. Return value must be boolean
* If the return result is false, tab switch is restricted
*/
beforeChange: {
type: Function
}
}
Vue-form-wizard emits certain events when certain actions happen inside the component. The events can be noticed in some of the demos and especially in the async validation demo
- on-complete Called when the finish button is clicked and the
before-change
for the last step (if present) was executed. No params are sent together with this event.this.$emit('on-complete')
- on-loading Called whenever an async
before-change
is executed. This event is emitted before executingbefore-change
and after finishing execution ofbefore-change
method.on-loading
is emitted together with a Boolean value.this.$emit('on-loading', value)
- on-validate Called whenever the execution of a
before-change
method is completed. The event sends along a Boolean which represents the validation result as well as an int with te tab index.this.$emit('on-validate', validationResult, this.activeTabIndex)
- on-error Called when
before-change
is a promised and is rejected with a message. The message is passed alongthis.$emit('on-error', error)
See async validation fiddle
- Default - Used for tab-contents
- title - Upper title section including sub-title
- prev - Previous button content (no need to worry about handling the button functionality)
- next - Next button content
- finish - Finish button content
- Fork the repo
- run
npm install
npm run dev
for launching the dev example- After making your changes make sure to pull the changes from the source repo to avoid conflicts
npm run build
to generate the new js and css bundles- Commit your changes + the js and css bundles so it's easy to test them right away in fiddles, codepen etc
- Open a Pull Request. For more information refer to github forking workflow