@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,15 +7,15 @@
7
7
  */
8
8
  import { PropType } from 'vue';
9
9
  /**
10
- * The props that are passed to the TabStripNavigation by the TabStrip.
10
+ * Represents the props that the TabStrip passes to the TabStripNavigation.
11
11
  */
12
12
  export interface TabStripNavigationProps {
13
13
  /**
14
- * The tabs collection.
14
+ * Sets the collection of tabs.
15
15
  */
16
16
  tabs?: Array<any>;
17
17
  /**
18
- * Sets the index of the selected tab. Controlled by the TabStrip component.
18
+ * Sets the index of the selected tab. The TabStrip controls this value.
19
19
  */
20
20
  selected?: number;
21
21
  /**
@@ -42,7 +42,7 @@ export interface TabStripNavigationProps {
42
42
  tabAlignment?: string;
43
43
  }
44
44
  /**
45
- * The props that are passed to the TabStripNavigation by the TabStrip.
45
+ * Represents the emits of the TabStripNavigation.
46
46
  */
47
47
  export interface TabStripNavigationEmits {
48
48
  /**
@@ -7,31 +7,36 @@
7
7
  */
8
8
  import { PropType } from 'vue';
9
9
  /**
10
- * The props that are passed by the TabStripNavigation to the TabStripNavigationItem.
10
+ * Represents the props that the TabStripNavigation passes to the TabStripNavigationItem.
11
11
  */
12
12
  export interface TabStripNavigationItemProps {
13
13
  /**
14
- * Defines whether the current TabStripNavigationItem is selected.
14
+ * Sets if the TabStripNavigationItem is selected.
15
+ *
16
+ * @remarks
17
+ * This property is related to accessibility.
15
18
  */
16
19
  active?: boolean;
17
20
  /**
18
- * Defines whether the TabStripNavigationItem is disabled.
21
+ * Sets if the TabStripNavigationItem is disabled.
19
22
  */
20
23
  disabled?: boolean;
21
24
  /**
22
- * Sets the index of the TabStripNavigationItem that is used to identify it.
25
+ * Sets the index of the TabStripNavigationItem. The TabStrip uses it to identify the item.
23
26
  */
24
27
  index: number;
25
28
  /**
26
- * Sets the id of the TabStripNavigationItem.
29
+ * Sets the `id` attribute of the TabStripNavigationItem.
27
30
  */
28
31
  id?: any;
29
32
  /**
30
33
  * Sets the title of the TabStripNavigationItem.
34
+ *
35
+ * @default `Untitled`
31
36
  */
32
37
  title?: any;
33
38
  /**
34
- * Defines the custom rendering of the title. Accepts a Vue component, a `render` function, or a slot name.
39
+ * Sets a custom rendering of the title. Accepts a Vue component, a `render` function, or a slot name.
35
40
  */
36
41
  titleRender?: any;
37
42
  /**
@@ -44,7 +49,7 @@ export interface TabStripNavigationItemProps {
44
49
  last?: boolean;
45
50
  }
46
51
  /**
47
- * The emits that are triggered by the TabStripNavigation to the TabStripNavigationItem.
52
+ * Represents the emits of the TabStripNavigationItem.
48
53
  */
49
54
  export interface TabStripNavigationItemEmits {
50
55
  /**
@@ -6,13 +6,37 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  import { PropType } from 'vue';
9
+ /**
10
+ * Represents a tab object that you pass to the `tabs` property of the TabStrip.
11
+ */
9
12
  export interface TabStripTabProperties {
13
+ /**
14
+ * Sets if the tab is disabled.
15
+ */
10
16
  disabled?: boolean;
17
+ /**
18
+ * Sets the `id` HTML attribute of the tab element.
19
+ */
11
20
  id?: string;
21
+ /**
22
+ * Sets the unique identifier of the tab that the TabStrip uses internally.
23
+ */
12
24
  tabId?: string;
25
+ /**
26
+ * Sets the title of the tab.
27
+ */
13
28
  title?: string;
29
+ /**
30
+ * Sets a custom template for the tab title. Accepts a Vue component, a `render` function, or a slot name.
31
+ */
14
32
  titleRender?: any;
33
+ /**
34
+ * Sets the content of the tab. Accepts a Vue component, a `render` function, or a slot name.
35
+ */
15
36
  content?: any;
37
+ /**
38
+ * Sets the CSS class names of the tab content.
39
+ */
16
40
  contentClassName?: string;
17
41
  }
18
42
  /**
@@ -20,23 +44,23 @@ export interface TabStripTabProperties {
20
44
  */
21
45
  export interface TabStripTabProps {
22
46
  /**
23
- * Defines whether a tab is disabled ([see example]({% slug tabs_tabstrip %}#toc-disabled-state)).
47
+ * Sets if the tab is disabled ([see example](slug:tabs_tabstrip#toc-disabled-state)).
24
48
  */
25
49
  disabled?: boolean;
26
50
  /**
27
- * Sets the title of the tab ([see example]({% slug tabs_tabstrip %}#toc-titles)).
51
+ * Sets the title of the tab ([see example](slug:tabs_tabstrip#toc-titles)).
28
52
  */
29
53
  title?: any;
30
54
  /**
31
- * Sets the id of the tab (li element).
55
+ * Sets the `id` HTML attribute of the tab (`li` element).
32
56
  */
33
57
  id?: string;
34
58
  /**
35
- * Defines the custom rendering of the title. Accepts a Vue component, a `render` function, or a slot name.
59
+ * Sets a custom template for the tab title. Accepts a Vue component, a `render` function, or a slot name.
36
60
  */
37
61
  titleRender?: ((h: any, defaultRendering: any | null, props: any, listeners: any) => any) | any;
38
62
  /**
39
- * Specifies the CSS class names of the TabStripTab content.
63
+ * Sets the CSS class names of the tab content.
40
64
  */
41
65
  contentClassName?: string;
42
66
  }
@@ -7,72 +7,107 @@
7
7
  */
8
8
  import { TileLayoutGap, TileLayoutItem, TilePosition, TileLayoutRepositionEvent, TileLayoutAutoFlow } from './interfaces/main';
9
9
  /**
10
- * Represents the properties of [TileLayout](% slug overview_tilelayout %) component.
10
+ * Represents the props of the [Kendo UI for Vue TileLayout component](slug:overview_tilelayout).
11
11
  */
12
12
  export interface TileLayoutProps {
13
13
  /**
14
- * Sets the `id` property of the root element.
14
+ * Sets the `id` attribute of the root TileLayout element.
15
15
  */
16
16
  id?: string;
17
17
  /**
18
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
18
+ * Sets the `dir` HTML attribute of the TileLayout. Use it to switch between LTR and RTL.
19
19
  */
20
20
  dir?: string;
21
21
  /**
22
- * Specifies the gaps between the tiles ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
22
+ * Sets the gaps between the tiles ([see example](slug:overview_tilelayout#toc-tilelayout-configuration-options)).
23
23
  *
24
- * * The possible keys are:
24
+ * The supported keys are:
25
25
  * * `rows`
26
26
  * * `columns`
27
27
  */
28
28
  gap?: TileLayoutGap;
29
29
  /**
30
- * Specifies the default number of columns ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
30
+ * Sets the number of columns ([see example](slug:overview_tilelayout#toc-tilelayout-configuration-options)).
31
+ *
32
+ * @default `3`
31
33
  */
32
34
  columns?: number;
33
35
  /**
34
- * Specifies the default width of the columns ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
36
+ * Sets the width of the columns ([see example](slug:overview_tilelayout#toc-tilelayout-configuration-options)).
37
+ * A `number` value sets the width in pixels. A `string` value accepts any CSS grid track size, such as `'1fr'`.
38
+ *
39
+ * @default `1fr`
35
40
  */
36
41
  columnWidth?: number | string;
37
42
  /**
38
- * Specifies the default height of the rows ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
43
+ * Sets the height of the rows ([see example](slug:overview_tilelayout#toc-tilelayout-configuration-options)).
44
+ * A `number` value sets the height in pixels. A `string` value accepts any CSS grid track size, such as `'1fr'`.
45
+ *
46
+ * @default `1fr`
39
47
  */
40
48
  rowHeight?: number | string;
41
49
  /**
42
- * Represents the `key` field of the TileLayout item. Used for setting unique keys to the TileLayout items.
50
+ * Sets the field of the TileLayout item that holds its unique key.
51
+ * The TileLayout uses this value as the `key` of each tile.
43
52
  */
44
53
  dataItemKey?: string;
45
54
  /**
46
- * The collection of items that will be rendered in the TileLayout
47
- * ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
55
+ * Sets the collection of items that the TileLayout renders
56
+ * ([see example](slug:overview_tilelayout#toc-tilelayout-configuration-options)).
48
57
  */
49
58
  items?: TileLayoutItem[];
50
59
  /**
51
- * The list of tiles' positions which are used when the TileLayout is in controlled mode
52
- * ([see example]({% slug tiles_position_dimensions_tilelayout %}#toc-controlling-the-position)).
60
+ * Sets the positions of the tiles when you use the TileLayout in controlled mode
61
+ * ([see example](slug:tiles_position_dimensions_tilelayout#toc-controlling-the-position)).
53
62
  */
54
63
  positions?: TilePosition[];
55
64
  /**
56
- * Fires when the user repositions the tile by either dragging or resizing
57
- * ([see example]({% slug tiles_position_dimensions_tilelayout %}#toc-controlling-the-position)).
65
+ * Fires when the user moves a tile by dragging or resizing it
66
+ * ([see example](slug:tiles_position_dimensions_tilelayout#toc-controlling-the-position)).
58
67
  */
59
68
  onReposition?: (event: TileLayoutRepositionEvent) => void;
60
69
  /**
61
- * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items get flowed into the TileLayout.
62
- * For further reference, check [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
63
- * Defaults to `column`
64
- * ([see example]({% slug autoflows_tilelayout %})).
70
+ * Controls how the auto-placement algorithm places items in the TileLayout
71
+ * ([see example](slug:autoflows_tilelayout)).
72
+ * For more information, see the [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
73
+ *
74
+ * The supported values are:
75
+ * * `column`
76
+ * * `row`
77
+ * * `column dense`
78
+ * * `row dense`
79
+ * * `unset`
80
+ *
81
+ * @default `column`
65
82
  */
66
83
  autoFlow?: TileLayoutAutoFlow | String;
67
84
  /**
68
- * Use this callback to prevent or allow dragging of the tiles based on specific dom event.
69
- * Setting `:ignoreDrag="$event => !$event.target.closest('.k-card-title')"` will make only the headers draggable.
70
- * Setting `:ignoreDrag="$event => $event.target.nodeName == 'INPUT'"` will ignore dragging input elements.
85
+ * Sets a callback that decides if the user can drag a tile, based on the DOM event.
86
+ * Return `true` to ignore the drag.
87
+ * For example, `:ignoreDrag="$event => !$event.target.closest('.k-card-title')"` lets you drag the tiles only by their headers.
88
+ * `:ignoreDrag="$event => $event.target.nodeName == 'INPUT'"` ignores the drag when it starts from an input element.
71
89
  */
72
90
  ignoreDrag?: (event: any) => boolean;
73
91
  }
74
92
  /**
75
- * @hidden
93
+ * Represents the [KendoVue TileLayout component](slug:overview_tilelayout).
94
+ * Use the TileLayout to arrange tiles in a grid that the user can reorder and resize.
95
+ *
96
+ * @example
97
+ * ```vue
98
+ * <TileLayout
99
+ * :columns="3"
100
+ * :row-height="150"
101
+ * :gap="{ rows: 10, columns: 10 }"
102
+ * :auto-flow="'row dense'"
103
+ * :data-item-key="'id'"
104
+ * :items="[
105
+ * { id: 'revenue', headerText: 'Revenue', bodyText: '$48,200', defaultPosition: { col: 1, colSpan: 2 } },
106
+ * { id: 'orders', headerText: 'Orders', bodyText: '1,240', defaultPosition: { col: 3 } }
107
+ * ]"
108
+ * @reposition="onReposition"
109
+ * />
110
+ * ```
76
111
  */
77
112
  declare const TileLayout: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
78
113
  id: StringConstructor;
@@ -102,6 +137,9 @@ declare const TileLayout: import('vue').DefineComponent<import('vue').ExtractPro
102
137
  'k-pos-relative': boolean;
103
138
  };
104
139
  }, {
140
+ /**
141
+ * Moves the focus to the root TileLayout element.
142
+ */
105
143
  focus(): void;
106
144
  updateHandle(index: number, dOrder: number, dCol: number, dRowSpan: number, dColSpan: number, isResized: boolean): void;
107
145
  }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
@@ -151,6 +151,9 @@ const j = {
151
151
  }, this), a]);
