Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit c412282

Browse files
author
Charles Salmon
committed
Improve documentation on TabContent type definitions, and order props in alignment with props declared in TabContent.vue.
1 parent 7209900 commit c412282

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

types/TabContent.ts

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
11
import Vue from 'vue'
22

33
export declare class Tab extends Vue {
4-
/** Title to be displayed under each step */
5-
title?: string
6-
/** css class for each step icon */
7-
icon?: string
8-
/***
9-
* Function to execute before tab switch. Return value must be boolean
10-
* If the return result is false, tab switch is restricted
4+
/**
5+
* Title to be displayed under each step.
6+
*
7+
* Default value: ''
8+
*/
9+
title: string
10+
11+
/** CSS class to be applied to each step icon.
12+
*
13+
* Default value: ''
14+
*/
15+
icon: string
16+
17+
/**
18+
* Function to execute before changing tabs. If the return result is false, the tab switch is restricted.
19+
*/
20+
beforeChange: () => boolean | Promise<boolean>
21+
22+
/**
23+
* Function to execute after changing tabs. It is safe to assume that necessary validation has already occurred.
24+
*/
25+
afterChange: () => void
26+
27+
/**
28+
* Vue router route object.
1129
*/
12-
beforeChange (): boolean | Promise<boolean>
13-
/** Vue router route object */
1430
route: string | object
31+
32+
/**
33+
* Default value: () => {}
34+
*/
1535
additionalInfo: object
1636
}

0 commit comments

Comments
 (0)