@progress/kendo-vue-layout 11.0.0 → 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 (104) hide show
  1. package/actionsheet/ActionSheet.d.ts +67 -23
  2. package/actionsheet/interfaces/ActionSheetContentProps.d.ts +2 -2
  3. package/actionsheet/interfaces/ActionSheetFooterProps.d.ts +2 -2
  4. package/actionsheet/interfaces/ActionSheetHeaderProps.d.ts +3 -3
  5. package/actionsheet/interfaces/ActionSheetItemProps.d.ts +24 -14
  6. package/appbar/AppBar.d.ts +21 -1
  7. package/appbar/AppBar.mjs +3 -0
  8. package/appbar/AppBarSection.d.ts +12 -1
  9. package/appbar/AppBarSection.mjs +3 -0
  10. package/appbar/AppBarSpacer.d.ts +10 -1
  11. package/appbar/AppBarSpacer.mjs +3 -0
  12. package/appbar/interfaces/AppBarProps.d.ts +31 -29
  13. package/appbar/interfaces/AppBarSectionProps.d.ts +1 -1
  14. package/appbar/interfaces/AppBarSpacerProps.d.ts +5 -2
  15. package/bottomnavigation/BottomNavigation.d.ts +23 -1
  16. package/bottomnavigation/BottomNavigation.mjs +3 -0
  17. package/bottomnavigation/BottomNavigationItemProps.d.ts +20 -9
  18. package/bottomnavigation/BottomNavigationProps.d.ts +73 -63
  19. package/bottomnavigation/models/events.d.ts +3 -3
  20. package/breadcrumb/Breadcrumb.d.ts +17 -1
  21. package/breadcrumb/BreadcrumbDelimiter.d.ts +8 -1
  22. package/breadcrumb/BreadcrumbLink.d.ts +17 -1
  23. package/breadcrumb/BreadcrumbLink.mjs +3 -0
  24. package/breadcrumb/interfaces/BreadcrumbDelimiterProps.d.ts +6 -3
  25. package/breadcrumb/interfaces/BreadcrumbLinkProps.d.ts +20 -11
  26. package/breadcrumb/interfaces/BreadcrumbOrderedListProps.d.ts +1 -1
  27. package/breadcrumb/interfaces/BreadcrumbProps.d.ts +56 -31
  28. package/card/Avatar.d.ts +7 -1
  29. package/card/Card.d.ts +18 -1
  30. package/card/CardActions.d.ts +10 -1
  31. package/card/CardBody.d.ts +13 -1
  32. package/card/CardFooter.d.ts +7 -1
  33. package/card/CardHeader.d.ts +13 -1
  34. package/card/CardImage.d.ts +7 -1
  35. package/card/CardSubtitle.d.ts +7 -1
  36. package/card/CardTitle.d.ts +7 -1
  37. package/card/interfaces/AvatarProps.d.ts +11 -8
  38. package/card/interfaces/CardActionsProps.d.ts +9 -3
  39. package/card/interfaces/CardBodyProps.d.ts +3 -0
  40. package/card/interfaces/CardFooterProps.d.ts +3 -0
  41. package/card/interfaces/CardHeaderProps.d.ts +3 -0
  42. package/card/interfaces/CardImageProps.d.ts +4 -1
  43. package/card/interfaces/CardProps.d.ts +12 -4
  44. package/card/interfaces/CardSubtitleProps.d.ts +3 -0
  45. package/card/interfaces/CardTitleProps.d.ts +3 -0
  46. package/card/interfaces/Enums.d.ts +57 -0
  47. package/contextmenu/ContextMenu.d.ts +23 -3
  48. package/dist/cdn/js/kendo-vue-layout.js +1 -1
  49. package/drawer/Drawer.d.ts +25 -1
  50. package/drawer/Drawer.mjs +3 -0
  51. package/drawer/DrawerContent.d.ts +1 -1
  52. package/drawer/DrawerItem.d.ts +1 -1
  53. package/drawer/interfaces/DrawerAnimation.d.ts +3 -3
  54. package/drawer/interfaces/DrawerContentProps.d.ts +1 -1
  55. package/drawer/interfaces/DrawerItemHandle.d.ts +3 -3
  56. package/drawer/interfaces/DrawerItemProps.d.ts +28 -12
  57. package/drawer/interfaces/DrawerProps.d.ts +49 -29
  58. package/drawer/interfaces/DrawerSelectEvent.d.ts +2 -2
  59. package/expansionpanel/ExpansionPanel.d.ts +16 -1
  60. package/expansionpanel/interfaces.d.ts +35 -20
  61. package/gridlayout/GridLayout.d.ts +22 -1
  62. package/gridlayout/interfaces/GridLayoutColumnProps.d.ts +4 -3
  63. package/gridlayout/interfaces/GridLayoutItemProps.d.ts +12 -11
  64. package/gridlayout/interfaces/GridLayoutProps.d.ts +23 -21
  65. package/gridlayout/interfaces/GridLayoutRowProps.d.ts +4 -3
  66. package/menu/MenuProps.d.ts +32 -16
  67. package/menu/components/Menu.d.ts +16 -6
  68. package/menu/events.d.ts +2 -2
  69. package/menu/models/BaseMenuItem.d.ts +27 -21
  70. package/menu/models/MenuItemActionsRenderProps.d.ts +2 -2
  71. package/menu/models/MenuItemGroupHeaderRenderProps.d.ts +2 -2
  72. package/menu/models/MenuItemModel.d.ts +2 -2
  73. package/package-metadata.js +1 -1
  74. package/package-metadata.mjs +2 -2
  75. package/package.json +8 -8
  76. package/panelbar/PanelBar.d.ts +30 -2
  77. package/panelbar/interfaces/PanelBarItemProps.d.ts +38 -17
  78. package/panelbar/interfaces/PanelBarProps.d.ts +31 -14
  79. package/panelbar/interfaces/PanelBarSelectEventArguments.d.ts +2 -2
  80. package/splitter/Splitter.d.ts +26 -56
  81. package/splitter/SplitterPane.d.ts +19 -11
  82. package/stacklayout/StackLayout.d.ts +12 -2
  83. package/stacklayout/StackLayoutProps.d.ts +24 -22
  84. package/stepper/Step.d.ts +25 -20
  85. package/stepper/Step.mjs +3 -0
  86. package/stepper/Stepper.d.ts +23 -49
  87. package/stepper/Stepper.mjs +3 -0
  88. package/stepper/interfaces/StepChangeEvent.d.ts +2 -2
  89. package/stepper/interfaces/StepFocusEvent.d.ts +1 -1
  90. package/stepper/interfaces/StepHandle.d.ts +3 -3
  91. package/stepper/interfaces/StepProps.d.ts +37 -24
  92. package/stepper/interfaces/StepperChangeEvent.d.ts +2 -2
  93. package/stepper/interfaces/StepperFocusEvent.d.ts +1 -1
  94. package/stepper/interfaces/StepperHandle.d.ts +3 -3
  95. package/stepper/interfaces/StepperOnNavigateEvent.d.ts +7 -4
  96. package/stepper/interfaces/StepperProps.d.ts +37 -25
  97. package/tabstrip/TabStrip.d.ts +60 -27
  98. package/tabstrip/TabStripContent.d.ts +5 -5
  99. package/tabstrip/TabStripNavigation.d.ts +4 -4
  100. package/tabstrip/TabStripNavigationItem.d.ts +12 -7
  101. package/tabstrip/TabStripTab.d.ts +29 -5
  102. package/tilelayout/TileLayout.d.ts +61 -23
  103. package/tilelayout/TileLayout.mjs +3 -0
  104. package/tilelayout/interfaces/main.d.ts +105 -69
