mirror of
https://github.com/tenrok/vue-form-wizard.git
synced 2026-06-07 20:52:24 +03:00
Initial jsx support
This commit is contained in:
@@ -7,6 +7,7 @@ import FormWizard from '../src/index'
|
||||
import WizardRoute from './WizardRoute.vue'
|
||||
import FormGeneratorRoute from './FormGeneratorRoute.vue'
|
||||
import TestRoute from './TestRoute.vue'
|
||||
import '../dist/vue-form-wizard.min.css'
|
||||
|
||||
const First = {template: '<div>First page</div>'}
|
||||
const Second = {template: '<div>Second page</div>'}
|
||||
|
||||
@@ -0,0 +1,453 @@
|
||||
import WizardButton from './WizardButton.vue'
|
||||
import WizardStep from './WizardStep.vue'
|
||||
import {isPromise, findElementAndFocus, getFocusedTabIndex} from './helpers'
|
||||
|
||||
export default {
|
||||
name: 'form-wizard',
|
||||
components: {
|
||||
WizardButton,
|
||||
WizardStep
|
||||
},
|
||||
provide () {
|
||||
return {
|
||||
addTab: this.addTab,
|
||||
removeTab: this.removeTab,
|
||||
shape: this.shape,
|
||||
color: this.color,
|
||||
errorColor: this.errorColor,
|
||||
reRegisterTabs: this.reRegisterTabs
|
||||
}
|
||||
},
|
||||
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'
|
||||
},
|
||||
hideButtons: {
|
||||
type: Boolean,
|
||||
default: false
|
||||
},
|
||||
validateOnBack: Boolean,
|
||||
/***
|
||||
* Applies to text, border and circle
|
||||
*/
|
||||
color: {
|
||||
type: String,
|
||||
default: '#e74c3c'
|
||||
},
|
||||
errorColor: {
|
||||
type: String,
|
||||
default: '#8b0000'
|
||||
},
|
||||
shape: {
|
||||
type: String,
|
||||
default: 'circle'
|
||||
},
|
||||
layout: {
|
||||
type: String,
|
||||
default: 'horizontal'
|
||||
},
|
||||
stepsClasses: {
|
||||
type: [String, Array],
|
||||
default: ''
|
||||
},
|
||||
stepSize: {
|
||||
type: String,
|
||||
default: 'md',
|
||||
validator: (value) => {
|
||||
let acceptedValues = ['xs', 'sm', 'md', 'lg']
|
||||
return acceptedValues.indexOf(value) !== -1
|
||||
}
|
||||
},
|
||||
/**
|
||||
* Name of the transition when transition between steps
|
||||
* */
|
||||
transition: {
|
||||
type: String,
|
||||
default: ''
|
||||
},
|
||||
/***
|
||||
*
|
||||
* Index of the initial tab to display
|
||||
*/
|
||||
startIndex: {
|
||||
type: Number,
|
||||
default: 0,
|
||||
validator: (value) => {
|
||||
return value >= 0
|
||||
}
|
||||
}
|
||||
},
|
||||
data () {
|
||||
return {
|
||||
activeTabIndex: 0,
|
||||
currentPercentage: 0,
|
||||
maxStep: 0,
|
||||
loading: false,
|
||||
tabs: []
|
||||
}
|
||||
},
|
||||
computed: {
|
||||
slotProps () {
|
||||
return {
|
||||
nextTab: this.nextTab,
|
||||
prevTab: this.prevTab,
|
||||
activeTabIndex: this.activeTabIndex,
|
||||
isLastStep: this.isLastStep,
|
||||
fillButtonStyle: this.fillButtonStyle
|
||||
}
|
||||
},
|
||||
tabCount () {
|
||||
return this.tabs.length
|
||||
},
|
||||
isLastStep () {
|
||||
return this.activeTabIndex === this.tabCount - 1
|
||||
},
|
||||
isVertical () {
|
||||
return this.layout === 'vertical'
|
||||
},
|
||||
displayPrevButton () {
|
||||
return this.activeTabIndex !== 0
|
||||
},
|
||||
stepPercentage () {
|
||||
return 1 / (this.tabCount * 2) * 100
|
||||
},
|
||||
progressBarStyle () {
|
||||
return {
|
||||
backgroundColor: this.color,
|
||||
width: `${this.progress}%`,
|
||||
color: this.color
|
||||
}
|
||||
},
|
||||
fillButtonStyle () {
|
||||
return {
|
||||
backgroundColor: this.color,
|
||||
borderColor: this.color,
|
||||
color: 'white'
|
||||
}
|
||||
},
|
||||
progress () {
|
||||
let percentage = 0
|
||||
if (this.activeTabIndex > 0) {
|
||||
let stepsToAdd = 1
|
||||
let stepMultiplier = 2
|
||||
percentage = this.stepPercentage * ((this.activeTabIndex * stepMultiplier) + stepsToAdd)
|
||||
} else {
|
||||
percentage = this.stepPercentage
|
||||
}
|
||||
return percentage
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
emitTabChange (prevIndex, nextIndex) {
|
||||
// this.$emit('on-change', prevIndex, nextIndex)
|
||||
// this.$emit('update:startIndex', nextIndex)
|
||||
},
|
||||
addTab (item) {
|
||||
const index = this.$slots.default.indexOf(item.$vnode)
|
||||
item.tabId = `t-${item.title.replace(/ /g, '')}${index}`
|
||||
this.tabs.splice(index, 0, item)
|
||||
// if a step is added before the current one, go to it
|
||||
if (index < this.activeTabIndex + 1) {
|
||||
this.maxStep = index
|
||||
this.changeTab(this.activeTabIndex + 1, index)
|
||||
}
|
||||
},
|
||||
removeTab (item) {
|
||||
const tabs = this.tabs
|
||||
const index = tabs.indexOf(item)
|
||||
if (index > -1) {
|
||||
// Go one step back if the current step is removed
|
||||
if (index === this.activeTabIndex) {
|
||||
this.maxStep = this.activeTabIndex - 1
|
||||
this.changeTab(this.activeTabIndex, this.activeTabIndex - 1)
|
||||
}
|
||||
if (index < this.activeTabIndex) {
|
||||
this.maxStep = this.activeTabIndex - 1
|
||||
this.activeTabIndex = this.activeTabIndex - 1
|
||||
this.emitTabChange(this.activeTabIndex + 1, this.activeTabIndex)
|
||||
}
|
||||
tabs.splice(index, 1)
|
||||
}
|
||||
},
|
||||
navigateToTab (index) {
|
||||
let validate = index > this.activeTabIndex
|
||||
if (index <= this.maxStep) {
|
||||
let cb = () => {
|
||||
if (validate && index - this.activeTabIndex > 1) {
|
||||
// validate all steps recursively until destination index
|
||||
this.changeTab(this.activeTabIndex, this.activeTabIndex + 1)
|
||||
this.beforeTabChange(this.activeTabIndex, cb)
|
||||
} else {
|
||||
this.changeTab(this.activeTabIndex, index)
|
||||
}
|
||||
}
|
||||
if (validate) {
|
||||
this.beforeTabChange(this.activeTabIndex, cb)
|
||||
} else {
|
||||
this.setValidationError(null)
|
||||
cb()
|
||||
}
|
||||
}
|
||||
return index <= this.maxStep
|
||||
},
|
||||
nextTab () {
|
||||
let cb = () => {
|
||||
if (this.activeTabIndex < this.tabCount - 1) {
|
||||
this.changeTab(this.activeTabIndex, this.activeTabIndex + 1)
|
||||
} else {
|
||||
this.$emit('on-complete')
|
||||
}
|
||||
}
|
||||
this.beforeTabChange(this.activeTabIndex, cb)
|
||||
},
|
||||
prevTab () {
|
||||
let cb = () => {
|
||||
if (this.activeTabIndex > 0) {
|
||||
this.setValidationError(null)
|
||||
this.changeTab(this.activeTabIndex, this.activeTabIndex - 1)
|
||||
}
|
||||
}
|
||||
if (this.validateOnBack) {
|
||||
this.beforeTabChange(this.activeTabIndex, cb)
|
||||
} else {
|
||||
cb()
|
||||
}
|
||||
},
|
||||
focusNextTab () {
|
||||
let tabIndex = getFocusedTabIndex(this.tabs)
|
||||
if (tabIndex !== -1 && tabIndex < this.tabs.length - 1) {
|
||||
let tabToFocus = this.tabs[tabIndex + 1]
|
||||
if (tabToFocus.checked) {
|
||||
findElementAndFocus(tabToFocus.tabId)
|
||||
}
|
||||
}
|
||||
},
|
||||
focusPrevTab () {
|
||||
let tabIndex = getFocusedTabIndex(this.tabs)
|
||||
if (tabIndex !== -1 && tabIndex > 0) {
|
||||
let toFocusId = this.tabs[tabIndex - 1].tabId
|
||||
findElementAndFocus(toFocusId)
|
||||
}
|
||||
},
|
||||
setLoading (value) {
|
||||
this.loading = value
|
||||
this.$emit('on-loading', value)
|
||||
},
|
||||
setValidationError (error) {
|
||||
this.tabs[this.activeTabIndex].validationError = error
|
||||
this.$emit('on-error', error)
|
||||
},
|
||||
validateBeforeChange (promiseFn, callback) {
|
||||
this.setValidationError(null)
|
||||
// we have a promise
|
||||
if (isPromise(promiseFn)) {
|
||||
this.setLoading(true)
|
||||
promiseFn.then((res) => {
|
||||
this.setLoading(false)
|
||||
let validationResult = res === true
|
||||
this.executeBeforeChange(validationResult, callback)
|
||||
}).catch((error) => {
|
||||
this.setLoading(false)
|
||||
this.setValidationError(error)
|
||||
})
|
||||
// we have a simple function
|
||||
} else {
|
||||
let validationResult = promiseFn === true
|
||||
this.executeBeforeChange(validationResult, callback)
|
||||
}
|
||||
},
|
||||
executeBeforeChange (validationResult, callback) {
|
||||
this.$emit('on-validate', validationResult, this.activeTabIndex)
|
||||
if (validationResult) {
|
||||
callback()
|
||||
} else {
|
||||
this.tabs[this.activeTabIndex].validationError = 'error'
|
||||
}
|
||||
},
|
||||
beforeTabChange (index, callback) {
|
||||
if (this.loading) {
|
||||
return
|
||||
}
|
||||
let oldTab = this.tabs[index]
|
||||
if (oldTab && oldTab.beforeChange !== undefined) {
|
||||
let tabChangeRes = oldTab.beforeChange()
|
||||
this.validateBeforeChange(tabChangeRes, callback)
|
||||
} else {
|
||||
callback()
|
||||
}
|
||||
},
|
||||
changeTab (oldIndex, newIndex, emitChangeEvent = true) {
|
||||
let oldTab = this.tabs[oldIndex]
|
||||
let newTab = this.tabs[newIndex]
|
||||
if (oldTab) {
|
||||
oldTab.active = false
|
||||
}
|
||||
if (newTab) {
|
||||
newTab.active = true
|
||||
}
|
||||
if (emitChangeEvent && this.activeTabIndex !== newIndex) {
|
||||
this.emitTabChange(oldIndex, newIndex)
|
||||
}
|
||||
this.activeTabIndex = newIndex
|
||||
this.activateTabAndCheckStep(this.activeTabIndex)
|
||||
return true
|
||||
},
|
||||
tryChangeRoute (tab) {
|
||||
if (this.$router && tab.route) {
|
||||
this.$router.push(tab.route)
|
||||
}
|
||||
},
|
||||
checkRouteChange (route) {
|
||||
let matchingTabIndex = -1
|
||||
let matchingTab = this.tabs.find((tab, index) => {
|
||||
let match = tab.route === route
|
||||
if (match) {
|
||||
matchingTabIndex = index
|
||||
}
|
||||
return match
|
||||
})
|
||||
|
||||
if (matchingTab && !matchingTab.active) {
|
||||
const shouldValidate = matchingTabIndex > this.activeTabIndex
|
||||
this.navigateToTab(matchingTabIndex, shouldValidate)
|
||||
}
|
||||
},
|
||||
deactivateTabs () {
|
||||
this.tabs.forEach(tab => {
|
||||
tab.active = false
|
||||
})
|
||||
},
|
||||
activateTab (index) {
|
||||
this.deactivateTabs()
|
||||
let tab = this.tabs[index]
|
||||
if (tab) {
|
||||
tab.active = true
|
||||
tab.checked = true
|
||||
this.tryChangeRoute(tab)
|
||||
}
|
||||
},
|
||||
activateTabAndCheckStep (index) {
|
||||
this.activateTab(index)
|
||||
if (index > this.maxStep) {
|
||||
this.maxStep = index
|
||||
}
|
||||
this.activeTabIndex = index
|
||||
},
|
||||
initializeTabs () {
|
||||
if (this.tabs.length > 0 && this.startIndex === 0) {
|
||||
this.activateTab(this.activeTabIndex)
|
||||
}
|
||||
if (this.startIndex < this.tabs.length) {
|
||||
this.activateTabAndCheckStep(this.startIndex)
|
||||
} else {
|
||||
window.console.warn(`Prop startIndex set to ${this.startIndex} is greater than the number of tabs - ${this.tabs.length}. Make sure that the starting index is less than the number of tabs registered`)
|
||||
}
|
||||
}
|
||||
},
|
||||
mounted () {
|
||||
this.initializeTabs()
|
||||
},
|
||||
watch: {
|
||||
'$route.path' (newRoute) {
|
||||
this.checkRouteChange(newRoute)
|
||||
}
|
||||
},
|
||||
render () {
|
||||
const tabs = this.$slots.default.filter(
|
||||
component => component.componentOptions
|
||||
)
|
||||
if (tabs.length !== this.tabs.length) {
|
||||
this.tabs = tabs
|
||||
}
|
||||
const steps = this.tabs.map((tab, index) => {
|
||||
return <wizard-step tab={tab}
|
||||
step-size={this.stepSize}
|
||||
onClick={() => this.navigateToTab(index)}
|
||||
transition={this.transition}
|
||||
index={this.index}>
|
||||
</wizard-step>
|
||||
})
|
||||
return (<div class={['vue-form-wizard', this.stepSize, {vertical: this.isVertical}]}>
|
||||
<div class="wizard-header">
|
||||
<slot name="title">
|
||||
<h4 class="wizard-title">{this.title}</h4>
|
||||
<p class="category">{this.subtitle}</p>
|
||||
</slot>
|
||||
</div>
|
||||
<div class="wizard-navigation">
|
||||
<div class="wizard-progress-with-circle">
|
||||
<div class="wizard-progress-bar" style={this.progressBarStyle}>
|
||||
</div>
|
||||
</div>
|
||||
<ul class={['wizard-nav wizard-nav-pills', this.stepsClasses]} role="tablist">
|
||||
{steps}
|
||||
</ul>
|
||||
<div class="wizard-tab-content">
|
||||
<transition name="fade" mode="out-in">
|
||||
{this.tabs[this.activeTabIndex]}
|
||||
</transition>
|
||||
</div>
|
||||
|
||||
<div class="wizard-card-footer clearfix">
|
||||
<slot name="footer">
|
||||
<div class="wizard-footer-left">
|
||||
<span onClick={this.prevTab}
|
||||
role="button"
|
||||
tabindex="0">
|
||||
<slot name="prev">
|
||||
<wizard-button
|
||||
style={this.fillButtonStyle}
|
||||
disabled={this.loading}>
|
||||
{this.backButtonText}
|
||||
</wizard-button>
|
||||
</slot>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="wizard-footer-right">
|
||||
<span onClick={this.nextTab}
|
||||
role="button"
|
||||
tabindex="0">
|
||||
<slot name="finish">
|
||||
<wizard-button
|
||||
style={this.fillButtonStyle}>
|
||||
{this.finishButtonText}
|
||||
</wizard-button>
|
||||
</slot>
|
||||
</span>
|
||||
<span onClick={this.nextTab}
|
||||
role="button"
|
||||
tabindex="0">
|
||||
<slot name="next">
|
||||
<wizard-button
|
||||
style={this.fillButtonStyle}
|
||||
disabled={this.loading}>
|
||||
{this.nextButtonText}
|
||||
</wizard-button>
|
||||
</slot>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
</slot>
|
||||
</div>
|
||||
</div>
|
||||
</div>)
|
||||
}
|
||||
}
|
||||
@@ -1,17 +1,17 @@
|
||||
<template>
|
||||
<div v-show="active" class="wizard-tab-container"
|
||||
role="tabpanel"
|
||||
:id="title"
|
||||
:aria-hidden="!active"
|
||||
:aria-labelledby="title">
|
||||
<slot :active="active">
|
||||
</slot>
|
||||
</div>
|
||||
<div class="wizard-tab-container"
|
||||
role="tabpanel"
|
||||
:id="title"
|
||||
:aria-hidden="!active"
|
||||
:aria-labelledby="title">
|
||||
<slot :active="active">
|
||||
</slot>
|
||||
</div>
|
||||
</template>
|
||||
<script>
|
||||
export default{
|
||||
name: 'tab-content',
|
||||
inject: ['addTab', 'removeTab'],
|
||||
inject: ['addTab', 'removeTab', 'reRegisterTabs'],
|
||||
props: {
|
||||
title: {
|
||||
type: String,
|
||||
@@ -44,13 +44,14 @@
|
||||
}
|
||||
},
|
||||
mounted () {
|
||||
this.addTab(this)
|
||||
},
|
||||
destroyed () {
|
||||
if (this.$el && this.$el.parentNode) {
|
||||
this.$el.parentNode.removeChild(this.$el)
|
||||
}
|
||||
this.removeTab(this)
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<style>
|
||||
.fade-enter-active, .fade-leave-active {
|
||||
transition: opacity .5s
|
||||
}
|
||||
.fade-enter, .fade-leave-to /* .fade-leave-active below version 2.1.8 */ {
|
||||
opacity: 0
|
||||
}
|
||||
</style>
|
||||
|
||||
+2
-1
@@ -2,9 +2,10 @@ import FormWizard from './components/FormWizard.vue'
|
||||
import TabContent from './components/TabContent.vue'
|
||||
import WizardButton from './components/WizardButton.vue'
|
||||
import WizardStep from './components/WizardStep.vue'
|
||||
import FWizard from './components/FWizard'
|
||||
const VueFormWizard = {
|
||||
install (Vue) {
|
||||
Vue.component('form-wizard', FormWizard)
|
||||
Vue.component('form-wizard', FWizard)
|
||||
Vue.component('tab-content', TabContent)
|
||||
Vue.component('wizard-button', WizardButton)
|
||||
Vue.component('wizard-step', WizardStep)
|
||||
|
||||
Reference in New Issue
Block a user