@vaadin/master-detail-layout 25.1.0-alpha6 → 25.1.0-alpha7
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/custom-elements.json +281 -0
- package/package.json +10 -8
- package/src/vaadin-master-detail-layout.js +1 -1
- package/web-types.json +1 -1
- package/web-types.lit.json +1 -1
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "vaadin-master-detail-layout.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "js",
|
|
12
|
+
"name": "*",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "*",
|
|
15
|
+
"module": "src/vaadin-master-detail-layout.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "src/vaadin-master-detail-layout.js",
|
|
23
|
+
"declarations": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "class",
|
|
26
|
+
"description": "`<vaadin-master-detail-layout>` is a web component for building UIs with a master\n(or primary) area and a detail (or secondary) area that is displayed next to, or\noverlaid on top of, the master area, depending on configuration and viewport size.\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------|----------------------\n`backdrop` | Backdrop covering the master area in the drawer mode\n`master` | The master area\n`detail` | The detail area\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n---------------| -----------\n`containment` | Set to `layout` or `viewport` depending on the containment.\n`orientation` | Set to `horizontal` or `vertical` depending on the orientation.\n`has-detail` | Set when the detail content is provided.\n`drawer` | Set when the layout is using the drawer mode.\n`stack` | Set when the layout is using the stack mode.\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:----------------------------------------------------|\n| `--vaadin-master-detail-layout-border-color` |\n| `--vaadin-master-detail-layout-border-width` |\n| `--vaadin-master-detail-layout-detail-background` |\n| `--vaadin-master-detail-layout-detail-shadow` |\n| `--vaadin-overlay-backdrop-background` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
|
|
27
|
+
"name": "MasterDetailLayout",
|
|
28
|
+
"members": [
|
|
29
|
+
{
|
|
30
|
+
"kind": "field",
|
|
31
|
+
"name": "containment",
|
|
32
|
+
"privacy": "public",
|
|
33
|
+
"type": {
|
|
34
|
+
"text": "string"
|
|
35
|
+
},
|
|
36
|
+
"description": "Defines the containment of the detail area when the layout is in\noverlay mode. When set to `layout`, the overlay is confined to the\nlayout. When set to `viewport`, the overlay is confined to the\nbrowser's viewport. Defaults to `layout`.",
|
|
37
|
+
"attribute": "containment"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"kind": "field",
|
|
41
|
+
"name": "detailMinSize",
|
|
42
|
+
"privacy": "public",
|
|
43
|
+
"type": {
|
|
44
|
+
"text": "string"
|
|
45
|
+
},
|
|
46
|
+
"description": "Minimum size (in CSS length units) to be set on the detail area.\nWhen specified, it prevents the detail area from shrinking below\nthis size. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
47
|
+
"attribute": "detail-min-size"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"kind": "field",
|
|
51
|
+
"name": "detailSize",
|
|
52
|
+
"privacy": "public",
|
|
53
|
+
"type": {
|
|
54
|
+
"text": "string"
|
|
55
|
+
},
|
|
56
|
+
"description": "Fixed size (in CSS length units) to be set on the detail area.\nWhen specified, it prevents the detail area from growing or\nshrinking. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
57
|
+
"attribute": "detail-size"
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"kind": "field",
|
|
61
|
+
"name": "forceOverlay",
|
|
62
|
+
"privacy": "public",
|
|
63
|
+
"type": {
|
|
64
|
+
"text": "boolean"
|
|
65
|
+
},
|
|
66
|
+
"description": "When specified, forces the details to be shown as an overlay\n(either as drawer or stack), even if there is enough space for\nmaster and detail to be shown next to each other using the default\n(split) mode.\n\nIn order to enforce the stack mode, use this property together with\n`stackOverlay` property and set both to `true`.",
|
|
67
|
+
"attribute": "force-overlay"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"kind": "field",
|
|
71
|
+
"name": "masterMinSize",
|
|
72
|
+
"privacy": "public",
|
|
73
|
+
"type": {
|
|
74
|
+
"text": "string"
|
|
75
|
+
},
|
|
76
|
+
"description": "Minimum size (in CSS length units) to be set on the master area.\nWhen specified, it prevents the master area from shrinking below\nthis size. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
77
|
+
"attribute": "master-min-size"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"kind": "field",
|
|
81
|
+
"name": "masterSize",
|
|
82
|
+
"privacy": "public",
|
|
83
|
+
"type": {
|
|
84
|
+
"text": "string"
|
|
85
|
+
},
|
|
86
|
+
"description": "Fixed size (in CSS length units) to be set on the master area.\nWhen specified, it prevents the master area from growing or\nshrinking. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
87
|
+
"attribute": "master-size"
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"kind": "field",
|
|
91
|
+
"name": "noAnimation",
|
|
92
|
+
"privacy": "public",
|
|
93
|
+
"type": {
|
|
94
|
+
"text": "boolean"
|
|
95
|
+
},
|
|
96
|
+
"description": "When true, the layout does not use animated transitions for the detail area.",
|
|
97
|
+
"attribute": "no-animation"
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"kind": "field",
|
|
101
|
+
"name": "orientation",
|
|
102
|
+
"privacy": "public",
|
|
103
|
+
"type": {
|
|
104
|
+
"text": "string"
|
|
105
|
+
},
|
|
106
|
+
"description": "Define how master and detail areas are shown next to each other,\nand the way how size and min-size properties are applied to them.\nPossible values are: `horizontal` or `vertical`.\nDefaults to horizontal.",
|
|
107
|
+
"attribute": "orientation"
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"kind": "field",
|
|
111
|
+
"name": "slotStyles",
|
|
112
|
+
"readonly": true
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"kind": "field",
|
|
116
|
+
"name": "stackOverlay",
|
|
117
|
+
"privacy": "public",
|
|
118
|
+
"type": {
|
|
119
|
+
"text": "boolean"
|
|
120
|
+
},
|
|
121
|
+
"description": "When true, the layout in the overlay mode is rendered as a stack,\nmaking detail area fully cover the master area. Otherwise, it is\nrendered as a drawer and has a visual backdrop.\n\nIn order to enforce the stack mode, use this property together with\n`forceOverlay` property and set both to `true`.",
|
|
122
|
+
"attribute": "stack-overlay"
|
|
123
|
+
}
|
|
124
|
+
],
|
|
125
|
+
"events": [
|
|
126
|
+
{
|
|
127
|
+
"name": "backdrop-click",
|
|
128
|
+
"type": {
|
|
129
|
+
"text": "CustomEvent"
|
|
130
|
+
},
|
|
131
|
+
"description": "Fired when the user clicks the backdrop in the drawer mode."
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "detail-escape-press",
|
|
135
|
+
"type": {
|
|
136
|
+
"text": "CustomEvent"
|
|
137
|
+
},
|
|
138
|
+
"description": "Fired when the user presses Escape in the detail area."
|
|
139
|
+
}
|
|
140
|
+
],
|
|
141
|
+
"attributes": [
|
|
142
|
+
{
|
|
143
|
+
"name": "containment",
|
|
144
|
+
"type": {
|
|
145
|
+
"text": "string"
|
|
146
|
+
},
|
|
147
|
+
"description": "Defines the containment of the detail area when the layout is in\noverlay mode. When set to `layout`, the overlay is confined to the\nlayout. When set to `viewport`, the overlay is confined to the\nbrowser's viewport. Defaults to `layout`.",
|
|
148
|
+
"fieldName": "containment"
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"name": "detail-min-size",
|
|
152
|
+
"type": {
|
|
153
|
+
"text": "string"
|
|
154
|
+
},
|
|
155
|
+
"description": "Minimum size (in CSS length units) to be set on the detail area.\nWhen specified, it prevents the detail area from shrinking below\nthis size. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
156
|
+
"fieldName": "detailMinSize"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "detail-size",
|
|
160
|
+
"type": {
|
|
161
|
+
"text": "string"
|
|
162
|
+
},
|
|
163
|
+
"description": "Fixed size (in CSS length units) to be set on the detail area.\nWhen specified, it prevents the detail area from growing or\nshrinking. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
164
|
+
"fieldName": "detailSize"
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "drawer",
|
|
168
|
+
"type": {
|
|
169
|
+
"text": "boolean"
|
|
170
|
+
},
|
|
171
|
+
"description": "When true, the component uses the drawer mode. This property is read-only.",
|
|
172
|
+
"fieldName": "_drawer"
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"name": "force-overlay",
|
|
176
|
+
"type": {
|
|
177
|
+
"text": "boolean"
|
|
178
|
+
},
|
|
179
|
+
"description": "When specified, forces the details to be shown as an overlay\n(either as drawer or stack), even if there is enough space for\nmaster and detail to be shown next to each other using the default\n(split) mode.\n\nIn order to enforce the stack mode, use this property together with\n`stackOverlay` property and set both to `true`.",
|
|
180
|
+
"fieldName": "forceOverlay"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "has-detail",
|
|
184
|
+
"type": {
|
|
185
|
+
"text": "boolean"
|
|
186
|
+
},
|
|
187
|
+
"description": "When true, the component has the detail content provided.",
|
|
188
|
+
"fieldName": "_hasDetail"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "master-min-size",
|
|
192
|
+
"type": {
|
|
193
|
+
"text": "string"
|
|
194
|
+
},
|
|
195
|
+
"description": "Minimum size (in CSS length units) to be set on the master area.\nWhen specified, it prevents the master area from shrinking below\nthis size. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
196
|
+
"fieldName": "masterMinSize"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "master-size",
|
|
200
|
+
"type": {
|
|
201
|
+
"text": "string"
|
|
202
|
+
},
|
|
203
|
+
"description": "Fixed size (in CSS length units) to be set on the master area.\nWhen specified, it prevents the master area from growing or\nshrinking. If there is not enough space to show master and detail\nareas next to each other, the details are shown as an overlay:\neither as drawer or stack, depending on the `stackOverlay` property.",
|
|
204
|
+
"fieldName": "masterSize"
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"name": "no-animation",
|
|
208
|
+
"type": {
|
|
209
|
+
"text": "boolean"
|
|
210
|
+
},
|
|
211
|
+
"description": "When true, the layout does not use animated transitions for the detail area.",
|
|
212
|
+
"fieldName": "noAnimation"
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "orientation",
|
|
216
|
+
"type": {
|
|
217
|
+
"text": "string"
|
|
218
|
+
},
|
|
219
|
+
"description": "Define how master and detail areas are shown next to each other,\nand the way how size and min-size properties are applied to them.\nPossible values are: `horizontal` or `vertical`.\nDefaults to horizontal.",
|
|
220
|
+
"fieldName": "orientation"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"name": "stack",
|
|
224
|
+
"type": {
|
|
225
|
+
"text": "boolean"
|
|
226
|
+
},
|
|
227
|
+
"description": "When true, the component uses the stack mode. This property is read-only.",
|
|
228
|
+
"fieldName": "_stack"
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "stack-overlay",
|
|
232
|
+
"type": {
|
|
233
|
+
"text": "boolean"
|
|
234
|
+
},
|
|
235
|
+
"description": "When true, the layout in the overlay mode is rendered as a stack,\nmaking detail area fully cover the master area. Otherwise, it is\nrendered as a drawer and has a visual backdrop.\n\nIn order to enforce the stack mode, use this property together with\n`forceOverlay` property and set both to `true`.",
|
|
236
|
+
"fieldName": "stackOverlay"
|
|
237
|
+
}
|
|
238
|
+
],
|
|
239
|
+
"mixins": [
|
|
240
|
+
{
|
|
241
|
+
"name": "SlotStylesMixin",
|
|
242
|
+
"package": "@vaadin/component-base/src/slot-styles-mixin.js"
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"name": "ResizeMixin",
|
|
246
|
+
"package": "@vaadin/component-base/src/resize-mixin.js"
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "ElementMixin",
|
|
250
|
+
"package": "@vaadin/component-base/src/element-mixin.js"
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
"name": "ThemableMixin",
|
|
254
|
+
"package": "@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js"
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"name": "PolylitMixin",
|
|
258
|
+
"package": "@vaadin/component-base/src/polylit-mixin.js"
|
|
259
|
+
}
|
|
260
|
+
],
|
|
261
|
+
"superclass": {
|
|
262
|
+
"name": "LitElement",
|
|
263
|
+
"package": "lit"
|
|
264
|
+
},
|
|
265
|
+
"tagName": "vaadin-master-detail-layout",
|
|
266
|
+
"customElement": true
|
|
267
|
+
}
|
|
268
|
+
],
|
|
269
|
+
"exports": [
|
|
270
|
+
{
|
|
271
|
+
"kind": "js",
|
|
272
|
+
"name": "MasterDetailLayout",
|
|
273
|
+
"declaration": {
|
|
274
|
+
"name": "MasterDetailLayout",
|
|
275
|
+
"module": "src/vaadin-master-detail-layout.js"
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
]
|
|
279
|
+
}
|
|
280
|
+
]
|
|
281
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/master-detail-layout",
|
|
3
|
-
"version": "25.1.0-
|
|
3
|
+
"version": "25.1.0-alpha7",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
"src",
|
|
24
24
|
"vaadin-*.d.ts",
|
|
25
25
|
"vaadin-*.js",
|
|
26
|
+
"custom-elements.json",
|
|
26
27
|
"web-types.json",
|
|
27
28
|
"web-types.lit.json"
|
|
28
29
|
],
|
|
@@ -33,21 +34,22 @@
|
|
|
33
34
|
"web-component"
|
|
34
35
|
],
|
|
35
36
|
"dependencies": {
|
|
36
|
-
"@vaadin/a11y-base": "25.1.0-
|
|
37
|
-
"@vaadin/component-base": "25.1.0-
|
|
38
|
-
"@vaadin/vaadin-themable-mixin": "25.1.0-
|
|
37
|
+
"@vaadin/a11y-base": "25.1.0-alpha7",
|
|
38
|
+
"@vaadin/component-base": "25.1.0-alpha7",
|
|
39
|
+
"@vaadin/vaadin-themable-mixin": "25.1.0-alpha7",
|
|
39
40
|
"lit": "^3.0.0"
|
|
40
41
|
},
|
|
41
42
|
"devDependencies": {
|
|
42
|
-
"@vaadin/aura": "25.1.0-
|
|
43
|
-
"@vaadin/chai-plugins": "25.1.0-
|
|
43
|
+
"@vaadin/aura": "25.1.0-alpha7",
|
|
44
|
+
"@vaadin/chai-plugins": "25.1.0-alpha7",
|
|
44
45
|
"@vaadin/testing-helpers": "^2.0.0",
|
|
45
|
-
"@vaadin/vaadin-lumo-styles": "25.1.0-
|
|
46
|
+
"@vaadin/vaadin-lumo-styles": "25.1.0-alpha7",
|
|
46
47
|
"sinon": "^21.0.0"
|
|
47
48
|
},
|
|
49
|
+
"customElements": "custom-elements.json",
|
|
48
50
|
"web-types": [
|
|
49
51
|
"web-types.json",
|
|
50
52
|
"web-types.lit.json"
|
|
51
53
|
],
|
|
52
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "98c586125f769c8fefd307536965293668fda81d"
|
|
53
55
|
}
|
|
@@ -54,7 +54,7 @@ import { masterDetailLayoutTransitionStyles } from './styles/vaadin-master-detai
|
|
|
54
54
|
* @fires {CustomEvent} backdrop-click - Fired when the user clicks the backdrop in the drawer mode.
|
|
55
55
|
* @fires {CustomEvent} detail-escape-press - Fired when the user presses Escape in the detail area.
|
|
56
56
|
*
|
|
57
|
-
* @customElement
|
|
57
|
+
* @customElement vaadin-master-detail-layout
|
|
58
58
|
* @extends HTMLElement
|
|
59
59
|
* @mixes ThemableMixin
|
|
60
60
|
* @mixes ElementMixin
|
package/web-types.json
CHANGED
package/web-types.lit.json
CHANGED