@@ -14,7 +14,28 @@ export interface DrawerComputed {
14
14
  drawerClassNames: object;
15
15
  }
16
16
  /**
17
- * @hidden
17
+ * Represents the [KendoVue Drawer component](slug:overview_drawer).
18
+ * Accepts properties of type [DrawerProps](slug:api_layout_drawerprops).
19
+ *
20
+ * @example
21
+ * ```vue
22
+ * <Drawer
23
+ * :expanded="expanded"
24
+ * :mode="'push'"
25
+ * :position="'start'"
26
+ * :mini="true"
27
+ * :width="240"
28
+ * :items="[
29
+ * { text: 'Dashboard', svgIcon: gridIcon, selected: true },
30
+ * { text: 'Patients', svgIcon: userIcon },
31
+ * { separator: true },
32
+ * { text: 'Appointments', svgIcon: calendarIcon }
33
+ * ]"
34
+ * @select="onSelect"
35
+ * >
36
+ * <DrawerContent>Selected page content</DrawerContent>
37
+ * </Drawer>
38
+ * ```
18
39
  */
19
40
  declare const Drawer: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
20
41
  animation: {
@@ -79,6 +100,9 @@ declare const Drawer: import('vue').DefineComponent<import('vue').ExtractPropTyp
79
100
  }, {
80
101
  drawerClassNames(): DrawerComputed['drawerClassNames'];
81
102
  }, {
103
+ /**
104
+ * Moves the focus to the root element of the Drawer.
105
+ */
82
106
  focus(): void;
83
107
  handleSelect(itemTarget: any, itemIndex: number): void;
84
108
  onOverlayClick(e: any): void;
package/drawer/Drawer.mjs CHANGED
@@ -163,6 +163,9 @@ const N = /* @__PURE__ */ g({
163
163
  }, null), e]);
