@progress/kendo-vue-layout 11.0.0 → 11.1.0-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.
- package/actionsheet/ActionSheet.d.ts +67 -23
- package/actionsheet/interfaces/ActionSheetContentProps.d.ts +2 -2
- package/actionsheet/interfaces/ActionSheetFooterProps.d.ts +2 -2
- package/actionsheet/interfaces/ActionSheetHeaderProps.d.ts +3 -3
- package/actionsheet/interfaces/ActionSheetItemProps.d.ts +24 -14
- package/appbar/AppBar.d.ts +21 -1
- package/appbar/AppBar.mjs +3 -0
- package/appbar/AppBarSection.d.ts +12 -1
- package/appbar/AppBarSection.mjs +3 -0
- package/appbar/AppBarSpacer.d.ts +10 -1
- package/appbar/AppBarSpacer.mjs +3 -0
- package/appbar/interfaces/AppBarProps.d.ts +31 -29
- package/appbar/interfaces/AppBarSectionProps.d.ts +1 -1
- package/appbar/interfaces/AppBarSpacerProps.d.ts +5 -2
- package/bottomnavigation/BottomNavigation.d.ts +23 -1
- package/bottomnavigation/BottomNavigation.mjs +3 -0
- package/bottomnavigation/BottomNavigationItemProps.d.ts +20 -9
- package/bottomnavigation/BottomNavigationProps.d.ts +73 -63
- package/bottomnavigation/models/events.d.ts +3 -3
- package/breadcrumb/Breadcrumb.d.ts +17 -1
- package/breadcrumb/BreadcrumbDelimiter.d.ts +8 -1
- package/breadcrumb/BreadcrumbLink.d.ts +17 -1
- package/breadcrumb/BreadcrumbLink.mjs +3 -0
- package/breadcrumb/interfaces/BreadcrumbDelimiterProps.d.ts +6 -3
- package/breadcrumb/interfaces/BreadcrumbLinkProps.d.ts +20 -11
- package/breadcrumb/interfaces/BreadcrumbOrderedListProps.d.ts +1 -1
- package/breadcrumb/interfaces/BreadcrumbProps.d.ts +56 -31
- package/card/Avatar.d.ts +7 -1
- package/card/Card.d.ts +18 -1
- package/card/CardActions.d.ts +10 -1
- package/card/CardBody.d.ts +13 -1
- package/card/CardFooter.d.ts +7 -1
- package/card/CardHeader.d.ts +13 -1
- package/card/CardImage.d.ts +7 -1
- package/card/CardSubtitle.d.ts +7 -1
- package/card/CardTitle.d.ts +7 -1
- package/card/interfaces/AvatarProps.d.ts +11 -8
- package/card/interfaces/CardActionsProps.d.ts +9 -3
- package/card/interfaces/CardBodyProps.d.ts +3 -0
- package/card/interfaces/CardFooterProps.d.ts +3 -0
- package/card/interfaces/CardHeaderProps.d.ts +3 -0
- package/card/interfaces/CardImageProps.d.ts +4 -1
- package/card/interfaces/CardProps.d.ts +12 -4
- package/card/interfaces/CardSubtitleProps.d.ts +3 -0
- package/card/interfaces/CardTitleProps.d.ts +3 -0
- package/card/interfaces/Enums.d.ts +57 -0
- package/contextmenu/ContextMenu.d.ts +23 -3
- package/dist/cdn/js/kendo-vue-layout.js +1 -1
- package/drawer/Drawer.d.ts +25 -1
- package/drawer/Drawer.mjs +3 -0
- package/drawer/DrawerContent.d.ts +1 -1
- package/drawer/DrawerItem.d.ts +1 -1
- package/drawer/interfaces/DrawerAnimation.d.ts +3 -3
- package/drawer/interfaces/DrawerContentProps.d.ts +1 -1
- package/drawer/interfaces/DrawerItemHandle.d.ts +3 -3
- package/drawer/interfaces/DrawerItemProps.d.ts +28 -12
- package/drawer/interfaces/DrawerProps.d.ts +49 -29
- package/drawer/interfaces/DrawerSelectEvent.d.ts +2 -2
- package/expansionpanel/ExpansionPanel.d.ts +16 -1
- package/expansionpanel/interfaces.d.ts +35 -20
- package/gridlayout/GridLayout.d.ts +22 -1
- package/gridlayout/interfaces/GridLayoutColumnProps.d.ts +4 -3
- package/gridlayout/interfaces/GridLayoutItemProps.d.ts +12 -11
- package/gridlayout/interfaces/GridLayoutProps.d.ts +23 -21
- package/gridlayout/interfaces/GridLayoutRowProps.d.ts +4 -3
- package/menu/MenuProps.d.ts +32 -16
- package/menu/components/Menu.d.ts +16 -6
- package/menu/events.d.ts +2 -2
- package/menu/models/BaseMenuItem.d.ts +27 -21
- package/menu/models/MenuItemActionsRenderProps.d.ts +2 -2
- package/menu/models/MenuItemGroupHeaderRenderProps.d.ts +2 -2
- package/menu/models/MenuItemModel.d.ts +2 -2
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +8 -8
- package/panelbar/PanelBar.d.ts +30 -2
- package/panelbar/interfaces/PanelBarItemProps.d.ts +38 -17
- package/panelbar/interfaces/PanelBarProps.d.ts +31 -14
- package/panelbar/interfaces/PanelBarSelectEventArguments.d.ts +2 -2
- package/splitter/Splitter.d.ts +26 -56
- package/splitter/SplitterPane.d.ts +19 -11
- package/stacklayout/StackLayout.d.ts +12 -2
- package/stacklayout/StackLayoutProps.d.ts +24 -22
- package/stepper/Step.d.ts +25 -20
- package/stepper/Step.mjs +3 -0
- package/stepper/Stepper.d.ts +23 -49
- package/stepper/Stepper.mjs +3 -0
- package/stepper/interfaces/StepChangeEvent.d.ts +2 -2
- package/stepper/interfaces/StepFocusEvent.d.ts +1 -1
- package/stepper/interfaces/StepHandle.d.ts +3 -3
- package/stepper/interfaces/StepProps.d.ts +37 -24
- package/stepper/interfaces/StepperChangeEvent.d.ts +2 -2
- package/stepper/interfaces/StepperFocusEvent.d.ts +1 -1
- package/stepper/interfaces/StepperHandle.d.ts +3 -3
- package/stepper/interfaces/StepperOnNavigateEvent.d.ts +7 -4
- package/stepper/interfaces/StepperProps.d.ts +37 -25
- package/tabstrip/TabStrip.d.ts +60 -27
- package/tabstrip/TabStripContent.d.ts +5 -5
- package/tabstrip/TabStripNavigation.d.ts +4 -4
- package/tabstrip/TabStripNavigationItem.d.ts +12 -7
- package/tabstrip/TabStripTab.d.ts +29 -5
- package/tilelayout/TileLayout.d.ts +61 -23
- package/tilelayout/TileLayout.mjs +3 -0
- package/tilelayout/interfaces/main.d.ts +105 -69
|
@@ -7,15 +7,15 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { PropType } from 'vue';
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Represents the props that the TabStrip passes to the TabStripNavigation.
|
|
11
11
|
*/
|
|
12
12
|
export interface TabStripNavigationProps {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Sets the collection of tabs.
|
|
15
15
|
*/
|
|
16
16
|
tabs?: Array<any>;
|
|
17
17
|
/**
|
|
18
|
-
* Sets the index of the selected tab.
|
|
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
|
-
*
|
|
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
|
-
*
|
|
10
|
+
* Represents the props that the TabStripNavigation passes to the TabStripNavigationItem.
|
|
11
11
|
*/
|
|
12
12
|
export interface TabStripNavigationItemProps {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
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
|
-
*
|
|
21
|
+
* Sets if the TabStripNavigationItem is disabled.
|
|
19
22
|
*/
|
|
20
23
|
disabled?: boolean;
|
|
21
24
|
/**
|
|
22
|
-
* Sets the index of the TabStripNavigationItem
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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](
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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`
|
|
14
|
+
* Sets the `id` attribute of the root TileLayout element.
|
|
15
15
|
*/
|
|
16
16
|
id?: string;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
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
|
-
*
|
|
22
|
+
* Sets the gaps between the tiles ([see example](slug:overview_tilelayout#toc-tilelayout-configuration-options)).
|
|
23
23
|
*
|
|
24
|
-
*
|
|
24
|
+
* The supported keys are:
|
|
25
25
|
* * `rows`
|
|
26
26
|
* * `columns`
|
|
27
27
|
*/
|
|
28
28
|
gap?: TileLayoutGap;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
47
|
-
* ([see example](
|
|
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
|
-
*
|
|
52
|
-
* ([see example](
|
|
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
|
|
57
|
-
* ([see example](
|
|
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
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
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
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
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
|
-
*
|
|
93
|
+
* Represents the [Kendo UI for Vue 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<{
|
|
@@ -6,200 +6,236 @@
|
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Describes an item that you pass to the `items` property of the TileLayout.
|
|
10
10
|
*/
|
|
11
11
|
export interface TileLayoutItem {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
* ([see example](
|
|
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
|
|
18
|
+
* Sets additional CSS styles to the tile.
|
|
19
19
|
*/
|
|
20
20
|
style?: object;
|
|
21
21
|
/**
|
|
22
|
-
* Sets additional classes to the
|
|
22
|
+
* Sets additional CSS classes to the tile.
|
|
23
23
|
*/
|
|
24
24
|
class?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Sets the tile object.
|
|
27
27
|
*/
|
|
28
28
|
tile?: object;
|
|
29
29
|
/**
|
|
30
|
-
* Sets additional CSS styles to the
|
|
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
|
|
34
|
+
* Sets additional CSS classes to the hint element of the tile.
|
|
35
35
|
*/
|
|
36
36
|
hintClass?: string;
|
|
37
37
|
/**
|
|
38
|
-
* Sets
|
|
39
|
-
* ([see example](
|
|
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
|
|
44
|
-
* ([see example](
|
|
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
|
|
49
|
-
* ([see example](
|
|
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
|
|
54
|
-
* ([see example](
|
|
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
|
-
*
|
|
59
|
-
* ([see example](
|
|
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
|
-
*
|
|
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
|
-
*
|
|
68
|
-
* ([see example](
|
|
69
|
-
*
|
|
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`—The user can resize the tile in both directions.
|
|
83
|
+
* * `false`—The user cannot resize the tile.
|
|
84
|
+
* * `horizontal`—The user can resize the tile only horizontally.
|
|
85
|
+
* * `vertical`—The user can resize the tile only vertically.
|
|
86
|
+
*
|
|
87
|
+
* @default `true`
|
|
70
88
|
*/
|
|
71
89
|
resizable?: TileResizeMode | string | boolean;
|
|
72
90
|
/**
|
|
73
|
-
*
|
|
74
|
-
* ([see example](
|
|
75
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
108
|
+
* Sets the position of a tile.
|
|
85
109
|
*/
|
|
86
110
|
export interface TilePosition {
|
|
87
111
|
/**
|
|
88
|
-
*
|
|
89
|
-
* If not set
|
|
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)
|
|
94
|
-
*
|
|
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
|
-
*
|
|
99
|
-
*
|
|
122
|
+
* Sets the number of columns that the tile spans.
|
|
123
|
+
*
|
|
124
|
+
* @default `1`
|
|
100
125
|
*/
|
|
101
126
|
colSpan?: number;
|
|
102
127
|
/**
|
|
103
|
-
*
|
|
128
|
+
* Sets the row line where the tile starts.
|
|
104
129
|
*/
|
|
105
130
|
row?: number;
|
|
106
131
|
/**
|
|
107
|
-
*
|
|
108
|
-
*
|
|
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
|
-
*
|
|
114
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
124
|
-
* Defaults to `1`.
|
|
148
|
+
* The number of rows that the tile spans.
|
|
125
149
|
*/
|
|
126
150
|
rowSpan: number;
|
|
127
151
|
/**
|
|
128
|
-
*
|
|
129
|
-
* Defaults to `1`.
|
|
152
|
+
* The number of columns that the tile spans.
|
|
130
153
|
*/
|
|
131
154
|
colSpan: number;
|
|
132
155
|
}
|
|
133
156
|
/**
|
|
134
|
-
*
|
|
135
|
-
* ([see example](
|
|
136
|
-
*
|
|
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`—The user can resize the tile in both directions.
|
|
162
|
+
* * `false`—The user cannot resize the tile.
|
|
163
|
+
* * `horizontal`—The user can resize the tile only horizontally.
|
|
164
|
+
* * `vertical`—The user can resize the tile only vertically.
|
|
137
165
|
*/
|
|
138
166
|
export type TileResizeMode = 'horizontal' | 'vertical' | boolean;
|
|
139
167
|
/**
|
|
140
|
-
*
|
|
168
|
+
* Sets the gaps between the tiles.
|
|
141
169
|
*/
|
|
142
170
|
export interface TileLayoutGap {
|
|
143
171
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
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
|
-
*
|
|
150
|
-
*
|
|
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
|
|
156
|
-
* For
|
|
157
|
-
*
|
|
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
|
-
*
|
|
195
|
+
* Represents the arguments of the `onReposition` TileLayout event.
|
|
162
196
|
*/
|
|
163
197
|
export interface TileLayoutRepositionEvent {
|
|
164
198
|
/**
|
|
165
|
-
* The new positions of the
|
|
199
|
+
* The new positions of the tiles.
|
|
166
200
|
*/
|
|
167
201
|
value: Array<TileStrictPosition>;
|
|
168
202
|
/**
|
|
169
|
-
* The index of the
|
|
203
|
+
* The index of the tile that the user moves.
|
|
170
204
|
*/
|
|
171
205
|
index: number;
|
|
172
206
|
/**
|
|
173
|
-
*
|
|
174
|
-
*
|
|
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
|
-
*
|
|
179
|
-
*
|
|
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
|
-
*
|
|
220
|
+
* Represents the arguments of the `onTileresize` TileLayout event.
|
|
185
221
|
*/
|
|
186
222
|
export interface TileLayoutTileResizeEvent {
|
|
187
223
|
/**
|
|
188
|
-
* The new
|
|
224
|
+
* The new positions of the tiles after the resize.
|
|
189
225
|
*/
|
|
190
226
|
value: Array<TileStrictPosition>;
|
|
191
227
|
/**
|
|
192
|
-
* The index of the
|
|
228
|
+
* The index of the tile that the user resizes.
|
|
193
229
|
*/
|
|
194
230
|
index: number;
|
|
195
231
|
/**
|
|
196
|
-
*
|
|
197
|
-
*
|
|
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
|
-
*
|
|
202
|
-
*
|
|
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
|
}
|