@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
@@ -6,40 +6,51 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The interface for describing items that can be passed to the `items` property of the BottomNavigation component.
9
+ * Represents an item that you pass to the `items` property of the BottomNavigation.
10
10
  */
11
11
  export interface BottomNavigationItemProps {
12
12
  /**
13
- * Style the BottomNavigation item.
13
+ * Sets the styles of the BottomNavigation item.
14
14
  */
15
15
  style?: object;
16
16
  /**
17
- * Class the BottomNavigation item.
17
+ * Sets the CSS classes of the BottomNavigation item.
18
18
  */
19
19
  class?: string;
20
20
  /**
21
21
  * Disables the BottomNavigation item.
22
+ *
23
+ * @remarks
24
+ * This property is related to accessibility.
22
25
  */
23
26
  disabled?: boolean;
24
27
  /**
25
- * Specifies if the BottomNavigation item is selected.
28
+ * Sets if the BottomNavigation item is selected.
29
+ *
30
+ * @remarks
31
+ * This property is related to accessibility.
26
32
  */
27
33
  selected?: boolean;
28
34
  /**
29
- * Defines the name for an existing icon in a Kendo UI for Vue theme.
30
- * The icon is rendered inside the BottomNavigation item by a `span.k-icon` element.
35
+ * Sets the name of an existing icon in a Kendo UI for Vue theme.
36
+ * The BottomNavigation item renders the icon in a `span.k-icon` element.
31
37
  */
32
38
  icon?: any;
33
39
  /**
34
- * Specifies the text content of the BottomNavigation item.
40
+ * Sets the text of the BottomNavigation item.
35
41
  */
36
42
  text?: any;
37
43
  /**
38
- * Sets the `tabIndex` property of the BottomNavigation item. Defaults to `0`.
44
+ * Sets the `tabIndex` attribute of the BottomNavigation item.
45
+ *
46
+ * @default `0`
47
+ *
48
+ * @remarks
49
+ * This property is related to accessibility.
39
50
  */
40
51
  tabIndex?: number;
41
52
  /**
42
- * Sets a custom property. Contained in the BottomNavItem props that are returned from the `onSelect` BottomNavigation event.
53
+ * Sets a custom property. The `select` event of the BottomNavigation returns it in the item data.
43
54
  */
44
55
  [customProp: string]: any;
45
56
  /**
@@ -8,36 +8,40 @@
8
8
  import { BottomNavigationItemProps } from './BottomNavigationItemProps';
9
9
  import { BottomNavigationEvent, BottomNavigationSelectEvent } from './models/events';
10
10
  /**
11
- * Represents the props of the [Kendo UI for Vue BottomNavigation component]({% slug overview_bottomnavigation %}).
11
+ * Represents the props of the [Kendo UI for Vue BottomNavigation component](slug:overview_bottomnavigation).
12
12
  */
13
13
  export interface BottomNavigationProps {
14
14
  /**
15
- * Sets the `id` property of the root BottomNavigation element.
15
+ * Sets the `id` attribute of the root BottomNavigation element.
16
16
  */
17
17
  id?: string;
18
18
  /**
19
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
19
+ * Sets the `dir` HTML attribute of the BottomNavigation. Use it to switch between LTR and RTL.
20
20
  */
21
21
  dir?: string;
22
22
  /**
23
- * Specifies the theme color of the BottomNavigation
24
- * ([see example]({% slug appearance_bottomnavigation %}#toc-theme-color)).
23
+ * Sets the theme color of the BottomNavigation
24
+ * ([see example](slug:appearance_bottomnavigation#toc-theme-color)).
25
25
  *
26
- * The possible values are:
27
- * * `base` (Default) — Applies base coloring.
28
- * * `primary` — Applies coloring based on the primary theme color.
29
- * * `secondary` — Applies coloring based on the secondary theme color.
30
- * * `tertiary` — Applies coloring based on the tertiary theme color.
31
- * * `inverse` — Applies coloring based on the inverted theme color.
26
+ * The available options are:
27
+ * * `base`—Applies the base coloring.
28
+ * * `primary`—Applies coloring based on the primary theme color.
29
+ * * `secondary`—Applies coloring based on the secondary theme color.
30
+ * * `tertiary`—Applies coloring based on the tertiary theme color.
31
+ * * `inverse`—Applies coloring based on the inverted theme color.
32
+ *
33
+ * @default `base`
32
34
  */
33
35
  themeColor?: BottomNavigationThemeColor | string;
34
36
  /**
35
- * The fill style of the BottomNavigation
36
- * ([see example]({% slug appearance_bottomnavigation %}#toc-fill)).
37
+ * Sets the fill style of the BottomNavigation
38
+ * ([see example](slug:appearance_bottomnavigation#toc-fill)).
39
+ *
40
+ * The available options are:
41
+ * * `flat`—Uses the theme color as the text color. The background is white.
42
+ * * `solid`—Uses the theme color as the background color.
37
43
  *
38
- * The possible values are:
39
- * * `flat`(Default) — Sets the theme color as the text color. The background will be white.
40
- * * `solid` — Sets the theme color as a background color.
44
+ * @default `flat`
41
45
  */
42
46
  fillMode?: BottomNavigationFill | string;
43
47
  /**
@@ -45,27 +49,33 @@ export interface BottomNavigationProps {
45
49
  */
46
50
  fill?: BottomNavigationFill | string;
47
51
  /**
48
- * Specifies the position and behavior of the BottomNavigation when the page is scrolled
49
- * ([see example]({% slug positioning_bottomnavigation %}#toc-position-mode)).
52
+ * Sets the position and behavior of the BottomNavigation when the user scrolls the page
53
+ * ([see example](slug:positioning_bottomnavigation#toc-position-mode)).
54
+ *
55
+ * The available options are:
56
+ * * `fixed`—The BottomNavigation always stays at the bottom of the viewport, no matter where the page is scrolled.
57
+ * * `sticky`—Positions the BottomNavigation based on the scroll position. A sticky element switches between the static
58
+ * and fixed values of the CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, based on the scroll position.
59
+ * It stays static until it reaches a set offset in the viewport. Then it "sticks" in place like the `fixed` mode.
50
60
  *
51
- * The possible values are:
52
- * * `fixed`(Default) — The BottomNavigation always stays at the bottom of the viewport, regardless of the page scroll position.
53
- * * `sticky` — Positions the BottomNavigation based on the user's scroll position. A sticky element toggles between static
54
- * and fixed CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, depending on the scroll position.
55
- * It is positioned static until a given offset position is met in the viewport - then it "sticks" in place like `fixed` positionMode.
61
+ * @default `fixed`
56
62
  */
57
63
  positionMode?: BottomNavigationPositionMode | string;
58
64
  /**
59
- * Specifies how the icon and text label are positioned in each item of the BottomNavigation
60
- * ([see example]({% slug content_types_bottomnavigation %}#toc-item-flow)).
65
+ * Sets how the icon and the text label are positioned in each BottomNavigation item
66
+ * ([see example](slug:content_types_bottomnavigation#toc-item-flow)).
61
67
  *
62
- * The possible values are:
63
- * * `vertical`(Default) — Renders the text below the icon.
64
- * * `horizontal` — Renders the text and the icon on the same line.
68
+ * The available options are:
69
+ * * `vertical`—Renders the text below the icon.
70
+ * * `horizontal`—Renders the text and the icon on the same line.
71
+ *
72
+ * @default `vertical`
65
73
  */
66
74
  itemFlow?: BottomNavigationItemFlow | string;
67
75
  /**
68
- * Sets a border to the BottomNavigation.
76
+ * Shows a border around the BottomNavigation.
77
+ *
78
+ * @default `true`
69
79
  */
70
80
  border?: boolean;
71
81
  /**
@@ -73,72 +83,72 @@ export interface BottomNavigationProps {
73
83
  */
74
84
  disabled?: boolean;
75
85
  /**
76
- * The index of the selected BottomNavigationItem.
86
+ * Sets the index of the selected BottomNavigation item.
77
87
  */
78
88
  selected?: number;
79
89
  /**
80
- * The collection of items that will be rendered in the BottomNavigation ([see example]({% slug overview_bottomnavigation %})).
90
+ * Sets the collection of items that the BottomNavigation renders ([see example](slug:overview_bottomnavigation)).
81
91
  */
82
92
  items?: Array<BottomNavigationItemProps>;
83
93
  /**
84
- * Overrides the default component's content responsible for visualizing a single item
85
- * ([see example]({% slug custom_rendering_bottomnavigation %}#toc-custom-rendering)).
94
+ * Overrides the default content of a single item
95
+ * ([see example](slug:custom_rendering_bottomnavigation#toc-custom-rendering)).
86
96
  */
87
97
  item?: any;
88
98
  /**
89
- * Fires when a BottomNavigation item is about to be rendered
90
- * ([see example]({% slug custom_rendering_bottomnavigation %}#toc-item-render-property)).
91
- * Used to override the default appearance of the items.
99
+ * Sets a custom rendering for the BottomNavigation items
100
+ * ([see example](slug:custom_rendering_bottomnavigation#toc-item-render-property)).
101
+ * Use it to override the default appearance of the items.
92
102
  */
93
103
  itemRender?: any;
94
104
  /**
95
- * Fires when a BottomNavigation item is selected.
105
+ * Fires when the user selects a BottomNavigation item.
96
106
  */
97
107
  onSelect?: (event: BottomNavigationSelectEvent) => void;
98
108
  /**
99
- * Triggered on `onKeyDown` event.
109
+ * Fires when the user presses a key on a BottomNavigation item.
100
110
  */
101
111
  onKeyDown?: (event: BottomNavigationEvent) => void;
102
112
  }
103
113
  /**
104
- * The fill style of the BottomNavigation
105
- * ([see example]({% slug appearance_bottomnavigation %}#toc-fill)).
114
+ * Represents the fill style of the BottomNavigation
115
+ * ([see example](slug:appearance_bottomnavigation#toc-fill)).
106
116
  *
107
- * The possible values are:
108
- * * `flat`(Default) &mdash; Sets the theme color as the text color. The background will be white.
109
- * * `solid` &mdash; Sets the theme color as a background color.
117
+ * The available options are:
118
+ * * `flat`&mdash;Uses the theme color as the text color. The background is white.
119
+ * * `solid`&mdash;Uses the theme color as the background color.
110
120
  *
111
121
  */
112
122
  export type BottomNavigationFill = 'solid' | 'flat';
113
123
  /**
114
- * Specifies how the icon and text label are positioned in each item of the BottomNavigation
115
- * ([see example]({% slug content_types_bottomnavigation %}#toc-item-flow)).
124
+ * Represents how the icon and the text label are positioned in each BottomNavigation item
125
+ * ([see example](slug:content_types_bottomnavigation#toc-item-flow)).
116
126
  *
117
- * The possible values are:
118
- * * `vertical`(Default) &mdash; Renders the text below the icon.
119
- * * `horizontal` &mdash; Renders the text and the icon on the same line.
127
+ * The available options are:
128
+ * * `vertical`&mdash;Renders the text below the icon.
129
+ * * `horizontal`&mdash;Renders the text and the icon on the same line.
120
130
  */
121
131
  export type BottomNavigationItemFlow = 'vertical' | 'horizontal';
122
132
  /**
123
- * Specifies the theme color of the BottomNavigationThemeColor.
124
- * ([see example]({% slug appearance_bottomnavigation %}#toc-theme-color)).
133
+ * Represents the theme color of the BottomNavigation
134
+ * ([see example](slug:appearance_bottomnavigation#toc-theme-color)).
125
135
  *
126
- * The possible values are:
127
- * * `base` (Default) &mdash; Applies base coloring.
128
- * * `primary` &mdash; Applies coloring based on the primary theme color.
129
- * * `secondary` &mdash; Applies coloring based on the secondary theme color.
130
- * * `tertiary` &mdash; Applies coloring based on the tertiary theme color.
131
- * * `inverse` &mdash; Applies coloring based on the inverted theme color.
136
+ * The available options are:
137
+ * * `base`&mdash;Applies the base coloring.
138
+ * * `primary`&mdash;Applies coloring based on the primary theme color.
139
+ * * `secondary`&mdash;Applies coloring based on the secondary theme color.
140
+ * * `tertiary`&mdash;Applies coloring based on the tertiary theme color.
141
+ * * `inverse`&mdash;Applies coloring based on the inverted theme color.
132
142
  */
133
143
  export type BottomNavigationThemeColor = 'base' | 'primary' | 'secondary' | 'tertiary' | 'inverse';
134
144
  /**
135
- * Specifies the position and behavior of the BottomNavigation when the page is scrolled
136
- * ([see example]({% slug positioning_bottomnavigation %}#toc-position-mode)).
145
+ * Represents the position and behavior of the BottomNavigation when the user scrolls the page
146
+ * ([see example](slug:positioning_bottomnavigation#toc-position-mode)).
137
147
  *
138
- * The possible values are:
139
- * * `fixed`(Default) &mdash; The BottomNavigation always stays at the bottom of the viewport, regardless of the page scroll position.
140
- * * `sticky` &mdash; Positions the BottomNavigation based on the user's scroll position. A sticky element toggles between
141
- * static and fixed CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, depending on the scroll position.
142
- * It is positioned static until a given offset position is met in the viewport - then it "sticks" in place like `fixed` positionMode.
148
+ * The available options are:
149
+ * * `fixed`&mdash;The BottomNavigation always stays at the bottom of the viewport, no matter where the page is scrolled.
150
+ * * `sticky`&mdash;Positions the BottomNavigation based on the scroll position. A sticky element switches between the static
151
+ * and fixed values of the CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, based on the scroll position.
152
+ * It stays static until it reaches a set offset in the viewport. Then it "sticks" in place like the `fixed` mode.
143
153
  */
144
154
  export type BottomNavigationPositionMode = 'sticky' | 'fixed';
@@ -6,11 +6,11 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The arguments for the `onSelect` BottomNavigation event.
9
+ * Represents the arguments of the `select` event of the BottomNavigation.
10
10
  */
11
11
  export interface BottomNavigationSelectEvent {
12
12
  /**
13
- * A BottomNavigation item event target.
13
+ * The data of the selected BottomNavigation item.
14
14
  */
15
15
  itemTarget: any;
16
16
  /**
@@ -19,7 +19,7 @@ export interface BottomNavigationSelectEvent {
19
19
  itemIndex: number;
20
20
  }
21
21
  /**
22
- * Represents the return type of the BottomNavigation events.
22
+ * Represents the arguments of the BottomNavigation events.
23
23
  */
24
24
  export interface BottomNavigationEvent {
25
25
  }
@@ -15,7 +15,23 @@ export interface BreadcrumbComputed {
15
15
  itemClasses: object;
16
16
  }
17
17
  /**
18
- * Represents the Breadcrumb component.
18
+ * Represents the [KendoVue Breadcrumb component](slug:overview_breadcrumb).
19
+ * Accepts properties of type [BreadcrumbProps](slug:api_layout_breadcrumbprops).
20
+ *
21
+ * @example
22
+ * ```vue
23
+ * <Breadcrumb
24
+ * :data-items="[
25
+ * { id: 'home', text: 'Home' },
26
+ * { id: 'electronics', text: 'Electronics' },
27
+ * { id: 'laptops', text: 'Laptops' }
28
+ * ]"
29
+ * :collapse-mode="'auto'"
30
+ * :size="'medium'"
31
+ * :aria-label="'Product categories'"
32
+ * @select="onSelect"
33
+ * />
34
+ * ```
19
35
  */
20
36
  declare const Breadcrumb: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
21
37
  id: PropType<string>;
@@ -7,7 +7,14 @@
7
7
  */
8
8
  import { PropType } from 'vue';
9
9
  /**
10
- * Represents the BreadcrumbDelimiter component.
10
+ * Represents the KendoVue BreadcrumbDelimiter component. The [Breadcrumb](slug:overview_breadcrumb) renders it between the items
11
+ * ([see example](slug:delimiter_breadcrumb)).
12
+ * Accepts properties of type [BreadcrumbDelimiterProps](slug:api_layout_breadcrumbdelimiterprops).
13
+ *
14
+ * @example
15
+ * ```vue
16
+ * <BreadcrumbDelimiter :id="'delimiter-1'" :tab-index="-1" />
17
+ * ```
11
18
  */
12
19
  declare const BreadcrumbDelimiter: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
13
20
  id: PropType<string>;
@@ -14,7 +14,20 @@ export interface BreadcrumbLinkComputed {
14
14
  itemClasses: object;
15
15
  }
16
16
  /**
17
- * Represents the BreadcrumbLink component.
17
+ * Represents the KendoVue BreadcrumbLink component. The [Breadcrumb](slug:overview_breadcrumb) renders it for each item.
18
+ * Accepts properties of type [BreadcrumbLinkProps](slug:api_layout_breadcrumblinkprops).
19
+ *
20
+ * @example
21
+ * ```vue
22
+ * <BreadcrumbLink
23
+ * :id="'laptops'"
24
+ * :text="'Laptops'"
25
+ * :tab-index="0"
26
+ * :disabled="false"
27
+ * :aria-current="true"
28
+ * @select="onSelect"
29
+ * />
30
+ * ```
18
31
  */
19
32
  declare const BreadcrumbLink: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
20
33
  id: PropType<string>;
@@ -37,6 +50,9 @@ declare const BreadcrumbLink: import('vue').DefineComponent<import('vue').Extrac
37
50
  }, {}, {
38
51
  itemClasses(): BreadcrumbLinkComputed['itemClasses'];
39
52
  }, {
53
+ /**
54
+ * Moves the focus to the BreadcrumbLink element.
55
+ */
40
56
  focus(): void;
41
57
  handleSelect(event: any): void;
42
58
  handleKeyDown(event: any): void;
@@ -83,6 +83,9 @@ const f = /* @__PURE__ */ l({
83
83
  }, [s])]);