164
164
  },
165
165
  methods: {
166
+ /**
167
+ * Moves the focus to the root element of the Drawer.
168
+ */
166
169
  focus() {
167
170
  this.$el && this.$el.focus();
168
171
  },
@@ -10,7 +10,7 @@
10
10
  */
11
11
  declare const DrawerContent: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
12
12
  /**
13
- * Represents the [Kendo UI for Vue Drawer component]({% slug overview_drawer %}).
13
+ * Represents the [Kendo UI for Vue Drawer component](slug:overview_drawer).
14
14
  *
15
15
  * ```jsx
16
16
  * <template>
@@ -44,7 +44,7 @@ declare const DrawerItem: import('vue').DefineComponent<import('vue').ExtractPro
44
44
  onClick?: (...args: any) => any;
45
45
  }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
46
46
  /**
47
- * Represents the [Kendo UI for Vue Drawer component]({% slug overview_drawer %}).
47
+ * Represents the [Kendo UI for Vue Drawer component](slug:overview_drawer).
48
48
  *
49
49
  * ```jsx
50
50
  * <Drawer
@@ -6,16 +6,16 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Specifies the animation settings of the Drawer.
9
+ * Represents the animation settings of the Drawer.
10
10
  *
11
11
  */
12
12
  export interface DrawerAnimation {
13
13
  /**
14
- * Specifies the type of the Drawer animation.
14
+ * Sets the type of the Drawer animation. The supported value is `slide`.
15
15
  */
16
16
  type?: 'slide';
17
17
  /**
18
- * Specifies the duration of the Drawer animation ([see example]({% slug display_modes_drawer %}#toc-expand-modes)) .
18
+ * Sets the duration of the Drawer animation in milliseconds ([see example](slug:display_modes_drawer#toc-expand-modes)).
19
19
  */
20
20
  duration: number;
21
21
  }
@@ -6,7 +6,7 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The properties of the [Kendo UI for Vue DrawerContent component]({% slug overview_drawer %}).
9
+ * Represents the props of the [Kendo UI for Vue DrawerContent component](slug:overview_drawer).
10
10
  */
11
11
  export interface DrawerContentProps {
12
12
  }
@@ -6,15 +6,15 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The DrawerItem ref.
9
+ * Represents the ref of a DrawerItem.
10
10
  */
11
11
  export interface DrawerItemHandle {
12
12
  /**
13
- * The DrawerItem element.
13
+ * The DOM element of the DrawerItem.
14
14
  */
15
15
  element: any;
16
16
  /**
17
- * Focus the DrawerItem.
17
+ * Moves the focus to the DrawerItem.
18
18
  */
19
19
  focus: (e: any) => void;
20
20
  /**
@@ -7,45 +7,61 @@
7
7
  */
8
8
  import { SVGIcon } from '@progress/kendo-vue-common';
9
9
  /**
10
- * An interface for the Drawer items.
10
+ * Represents the props of the Drawer items.
11
11
  */
12
12
  export interface DrawerItemProps {
13
13
  /**
14
- * Specifies if the Drawer item is disabled.
14
+ * Sets if the Drawer item is disabled.
15
+ * A disabled item gets the `aria-disabled` attribute.
16
+ *
17
+ * @remarks
18
+ * This property is related to accessibility.
15
19
  */
16
20
  disabled?: boolean;
17
21
  /**
18
- * Defines the name for an existing icon in a Kendo UI for Vue theme.
19
- * The icon is rendered inside the Drawer item by a `span.k-icon` element.
22
+ * Sets the name of an existing icon in a Kendo UI for Vue theme.
23
+ * The Drawer item renders the icon in a `span.k-icon` element.
20
24
  */
21
25
  icon?: string;
22
26
  /**
23
- * Defines an SVGIcon to be rendered within the Drawer item.
27
+ * Sets the SVGIcon that the Drawer item renders.
24
28
  */
25
29
  svgIcon?: SVGIcon;
26
30
  /**
27
- * Specifies if the Drawer item is initially selected.
31
+ * Sets if the Drawer item is selected when the Drawer first renders.
32
+ * A selected item gets the `aria-current` attribute.
33
+ *
34
+ * @remarks
35
+ * This property is related to accessibility.
28
36
  */
29
37
  selected?: boolean;
30
38
  /**
31
- * Specifies if this is a separator item.
39
+ * Sets if the item is a separator.
32
40
  */
33
41
  separator?: boolean;
34
42
  /**
35
- * Specifies the text content of the Drawer item.
43
+ * Sets the text of the Drawer item.
44
+ * The Drawer item also uses this text as its accessible name.
45
+ *
46
+ * @remarks
47
+ * This property is related to accessibility.
36
48
  */
37
49
  text?: string;
38
50
  /**
39
- * Sets the index of the DrawerItem that is used to identify it.
51
+ * Sets the index that identifies the Drawer item.
40
52
  */
41
53
  index?: number;
42
54
  /**
43
- * Sets the `tabIndex` property of the DrawerItem.
44
- * Defaults to `0`.
55
+ * Sets the `tabIndex` attribute of the Drawer item.
56
+ *
57
+ * @default `0`
58
+ *
59
+ * @remarks
60
+ * This property is related to accessibility.
45
61
  */
46
62
  tabIndex?: number;
47
63
  /**
48
- * Sets a custom property. Contained in the DrawerItem props that are returned from the `onSelect` Drawer event.
64
+ * Sets a custom property. The `select` event of the Drawer returns it with the other Drawer item props.
49
65
  */
50
66
  [customProp: string]: any;
51
67
  /**
@@ -9,84 +9,104 @@ import { DrawerSelectEvent } from './DrawerSelectEvent';
9
9
  import { DrawerAnimation } from '../interfaces/DrawerAnimation';
10
10
  import { DrawerItemProps } from './DrawerItemProps';
11
11
  /**
12
- * The properties of the [Kendo UI for Vue Drawer component]({% slug overview_drawer %}).
12
+ * Represents the props of the [Kendo UI for Vue Drawer component](slug:overview_drawer).
13
13
  */
14
14
  export interface DrawerProps {
15
15
  /**
16
- * Specifies the animation settings of the Drawer.
17
- * If boolean enables or disables the default animation.
18
- * Use DrawerAnimation to set slide animation with customizable duration option. Accepts a number in milliseconds.
16
+ * Sets the animation settings of the Drawer.
17
+ * Set a `boolean` value to turn the default animation on or off.
18
+ * Set a `DrawerAnimation` object to use a slide animation with a custom `duration` in milliseconds.
19
+ *
20
+ * @default `true`
19
21
  */
20
22
  animation?: boolean | DrawerAnimation;
21
23
  /**
22
- * Specifies the state of the Drawer. Defaults to `false` ([see example]({% slug expanded_state_drawer %})).
24
+ * Sets if the Drawer is expanded ([see example](slug:expanded_state_drawer)).
25
+ *
26
+ * @default `false`
23
27
  */
24
28
  expanded?: boolean;
25
29
  /**
26
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
30
+ * Sets the `dir` HTML attribute of the Drawer. Use it to switch between LTR and RTL.
31
+ *
32
+ * @default `ltr`
27
33
  */
28
34
  dir?: string;
29
35
  /**
30
- * Specifies the mode in which the Drawer will be displayed.
31
- * The possible values are `overlay` and `push`.
32
- * Defaults to `overlay` ([see example]({% slug display_modes_drawer %}#toc-expand-modes)).
36
+ * Sets the mode in which the Drawer shows ([see example](slug:display_modes_drawer#toc-expand-modes)).
37
+ * The supported values are `overlay` and `push`.
38
+ *
39
+ * @default `overlay`
33
40
  */
34
41
  mode?: 'overlay' | 'push' | string;
35
42
  /**
36
- * Specifies the position of the Drawer.
37
- * The possible values are `start` and `end` ([see example]({% slug positioning_drawer %})).
43
+ * Sets the position of the Drawer ([see example](slug:positioning_drawer)).
44
+ * The supported values are `start` and `end`.
45
+ *
46
+ * @default `start`
38
47
  */
39
48
  position?: 'start' | 'end' | string;
40
49
  /**
41
- * Sets the `tabIndex` property of the Drawer.
50
+ * Sets the `tabIndex` attribute of the Drawer.
51
+ *
52
+ * @remarks
53
+ * This property is related to accessibility.
42
54
  */
43
55
  tabIndex?: number;
44
56
  /**
45
- * Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed
46
- * ([see example]({% slug display_modes_drawer %}#toc-mini-view))).
57
+ * Turns on the mini (compact) view of the Drawer. The Drawer shows the mini view when it is collapsed
58
+ * ([see example](slug:display_modes_drawer#toc-mini-view)).
59
+ *
60
+ * @default `false`
47
61
  */
48
62
  mini?: boolean;
49
63
  /**
50
- * Defines the width of the Drawer when the mini view is enabled and the component is collapsed. Defaults to `50`.
64
+ * Sets the width of the Drawer in pixels when the mini view is on and the Drawer is collapsed.
65
+ *
66
+ * @default `50`
51
67
  */
52
68
  miniWidth?: number;
53
69
  /**
54
- * Defines the width of the Drawer when it is expanded. Defaults to `240`.
70
+ * Sets the width of the Drawer in pixels when it is expanded.
71
+ *
72
+ * @default `240`
55
73
  */
56
74
  width?: number;
57
75
  /**
58
- * The collection of items that will be rendered in the Drawer ([see example]({% slug overview_drawer %})).
76
+ * Sets the collection of items that the Drawer renders ([see example](slug:overview_drawer)).
77
+ *
78
+ * @default `[]`
59
79
  */
60
80
  items?: Array<DrawerItemProps>;
61
81
  /**
62
- * Overrides the default component responsible for visualizing a single item ([see example]({% slug custom_rendering %})).
82
+ * Overrides the default component that renders a single item ([see example](slug:custom_rendering)).
63
83
  *
64
- * The default Component is: [DrawerItem]({% slug api_layout_draweritemprops %}).
84
+ * The default component is: [DrawerItem](slug:api_layout_draweritemprops).
65
85
  */
66
86
  item?: any;
67
87
  /**
68
- * The event handler that will be fired when the overlay is clicked.
69
- * Used in overlay mode only.
88
+ * Fires when the user clicks the overlay.
89
+ * The Drawer fires this event only in `overlay` mode.
70
90
  */
71
91
  onOverlayclick?: (event: any) => void;
72
92
  /**
73
- * Fires when a Drawer item is selected.
93
+ * Fires when the user selects a Drawer item.
74
94
  */
75
95
  onSelect?: (event: DrawerSelectEvent) => void;
76
96
  /**
77
- * Provides the option to define a `header` in the Drawer component ([see example]({% slug custom_rendering %})).
78
- * The header is rendered above the Drawer Items. By default, the property is not defined.
97
+ * Sets a custom `header` for the Drawer ([see example](slug:custom_rendering)).
98
+ * The Drawer renders the header above the items. By default, the Drawer has no header.
79
99
  */
80
100
  navigationHeader?: String | Object | Function;
81
101
  /**
82
- * Provides the option to define a `footer` in the Drawer component ([see example]({% slug custom_rendering %})).
83
- * The footer is rendered below the Drawer Items. By default, the property is not defined.
102
+ * Sets a custom `footer` for the Drawer ([see example](slug:custom_rendering)).
103
+ * The Drawer renders the footer below the items. By default, the Drawer has no footer.
84
104
  */
85
105
  navigationFooter?: String | Object | Function;
86
106
  /**
87
- * Provides the option to define a custom template inside the navigational section of the Drawer component ([see example]({% slug custom_rendering %})).
88
- * When defined, the custom template will override the default [DrawerItem]({% slug api_layout_draweritemprops %}) rendering.
89
- * By default, the property is not defined.
107
+ * Sets a custom template for the navigation part of the Drawer ([see example](slug:custom_rendering)).
108
+ * When you set it, the template replaces the default [DrawerItem](slug:api_layout_draweritemprops) rendering.
109
+ * By default, the Drawer has no custom navigation template.
90
110
  */
91
111
  navigationContent?: String | Object | Function;
92
112
  }
@@ -6,11 +6,11 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The arguments for the `onSelect` Drawer event.
9
+ * Represents the arguments of the `select` event of the Drawer.
10
10
  */
11
11
  export interface DrawerSelectEvent {
12
12
  /**
13
- * A Drawer item event target.
13
+ * The target of the selected Drawer item.
14
14
  */
15
15
  itemTarget: any;
16
16
  /**
@@ -6,7 +6,22 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * @hidden
9
+ * Represents the [KendoVue ExpansionPanel component](slug:overview_expansionpanel).
10
+ * Use the ExpansionPanel to show and hide content in a panel that the user can expand and collapse.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <ExpansionPanel
15
+ * :title="'Shipping address'"
16
+ * :subtitle="'Required'"
17
+ * :expanded="expanded"
18
+ * @action="expanded = !expanded"
19
+ * >
20
+ * <ExpansionPanelContent>
21
+ * <p>221B Baker Street, London</p>
22
+ * </ExpansionPanelContent>
23
+ * </ExpansionPanel>
24
+ * ```
10
25
  */
11
26
  declare const ExpansionPanel: any;
12
27
  export { ExpansionPanel };
@@ -7,25 +7,25 @@
7
7
  */
8
8
  import { SVGIcon } from '@progress/kendo-vue-common';
9
9
  /**
10
- * The ExpansionPanel ref.
10
+ * Represents the ExpansionPanel ref.
11
11
  */
12
12
  export interface ExpansionPanelHandle {
13
13
  /**
14
- * The ExpansionPanel element.
14
+ * The root element of the ExpansionPanel.
15
15
  */
16
16
  element: HTMLDivElement | null;
17
17
  }
18
18
  /**
19
- * The arguments for the `onAction` ExpansionPanel event.
19
+ * Represents the arguments of the `onAction` ExpansionPanel event.
20
20
  */
21
21
  export interface ExpansionPanelActionEvent {
22
22
  /**
23
- * Represents the `expanded` state of the ExpansionPanel.
23
+ * The current `expanded` state of the ExpansionPanel.
24
24
  */
25
25
  expanded: boolean;
26
26
  }
27
27
  /**
28
- * The props of the ExpansionPanel component.
28
+ * Represents the props of the [Kendo UI for Vue ExpansionPanel component](slug:overview_expansionpanel).
29
29
  */
30
30
  export interface ExpansionPanelProps {
31
31
  /**
@@ -33,63 +33,78 @@ export interface ExpansionPanelProps {
33
33
  */
34
34
  class?: string;
35
35
  /**
36
- * Sets the `id` property of the root ExpansionPanel element.
36
+ * Sets the `id` attribute of the root ExpansionPanel element.
37
37
  */
38
38
  id?: string;
39
39
  /**
40
- * Specifies the primary text in the header of the ExpansionPanel.
40
+ * Sets the primary text in the header of the ExpansionPanel.
41
41
  */
42
42
  title?: string;
43
43
  /**
44
- * Specifies the secondary text in the header of the ExpansionPanel, which is rendered next to the collapse/expand icon.
44
+ * Sets the secondary text in the header of the ExpansionPanel. The ExpansionPanel renders it next to the expand and collapse icon.
45
45
  */
46
46
  subtitle?: string;
47
47
  /**
48
- * Specifies the primary text template in the header of the ExpansionPanel.
48
+ * Sets a custom template for the primary text in the header of the ExpansionPanel.
49
49
  */
50
50
  titleRender?: any;
51
51
  /**
52
- * Specifies the secondary text in the header of the ExpansionPanel, which is rendered next to the collapse/expand icon.
52
+ * Sets a custom template for the secondary text in the header of the ExpansionPanel. The ExpansionPanel renders it next to the expand and collapse icon.
53
53
  */
54
54
  subtitleRender?: any;
55
55
  /**
56
- * Sets a custom icon via css class(es), for the expanded state of the ExpansionPanel.
56
+ * Sets a custom font icon for the expanded state of the ExpansionPanel through CSS classes.
57
57
  */
58
58
  expandIcon?: string;
59
59
  /**
60
- * Defines an SVGIcon to be rendered within the expand arrow.
60
+ * Sets an SVG icon for the expanded state of the ExpansionPanel.
61
61
  */
62
62
  expandSvgIcon?: SVGIcon;
63
63
  /**
64
- * Sets a custom icon via css class(es), for the collapsed state of the ExpansionPanel.
64
+ * Sets a custom font icon for the collapsed state of the ExpansionPanel through CSS classes.
65
65
  */
66
66
  collapseIcon?: string;
67
67
  /**
68
- * Defines an SVGIcon to be rendered within the collapse arrow.
68
+ * Sets an SVG icon for the collapsed state of the ExpansionPanel.
69
69
  */
70
70
  collapseSvgIcon?: SVGIcon;
71
71
  /**
72
- * Sets the `dir` property of the ExpansionPanel.
72
+ * Sets the `dir` HTML attribute of the ExpansionPanel. Use it to switch between LTR and RTL.
73
73
  */
74
74
  dir?: string;
75
75
  /**
76
- * Sets the `tabIndex` property of the ExpansionPanel.
76
+ * Sets the `tabIndex` of the ExpansionPanel header.
77
+ *
78
+ * @remarks
79
+ * This property is related to accessibility.
77
80
  */
78
81
  tabIndex?: number;
79
82
  /**
80
- * Sets the `expanded` state of the ExpansionPanel.
83
+ * Sets the expanded state of the ExpansionPanel. The header also uses this value for its `aria-expanded` attribute.
84
+ *
85
+ * @default `false`
86
+ *
87
+ * @remarks
88
+ * This property is related to accessibility.
81
89
  */
82
90
  expanded?: boolean;
83
91
  /**
84
- * Sets the `disabled` state of the ExpansionPanel.
92
+ * Sets the disabled state of the ExpansionPanel. The header also uses this value for its `aria-disabled` attribute.
93
+ *
94
+ * @remarks
95
+ * This property is related to accessibility.
85
96
  */
86
97
  disabled?: boolean;
87
98
  /**
88
- * Sets `aria-controls`. The value should represent the `id` of the controlled content element.
99
+ * Sets the `aria-controls` attribute of the ExpansionPanel header. Set it to the `id` of the content element that the header controls.
100
+ *
101
+ * @remarks
102
+ * This property is related to accessibility.
89
103
  */
90
104
  ariaControls?: string;
91
105
  /**
92
- * The event handler that will be fired when the expanded state of the ExpansionPanel is about to change.
106
+ * Fires when the user clicks the header or presses `Enter` or `Space` on it.
107
+ * Use it to change the `expanded` state of the ExpansionPanel.
93
108
  */
94
109
  onAction?: (event: ExpansionPanelActionEvent) => void;
95
110
  }
@@ -9,7 +9,28 @@ import { GridLayoutAlign } from './interfaces/GridLayoutProps';
9
9
  import { GridLayoutItemProps } from './interfaces/GridLayoutItemProps';
10
10
  import { PropType } from 'vue';
11
11
  /**
12
- * @hidden
12
+ * Represents the [KendoVue GridLayout component](slug:overview_gridlayout).
13
+ * Use the GridLayout to arrange content in rows and columns.
14
+ *
15
+ * @example
16
+ * ```vue
17
+ * <GridLayout
18
+ * :id="'dashboard-layout'"
19
+ * :gap="{ rows: 8, cols: 8 }"
20
+ * :align="{ horizontal: 'stretch', vertical: 'top' }"
21
+ * :rows="[{ height: 60 }, { height: 200 }]"
22
+ * :cols="[{ width: 200 }, { width: '1fr' }]"
23
+ * :items="[
24
+ * { row: 1, col: 1, colSpan: 2, content: 'header' },
25
+ * { row: 2, col: 1, content: 'menu' },
26
+ * { row: 2, col: 2, content: 'orders' }
27
+ * ]"
28
+ * >
29
+ * <template #header>Sales dashboard</template>
30
+ * <template #menu>Menu</template>
31
+ * <template #orders>Recent orders</template>
32
+ * </GridLayout>
33
+ * ```
13
34
  */
14
35
  declare const GridLayout: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
15
36
  id: PropType<string>;
@@ -6,12 +6,13 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Represents the props of the [Kendo UI for Vue GridLayout column]({% slug overview_gridlayout %}).
9
+ * Represents the props of a [Kendo UI for Vue GridLayout column](slug:overview_gridlayout).
10
10
  */
11
11
  export interface GridLayoutColumnProps {
12
12
  /**
13
- * Specifies the width of the GridLayout
14
- * column ([see example]({% slug overview_gridlayout %})).
13
+ * Sets the width of the GridLayout
14
+ * column ([see example](slug:overview_gridlayout)).
15
+ * A `number` value sets the width in pixels. A `string` value accepts any CSS grid track size, such as `'1fr'`.
15
16
  */
16
17
  width?: number | string;
17
18
  }
@@ -6,41 +6,42 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Represents the props of the [Kendo UI for Vue GridLayoutItem component]({% slug overview_gridlayout %}).
9
+ * Represents the props of a [Kendo UI for Vue GridLayout item](slug:overview_gridlayout).
10
10
  */
11
11
  export interface GridLayoutItemProps {
12
12
  /**
13
- * Sets additional CSS classes to the GridLayoutItem.
13
+ * Sets additional CSS classes to the GridLayout item.
14
14
  */
15
15
  class?: string;
16
16
  /**
17
- * Sets additional CSS styles to the GridLayoutItem.
17
+ * Sets additional CSS styles to the GridLayout item.
18
18
  */
19
19
  style?: any;
20
20
  /**
21
- * Sets the `id` property of the root GridLayoutItem element.
21
+ * Sets the `id` attribute of the root GridLayout item element.
22
22
  */
23
23
  id?: string;
24
24
  /**
25
- * Defines the column line from which the element will start ([see example]({% slug items_gridlayout %}#toc-items)).
25
+ * Sets the column line where the item starts ([see example](slug:items_gridlayout#toc-items)).
26
26
  */
27
27
  col?: number;
28
28
  /**
29
- * Specifies the number of columns over which the element will span ([see example]({% slug items_gridlayout %}#toc-items)).
30
- * Defaults to `1`.
29
+ * Sets the number of columns that the item spans ([see example](slug:items_gridlayout#toc-items)).
30
+ * When you do not set it, the item spans one column.
31
31
  */
32
32
  colSpan?: number;
33
33
  /**
34
- * Defines the row line from which the element will start ([see example]({% slug items_gridlayout %}#toc-items)).
34
+ * Sets the row line where the item starts ([see example](slug:items_gridlayout#toc-items)).
35
35
  */
36
36
  row?: number;
37
37
  /**
38
- * Specifies the number of rows over which the element will span ([see example]({% slug items_gridlayout %}#toc-items)).
39
- * Defaults to `1`.
38
+ * Sets the number of rows that the item spans ([see example](slug:items_gridlayout#toc-items)).
39
+ * When you do not set it, the item spans one row.
40
40
  */
41
41
  rowSpan?: number;
42
42
  /**
43
- * Sets the content of the GridLayoutItem.
43
+ * Sets the content of the GridLayout item.
44
+ * Pass the name of a slot, a render function, or a component.
44
45
  */
45
46
  content?: any;
46
47
  }