@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
@@ -11,24 +11,24 @@ import { BreadcrumbLinkProps } from './BreadcrumbLinkProps';
11
11
  import { BreadcrumbListItemProps } from './BreadcrumbListItemProps';
12
12
  import { BreadcrumbDelimiterProps } from './BreadcrumbDelimiterProps';
13
13
  /**
14
- * Represents the BreadcrumbDataModel object type.
14
+ * Represents the data item of the Breadcrumb.
15
15
  */
16
16
  export interface BreadcrumbDataModel {
17
17
  /**
18
- * Represents the `id` of the dataItems object.
19
- * Used for setting the `key` of the BreadcrumbListItem component and the `id` of the BreadcrumbLink component.
18
+ * Sets the `id` of the data item.
19
+ * The Breadcrumb uses it as the `key` of the BreadcrumbListItem component and the `id` of the BreadcrumbLink component.
20
20
  */
21
21
  id?: string;
22
22
  /**
23
- * Represents the `text` used inside the BreadcrumbLink component.
23
+ * Sets the `text` that the BreadcrumbLink component shows.
24
24
  */
25
25
  text?: string;
26
26
  /**
27
- * Represents the `svgIcon` used inside the BreadcrumbLink component.
27
+ * Sets the `svgIcon` that the BreadcrumbLink component shows.
28
28
  */
29
29
  svgIcon?: VNode;
30
30
  /**
31
- * Represents the `icon` used inside the BreadcrumbLink component.
31
+ * Sets the `icon` that the BreadcrumbLink component shows.
32
32
  */
33
33
  icon?: VNode;
34
34
  /**
@@ -37,45 +37,51 @@ export interface BreadcrumbDataModel {
37
37
  disabled?: boolean;
38
38
  }
39
39
  /**
40
- * Represents the `BreadcrumbLinkMouseEvent`.
40
+ * Represents the arguments of the `select` event of the Breadcrumb.
41
41
  */
42
42
  export interface BreadcrumbLinkMouseEvent {
43
43
  /**
44
- * Represents the `id` of the `BreadcrumbLinkMouseEvent`.
44
+ * The `id` of the selected item.
45
45
  */
46
46
  id?: string;
47
47
  /**
48
- * A Vue native DOM event.
48
+ * The native DOM event.
49
49
  */
50
50
  nativeEvent: any;
51
51
  }
52
+ /**
53
+ * Represents the props of the [Kendo UI for Vue Breadcrumb component](slug:overview_breadcrumb).
54
+ */
52
55
  export interface BreadcrumbProps {
53
56
  /**
54
- * Sets the `id` property of the top `div` element of the Breadcrumb.
57
+ * Sets the `id` attribute of the root `nav` element of the Breadcrumb.
55
58
  */
56
59
  id?: string;
57
60
  /**
58
- * Represents the Breadcrumb ordered list component.
61
+ * Overrides the default component that renders the ordered list of the Breadcrumb.
59
62
  */
60
63
  breadcrumbOrderedList?: Component<BreadcrumbOrderedListProps>;
61
64
  /**
62
- * Represents the Breadcrumb list item component.
65
+ * Overrides the default component that renders each list item of the Breadcrumb.
63
66
  */
64
67
  breadcrumbListItem?: Component<BreadcrumbListItemProps>;
65
68
  /**
66
- * Represents the Breadcrumb delimiter component.
69
+ * Overrides the default component that renders the delimiter between the items
70
+ * ([see example](slug:delimiter_breadcrumb)).
67
71
  */
68
72
  breadcrumbDelimiter?: Component<BreadcrumbDelimiterProps>;
69
73
  /**
70
- * Represents the Breadcrumb link component.
74
+ * Overrides the default component that renders each link of the Breadcrumb.
71
75
  */
72
76
  breadcrumbLink?: Component<BreadcrumbLinkProps>;
73
77
  /**
74
- * Represents the dataItems of the Breadcrumb from type BreadcrumbDataModel.
78
+ * Sets the data items of the Breadcrumb. Each item is a `BreadcrumbDataModel` object.
79
+ *
80
+ * @default `[]`
75
81
  */
76
82
  dataItems: BreadcrumbDataModel[];
77
83
  /**
78
- * Specifies the padding of all Breadcrumb elements.
84
+ * Sets the padding of all Breadcrumb elements.
79
85
  *
80
86
  * The possible values are:
81
87
  * * `small`
@@ -86,53 +92,72 @@ export interface BreadcrumbProps {
86
92
  */
87
93
  size?: 'small' | 'medium' | 'large';
88
94
  /**
89
- * The Breadcrumb direction `ltr` or `rtl`.
95
+ * Sets the direction of the Breadcrumb. The supported values are `ltr` and `rtl`.
90
96
  */
91
97
  dir?: 'ltr' | 'rtl';
92
98
  /**
93
- * Sets the `tabIndex` attribute to the Breadcrumb.
99
+ * Sets the `tabIndex` attribute of the Breadcrumb.
100
+ *
101
+ * @remarks
102
+ * This property is related to accessibility.
94
103
  */
95
104
  tabIndex?: number;
96
105
  /**
97
- * Sets the Collapse mode of the Breadcrumb.
106
+ * Sets the collapse mode of the Breadcrumb.
98
107
  * The available values are:
99
- * - `auto`(default)&mdash;Items are automatically collapsed based on the width of the Breadcrumb. First and last item always remain visible.
100
- * - `wrap`&mdash;Items are wrapped on multiple rows when their total width is bigger than the width of the BreadCrumb.
101
- * - `none`&mdash;All items are expanded on the same row. This scenario is useful when the Breadcrumb needs to be scrolled.
108
+ * - `auto`&mdash;Collapses the items based on the width of the Breadcrumb. The first and the last items always stay visible.
109
+ * - `wrap`&mdash;Wraps the items on multiple rows when their total width is bigger than the width of the Breadcrumb.
110
+ * - `none`&mdash;Shows all items on the same row. Use it when you want to scroll the Breadcrumb.
111
+ *
112
+ * For more information and examples, see the [Collapse Modes](slug:collapse_modes_breadcrumb) article.
102
113
  *
103
- * For more information and example refer to the [Collapse Modes]({% slug collapse_modes_breadcrumb %}) article.
114
+ * @default `auto`
104
115
  */
105
116
  collapseMode?: 'auto' | 'wrap' | 'none';
106
117
  /**
107
- * Determines the `disabled` mode of the Breadcrumb. If `true`, the component is disabled.
118
+ * Disables the Breadcrumb when set to `true`.
108
119
  */
109
120
  disabled?: boolean;
110
121
  /**
111
- * Represents the `value` field. Used for setting the key of the BreadcrumbListItem component and the `id` of the BreadcrumbLink component.
122
+ * Sets the name of the field that holds the item `id`.
123
+ * The Breadcrumb uses it as the `key` of the BreadcrumbListItem component and the `id` of the BreadcrumbLink component.
124
+ *
125
+ * @default `id`
112
126
  */
113
127
  valueField?: string;
114
128
  /**
115
- * Represents the `text` field. Used for setting the `text` inside the BreadcrumbLink component.
129
+ * Sets the name of the field that holds the `text` of the BreadcrumbLink component.
130
+ *
131
+ * @default `text`
116
132
  */
117
133
  textField?: string;
118
134
  /**
119
- * Represents the `svgIcon` field. Used for setting the `svgIcon` inside the BreadcrumbLink component.
135
+ * Sets the name of the field that holds the `svgIcon` of the BreadcrumbLink component.
136
+ *
137
+ * @default `svgIcon`
120
138
  */
121
139
  svgIconField?: string;
122
140
  /**
123
- * Represents the `icon` field. Used for setting the `icon` inside the BreadcrumbLink component.
141
+ * Sets the name of the field that holds the `icon` of the BreadcrumbLink component.
142
+ *
143
+ * @default `icon`
124
144
  */
125
145
  iconField?: string;
126
146
  /**
127
- * Represents the `onSelect` event. Triggered after click on the Breadcrumb.
147
+ * Fires when the user selects a Breadcrumb item.
128
148
  */
129
149
  onSelect?: (event: BreadcrumbLinkMouseEvent) => void;
130
150
  /**
131
- * Triggered on onKeydown event.
151
+ * Fires when the user presses a key on a Breadcrumb item.
132
152
  */
133
153
  onKeydown?: (event: any) => void;
134
154
  /**
135
- * Represents the label of the Breadcrumb component.
155
+ * Sets the accessible name of the Breadcrumb.
156
+ *
157
+ * @default `Breadcrumb`
158
+ *
159
+ * @remarks
160
+ * This property is related to accessibility.
136
161
  */
137
162
  ariaLabel?: string;
138
163
  }
package/card/Avatar.d.ts CHANGED
@@ -16,7 +16,13 @@ export interface AvatarComputed {
16
16
  innerClass: object;
17
17
  }
18
18
  /**
19
- * @hidden
19
+ * Represents the [KendoVue Avatar component](slug:overview_avatar).
20
+ * Use the Avatar to show an image, initials, or an icon for a person or an item.
21
+ *
22
+ * @example
23
+ * ```vue
24
+ * <Avatar :type="'text'" :theme-color="'primary'" :rounded="'full'">JD</Avatar>
25
+ * ```
20
26
  */
21
27
  declare const Avatar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
22
28
  type: {
package/card/Card.d.ts CHANGED
@@ -15,7 +15,24 @@ export interface CardComputed {
15
15
  wrapperClass: object;
16
16
  }
17
17
  /**
18
- * @hidden
18
+ * Represents the [KendoVue Card component](slug:overview_card).
19
+ * Use the Card to group related content and actions in one container.
20
+ *
21
+ * @example
22
+ * ```vue
23
+ * <Card :type="'info'" :orientation="'vertical'">
24
+ * <CardHeader>
25
+ * <CardTitle>Order shipped</CardTitle>
26
+ * </CardHeader>
27
+ * <CardBody>Your order is on its way.</CardBody>
28
+ * <CardActions :layout="'end'">
29
+ * <Button>Track order</Button>
30
+ * </CardActions>
31
+ * </Card>
32
+ * ```
33
+ *
34
+ * @remarks
35
+ * Supported children components are: {@link CardHeader}, {@link CardBody}, {@link CardActions}, {@link CardImage}, {@link CardFooter}.
19
36
  */
20
37
  declare const Card: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
21
38
  dir: PropType<string>;
@@ -15,7 +15,16 @@ export interface CardActionsComputed {
15
15
  wrapperClass: object;
16
16
  }
17
17
  /**
18
- * @hidden
18
+ * Represents the [KendoVue CardActions component](slug:actions_card).
19
+ * Use the CardActions to show action buttons inside the Card.
20
+ *
21
+ * @example
22
+ * ```vue
23
+ * <CardActions :layout="'stretched'" :orientation="'horizontal'">
24
+ * <Button>Approve</Button>
25
+ * <Button>Decline</Button>
26
+ * </CardActions>
27
+ * ```
19
28
  */
20
29
  declare const CardActions: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
21
30
  layout: {
@@ -6,7 +6,19 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * @hidden
9
+ * Represents the KendoVue CardBody component.
10
+ * Use the CardBody to show the main content of the Card.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <CardBody>
15
+ * <CardTitle>Payment received</CardTitle>
16
+ * <p>The payment for invoice #1024 is complete.</p>
17
+ * </CardBody>
18
+ * ```
19
+ *
20
+ * @remarks
21
+ * Supported children components are: {@link CardTitle}, {@link CardSubtitle}.
10
22
  */
11
23
  declare const CardBody: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
12
24
  export { CardBody };
@@ -6,7 +6,13 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * @hidden
9
+ * Represents the KendoVue CardFooter component.
10
+ * Use the CardFooter to show content at the bottom of the Card.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <CardFooter>Last updated 5 minutes ago</CardFooter>
15
+ * ```
10
16
  */
11
17
  declare const CardFooter: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
12
18
  export { CardFooter };
@@ -6,7 +6,19 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * @hidden
9
+ * Represents the KendoVue CardHeader component.
10
+ * Use the CardHeader to show the title and subtitle at the top of the Card.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <CardHeader>
15
+ * <CardTitle>Invoice #1024</CardTitle>
16
+ * <CardSubtitle>Due on May 5</CardSubtitle>
17
+ * </CardHeader>
18
+ * ```
19
+ *
20
+ * @remarks
21
+ * Supported children components are: {@link CardTitle}, {@link CardSubtitle}.
10
22
  */
11
23
  declare const CardHeader: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
12
24
  export { CardHeader };
@@ -7,7 +7,13 @@
7
7
  */
8
8
  import { PropType } from 'vue';
9
9
  /**
10
- * @hidden
10
+ * Represents the KendoVue CardImage component.
11
+ * Use the CardImage to show an image inside the Card.
12
+ *
13
+ * @example
14
+ * ```vue
15
+ * <CardImage :src="productImageUrl" />
16
+ * ```
11
17
  */
12
18
  declare const CardImage: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
13
19
  src: PropType<string>;
@@ -6,7 +6,13 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * @hidden
9
+ * Represents the KendoVue CardSubtitle component.
10
+ * Use the CardSubtitle to show extra text under the title of the Card.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <CardSubtitle>Due on May 5</CardSubtitle>
15
+ * ```
10
16
  */
11
17
  declare const CardSubtitle: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
12
18
  export { CardSubtitle };
@@ -6,7 +6,13 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * @hidden
9
+ * Represents the KendoVue CardTitle component.
10
+ * Use the CardTitle to show the main title of the Card.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <CardTitle>Invoice #1024</CardTitle>
15
+ * ```
10
16
  */
11
17
  declare const CardTitle: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
12
18
  export { CardTitle };
@@ -6,14 +6,16 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  import { avatarShape, avatarType } from './Enums';
9
+ /**
10
+ * Represents the props of the [Kendo UI for Vue Avatar component](slug:overview_avatar).
11
+ */
9
12
  export interface AvatarProps {
10
13
  /**
11
- * Specifies the appearance fill style of the Avatar.
14
+ * Sets the fill style of the Avatar.
12
15
  *
13
16
  * The possible values are:
14
17
  * * `solid` (Default)
15
18
  * * `outline`
16
- *
17
19
  */
18
20
  fillMode?: null | 'solid' | 'outline' | string;
19
21
  /**
@@ -21,21 +23,20 @@ export interface AvatarProps {
21
23
  */
22
24
  shape?: avatarShape | string;
23
25
  /**
24
- * Specifies the size of the Avatar
26
+ * Sets the size of the Avatar.
25
27
  *
26
28
  * The possible values are:
27
29
  * * `small`
28
30
  * * `medium` (Default)
29
31
  * * `large`
30
- *
31
32
  */
32
33
  size?: null | 'small' | 'medium' | 'large';
33
34
  /**
34
- * Sets a border to the Avatar.
35
+ * When set to `true`, shows a border around the Avatar.
35
36
  */
36
37
  border?: boolean;
37
38
  /**
38
- * Configures the `roundness` of the Avatar.
39
+ * Sets the `roundness` of the Avatar.
39
40
  *
40
41
  * The available options are:
41
42
  * - small
@@ -48,16 +49,18 @@ export interface AvatarProps {
48
49
  */
49
50
  rounded?: null | 'small' | 'medium' | 'large' | 'full' | string;
50
51
  /**
51
- * Set the type of the Avatar.
52
+ * Sets the type of content that the Avatar shows.
52
53
  *
53
54
  * The supported values are:
54
55
  * * `image`
55
56
  * * `text`
56
57
  * * `icon`
58
+ *
59
+ * @default `text`
57
60
  */
58
61
  type?: avatarType | string;
59
62
  /**
60
- * Configures the `themeColor` of the Avatar.
63
+ * Sets the `themeColor` of the Avatar.
61
64
  *
62
65
  * The available options are:
63
66
  * - base
@@ -6,24 +6,30 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  import { cardActionsLayout, cardOrientation } from './Enums';
9
+ /**
10
+ * Represents the props of the Kendo UI for Vue CardActions component.
11
+ */
9
12
  export interface CardActionsProps {
10
13
  /**
11
- * Set the layout of the actions.
14
+ * Sets how the CardActions aligns the action buttons.
12
15
  *
13
16
  * The supported values are:
14
17
  * * (Default) `start`
15
18
  * * `center`
16
19
  * * `end`
17
20
  * * `stretched`
21
+ *
22
+ * @default `start`
18
23
  */
19
24
  layout?: cardActionsLayout | string;
20
25
  /**
21
- * Specifies the orientation of the Card action buttons.
26
+ * Sets the orientation of the Card action buttons.
22
27
  *
23
- * * The possible values are:
28
+ * The supported values are:
24
29
  * * (Default) `horizontal`
25
30
  * * `vertical`
26
31
  *
32
+ * @default `horizontal`
27
33
  */
28
34
  orientation?: cardOrientation | string;
29
35
  }
@@ -5,5 +5,8 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
+ /**
9
+ * Represents the props of the Kendo UI for Vue CardBody component.
10
+ */
8
11
  export interface CardBodyProps {
9
12
  }
@@ -5,5 +5,8 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
+ /**
9
+ * Represents the props of the Kendo UI for Vue CardFooter component.
10
+ */
8
11
  export interface CardFooterProps {
9
12
  }
@@ -5,5 +5,8 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
+ /**
9
+ * Represents the props of the Kendo UI for Vue CardHeader component.
10
+ */
8
11
  export interface CardHeaderProps {
9
12
  }
@@ -5,9 +5,12 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
+ /**
9
+ * Represents the props of the Kendo UI for Vue CardImage component.
10
+ */
8
11
  export interface CardImageProps {
9
12
  /**
10
- * Set the source of the image.
13
+ * Sets the URL of the image that the CardImage shows.
11
14
  */
12
15
  src?: string;
13
16
  }
@@ -6,13 +6,17 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  import { cardType, cardOrientation } from './Enums';
9
+ /**
10
+ * Represents the props of the [Kendo UI for Vue Card component](slug:overview_card).
11
+ */
9
12
  export interface CardProps {
10
13
  /**
11
- * Sets the [dir](https://www.w3schools.com/tags/att_global_dir.asp) of the Card.
14
+ * Sets the [dir](https://www.w3schools.com/tags/att_global_dir.asp) attribute of the Card.
15
+ * Use `rtl` to show the content from right to left.
12
16
  */
13
17
  dir?: string;
14
18
  /**
15
- * Set the type of the Card.
19
+ * Sets the type of the Card. The type changes the colors of the Card.
16
20
  *
17
21
  * The supported values are:
18
22
  * * `default`
@@ -21,14 +25,18 @@ export interface CardProps {
21
25
  * * `success`
22
26
  * * `warning`
23
27
  * * `error`
28
+ *
29
+ * @default `default`
24
30
  */
25
31
  type?: cardType | string;
26
32
  /**
27
- * Set the orientation of the Card.
33
+ * Sets the orientation of the Card.
28
34
  *
29
35
  * The supported values are:
30
- * * `horizontal` - Default
36
+ * * `horizontal`
31
37
  * * `vertical`
38
+ *
39
+ * @default `vertical`
32
40
  */
33
41
  orientation?: cardOrientation | string;
34
42
  }
@@ -5,5 +5,8 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
+ /**
9
+ * Represents the props of the Kendo UI for Vue CardSubtitle component.
10
+ */
8
11
  export interface CardSubtitleProps {
9
12
  }
@@ -5,5 +5,8 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
+ /**
9
+ * Represents the props of the Kendo UI for Vue CardTitle component.
10
+ */
8
11
  export interface CardTitleProps {
9
12
  }
@@ -14,26 +14,83 @@ export declare enum avatarShape {
14
14
  ROUNDED = "rounded",
15
15
  RECTANGLE = "rectangle"
16
16
  }
17
+ /**
18
+ * Lists the content types of the Avatar.
19
+ */
17
20
  export declare enum avatarType {
21
+ /**
22
+ * Shows text, such as initials.
23
+ */
18
24
  TEXT = "text",
25
+ /**
26
+ * Shows an image.
27
+ */
19
28
  IMAGE = "image",
29
+ /**
30
+ * Shows an icon.
31
+ */
20
32
  ICON = "icon"
21
33
  }
34
+ /**
35
+ * Lists the orientations of the Card and the CardActions.
36
+ */
22
37
  export declare enum cardOrientation {
38
+ /**
39
+ * Arranges the content in a row.
40
+ */
23
41
  HORIZONTAL = "horizontal",
42
+ /**
43
+ * Arranges the content in a column.
44
+ */
24
45
  VERTICAL = "vertical"
25
46
  }
47
+ /**
48
+ * Lists the types of the Card. Each type sets different colors.
49
+ */
26
50
  export declare enum cardType {
51
+ /**
52
+ * Sets the default colors.
53
+ */
27
54
  DEFAULT = "default",
55
+ /**
56
+ * Sets the primary colors.
57
+ */
28
58
  primary = "primary",
59
+ /**
60
+ * Sets the info colors.
61
+ */
29
62
  INFO = "info",
63
+ /**
64
+ * Sets the success colors.
65
+ */
30
66
  SUCCESS = "success",
67
+ /**
68
+ * Sets the warning colors.
69
+ */
31
70
  WARNING = "warning",
71
+ /**
72
+ * Sets the error colors.
73
+ */
32
74
  ERROR = "error"
33
75
  }
76
+ /**
77
+ * Lists the layouts of the action buttons in the CardActions.
78
+ */
34
79
  export declare enum cardActionsLayout {
80
+ /**
81
+ * Aligns the buttons to the start.
82
+ */
35
83
  START = "start",
84
+ /**
85
+ * Aligns the buttons to the center.
86
+ */
36
87
  CENTER = "center",
88
+ /**
89
+ * Aligns the buttons to the end.
90
+ */
37
91
  END = "end",
92
+ /**
93
+ * Stretches the buttons to fill the available space.
94
+ */
38
95
  STRETCHED = "stretched"
39
96
  }