84
84
  },
85
85
  methods: {
86
+ /**
87
+ * Moves the focus to the BreadcrumbLink element.
88
+ */
86
89
  focus() {
87
90
  this.$el && this.$el.focus();
88
91
  },
@@ -6,15 +6,18 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Represents the properties of BreadcrumbDelimiter component.
9
+ * Represents the props of the KendoVue BreadcrumbDelimiter component.
10
10
  */
11
11
  export interface BreadcrumbDelimiterProps {
12
12
  /**
13
- * Sets the `id` property of the BreadcrumbDelimiter component.
13
+ * Sets the `id` attribute of the BreadcrumbDelimiter element.
14
14
  */
15
15
  id?: string;
16
16
  /**
17
- * Sets the `tabIndex` attribute to the BreadcrumbDelimiter.
17
+ * Sets the `tabIndex` attribute of the BreadcrumbDelimiter.
18
+ *
19
+ * @remarks
20
+ * This property is related to accessibility.
18
21
  */
19
22
  tabIndex?: number;
20
23
  /**
@@ -7,47 +7,56 @@
7
7
  */
8
8
  import { VNode } from 'vue';
9
9
  /**
10
- * Represents the properties of BreadcrumbLink component.
10
+ * Represents the props of the KendoVue BreadcrumbLink component.
11
11
  */
12
12
  export interface BreadcrumbLinkProps {
13
13
  /**
14
- * Sets the `id` property of the top `div` element of the BreadcrumbLink.
14
+ * Sets the `id` attribute of the BreadcrumbLink element.
15
15
  */
16
16
  id?: string;
17
17
  /**
18
- * Sets the `tabIndex` attribute to the BreadcrumbLink.
18
+ * Sets the `tabIndex` attribute of the BreadcrumbLink.
19
+ *
20
+ * @remarks
21
+ * This property is related to accessibility.
19
22
  */
20
23
  tabIndex?: number;
21
24
  /**
22
- * The Breadcrumb direction `ltr` or `rtl`.
25
+ * Sets the direction of the BreadcrumbLink. The supported values are `ltr` and `rtl`.
23
26
  */
24
27
  dir?: string;
25
28
  /**
26
- * Determines the `disabled` mode of the BreadcrumbLink. If `true`, the component is disabled.
29
+ * Disables the BreadcrumbLink when set to `true`.
30
+ *
31
+ * @remarks
32
+ * This property is related to accessibility.
27
33
  */
28
34
  disabled?: boolean;
29
35
  /**
30
- * Represents the `text` of the BreadcrumbLink component.
36
+ * Sets the `text` of the BreadcrumbLink.
31
37
  */
32
38
  text?: string;
33
39
  /**
34
- * Represents the `svgIcon` of the BreadcrumbLink component.
40
+ * Sets the `svgIcon` of the BreadcrumbLink.
35
41
  */
36
42
  svgIcon?: VNode;
37
43
  /**
38
- * Represents the `icon` of the BreadcrumbLink component.
44
+ * Sets the `icon` of the BreadcrumbLink.
39
45
  */
40
46
  icon?: VNode;
41
47
  /**
42
- * Represents the `onSelect` event. Triggered after click on the BreadcrumbLink item.
48
+ * Fires when the user clicks the BreadcrumbLink.
43
49
  */
44
50
  onSelect?: (event: any) => void;
45
51
  /**
46
- * Represents the `onKeydown` event. Triggered after key down on the BreadcrumbLink item.
52
+ * Fires when the user presses a key on the BreadcrumbLink.
47
53
  */
48
54
  onKeydown?: (event: any) => void;
49
55
  /**
50
- * Sets the `aria-current` value.
56
+ * Sets the `aria-current` attribute of the BreadcrumbLink.
57
+ *
58
+ * @remarks
59
+ * This property is related to accessibility.
51
60
  */
52
61
  ariaCurrent?: boolean;
53
62
  /**
@@ -28,7 +28,7 @@ export interface BreadcrumbOrderedListProps {
28
28
  * - `wrap`&mdash;Items are wrapped on multiple rows when their total width is bigger than the width of the BreadCrumb.
29
29
  * - `none`&mdash;All items are expanded on the same row. This scenario is useful when the Breadcrumb needs to be scrolled.
30
30
  *
31
- * For more information and example refer to the [Collapse Modes]({% slug collapse_modes_breadcrumb %}) article.
31
+ * For more information and example refer to the [Collapse Modes](slug:collapse_modes_breadcrumb) article.
32
32
  */
33
33
  collapseMode?: 'auto' | 'wrap' | 'none';
34
34
  /**