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

Improve documentation on TabContent type definitions, and order props in alignment with props declared in TabContent.vue.

This commit is contained in:
Charles Salmon
2019-02-28 12:11:57 +13:00
parent 7209900cbe
commit c41228292a
+29 -9
View File
@@ -1,16 +1,36 @@
import Vue from 'vue'
export declare class Tab extends Vue {
/** Title to be displayed under each step */
title?: string
/** css class for each step icon */
icon?: string
/***
* Function to execute before tab switch. Return value must be boolean
* If the return result is false, tab switch is restricted
/**
* Title to be displayed under each step.
*
* Default value: ''
*/
title: string
/** CSS class to be applied to each step icon.
*
* Default value: ''
*/
icon: string
/**
* Function to execute before changing tabs. If the return result is false, the tab switch is restricted.
*/
beforeChange: () => boolean | Promise<boolean>
/**
* Function to execute after changing tabs. It is safe to assume that necessary validation has already occurred.
*/
afterChange: () => void
/**
* Vue router route object.
*/
beforeChange (): boolean | Promise<boolean>
/** Vue router route object */
route: string | object
/**
* Default value: () => {}
*/
additionalInfo: object
}