152
152
  },
153
153
  methods: {
154
+ /**
155
+ * Moves the focus to the root TileLayout element.
156
+ */
154
157
  focus() {
155
158
  this.$el && this.$el.focus();
156
159
  },
@@ -6,200 +6,236 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The interface for describing items that can be passed to the `items` property of the TileLayout component.
9
+ * Describes an item that you pass to the `items` property of the TileLayout.
10
10
  */
11
11
  export interface TileLayoutItem {
12
12
  /**
13
- * The position which is used when the TileLayout is in uncontrolled mode
14
- * ([see example]({% slug tiles_position_dimensions_tilelayout %})).
13
+ * Sets the position of the tile when you use the TileLayout in uncontrolled mode
14
+ * ([see example](slug:tiles_position_dimensions_tilelayout)).
15
15
  */
16
16
  defaultPosition?: TilePosition;
17
17
  /**
18
- * Sets additional styles to the TileLayoutItem.
18
+ * Sets additional CSS styles to the tile.
19
19
  */
20
20
  style?: object;
21
21
  /**
22
- * Sets additional classes to the TileLayoutItem.
22
+ * Sets additional CSS classes to the tile.
23
23
  */
24
24
  class?: string;
25
25
  /**
26
- * The tile object.
26
+ * Sets the tile object.
27
27
  */
28
28
  tile?: object;
29
29
  /**
30
- * Sets additional CSS styles to the TileLayoutItem hint element.
30
+ * Sets additional CSS styles to the hint element of the tile.
31
31
  */
32
32
  hintStyle?: object;
33
33
  /**
34
- * Sets additional classes to the TileLayoutItem hint element.
34
+ * Sets additional CSS classes to the hint element of the tile.
35
35
  */
36
36
  hintClass?: string;
37
37
  /**
38
- * Sets the title in the TileLayoutItem's header content
39
- * ([see example]({% slug tiles_position_dimensions_tilelayout %})).
38
+ * Sets a custom template for the header of the tile
39
+ * ([see example](slug:tiles_position_dimensions_tilelayout)).
40
+ * The template receives the `tile`, `index`, `id`, and `headerText` values.
40
41
  */
41
42
  header?: any;
42
43
  /**
43
- * Sets the title in the TileLayoutItem's header text
44
- * ([see example]({% slug tiles_position_dimensions_tilelayout %})).
44
+ * Sets the text in the header of the tile
45
+ * ([see example](slug:tiles_position_dimensions_tilelayout)).
46
+ * The tile uses this text as its accessible description.
47
+ *
48
+ * @remarks
49
+ * This property is related to accessibility.
45
50
  */
46
51
  headerText?: string;
47
52
  /**
48
- * Sets the content in TileLayoutItem's body content
49
- * ([see example]({% slug tiles_position_dimensions_tilelayout %})).
53
+ * Sets a custom template for the body of the tile
54
+ * ([see example](slug:tiles_position_dimensions_tilelayout)).
55
+ * The template receives the `tile`, `index`, and `bodyText` values.
50
56
  */
51
57
  body?: any;
52
58
  /**
53
- * Sets the content in TileLayoutItem's body text
54
- * ([see example]({% slug tiles_position_dimensions_tilelayout %})).
59
+ * Sets the text in the body of the tile
60
+ * ([see example](slug:tiles_position_dimensions_tilelayout)).
55
61
  */
56
62
  bodyText?: string;
57
63
  /**
58
- * Overrides the default rendering of the TileLayoutItem
59
- * ([see example]({% slug tiles_custom_rendering_tilelayout %})).
64
+ * Sets a custom template that replaces the default rendering of the tile
65
+ * ([see example](slug:tiles_custom_rendering_tilelayout)).
66
+ * The template receives the `tile` and `index` values.
60
67
  */
61
68
  item?: any;
62
69
  /**
63
- * Specifies the id of each Tile if needed to be user-defined. By default the id is automatically generated.
70
+ * Sets a custom `id` for the header title of the tile. The tile references this `id` in its `aria-describedby` attribute.
71
+ * If you do not set `id`, the TileLayout generates one.
72
+ *
73
+ * @remarks
74
+ * This property is related to accessibility.
64
75
  */
65
76
  id?: any;
66
77
  /**
67
- * Specifies if the user is allowed to resize the TileLayoutItem and in which direction
68
- * ([see example]({% slug tiles_resizing_tilelayout %})).
69
- * If `resizable` is not specified, the resizing of the TileLayoutItem will be enabled for both directions.
78
+ * Sets if the user can resize the tile and in which direction
79
+ * ([see example](slug:tiles_resizing_tilelayout)).
80
+ *
81
+ * The supported values are:
82
+ * * `true`&mdash;The user can resize the tile in both directions.
83
+ * * `false`&mdash;The user cannot resize the tile.
84
+ * * `horizontal`&mdash;The user can resize the tile only horizontally.
85
+ * * `vertical`&mdash;The user can resize the tile only vertically.
86
+ *
87
+ * @default `true`
70
88
  */
71
89
  resizable?: TileResizeMode | string | boolean;
72
90
  /**
73
- * Specifies if the user is allowed to reorder the TileLayoutItem by dragging and dropping it
74
- * ([see example]({% slug tiles_reordering_tilelayout %})).
75
- * If `reorderable` is not specified, the dragging functionality of the TileLayoutItem will be enabled.
91
+ * Sets if the user can reorder the tile by dragging and dropping it
92
+ * ([see example](slug:tiles_reordering_tilelayout)).
93
+ *
94
+ * @default `true`
76
95
  */
77
96
  reorderable?: boolean;
78
97
  /**
79
- * Specifies if the tabIndex of each TileLayout tile if the scenario requires it. Defaults to `0`.
98
+ * Sets the `tabIndex` of the tile.
99
+ *
100
+ * @default `0`
101
+ *
102
+ * @remarks
103
+ * This property is related to accessibility.
80
104
  */
81
105
  tabIndex?: number;
82
106
  }
83
107
  /**
84
- * Specifies the position of each tile.
108
+ * Sets the position of a tile.
85
109
  */
86
110
  export interface TilePosition {
87
111
  /**
88
- * Defines the order index of the TileLayoutItem.
89
- * If not set, items will receive a sequential order.
112
+ * Sets the order index of the tile.
113
+ * If you do not set `order`, the tiles get a sequential order.
90
114
  */
91
115
  order?: number;
92
116
  /**
93
- * (Required) Defines on which column-line the TileLayoutItem will start.
94
- * It is required in order reordering and resizing functionalities to work as expected as they rely on it.
117
+ * (Required) Sets the column line where the tile starts.
118
+ * The reordering and resizing features need this value to work as expected.
95
119
  */
96
120
  col: number;
97
121
  /**
98
- * Specifies how many columns will the TileLayoutItem spans.
99
- * Defaults to `1`.
122
+ * Sets the number of columns that the tile spans.
123
+ *
124
+ * @default `1`
100
125
  */
101
126
  colSpan?: number;
102
127
  /**
103
- * Defines on which row-line the TileLayoutItem will start.
128
+ * Sets the row line where the tile starts.
104
129
  */
105
130
  row?: number;
106
131
  /**
107
- * Specifies how many rows will the TileLayoutItem spans.
108
- * Defaults to `1`.
132
+ * Sets the number of rows that the tile spans.
133
+ *
134
+ * @default `1`
109
135
  */
110
136
  rowSpan?: number;
111
137
  }
112
138
  /**
113
- * Specifies the strict position of each tile.
114
- * Used in the [TileLayoutRepositionEvent]({% slug api_layout_tilelayoutrepositionevent %}).
139
+ * Represents the strict position of a tile.
140
+ * The [TileLayoutRepositionEvent](slug:api_layout_tilelayoutrepositionevent) uses it.
115
141
  */
116
142
  export interface TileStrictPosition extends TilePosition {
117
143
  /**
118
- * Defines the order index of the TileLayoutItem.
119
- * If not set, items will receive a sequential order.
144
+ * The order index of the tile.
120
145
  */
121
146
  order: number;
122
147
  /**
123
- * Specifies how many rows will the TileLayoutItem spans.
124
- * Defaults to `1`.
148
+ * The number of rows that the tile spans.
125
149
  */
126
150
  rowSpan: number;
127
151
  /**
128
- * Specifies how many columns will the TileLayoutItem spans.
129
- * Defaults to `1`.
152
+ * The number of columns that the tile spans.
130
153
  */
131
154
  colSpan: number;
132
155
  }
133
156
  /**
134
- * Specifies if the user is allowed to resize the TileLayoutItem and in which direction
135
- * ([see example]({% slug tiles_resizing_tilelayout %})).
136
- * If `resizable` is not specified, the resizing of the TileLayoutItem will be enabled for both directions.
157
+ * Sets if the user can resize the tile and in which direction
158
+ * ([see example](slug:tiles_resizing_tilelayout)).
159
+ *
160
+ * The supported values are:
161
+ * * `true`&mdash;The user can resize the tile in both directions.
162
+ * * `false`&mdash;The user cannot resize the tile.
163
+ * * `horizontal`&mdash;The user can resize the tile only horizontally.
164
+ * * `vertical`&mdash;The user can resize the tile only vertically.
137
165
  */
138
166
  export type TileResizeMode = 'horizontal' | 'vertical' | boolean;
139
167
  /**
140
- * Specifies the gaps between the tiles.
168
+ * Sets the gaps between the tiles.
141
169
  */
142
170
  export interface TileLayoutGap {
143
171
  /**
144
- * The rows gap between tiles.
145
- * Defaults to `16px`.
172
+ * Sets the gap between the rows.
173
+ * A `number` value sets the gap in pixels. A `string` value accepts any CSS length, such as `'1rem'`.
146
174
  */
147
175
  rows?: number | string;
148
176
  /**
149
- * The columns gap between tiles.
150
- * Defaults to `16px`.
177
+ * Sets the gap between the columns.
178
+ * A `number` value sets the gap in pixels. A `string` value accepts any CSS length, such as `'1rem'`.
151
179
  */
152
180
  columns?: number | string;
153
181
  }
154
182
  /**
155
- * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items get flowed into the TileLayout.
156
- * For further reference, check [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
157
- * Defaults to `column`.
183
+ * Controls how the auto-placement algorithm places items in the TileLayout.
184
+ * For more information, see the [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
185
+ *
186
+ * The supported values are:
187
+ * * `column` (default)
188
+ * * `row`
189
+ * * `column dense`
190
+ * * `row dense`
191
+ * * `unset`
158
192
  */
159
193
  export type TileLayoutAutoFlow = 'column' | 'row' | 'column dense' | 'row dense' | 'unset';
160
194
  /**
161
- * The arguments for the `onReposition` TileLayout event.
195
+ * Represents the arguments of the `onReposition` TileLayout event.
162
196
  */
163
197
  export interface TileLayoutRepositionEvent {
164
198
  /**
165
- * The new positions of the TileLayout tiles.
199
+ * The new positions of the tiles.
166
200
  */
167
201
  value: Array<TileStrictPosition>;
168
202
  /**
169
- * The index of the currently moved tile.
203
+ * The index of the tile that the user moves.
170
204
  */
171
205
  index: number;
172
206
  /**
173
- * Returns 0 if the row is not changed, 1 if the item is dragged to the next row
174
- * and -1 if the item is drag to the previous row.
207
+ * Shows how the row of the tile changes.
208
+ * The value is `0` if the row does not change, `1` if the user drags the tile to the next row,
209
+ * and `-1` if the user drags the tile to the previous row.
175
210
  */
176
211
  row: number;
177
212
  /**
178
- * Returns 0 if the column is not changed, 1 if the item is dragged to the next column
179
- * and -1 if the item is drag to the previous column.
213
+ * Shows how the column of the tile changes.
214
+ * The value is `0` if the column does not change, `1` if the user drags the tile to the next column,
215
+ * and `-1` if the user drags the tile to the previous column.
180
216
  */
181
217
  col: number;
182
218
  }
183
219
  /**
184
- * The arguments for the `onTileresize` TileLayout event.
220
+ * Represents the arguments of the `onTileresize` TileLayout event.
185
221
  */
186
222
  export interface TileLayoutTileResizeEvent {
187
223
  /**
188
- * The new resized positions of the TileLayout tiles.
224
+ * The new positions of the tiles after the resize.
189
225
  */
190
226
  value: Array<TileStrictPosition>;
191
227
  /**
192
- * The index of the currently resized tile.
228
+ * The index of the tile that the user resizes.
193
229
  */
194
230
  index: number;
195
231
  /**
196
- * Returns 0 if the rowSpan is not changed, 1 if the rowSpan is increased
197
- * and -1 if the rowSpan is decreased.
232
+ * Shows how the `rowSpan` of the tile changes.
233
+ * The value is `0` if the `rowSpan` does not change, `1` if it increases, and `-1` if it decreases.
198
234
  */
199
235
  rowSpan: number;
200
236
  /**
201
- * Returns 0 if the columnSpan is not changed, 1 if the columnSpan is increased
202
- * and -1 if the columnSpan is decreased.
237
+ * Shows how the `colSpan` of the tile changes.
238
+ * The value is `0` if the `colSpan` does not change, `1` if it increases, and `-1` if it decreases.
203
239
  */
204
240
  colSpan: number;
205
241
  }