@progress/kendo-vue-layout 11.0.0 → 11.1.0-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/actionsheet/ActionSheet.d.ts +67 -23
- package/actionsheet/interfaces/ActionSheetContentProps.d.ts +2 -2
- package/actionsheet/interfaces/ActionSheetFooterProps.d.ts +2 -2
- package/actionsheet/interfaces/ActionSheetHeaderProps.d.ts +3 -3
- package/actionsheet/interfaces/ActionSheetItemProps.d.ts +24 -14
- package/appbar/AppBar.d.ts +21 -1
- package/appbar/AppBar.mjs +3 -0
- package/appbar/AppBarSection.d.ts +12 -1
- package/appbar/AppBarSection.mjs +3 -0
- package/appbar/AppBarSpacer.d.ts +10 -1
- package/appbar/AppBarSpacer.mjs +3 -0
- package/appbar/interfaces/AppBarProps.d.ts +31 -29
- package/appbar/interfaces/AppBarSectionProps.d.ts +1 -1
- package/appbar/interfaces/AppBarSpacerProps.d.ts +5 -2
- package/bottomnavigation/BottomNavigation.d.ts +23 -1
- package/bottomnavigation/BottomNavigation.mjs +3 -0
- package/bottomnavigation/BottomNavigationItemProps.d.ts +20 -9
- package/bottomnavigation/BottomNavigationProps.d.ts +73 -63
- package/bottomnavigation/models/events.d.ts +3 -3
- package/breadcrumb/Breadcrumb.d.ts +17 -1
- package/breadcrumb/BreadcrumbDelimiter.d.ts +8 -1
- package/breadcrumb/BreadcrumbLink.d.ts +17 -1
- package/breadcrumb/BreadcrumbLink.mjs +3 -0
- package/breadcrumb/interfaces/BreadcrumbDelimiterProps.d.ts +6 -3
- package/breadcrumb/interfaces/BreadcrumbLinkProps.d.ts +20 -11
- package/breadcrumb/interfaces/BreadcrumbOrderedListProps.d.ts +1 -1
- package/breadcrumb/interfaces/BreadcrumbProps.d.ts +56 -31
- package/card/Avatar.d.ts +7 -1
- package/card/Card.d.ts +18 -1
- package/card/CardActions.d.ts +10 -1
- package/card/CardBody.d.ts +13 -1
- package/card/CardFooter.d.ts +7 -1
- package/card/CardHeader.d.ts +13 -1
- package/card/CardImage.d.ts +7 -1
- package/card/CardSubtitle.d.ts +7 -1
- package/card/CardTitle.d.ts +7 -1
- package/card/interfaces/AvatarProps.d.ts +11 -8
- package/card/interfaces/CardActionsProps.d.ts +9 -3
- package/card/interfaces/CardBodyProps.d.ts +3 -0
- package/card/interfaces/CardFooterProps.d.ts +3 -0
- package/card/interfaces/CardHeaderProps.d.ts +3 -0
- package/card/interfaces/CardImageProps.d.ts +4 -1
- package/card/interfaces/CardProps.d.ts +12 -4
- package/card/interfaces/CardSubtitleProps.d.ts +3 -0
- package/card/interfaces/CardTitleProps.d.ts +3 -0
- package/card/interfaces/Enums.d.ts +57 -0
- package/contextmenu/ContextMenu.d.ts +23 -3
- package/dist/cdn/js/kendo-vue-layout.js +1 -1
- package/drawer/Drawer.d.ts +25 -1
- package/drawer/Drawer.mjs +3 -0
- package/drawer/DrawerContent.d.ts +1 -1
- package/drawer/DrawerItem.d.ts +1 -1
- package/drawer/interfaces/DrawerAnimation.d.ts +3 -3
- package/drawer/interfaces/DrawerContentProps.d.ts +1 -1
- package/drawer/interfaces/DrawerItemHandle.d.ts +3 -3
- package/drawer/interfaces/DrawerItemProps.d.ts +28 -12
- package/drawer/interfaces/DrawerProps.d.ts +49 -29
- package/drawer/interfaces/DrawerSelectEvent.d.ts +2 -2
- package/expansionpanel/ExpansionPanel.d.ts +16 -1
- package/expansionpanel/interfaces.d.ts +35 -20
- package/gridlayout/GridLayout.d.ts +22 -1
- package/gridlayout/interfaces/GridLayoutColumnProps.d.ts +4 -3
- package/gridlayout/interfaces/GridLayoutItemProps.d.ts +12 -11
- package/gridlayout/interfaces/GridLayoutProps.d.ts +23 -21
- package/gridlayout/interfaces/GridLayoutRowProps.d.ts +4 -3
- package/menu/MenuProps.d.ts +32 -16
- package/menu/components/Menu.d.ts +16 -6
- package/menu/events.d.ts +2 -2
- package/menu/models/BaseMenuItem.d.ts +27 -21
- package/menu/models/MenuItemActionsRenderProps.d.ts +2 -2
- package/menu/models/MenuItemGroupHeaderRenderProps.d.ts +2 -2
- package/menu/models/MenuItemModel.d.ts +2 -2
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +8 -8
- package/panelbar/PanelBar.d.ts +30 -2
- package/panelbar/interfaces/PanelBarItemProps.d.ts +38 -17
- package/panelbar/interfaces/PanelBarProps.d.ts +31 -14
- package/panelbar/interfaces/PanelBarSelectEventArguments.d.ts +2 -2
- package/splitter/Splitter.d.ts +26 -56
- package/splitter/SplitterPane.d.ts +19 -11
- package/stacklayout/StackLayout.d.ts +12 -2
- package/stacklayout/StackLayoutProps.d.ts +24 -22
- package/stepper/Step.d.ts +25 -20
- package/stepper/Step.mjs +3 -0
- package/stepper/Stepper.d.ts +23 -49
- package/stepper/Stepper.mjs +3 -0
- package/stepper/interfaces/StepChangeEvent.d.ts +2 -2
- package/stepper/interfaces/StepFocusEvent.d.ts +1 -1
- package/stepper/interfaces/StepHandle.d.ts +3 -3
- package/stepper/interfaces/StepProps.d.ts +37 -24
- package/stepper/interfaces/StepperChangeEvent.d.ts +2 -2
- package/stepper/interfaces/StepperFocusEvent.d.ts +1 -1
- package/stepper/interfaces/StepperHandle.d.ts +3 -3
- package/stepper/interfaces/StepperOnNavigateEvent.d.ts +7 -4
- package/stepper/interfaces/StepperProps.d.ts +37 -25
- package/tabstrip/TabStrip.d.ts +60 -27
- package/tabstrip/TabStripContent.d.ts +5 -5
- package/tabstrip/TabStripNavigation.d.ts +4 -4
- package/tabstrip/TabStripNavigationItem.d.ts +12 -7
- package/tabstrip/TabStripTab.d.ts +29 -5
- package/tilelayout/TileLayout.d.ts +61 -23
- package/tilelayout/TileLayout.mjs +3 -0
- package/tilelayout/interfaces/main.d.ts +105 -69
package/stepper/Stepper.d.ts
CHANGED
|
@@ -16,58 +16,29 @@ export interface StepperComputed {
|
|
|
16
16
|
computedValue: number;
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* Represents the [Kendo UI for Vue Stepper component](
|
|
19
|
+
* Represents the [Kendo UI for Vue Stepper component](slug:overview_stepper).
|
|
20
|
+
* Accepts properties of type [StepperProps](slug:api_layout_stepperprops).
|
|
20
21
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* items: [
|
|
38
|
-
* {
|
|
39
|
-
* label: "Cart",
|
|
40
|
-
* icon: "cart",
|
|
41
|
-
* },
|
|
42
|
-
* {
|
|
43
|
-
* label: "Delivery Address",
|
|
44
|
-
* icon: "marker-pin-target",
|
|
45
|
-
* },
|
|
46
|
-
* {
|
|
47
|
-
* label: "Payment Method",
|
|
48
|
-
* icon: "dollar",
|
|
49
|
-
* },
|
|
50
|
-
* {
|
|
51
|
-
* label: "Preview",
|
|
52
|
-
* icon: "preview",
|
|
53
|
-
* optional: true,
|
|
54
|
-
* },
|
|
55
|
-
* {
|
|
56
|
-
* label: "Finish Order",
|
|
57
|
-
* icon: "track-changes-accept",
|
|
58
|
-
* },
|
|
59
|
-
* ]
|
|
60
|
-
* }
|
|
61
|
-
* },
|
|
62
|
-
* methods: {
|
|
63
|
-
* handleChange (e) {
|
|
64
|
-
* this.value = e.value;
|
|
65
|
-
* }
|
|
66
|
-
* }
|
|
67
|
-
* };
|
|
68
|
-
* </script>
|
|
22
|
+
* @example
|
|
23
|
+
* ```vue
|
|
24
|
+
* <Stepper
|
|
25
|
+
* :value="value"
|
|
26
|
+
* :items="[
|
|
27
|
+
* { label: 'Cart', icon: 'cart' },
|
|
28
|
+
* { label: 'Delivery Address', icon: 'marker-pin-target' },
|
|
29
|
+
* { label: 'Payment Method', icon: 'dollar' },
|
|
30
|
+
* { label: 'Preview', icon: 'preview', optional: true },
|
|
31
|
+
* { label: 'Finish Order', icon: 'track-changes-accept' }
|
|
32
|
+
* ]"
|
|
33
|
+
* :orientation="'horizontal'"
|
|
34
|
+
* :mode="'steps'"
|
|
35
|
+
* :linear="false"
|
|
36
|
+
* @change="onChange"
|
|
37
|
+
* />
|
|
69
38
|
* ```
|
|
70
39
|
*
|
|
40
|
+
* @remarks
|
|
41
|
+
* Supported children components are: {@link Step}.
|
|
71
42
|
*/
|
|
72
43
|
declare const Stepper: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
|
73
44
|
animationDuration: {
|
|
@@ -141,6 +112,9 @@ declare const Stepper: import('vue').DefineComponent<import('vue').ExtractPropTy
|
|
|
141
112
|
gridRowEnd: string | number;
|
|
142
113
|
};
|
|
143
114
|
}, {
|
|
115
|
+
/**
|
|
116
|
+
* Moves the focus to the first focusable element in the Stepper.
|
|
117
|
+
*/
|
|
144
118
|
focus(): void;
|
|
145
119
|
dispatchChangeEvent(event: any, val: number): void;
|
|
146
120
|
handleChange(event: StepChangeEvent): void;
|
package/stepper/Stepper.mjs
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Represents the arguments of the `onChange` event of the Step.
|
|
10
10
|
*/
|
|
11
11
|
export interface StepChangeEvent {
|
|
12
12
|
/**
|
|
13
|
-
* The index of the selected
|
|
13
|
+
* The index of the selected step.
|
|
14
14
|
*/
|
|
15
15
|
value: number;
|
|
16
16
|
}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Represents the arguments of the `onFocus` event of the Step.
|
|
10
10
|
*/
|
|
11
11
|
export interface StepFocusEvent {
|
|
12
12
|
}
|
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Represents the Step ref.
|
|
10
10
|
*/
|
|
11
11
|
export interface StepHandle {
|
|
12
12
|
/**
|
|
13
|
-
* The Step
|
|
13
|
+
* The `li` element that the Step renders.
|
|
14
14
|
*/
|
|
15
15
|
element: HTMLLIElement | null;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Moves the focus to the Step.
|
|
18
18
|
*/
|
|
19
19
|
focus: () => void;
|
|
20
20
|
}
|
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { SVGIcon } from '@progress/kendo-vue-common';
|
|
9
9
|
/**
|
|
10
|
-
* Represents the props of the [Kendo UI for Vue Step component](
|
|
10
|
+
* Represents the props of the [Kendo UI for Vue Step component](slug:overview_stepper).
|
|
11
11
|
*/
|
|
12
12
|
export interface StepProps {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Sets a list of CSS classes that the Step adds to its root element.
|
|
15
15
|
*/
|
|
16
16
|
className?: string;
|
|
17
17
|
/**
|
|
@@ -21,7 +21,10 @@ export interface StepProps {
|
|
|
21
21
|
*/
|
|
22
22
|
content?: any;
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Sets if the Step is the current step.
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* This property is related to accessibility.
|
|
25
28
|
*/
|
|
26
29
|
current?: boolean;
|
|
27
30
|
/**
|
|
@@ -29,63 +32,73 @@ export interface StepProps {
|
|
|
29
32
|
*/
|
|
30
33
|
[customProp: string]: any;
|
|
31
34
|
/**
|
|
32
|
-
*
|
|
33
|
-
* ([see example](
|
|
35
|
+
* Sets if the Step is disabled
|
|
36
|
+
* ([see example](slug:display_modes_stepper)).
|
|
37
|
+
*
|
|
38
|
+
* @remarks
|
|
39
|
+
* This property is related to accessibility.
|
|
34
40
|
*/
|
|
35
41
|
disabled?: boolean;
|
|
36
42
|
/**
|
|
37
|
-
*
|
|
38
|
-
* The
|
|
39
|
-
* ([see example](
|
|
43
|
+
* Sets the name of an existing icon in a Kendo UI for Vue theme.
|
|
44
|
+
* The Step renders the icon inside its indicator in a `span.k-icon` element
|
|
45
|
+
* ([see example](slug:display_modes_stepper)).
|
|
40
46
|
*/
|
|
41
47
|
icon?: string;
|
|
42
48
|
/**
|
|
43
|
-
*
|
|
49
|
+
* Sets an `SVGIcon` that the Step renders inside its indicator.
|
|
44
50
|
*/
|
|
45
51
|
svgIcon?: SVGIcon;
|
|
46
52
|
/**
|
|
47
|
-
*
|
|
53
|
+
* Sets the name of a success icon in a Kendo UI for Vue theme. The Step shows it when it is valid.
|
|
48
54
|
*/
|
|
49
55
|
successIcon?: String;
|
|
50
56
|
/**
|
|
51
|
-
*
|
|
57
|
+
* Sets a success `SVGIcon` that the Step shows when it is valid.
|
|
52
58
|
*/
|
|
53
59
|
successSvgIcon?: Object;
|
|
54
60
|
/**
|
|
55
|
-
*
|
|
61
|
+
* Sets the name of an error icon in a Kendo UI for Vue theme. The Step shows it when it is invalid.
|
|
56
62
|
*/
|
|
57
63
|
errorIcon?: String;
|
|
58
64
|
/**
|
|
59
|
-
*
|
|
65
|
+
* Sets an error `SVGIcon` that the Step shows when it is invalid.
|
|
60
66
|
*/
|
|
61
67
|
errorSvgIcon?: Object;
|
|
62
68
|
/**
|
|
63
|
-
* Sets the index of the Step
|
|
69
|
+
* Sets the index of the Step. The Stepper uses it to identify the Step.
|
|
64
70
|
*/
|
|
65
71
|
index?: number;
|
|
66
72
|
/**
|
|
67
|
-
*
|
|
68
|
-
* ([see example](
|
|
73
|
+
* Sets if the Step is valid
|
|
74
|
+
* ([see example](slug:display_modes_stepper)).
|
|
75
|
+
*
|
|
76
|
+
* @remarks
|
|
77
|
+
* This property is related to accessibility.
|
|
69
78
|
*/
|
|
70
79
|
isValid?: boolean;
|
|
71
80
|
/**
|
|
72
|
-
*
|
|
73
|
-
* ([see example](
|
|
81
|
+
* Sets the label of the Step
|
|
82
|
+
* ([see example](slug:display_modes_stepper)).
|
|
74
83
|
*/
|
|
75
84
|
label?: string;
|
|
76
85
|
/**
|
|
77
|
-
*
|
|
78
|
-
* ([see example](
|
|
86
|
+
* Sets if the Step is optional. The Stepper does not validate optional steps
|
|
87
|
+
* ([see example](slug:display_modes_stepper)).
|
|
79
88
|
*/
|
|
80
89
|
optional?: boolean;
|
|
81
90
|
/**
|
|
82
|
-
* Sets the `tabIndex`
|
|
83
|
-
*
|
|
91
|
+
* Sets the `tabIndex` attribute of the Step.
|
|
92
|
+
*
|
|
93
|
+
* @default `0`
|
|
94
|
+
*
|
|
95
|
+
* @remarks
|
|
96
|
+
* This property is related to accessibility.
|
|
84
97
|
*/
|
|
85
98
|
tabIndex?: number;
|
|
86
99
|
/**
|
|
87
|
-
*
|
|
88
|
-
* ([see example](
|
|
100
|
+
* Sets the text inside the Step indicator
|
|
101
|
+
* ([see example](slug:display_modes_stepper)).
|
|
89
102
|
*/
|
|
90
103
|
text?: string;
|
|
91
104
|
}
|
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Represents the arguments of the `change` event of the Stepper.
|
|
10
10
|
*/
|
|
11
11
|
export interface StepperChangeEvent {
|
|
12
12
|
/**
|
|
13
|
-
* The index of the selected
|
|
13
|
+
* The index of the selected step.
|
|
14
14
|
*/
|
|
15
15
|
value: number;
|
|
16
16
|
}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Represents the arguments of the `focus` event of the Stepper.
|
|
10
10
|
*/
|
|
11
11
|
export interface StepperFocusEvent {
|
|
12
12
|
}
|
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Represents the Stepper ref.
|
|
10
10
|
*/
|
|
11
11
|
export interface StepperHandle {
|
|
12
12
|
/**
|
|
13
|
-
* The Stepper
|
|
13
|
+
* The root element that the Stepper renders.
|
|
14
14
|
*/
|
|
15
15
|
element: HTMLMenuElement | null;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Moves the focus to the first focusable child of the Stepper.
|
|
18
18
|
*/
|
|
19
19
|
focus: () => void;
|
|
20
20
|
}
|
|
@@ -7,20 +7,23 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { StepperHandle } from './../interfaces/StepperHandle';
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Represents the arguments of the navigation event of the Stepper.
|
|
11
11
|
*/
|
|
12
12
|
export declare class StepperOnNavigateEvent {
|
|
13
13
|
/**
|
|
14
|
-
* The Stepper
|
|
14
|
+
* The Stepper that fires the event.
|
|
15
15
|
*/
|
|
16
16
|
target: StepperHandle;
|
|
17
|
+
/**
|
|
18
|
+
* The DOM event that starts the navigation.
|
|
19
|
+
*/
|
|
17
20
|
event: any;
|
|
18
21
|
/**
|
|
19
|
-
* The
|
|
22
|
+
* The index of the step before the navigation.
|
|
20
23
|
*/
|
|
21
24
|
prevIndex: number;
|
|
22
25
|
/**
|
|
23
|
-
* The
|
|
26
|
+
* The index of the step after the navigation.
|
|
24
27
|
*/
|
|
25
28
|
nextIndex: number;
|
|
26
29
|
/**
|
|
@@ -9,19 +9,22 @@ import { StepProps } from './StepProps';
|
|
|
9
9
|
import { StepperChangeEvent } from './StepperChangeEvent';
|
|
10
10
|
import { StepperFocusEvent } from './StepperFocusEvent';
|
|
11
11
|
/**
|
|
12
|
-
* Represents the props of the [Kendo UI for Vue Stepper component](
|
|
12
|
+
* Represents the props of the [Kendo UI for Vue Stepper component](slug:overview_stepper).
|
|
13
13
|
*/
|
|
14
14
|
export interface StepperProps {
|
|
15
15
|
/**
|
|
16
|
-
* Sets the duration of the Stepper animation
|
|
16
|
+
* Sets the duration of the Stepper animation in milliseconds.
|
|
17
|
+
* Set it to `false` to turn off the animation.
|
|
18
|
+
*
|
|
19
|
+
* @default `400`
|
|
17
20
|
*/
|
|
18
21
|
animationDuration?: boolean | number;
|
|
19
22
|
/**
|
|
20
|
-
*
|
|
23
|
+
* Sets a list of CSS classes that the Stepper adds to its root element.
|
|
21
24
|
*/
|
|
22
25
|
className?: string;
|
|
23
26
|
/**
|
|
24
|
-
*
|
|
27
|
+
* Sets the `dir` HTML attribute of the Stepper. Use it to switch between LTR and RTL.
|
|
25
28
|
*/
|
|
26
29
|
dir?: string;
|
|
27
30
|
/**
|
|
@@ -29,55 +32,64 @@ export interface StepperProps {
|
|
|
29
32
|
*/
|
|
30
33
|
disabled?: boolean;
|
|
31
34
|
/**
|
|
32
|
-
*
|
|
35
|
+
* Sets a custom icon that the Stepper shows inside each invalid step.
|
|
33
36
|
*/
|
|
34
37
|
errorIcon?: string;
|
|
35
38
|
/**
|
|
36
|
-
* Overrides the default component
|
|
39
|
+
* Overrides the default component that renders a single step ([see example](slug:custom_rendering_stepper)).
|
|
37
40
|
*
|
|
38
|
-
* The default
|
|
41
|
+
* The default component is: [Step](slug:api_layout_step).
|
|
39
42
|
*/
|
|
40
43
|
item?: any;
|
|
41
44
|
/**
|
|
42
|
-
*
|
|
45
|
+
* Sets the collection of steps that the Stepper renders ([see example](slug:overview_stepper)).
|
|
43
46
|
*/
|
|
44
47
|
items: Array<StepProps>;
|
|
45
48
|
/**
|
|
46
|
-
*
|
|
47
|
-
* ([see example](
|
|
49
|
+
* Turns on the linear flow of the Stepper. In linear mode, you can move only to the previous or the next step
|
|
50
|
+
* ([see example](slug:linear_mode_stepper)).
|
|
48
51
|
*/
|
|
49
52
|
linear?: boolean;
|
|
50
53
|
/**
|
|
51
|
-
*
|
|
52
|
-
* ([see example](
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
* * `
|
|
54
|
+
* Sets the display mode of the Stepper
|
|
55
|
+
* ([see example](slug:display_modes_stepper)).
|
|
56
|
+
*
|
|
57
|
+
* The available options are:
|
|
58
|
+
* * `steps`—Renders the step indicator and an optional label.
|
|
59
|
+
* * `labels`—Renders only the labels.
|
|
60
|
+
*
|
|
61
|
+
* @default `steps`
|
|
56
62
|
*/
|
|
57
63
|
mode?: 'steps' | 'labels' | string;
|
|
58
64
|
/**
|
|
59
|
-
*
|
|
60
|
-
* ([see example](
|
|
65
|
+
* Sets the orientation of the Stepper
|
|
66
|
+
* ([see example](slug:orientation_stepper)).
|
|
61
67
|
*
|
|
62
|
-
* The
|
|
63
|
-
* *
|
|
68
|
+
* The available options are:
|
|
69
|
+
* * `horizontal`
|
|
64
70
|
* * `vertical`
|
|
71
|
+
*
|
|
72
|
+
* @default `horizontal`
|
|
65
73
|
*/
|
|
66
74
|
orientation?: 'horizontal' | 'vertical' | string;
|
|
67
75
|
/**
|
|
68
|
-
*
|
|
76
|
+
* Sets a custom icon that the Stepper shows inside each valid step.
|
|
69
77
|
*/
|
|
70
78
|
successIcon?: string;
|
|
71
79
|
/**
|
|
72
|
-
*
|
|
80
|
+
* Sets the index of the selected step.
|
|
81
|
+
*
|
|
82
|
+
* @default `0`
|
|
73
83
|
*/
|
|
74
84
|
value: number;
|
|
75
85
|
/**
|
|
76
|
-
*
|
|
86
|
+
* Sets the maximum value of the ProgressBar inside the Stepper.
|
|
87
|
+
* If you do not set it, the Stepper uses the number of steps.
|
|
77
88
|
*/
|
|
78
89
|
progressTotal?: number;
|
|
79
90
|
/**
|
|
80
|
-
*
|
|
91
|
+
* Sets the current progress of the ProgressBar inside the Stepper.
|
|
92
|
+
* If you do not set it, the Stepper uses the current `value`.
|
|
81
93
|
*/
|
|
82
94
|
progress?: number;
|
|
83
95
|
/**
|
|
@@ -85,11 +97,11 @@ export interface StepperProps {
|
|
|
85
97
|
*/
|
|
86
98
|
modelValue?: number;
|
|
87
99
|
/**
|
|
88
|
-
*
|
|
100
|
+
* Fires when the user selects a different step and the value changes.
|
|
89
101
|
*/
|
|
90
102
|
onChange?: (event: StepperChangeEvent) => void;
|
|
91
103
|
/**
|
|
92
|
-
*
|
|
104
|
+
* Fires when a step receives the focus.
|
|
93
105
|
*/
|
|
94
106
|
onFocus?: (event: StepperFocusEvent) => void;
|
|
95
107
|
}
|
package/tabstrip/TabStrip.d.ts
CHANGED
|
@@ -8,56 +8,62 @@
|
|
|
8
8
|
import { TabStripTabProperties } from './TabStripTab';
|
|
9
9
|
import { PropType } from 'vue';
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Represents the arguments that the TabStrip passes to the `onSelect` callback function.
|
|
12
12
|
*/
|
|
13
13
|
export interface TabStripSelectEventArguments {
|
|
14
14
|
/**
|
|
15
|
-
* The index of the selected
|
|
15
|
+
* The index of the selected tab.
|
|
16
16
|
*/
|
|
17
17
|
selected: number;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
* Represents the emits of the [Kendo UI for Vue TabStrip component](
|
|
20
|
+
* Represents the emits of the [Kendo UI for Vue TabStrip component](slug:overview_tabstrip).
|
|
21
21
|
*/
|
|
22
22
|
export interface TabStripEmits {
|
|
23
23
|
/**
|
|
24
|
-
* Fires each time the user
|
|
24
|
+
* Fires each time the user selects a tab.
|
|
25
25
|
*/
|
|
26
26
|
onSelect?: (e: TabStripSelectEventArguments) => void;
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Represents the values of the `size` property of the TabStrip.
|
|
30
30
|
*/
|
|
31
31
|
export type TabStripSize = 'small' | 'medium' | 'large' | null;
|
|
32
32
|
/**
|
|
33
|
-
* Represents the props of the [Kendo UI for Vue TabStrip component](
|
|
33
|
+
* Represents the props of the [Kendo UI for Vue TabStrip component](slug:overview_tabstrip).
|
|
34
34
|
*/
|
|
35
35
|
export interface TabStripProps extends TabStripEmits {
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Turns on the animation when the user switches tabs.
|
|
38
|
+
*
|
|
39
|
+
* @default `true`
|
|
38
40
|
*/
|
|
39
41
|
animation?: boolean;
|
|
40
42
|
/**
|
|
41
|
-
* Sets the index of the selected
|
|
42
|
-
* ([see example](
|
|
43
|
+
* Sets the index of the selected tab
|
|
44
|
+
* ([see example](slug:tabs_tabstrip#toc-tabs-on-initial-loading)).
|
|
43
45
|
*/
|
|
44
46
|
selected?: number;
|
|
45
47
|
/**
|
|
46
|
-
*
|
|
48
|
+
* Sets the size of the TabStrip.
|
|
47
49
|
*
|
|
48
|
-
*
|
|
50
|
+
* The available options are:
|
|
51
|
+
* - `small`
|
|
52
|
+
* - `medium`
|
|
53
|
+
* - `large`
|
|
54
|
+
* - `null`—Does not set a size class.
|
|
49
55
|
*/
|
|
50
56
|
size?: TabStripSize;
|
|
51
57
|
/**
|
|
52
|
-
*
|
|
58
|
+
* Sets the position of the tabs in the TabStrip.
|
|
53
59
|
*
|
|
54
60
|
* The available options are:
|
|
55
|
-
* - `"top"`—Renders the
|
|
56
|
-
* - `"bottom"`—Renders the
|
|
57
|
-
* - `"left"`—Renders the
|
|
58
|
-
* - `"right"`—Renders the
|
|
61
|
+
* - `"top"`—Renders the tabs at the top of the TabStrip.
|
|
62
|
+
* - `"bottom"`—Renders the tabs at the bottom of the TabStrip.
|
|
63
|
+
* - `"left"`—Renders the tabs on the left side of the TabStrip.
|
|
64
|
+
* - `"right"`—Renders the tabs on the right side of the TabStrip.
|
|
59
65
|
*
|
|
60
|
-
* @default
|
|
66
|
+
* @default `top`
|
|
61
67
|
*/
|
|
62
68
|
tabPosition?: string;
|
|
63
69
|
/**
|
|
@@ -65,30 +71,57 @@ export interface TabStripProps extends TabStripEmits {
|
|
|
65
71
|
*
|
|
66
72
|
*
|
|
67
73
|
* The available options are:
|
|
68
|
-
* - `"start"`—Aligns the tabs at the start of the
|
|
69
|
-
* - `"center"`—Aligns the tabs in the center of the
|
|
70
|
-
* - `"end"`—Aligns the tabs at the end of the
|
|
71
|
-
* - `"justify"`—Justifies the tabs inside the
|
|
72
|
-
* - `"stretched"`—Stretches the tabs
|
|
74
|
+
* - `"start"`—Aligns the tabs at the start of the tab list.
|
|
75
|
+
* - `"center"`—Aligns the tabs in the center of the tab list.
|
|
76
|
+
* - `"end"`—Aligns the tabs at the end of the tab list.
|
|
77
|
+
* - `"justify"`—Justifies the tabs inside the tab list.
|
|
78
|
+
* - `"stretched"`—Stretches the tabs to fill the tab list.
|
|
73
79
|
*
|
|
74
|
-
* @default
|
|
80
|
+
* @default `start`
|
|
75
81
|
*/
|
|
76
82
|
tabAlignment?: string;
|
|
77
83
|
/**
|
|
78
|
-
* Sets the array of tabs.
|
|
84
|
+
* Sets the array of tabs that the TabStrip renders. Each tab is a `TabStripTabProperties` object.
|
|
79
85
|
*/
|
|
80
86
|
tabs?: TabStripTabProperties[];
|
|
81
87
|
/**
|
|
82
|
-
* Sets the `tabIndex` of the
|
|
88
|
+
* Sets the `tabIndex` attribute of the tab list.
|
|
89
|
+
*
|
|
90
|
+
* @default `0`
|
|
91
|
+
*
|
|
92
|
+
* @remarks
|
|
93
|
+
* This property is related to accessibility.
|
|
83
94
|
*/
|
|
84
95
|
tabIndex?: number;
|
|
85
96
|
/**
|
|
86
|
-
* Sets the
|
|
97
|
+
* Sets the `dir` HTML attribute of the TabStrip. Use it to switch between LTR and RTL.
|
|
87
98
|
*/
|
|
88
99
|
dir?: string;
|
|
89
100
|
}
|
|
90
101
|
/**
|
|
91
|
-
*
|
|
102
|
+
* Represents the [Kendo UI for Vue TabStrip component](slug:overview_tabstrip).
|
|
103
|
+
* Accepts properties of type [TabStripProps](slug:api_layout_tabstripprops).
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* ```vue
|
|
107
|
+
* <TabStrip
|
|
108
|
+
* :selected="selected"
|
|
109
|
+
* :tabs="[
|
|
110
|
+
* { title: 'Orders', content: 'orders' },
|
|
111
|
+
* { title: 'Invoices', content: 'invoices' },
|
|
112
|
+
* { title: 'Returns', content: 'returns', disabled: true }
|
|
113
|
+
* ]"
|
|
114
|
+
* :tab-position="'top'"
|
|
115
|
+
* :tab-alignment="'start'"
|
|
116
|
+
* :size="'medium'"
|
|
117
|
+
* :animation="true"
|
|
118
|
+
* @select="onSelect"
|
|
119
|
+
* >
|
|
120
|
+
* <template v-slot:orders>Open orders</template>
|
|
121
|
+
* <template v-slot:invoices>Unpaid invoices</template>
|
|
122
|
+
* <template v-slot:returns>Pending returns</template>
|
|
123
|
+
* </TabStrip>
|
|
124
|
+
* ```
|
|
92
125
|
*/
|
|
93
126
|
declare const TabStrip: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
|
94
127
|
animation: {
|
|
@@ -7,23 +7,23 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { PropType } from 'vue';
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Represents the props that the TabStrip passes to the TabStripContent.
|
|
11
11
|
*/
|
|
12
12
|
export interface TabStripContentProps {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Turns on the animation when the content changes.
|
|
15
15
|
*/
|
|
16
16
|
animation?: boolean;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Sets if the TabStripContent renders the content of all tabs.
|
|
19
19
|
*/
|
|
20
20
|
showAll?: boolean;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Sets the index of the selected tab. The TabStripContent uses it to decide which content to render.
|
|
23
23
|
*/
|
|
24
24
|
selected?: number;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Sets the collection of tabs.
|
|
27
27
|
*/
|
|
28
28
|
tabs?: Array<any>;
|
|
29
29
|
/**
|