@progress/kendo-vue-layout 11.0.0-develop.1 → 11.0.1-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.
Files changed (105) hide show
  1. package/NOTICE.txt +17 -17
  2. package/actionsheet/ActionSheet.d.ts +67 -23
  3. package/actionsheet/interfaces/ActionSheetContentProps.d.ts +2 -2
  4. package/actionsheet/interfaces/ActionSheetFooterProps.d.ts +2 -2
  5. package/actionsheet/interfaces/ActionSheetHeaderProps.d.ts +3 -3
  6. package/actionsheet/interfaces/ActionSheetItemProps.d.ts +24 -14
  7. package/appbar/AppBar.d.ts +21 -1
  8. package/appbar/AppBar.mjs +3 -0
  9. package/appbar/AppBarSection.d.ts +12 -1
  10. package/appbar/AppBarSection.mjs +3 -0
  11. package/appbar/AppBarSpacer.d.ts +10 -1
  12. package/appbar/AppBarSpacer.mjs +3 -0
  13. package/appbar/interfaces/AppBarProps.d.ts +31 -29
  14. package/appbar/interfaces/AppBarSectionProps.d.ts +1 -1
  15. package/appbar/interfaces/AppBarSpacerProps.d.ts +5 -2
  16. package/bottomnavigation/BottomNavigation.d.ts +23 -1
  17. package/bottomnavigation/BottomNavigation.mjs +3 -0
  18. package/bottomnavigation/BottomNavigationItemProps.d.ts +20 -9
  19. package/bottomnavigation/BottomNavigationProps.d.ts +73 -63
  20. package/bottomnavigation/models/events.d.ts +3 -3
  21. package/breadcrumb/Breadcrumb.d.ts +17 -1
  22. package/breadcrumb/BreadcrumbDelimiter.d.ts +8 -1
  23. package/breadcrumb/BreadcrumbLink.d.ts +17 -1
  24. package/breadcrumb/BreadcrumbLink.mjs +3 -0
  25. package/breadcrumb/interfaces/BreadcrumbDelimiterProps.d.ts +6 -3
  26. package/breadcrumb/interfaces/BreadcrumbLinkProps.d.ts +20 -11
  27. package/breadcrumb/interfaces/BreadcrumbOrderedListProps.d.ts +1 -1
  28. package/breadcrumb/interfaces/BreadcrumbProps.d.ts +56 -31
  29. package/card/Avatar.d.ts +7 -1
  30. package/card/Card.d.ts +18 -1
  31. package/card/CardActions.d.ts +10 -1
  32. package/card/CardBody.d.ts +13 -1
  33. package/card/CardFooter.d.ts +7 -1
  34. package/card/CardHeader.d.ts +13 -1
  35. package/card/CardImage.d.ts +7 -1
  36. package/card/CardSubtitle.d.ts +7 -1
  37. package/card/CardTitle.d.ts +7 -1
  38. package/card/interfaces/AvatarProps.d.ts +11 -8
  39. package/card/interfaces/CardActionsProps.d.ts +9 -3
  40. package/card/interfaces/CardBodyProps.d.ts +3 -0
  41. package/card/interfaces/CardFooterProps.d.ts +3 -0
  42. package/card/interfaces/CardHeaderProps.d.ts +3 -0
  43. package/card/interfaces/CardImageProps.d.ts +4 -1
  44. package/card/interfaces/CardProps.d.ts +12 -4
  45. package/card/interfaces/CardSubtitleProps.d.ts +3 -0
  46. package/card/interfaces/CardTitleProps.d.ts +3 -0
  47. package/card/interfaces/Enums.d.ts +57 -0
  48. package/contextmenu/ContextMenu.d.ts +23 -3
  49. package/dist/cdn/js/kendo-vue-layout.js +1 -1
  50. package/drawer/Drawer.d.ts +25 -1
  51. package/drawer/Drawer.mjs +3 -0
  52. package/drawer/DrawerContent.d.ts +1 -1
  53. package/drawer/DrawerItem.d.ts +1 -1
  54. package/drawer/interfaces/DrawerAnimation.d.ts +3 -3
  55. package/drawer/interfaces/DrawerContentProps.d.ts +1 -1
  56. package/drawer/interfaces/DrawerItemHandle.d.ts +3 -3
  57. package/drawer/interfaces/DrawerItemProps.d.ts +28 -12
  58. package/drawer/interfaces/DrawerProps.d.ts +49 -29
  59. package/drawer/interfaces/DrawerSelectEvent.d.ts +2 -2
  60. package/expansionpanel/ExpansionPanel.d.ts +16 -1
  61. package/expansionpanel/interfaces.d.ts +35 -20
  62. package/gridlayout/GridLayout.d.ts +22 -1
  63. package/gridlayout/interfaces/GridLayoutColumnProps.d.ts +4 -3
  64. package/gridlayout/interfaces/GridLayoutItemProps.d.ts +12 -11
  65. package/gridlayout/interfaces/GridLayoutProps.d.ts +23 -21
  66. package/gridlayout/interfaces/GridLayoutRowProps.d.ts +4 -3
  67. package/menu/MenuProps.d.ts +32 -16
  68. package/menu/components/Menu.d.ts +16 -6
  69. package/menu/events.d.ts +2 -2
  70. package/menu/models/BaseMenuItem.d.ts +27 -21
  71. package/menu/models/MenuItemActionsRenderProps.d.ts +2 -2
  72. package/menu/models/MenuItemGroupHeaderRenderProps.d.ts +2 -2
  73. package/menu/models/MenuItemModel.d.ts +2 -2
  74. package/package-metadata.js +1 -1
  75. package/package-metadata.mjs +2 -2
  76. package/package.json +8 -8
  77. package/panelbar/PanelBar.d.ts +30 -2
  78. package/panelbar/interfaces/PanelBarItemProps.d.ts +38 -17
  79. package/panelbar/interfaces/PanelBarProps.d.ts +31 -14
  80. package/panelbar/interfaces/PanelBarSelectEventArguments.d.ts +2 -2
  81. package/splitter/Splitter.d.ts +26 -56
  82. package/splitter/SplitterPane.d.ts +19 -11
  83. package/stacklayout/StackLayout.d.ts +12 -2
  84. package/stacklayout/StackLayoutProps.d.ts +24 -22
  85. package/stepper/Step.d.ts +25 -20
  86. package/stepper/Step.mjs +3 -0
  87. package/stepper/Stepper.d.ts +23 -49
  88. package/stepper/Stepper.mjs +3 -0
  89. package/stepper/interfaces/StepChangeEvent.d.ts +2 -2
  90. package/stepper/interfaces/StepFocusEvent.d.ts +1 -1
  91. package/stepper/interfaces/StepHandle.d.ts +3 -3
  92. package/stepper/interfaces/StepProps.d.ts +37 -24
  93. package/stepper/interfaces/StepperChangeEvent.d.ts +2 -2
  94. package/stepper/interfaces/StepperFocusEvent.d.ts +1 -1
  95. package/stepper/interfaces/StepperHandle.d.ts +3 -3
  96. package/stepper/interfaces/StepperOnNavigateEvent.d.ts +7 -4
  97. package/stepper/interfaces/StepperProps.d.ts +37 -25
  98. package/tabstrip/TabStrip.d.ts +60 -27
  99. package/tabstrip/TabStripContent.d.ts +5 -5
  100. package/tabstrip/TabStripNavigation.d.ts +4 -4
  101. package/tabstrip/TabStripNavigationItem.d.ts +12 -7
  102. package/tabstrip/TabStripTab.d.ts +29 -5
  103. package/tilelayout/TileLayout.d.ts +61 -23
  104. package/tilelayout/TileLayout.mjs +3 -0
  105. package/tilelayout/interfaces/main.d.ts +105 -69
