2
0
mirror of https://github.com/tenrok/vue-form-wizard.git synced 2026-06-23 21:50:32 +03:00

Add docs to props which need additional details

This commit is contained in:
cristijora
2017-04-16 18:52:42 +03:00
parent 78f21f0b4c
commit a15e952532
3 changed files with 19 additions and 2 deletions
-1
View File
@@ -2,7 +2,6 @@
<div class="col-xs-8 col-xs-offset-2"> <div class="col-xs-8 col-xs-offset-2">
<tab-wizard @on-complete="onComplete" <tab-wizard @on-complete="onComplete"
class="card" class="card"
:startIndex="2"
color="#27ae60"> color="#27ae60">
<tab-content title="Personal details" <tab-content title="Personal details"
icon="ti-user"> icon="ti-user">
+8
View File
@@ -12,10 +12,18 @@
type: String, type: String,
default: '' default: ''
}, },
/***
* Icon name for the upper circle corresponding to the tab
* Supports themify icons only for now.
*/
icon: { icon: {
type: String, type: String,
default: '' default: ''
}, },
/***
* Function to execute before tab switch. Return value must be boolean
* If the return result is false, tab switch is restricted
*/
beforeChange: { beforeChange: {
type: Function type: Function
} }
+11 -1
View File
@@ -40,7 +40,7 @@
<template> <template>
<span @click="prevTab" v-if="displayPrevButton"> <span @click="prevTab" v-if="displayPrevButton">
<slot name="prev"> <slot name="prev">
<button type="button" class="btn btn-default btn-wd"> <button type="button" class="btn btn-default btn-wd">
{{backButtonText}} {{backButtonText}}
</button> </button>
</slot> </slot>
@@ -94,14 +94,24 @@
type: String, type: String,
default: 'Finish' default: 'Finish'
}, },
/***
* Applies to text, border and circle
*/
color: { color: {
type: String, type: String,
default: '#e74c3c' default: '#e74c3c'
}, },
/**
* Name of the transition when transition between steps
* */
transition: { transition: {
type: String, type: String,
default: '' default: ''
}, },
/***
*
* Index of the initial tab to display
*/
startIndex: { startIndex: {
type: Number, type: Number,
default: 0 default: 0