@@ -7,27 +7,35 @@
7
7
  */
8
8
  import { SVGIcon } from '@progress/kendo-vue-common';
9
9
  /**
10
- * Represents the props of the PanelBarItem component.
10
+ * Represents the props of the PanelBar items.
11
11
  */
12
12
  export interface PanelBarItemProps {
13
13
  /**
14
- * Sets the subitems of the item.
14
+ * Sets the child items of the item.
15
15
  */
16
16
  items?: any[];
17
17
  /**
18
- * Allows individual animation control over the child ([see example]({% slug animations_panelbar %})). By default, it is controlled by the PanelBar component.
18
+ * Sets if the item animates its child items ([see example](slug:animations_panelbar)). By default, the PanelBar controls the animation.
19
19
  */
20
20
  animation?: boolean;
21
21
  /**
22
- * The class name that is set to the PanelBarItem header.
22
+ * Adds a custom CSS class to the header of the item.
23
23
  */
24
24
  headerClassName?: string;
25
25
  /**
26
- * Sets the initial expanded state of the PanelBarItem ([see example]({% slug statesitems_panelbar %}#toc-expanded-items)). Controlled by the PanelBar component.
26
+ * Sets if the item is expanded when the PanelBar first renders ([see example](slug:statesitems_panelbar#toc-expanded-items)). The PanelBar controls this state.
27
+ * An expanded item gets the `aria-expanded` attribute.
28
+ *
29
+ * @remarks
30
+ * This property is related to accessibility.
27
31
  */
28
32
  expanded?: boolean;
29
33
  /**
30
- * Sets the disabled state of the PanelBarItem ([see example]({% slug statesitems_panelbar %}#toc-disabled-items)).
34
+ * Sets if the item is disabled ([see example](slug:statesitems_panelbar#toc-disabled-items)).
35
+ * A disabled item gets the `aria-disabled` attribute.
36
+ *
37
+ * @remarks
38
+ * This property is related to accessibility.
31
39
  */
32
40
  disabled?: boolean;
33
41
  /**
@@ -35,35 +43,48 @@ export interface PanelBarItemProps {
35
43
  */
36
44
  level?: number;
37
45
  /**
38
- * Defines an icon that will be rendered next to the title ([see example]({% slug titlesitems_panelbar %}#toc-adding-icons)).
46
+ * Sets the icon that the item shows next to the title ([see example](slug:titlesitems_panelbar#toc-adding-icons)).
39
47
  */
40
48
  icon?: string;
41
49
  /**
42
- * Defines an SVGIcon to be rendered next to the title.
50
+ * Sets the SVGIcon that the item shows next to the title.
43
51
  */
44
52
  svgIcon?: SVGIcon;
45
53
  /**
46
- * Defines an icon with a custom CSS class that will be rendered next to the title ([see example]({% slug titlesitems_panelbar %}#toc-adding-icons)).
54
+ * Sets a custom CSS class for an icon that the item shows next to the title ([see example](slug:titlesitems_panelbar#toc-adding-icons)).
47
55
  */
48
56
  iconClass?: string;
49
57
  /**
50
- * Defines the location of the image that will be displayed next to the title ([see example]({% slug titlesitems_panelbar %}#toc-adding-images)).
58
+ * Sets the URL of an image that the item shows next to the title ([see example](slug:titlesitems_panelbar#toc-adding-images)).
51
59
  */
52
60
  imageUrl?: string;
53
61
  /**
54
- * Sets the initial selected state of the PanelBarItem. Controlled by the PanelBarItem component ([see example]({% slug statesitems_panelbar %}#toc-selected-items)).
62
+ * Sets if the item is selected when the PanelBar first renders ([see example](slug:statesitems_panelbar#toc-selected-items)). The PanelBar controls this state.
63
+ * A selected item gets the `aria-selected` attribute.
64
+ *
65
+ * @remarks
66
+ * This property is related to accessibility.
55
67
  */
56
68
  selected?: boolean;
57
69
  /**
58
- * Sets the title of the PanelBar item ([see example]({% slug titlesitems_panelbar %}#toc-getting-started)).
70
+ * Sets the title of the item ([see example](slug:titlesitems_panelbar#toc-getting-started)).
71
+ *
72
+ * @default `Untitled`
59
73
  */
60
74
  title?: any;
61
75
  /**
62
- * Allows the component to set the `id` property to each item. If not set, a default `id` is applied.
76
+ * Sets the `id` attribute of the item. If you do not set it, the PanelBar applies a default `id`.
77
+ * The PanelBar uses this `id` in its `aria-activedescendant` attribute.
78
+ *
79
+ * @remarks
80
+ * This property is related to accessibility.
63
81
  */
64
82
  id?: string | number;
65
83
  /**
66
- * Sets the initial focused state of the PanelBarItem. Controlled by the PanelBar component.
84
+ * Sets if the item is focused when the PanelBar first renders. The PanelBar controls this state.
85
+ *
86
+ * @remarks
87
+ * This property is related to accessibility.
67
88
  */
68
89
  focused?: boolean;
69
90
  /**
@@ -71,15 +92,15 @@ export interface PanelBarItemProps {
71
92
  */
72
93
  parentExpanded?: boolean;
73
94
  /**
74
- * Defines the custom rendering of the content of the PanelBarItem. Accepts a Vue component, a `render` function, or a slot name.
95
+ * Sets a custom rendering for the content of the item. Accepts a Vue component, a `render` function, or a slot name.
75
96
  */
76
97
  content?: any;
77
98
  /**
78
- * Defines the custom rendering of the header of the PanelBarItem. Accepts a Vue component, a `render` function, or a slot name.
99
+ * Sets a custom rendering for the header of the item. Accepts a Vue component, a `render` function, or a slot name.
79
100
  */
80
101
  header?: any;
81
102
  /**
82
- * Used to identify the PanelBarItems inside the PanelBar ([see example]({% slug controlling_state_panelbar %})). Does not depend on the state of the PanelBarItem.
103
+ * Identifies the item inside the PanelBar ([see example](slug:controlling_state_panelbar)). It does not depend on the state of the item.
83
104
  */
84
105
  uniquePrivateKey?: string | number;
85
106
  /**
@@ -7,19 +7,21 @@
7
7
  */
8
8
  import { PanelBarSelectEventArguments } from './PanelBarSelectEventArguments';
9
9
  /**
10
- * Represents the expand modes of the Kendo UI for Vue PanelBar. Defaults to `multiple`.
10
+ * Represents the expand modes of the Kendo UI for Vue PanelBar. The default value is `multiple`.
11
11
  */
12
12
  export type PanelBarExpandMode = 'single' | 'multiple';
13
13
  /**
14
- * Represents the props of the [Kendo UI for Vue PanelBar component]({% slug overview_panelbar %}).
14
+ * Represents the props of the [Kendo UI for Vue PanelBar component](slug:overview_panelbar).
15
15
  */
16
16
  export interface PanelBarProps {
17
17
  /**
18
- * The class name that is set to the PanelBar.
18
+ * Adds a custom CSS class to the PanelBar.
19
19
  */
20
20
  className?: string;
21
21
  /**
22
- * Sets the animation state of the PanelBar.
22
+ * Sets if the PanelBar animates the expanding and collapsing of its items.
23
+ *
24
+ * @default `true`
23
25
  */
24
26
  animation?: boolean;
25
27
  /**
@@ -27,39 +29,54 @@ export interface PanelBarProps {
27
29
  */
28
30
  items?: any[];
29
31
  /**
30
- * Sets the expand mode of the PanelBar ([see example]({% slug expandmodes_panelbar %})).
32
+ * Sets the expand mode of the PanelBar ([see example](slug:expandmodes_panelbar)).
31
33
  *
32
34
  * The available modes are:
33
- * - `"single"`—Allows you to expand only one item at a time. The expanding of an item collapses the item that was previously expanded.
34
- * - `"multiple"` (default)—Allows you to expand two or more items at a time. Items can also be toggled.
35
+ * - `"single"`—Lets you expand only one item at a time. When you expand an item, the item that was expanded before collapses.
36
+ * - `"multiple"` (default)—Lets you expand two or more items at a time. You can also toggle the items.
37
+ *
38
+ * @default `multiple`
35
39
  */
36
40
  expandMode?: PanelBarExpandMode;
37
41
  /**
38
- * Sets the direction of the PanelBar component.
42
+ * Sets the `dir` HTML attribute of the PanelBar. Use it to switch between LTR and RTL.
39
43
  */
40
44
  dir?: string;
41
45
  /**
42
- * If set, overrides the currently selected property in the PanelBar state.
46
+ * Sets the selected item of the PanelBar. When you set it, it overrides the selected item in the PanelBar state.
47
+ * The selected item gets the `aria-selected` attribute.
48
+ *
49
+ * @remarks
50
+ * This property is related to accessibility.
43
51
  */
44
52
  selected?: string | number;
45
53
  /**
46
- * Sets the initial expanded state of the PanelBar.
54
+ * Sets the expanded items of the PanelBar.
55
+ * An expanded item gets the `aria-expanded` attribute.
56
+ *
57
+ * @remarks
58
+ * This property is related to accessibility.
47
59
  */
48
60
  expanded?: string[];
49
61
  /**
50
- * Sets the initial focused state of the PanelBar.
62
+ * Sets the item that is focused when the PanelBar first renders.
63
+ *
64
+ * @remarks
65
+ * This property is related to accessibility.
51
66
  */
52
67
  focused?: string | number;
53
68
  /**
54
- * Determines if the PanelBar items will be mounted after expand collapse. Defaults to `false`.
69
+ * Sets if the PanelBar keeps the content of collapsed items mounted.
70
+ *
71
+ * @default `false`
55
72
  */
56
73
  keepItemsMounted?: boolean;
57
74
  /**
58
- * Determines if the PanelBar is going to be used in controlled state.
75
+ * Sets if you use the PanelBar in controlled mode.
59
76
  */
60
77
  isControlled?: boolean;
61
78
  /**
62
- * Fires each time the user makes a selection ([see example]({% slug controlling_state_panelbar %})).
79
+ * Fires each time the user selects an item ([see example](slug:controlling_state_panelbar)).
63
80
  */
64
81
  onSelect?: (event: PanelBarSelectEventArguments) => void;
65
82
  }
@@ -6,7 +6,7 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The arguments that are passed to the `onSelect` callback function.
9
+ * Represents the arguments that the PanelBar passes to the `onSelect` callback function.
10
10
  */
11
11
  export interface PanelBarSelectEventArguments {
12
12
  /**
@@ -14,7 +14,7 @@ export interface PanelBarSelectEventArguments {
14
14
  */
15
15
  target: any;
16
16
  /**
17
- * The new expanded PanelBar items state.
17
+ * The new list of expanded PanelBar items.
18
18
  */
19
19
  expandedItems: string[];
20
20
  }
@@ -8,15 +8,15 @@
8
8
  import { SplitterPaneExtendedProps, SplitterPaneProps } from './SplitterPane';
9
9
  import { PropType } from 'vue';
10
10
  /**
11
- * Represents the onChange event of the Splitter.
11
+ * Represents the arguments of the `change` event of the Splitter.
12
12
  */
13
13
  export interface SplitterOnChangeEvent {
14
14
  /**
15
- * The new panes state.
15
+ * The new state of the panes.
16
16
  */
17
17
  newState: SplitterPaneProps[];
18
18
  /**
19
- * Indicates if is the last event during drag. Can be used to optimize performance.
19
+ * Shows if this is the last event during the drag. Use it to improve performance.
20
20
  */
21
21
  isLast: boolean;
22
22
  /**
@@ -25,23 +25,27 @@ export interface SplitterOnChangeEvent {
25
25
  nativeEvent: any;
26
26
  }
27
27
  /**
28
- * Represents the options of the Splitter.
28
+ * Represents the props of the [Kendo UI for Vue Splitter component](slug:overview_splitter).
29
29
  */
30
30
  export interface SplitterProps {
31
31
  /**
32
- * Sets the options of the Splitter panes ([more information and examples]({% slug panes_splitter %})). Can be used for controlled state.
32
+ * Sets the options of the Splitter panes ([more information and examples](slug:panes_splitter)). Use it for controlled state.
33
33
  */
34
34
  panes?: SplitterPaneProps[];
35
35
  /**
36
- * Sets the initial options of the Splitter panes ([more information and examples]({% slug panes_splitter %})). Can be used for uncontrolled state.
36
+ * Sets the initial options of the Splitter panes ([more information and examples](slug:panes_splitter)). Use it for uncontrolled state.
37
37
  */
38
38
  defaultPanes?: SplitterPaneProps[];
39
39
  /**
40
- * Specifies the orientation of the panes within the Splitter ([more information and examples]({% slug orientation_splitter %})). Panes in a horizontal Splitter are placed horizontally. Panes in a vertical Splitter are placed vertically.
40
+ * Sets the orientation of the panes in the Splitter ([more information and examples](slug:orientation_splitter)). A horizontal Splitter places the panes side by side. A vertical Splitter places the panes one above the other.
41
+ *
42
+ * The supported values are `horizontal` and `vertical`.
43
+ *
44
+ * @default `horizontal`
41
45
  */
42
46
  orientation?: 'vertical' | 'horizontal' | string;
43
47
  /**
44
- * Fires after a Splitter pane is resized or collapsed. Useful for updating the pane options and triggering layout calculations on components which are positioned inside the panes.
48
+ * Fires after the user resizes or collapses a Splitter pane. Use it to update the pane options and to recalculate the layout of components inside the panes.
45
49
  */
46
50
  onChange?: (event: SplitterOnChangeEvent) => void;
47
51
  }
@@ -59,58 +63,24 @@ export interface SplitterData {
59
63
  currentPanes: SplitterPaneProps[];
60
64
  }
61
65
  /**
62
- * Represents the [Kendo UI for Vue Splitter component]({% slug overview_splitter %}).
66
+ * Represents the [KendoVue Splitter component](slug:overview_splitter).
67
+ * Accepts properties of type [SplitterProps](slug:api_layout_splitterprops).
63
68
  *
64
- * ```js-no-run
65
- * <template>
66
- * <Splitter
69
+ * @example
70
+ * ```vue
71
+ * <Splitter
67
72
  * :style="{ height: '340px' }"
68
- * :panes="panes"
69
- * :orientation="'vertical'"
73
+ * :panes="[
74
+ * { size: '30%', min: '20%', collapsible: true, content: 'shipments' },
75
+ * { content: 'details' }
76
+ * ]"
77
+ * :orientation="'horizontal'"
70
78
  * @change="onChange"
71
- * >
72
- * <template v-slot:first>
73
- * <div class="pane-content">
74
- * <h3>Top Pane</h3>
75
- * </div>
76
- * </template>
77
- * <template v-slot:second>
78
- * <div class="pane-content">
79
- * <h3>Bottom Pane</h3>
80
- * </div>
81
- * </template>
82
- * </Splitter>
83
- * </template>
84
- *
85
- * <script>
86
- * import { Splitter } from '@progress/kendo-vue-layout';
87
- * import './styles.css';
88
- *
89
- * export default {
90
- * components: {
91
- * Splitter,
92
- * },
93
- * data() {
94
- * return {
95
- * panes: [
96
- * { size: '40%', containsSplitter: true, content: 'first' },
97
- * { content: 'second' },
98
- * ],
99
- * };
100
- * },
101
- * methods: {
102
- * onChange(event) {
103
- * this.panes = event.newState;
104
- * },
105
- * },
106
- * };
107
- * </script>
79
+ * >
80
+ * <template v-slot:shipments>Shipment list</template>
81
+ * <template v-slot:details>Shipment details</template>
82
+ * </Splitter>
108
83
  * ```
109
- *
110
- *
111
- *
112
- * ### props <span class='code'>Readonly&lt;[SplitterProps]({% slug api_layout_splitterprops %})</span>
113
- * The props of the Splitter component.
114
84
  */
115
85
  declare const Splitter: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
116
86
  orientation: {
@@ -7,47 +7,55 @@
7
7
  */
8
8
  import { PropType } from 'vue';
9
9
  /**
10
- * Represents the pane options of the Splitter.
10
+ * Represents the options of a Splitter pane.
11
11
  */
12
12
  export interface SplitterPaneProps {
13
13
  /**
14
- * Sets the size of the pane ([see example]({% slug panes_splitter %}#toc-dimensions)). Has to be between the `min` and `max` properties.
14
+ * Sets the size of the pane ([see example](slug:panes_splitter#toc-dimensions)). The value must be between the `min` and `max` values.
15
15
  */
16
16
  size?: string;
17
17
  /**
18
- * Sets the minimum possible size of the pane ([see example]({% slug panes_splitter %}#toc-dimensions)).
18
+ * Sets the minimum size of the pane ([see example](slug:panes_splitter#toc-dimensions)).
19
19
  */
20
20
  min?: string;
21
21
  /**
22
- * Sets the maximum possible size of the pane ([see example]({% slug panes_splitter %}#toc-dimensions)).
22
+ * Sets the maximum size of the pane ([see example](slug:panes_splitter#toc-dimensions)).
23
23
  */
24
24
  max?: string;
25
25
  /**
26
- * Specifies if the user is allowed to resize the pane and provide space for other panes ([see example]({% slug panes_splitter %}#toc-resizing)). If `resizable` is not specified, the resizing of the pane will be enabled.
26
+ * Sets if the user can resize the pane to make space for other panes ([see example](slug:panes_splitter#toc-resizing)).
27
+ *
28
+ * @default `true`
27
29
  */
28
30
  resizable?: boolean;
29
31
  /**
30
- * Specifies if the user is allowed to hide the pane and provide space for other panes ([see example]({% slug panes_splitter %}#toc-collapsing)).
32
+ * Sets if the user can collapse the pane to make space for other panes ([see example](slug:panes_splitter#toc-collapsing)).
33
+ *
34
+ * @default `false`
31
35
  */
32
36
  collapsible?: boolean;
33
37
  /**
34
- * Specifies the pane collapsed state ([see example]({% slug panes_splitter %}#toc-collapsing)).
38
+ * Sets if the pane is collapsed ([see example](slug:panes_splitter#toc-collapsing)).
39
+ *
40
+ * @default `false`
35
41
  */
36
42
  collapsed?: boolean;
37
43
  /**
38
- * Specifies if overflowing content is scrollable or hidden ([see example]({% slug panes_splitter %}#toc-scrolling)). If `scrollable` is not specified, the content will be scrollable.
44
+ * Sets if the pane scrolls or hides overflowing content ([see example](slug:panes_splitter#toc-scrolling)).
45
+ *
46
+ * @default `true`
39
47
  */
40
48
  scrollable?: boolean;
41
49
  /**
42
- * Specifies if the content of the pane contains Splitter.
50
+ * Sets if the pane content contains a nested Splitter.
43
51
  */
44
52
  containsSplitter: boolean;
45
53
  /**
46
- * Specifies if the children of the pane should be mounted when it's in collapsed state.
54
+ * Sets if the pane keeps its content mounted when the pane is collapsed.
47
55
  */
48
56
  keepMounted?: boolean;
49
57
  /**
50
- * The slot template for the content of the splitter
58
+ * Sets the slot template for the content of the pane.
51
59
  */
52
60
  content?: any;
53
61
  }
@@ -8,8 +8,18 @@
8
8
  import { PropType } from 'vue';
9
9
  import { StackLayoutAlign } from './StackLayoutProps';
10
10
  /**
11
- * Represents the [Kendo UI for Vue StackLayout component]({% slug overview_stacklayout %}).
12
- * Arranges its inner elements horizontally, or vertically in a stack. Nesting stack layouts is supported to build more complex layouts.
11
+ * Represents the [KendoVue StackLayout component](slug:overview_stacklayout).
12
+ * Use the StackLayout to arrange its inner elements in a horizontal or vertical stack.
13
+ * You can nest StackLayout components to build more complex layouts.
14
+ *
15
+ * @example
16
+ * ```vue
17
+ * <StackLayout :orientation="'vertical'" :gap="16" :align="{ horizontal: 'center', vertical: 'top' }">
18
+ * <div>Pending orders</div>
19
+ * <div>Shipped orders</div>
20
+ * <div>Delivered orders</div>
21
+ * </StackLayout>
22
+ * ```
13
23
  */
14
24
  declare const StackLayout: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
15
25
  id: PropType<string>;
@@ -6,37 +6,40 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Represents the props of the [Kendo UI for Vue StackLayout component]({% slug overview_stacklayout %}).
9
+ * Represents the props of the [Kendo UI for Vue StackLayout component](slug:overview_stacklayout).
10
10
  */
11
11
  export interface StackLayoutProps {
12
12
  /**
13
- * Sets the `id` property of the root StackLayout element.
13
+ * Sets the `id` attribute of the root StackLayout element.
14
14
  */
15
15
  id?: string;
16
16
  /**
17
- * Specifies the gap between the inner elements ([see example]({% slug layout_stacklayout_gaps %})).
17
+ * Sets the gap between the inner elements ([see example](slug:layout_stacklayout_gaps)).
18
+ * A `number` value sets the gap in pixels. A `string` value accepts any CSS length, such as `'1rem'`.
18
19
  */
19
20
  gap?: number | string;
20
21
  /**
21
- * Specifies the orientation of the StackLayout.
22
- * ([see example]({% slug layout_stacklayout_orientation %})).
22
+ * Sets the orientation of the StackLayout
23
+ * ([see example](slug:layout_stacklayout_orientation)).
23
24
  *
24
- * The possible values are:
25
- * * (Default)`horizontal`
25
+ * The supported values are:
26
+ * * `horizontal`
26
27
  * * `vertical`
28
+ *
29
+ * @default `horizontal`
27
30
  */
28
31
  orientation?: StackLayoutOrientation | string;
29
32
  /**
30
- * Specifies the horizontal and vertical alignment of the inner StackLayout elements.
31
- * Demo ([here]({% slug layout_stacklayout_alignment %}#toc-horizontal-alignment)) and ([here]({% slug layout_stacklayout_alignment %}#toc-vertical-alignment)).
33
+ * Sets the horizontal and vertical alignment of the inner StackLayout elements.
34
+ * Demo ([here](slug:layout_stacklayout_alignment#toc-horizontal-alignment)) and ([here](slug:layout_stacklayout_alignment#toc-vertical-alignment)).
32
35
  *
33
- * The possible keys are:
34
- * * `horizontal`&mdash;Defines the possible horizontal alignment of the inner StackLayout elements.
36
+ * The supported keys are:
37
+ * * `horizontal`&mdash;Sets the horizontal alignment of the inner StackLayout elements.
35
38
  * * `start`&mdash;Uses the start point of the container.
36
39
  * * `center`&mdash;Uses the central point of the container.
37
40
  * * `end`&mdash;Uses the end point of the container.
38
41
  * * (Default)`stretch`&mdash;Stretches the items to fill the width of the container.
39
- * * `vertical`&mdash;Defines the possible vertical alignment of the inner StackLayout elements.
42
+ * * `vertical`&mdash;Sets the vertical alignment of the inner StackLayout elements.
40
43
  * * `top`&mdash;Uses the top point of the container.
41
44
  * * `middle`&mdash;Uses the middle point of the container.
42
45
  * * `bottom`&mdash;Uses the bottom point of the container.
@@ -45,23 +48,22 @@ export interface StackLayoutProps {
45
48
  align?: StackLayoutAlign;
46
49
  }
47
50
  /**
48
- * Specifies the orientation of the StackLayout ([see example]({% slug layout_stacklayout_orientation %})).
51
+ * Sets the orientation of the StackLayout ([see example](slug:layout_stacklayout_orientation)).
49
52
  *
50
- * The possible values are:
53
+ * The supported values are:
51
54
  * * (Default)`horizontal`
52
55
  * * `vertical`
53
- *
54
56
  */
55
57
  export type StackLayoutOrientation = 'horizontal' | 'vertical';
56
58
  /**
57
- * Specifies the horizontal and vertical alignment of the inner StackLayout elements.
59
+ * Sets the horizontal and vertical alignment of the inner StackLayout elements.
58
60
  */
59
61
  export interface StackLayoutAlign {
60
62
  /**
61
- * Defines the possible horizontal alignment of the inner StackLayout elements
62
- * ([see example]({% slug layout_stacklayout_alignment %}#toc-horizontal-alignment)).
63
+ * Sets the horizontal alignment of the inner StackLayout elements
64
+ * ([see example](slug:layout_stacklayout_alignment#toc-horizontal-alignment)).
63
65
  *
64
- * The available values are:
66
+ * The supported values are:
65
67
  * - `start`&mdash;Uses the start point of the container.
66
68
  * - `center`&mdash;Uses the center point of the container.
67
69
  * - `end`&mdash;Uses the end point of the container.
@@ -69,10 +71,10 @@ export interface StackLayoutAlign {
69
71
  */
70
72
  horizontal?: 'start' | 'center' | 'end' | 'stretch';
71
73
  /**
72
- * Defines the possible vertical alignment of the inner StackLayout elements
73
- * ([see example]({% slug layout_stacklayout_alignment %}#toc-vertical-alignment)).
74
+ * Sets the vertical alignment of the inner StackLayout elements
75
+ * ([see example](slug:layout_stacklayout_alignment#toc-vertical-alignment)).
74
76
  *
75
- * The available values are:
77
+ * The supported values are:
76
78
  * - `top`&mdash;Uses the top point of the container.
77
79
  * - `middle`&mdash;Uses the middle point of the container.
78
80
  * - `bottom`&mdash;Uses the bottom point of the container.
package/stepper/Step.d.ts CHANGED
@@ -14,17 +14,18 @@ export interface StepComputed {
14
14
  itemStyles: object;
15
15
  }
16
16
  /**
17
- * Represents the [Kendo UI for Vue Step component]({% slug overview_stepper %}).
17
+ * Represents the [KendoVue Step component](slug:overview_stepper).
18
+ * Accepts properties of type [StepProps](slug:api_layout_stepprops).
18
19
  *
19
- * ```jsx
20
- * <Step v-bind="props" @change="(e) => props.onChange(e)">
21
- * <span class="k-step-indicator" aria-hidden="true">
22
- * <span class="emoji">{{ props.emoji }}</span>
23
- * </span>
24
- * <span class="k-step-label">
25
- * <span class="k-step-text">{{ props.label }}</span>
26
- * </span>
27
- * </Step>
20
+ * @example
21
+ * ```vue
22
+ * <Stepper :value="value" :items="steps" :item="'CustomStep'" @change="onChange">
23
+ * <template v-slot:CustomStep="{ props }">
24
+ * <Step v-bind="props">
25
+ * <span class="k-step-label">{{ props.label }}</span>
26
+ * </Step>
27
+ * </template>
28
+ * </Stepper>
28
29
  * ```
29
30
  */
30
31
  declare const Step: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
@@ -65,6 +66,9 @@ declare const Step: import('vue').DefineComponent<import('vue').ExtractPropTypes
65
66
  itemStyles(): StepComputed['itemStyles'];
66
67
  }, {
67
68
  getStepIndicatorContent(label: string, icon: string, svgIcon: any, text: string, index: number, isValid: boolean | undefined, validationIcons: any): any;
69
+ /**
70
+ * Moves the focus to the first focusable element in the Step.
71
+ */
68
72
  focus(): void;
69
73
  handleClick(event: any): void;
70
74
  handleFocus(event: any): void;
@@ -104,17 +108,18 @@ declare const Step: import('vue').DefineComponent<import('vue').ExtractPropTypes
104
108
  isValid: boolean;
105
109
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
106
110
  /**
107
- * Represents the [Kendo UI for Vue Step component]({% slug overview_stepper %}).
111
+ * Represents the [KendoVue Step component](slug:overview_stepper).
112
+ * Accepts properties of type [StepProps](slug:api_layout_stepprops).
108
113
  *
109
- * ```jsx
110
- * <Step v-bind="props" @change="(e) => props.onChange(e)">
111
- * <span class="k-step-indicator" aria-hidden="true">
112
- * <span class="emoji">{{ props.emoji }}</span>
113
- * </span>
114
- * <span class="k-step-label">
115
- * <span class="k-step-text">{{ props.label }}</span>
116
- * </span>
117
- * </Step>
114
+ * @example
115
+ * ```vue
116
+ * <Stepper :value="value" :items="steps" :item="'CustomStep'" @change="onChange">
117
+ * <template v-slot:CustomStep="{ props }">
118
+ * <Step v-bind="props">
119
+ * <span class="k-step-label">{{ props.label }}</span>
120
+ * </Step>
121
+ * </template>
122
+ * </Stepper>
118
123
  * ```
119
124
  */
120
125
  export { Step };
package/stepper/Step.mjs CHANGED
@@ -168,6 +168,9 @@ const Y = /* @__PURE__ */ E({
168
168
  class: "k-step-indicator-text"
169
169
  }, [o || s + 1]);
170
170
  },
171
+ /**
172
+ * Moves the focus to the first focusable element in the Step.
173
+ */
171
174
  focus() {
172
175
  this.$el && D(this.$el);
173
176
  },