@spectrum-web-components/menu 0.0.0-20241209155954
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/README.md +164 -0
- package/package.json +112 -0
- package/sp-menu-divider.d.ts +6 -0
- package/sp-menu-divider.dev.js +5 -0
- package/sp-menu-divider.dev.js.map +7 -0
- package/sp-menu-divider.js +2 -0
- package/sp-menu-divider.js.map +7 -0
- package/sp-menu-group.d.ts +6 -0
- package/sp-menu-group.dev.js +5 -0
- package/sp-menu-group.dev.js.map +7 -0
- package/sp-menu-group.js +2 -0
- package/sp-menu-group.js.map +7 -0
- package/sp-menu-item.d.ts +6 -0
- package/sp-menu-item.dev.js +5 -0
- package/sp-menu-item.dev.js.map +7 -0
- package/sp-menu-item.js +2 -0
- package/sp-menu-item.js.map +7 -0
- package/sp-menu.d.ts +6 -0
- package/sp-menu.dev.js +5 -0
- package/sp-menu.dev.js.map +7 -0
- package/sp-menu.js +2 -0
- package/sp-menu.js.map +7 -0
- package/src/Menu.d.ts +118 -0
- package/src/Menu.dev.js +740 -0
- package/src/Menu.dev.js.map +7 -0
- package/src/Menu.js +8 -0
- package/src/Menu.js.map +7 -0
- package/src/MenuDivider.d.ts +13 -0
- package/src/MenuDivider.dev.js +19 -0
- package/src/MenuDivider.dev.js.map +7 -0
- package/src/MenuDivider.js +2 -0
- package/src/MenuDivider.js.map +7 -0
- package/src/MenuGroup.d.ts +18 -0
- package/src/MenuGroup.dev.js +78 -0
- package/src/MenuGroup.dev.js.map +7 -0
- package/src/MenuGroup.js +7 -0
- package/src/MenuGroup.js.map +7 -0
- package/src/MenuItem.d.ts +125 -0
- package/src/MenuItem.dev.js +518 -0
- package/src/MenuItem.dev.js.map +7 -0
- package/src/MenuItem.js +50 -0
- package/src/MenuItem.js.map +7 -0
- package/src/checkmark-overrides.css.d.ts +2 -0
- package/src/checkmark-overrides.css.dev.js +7 -0
- package/src/checkmark-overrides.css.dev.js.map +7 -0
- package/src/checkmark-overrides.css.js +4 -0
- package/src/checkmark-overrides.css.js.map +7 -0
- package/src/chevron-overrides.css.d.ts +2 -0
- package/src/chevron-overrides.css.dev.js +7 -0
- package/src/chevron-overrides.css.dev.js.map +7 -0
- package/src/chevron-overrides.css.js +4 -0
- package/src/chevron-overrides.css.js.map +7 -0
- package/src/index.d.ts +4 -0
- package/src/index.dev.js +6 -0
- package/src/index.dev.js.map +7 -0
- package/src/index.js +2 -0
- package/src/index.js.map +7 -0
- package/src/menu-divider-overrides.css.d.ts +2 -0
- package/src/menu-divider-overrides.css.dev.js +7 -0
- package/src/menu-divider-overrides.css.dev.js.map +7 -0
- package/src/menu-divider-overrides.css.js +4 -0
- package/src/menu-divider-overrides.css.js.map +7 -0
- package/src/menu-divider.css.d.ts +2 -0
- package/src/menu-divider.css.dev.js +7 -0
- package/src/menu-divider.css.dev.js.map +7 -0
- package/src/menu-divider.css.js +4 -0
- package/src/menu-divider.css.js.map +7 -0
- package/src/menu-group.css.d.ts +2 -0
- package/src/menu-group.css.dev.js +7 -0
- package/src/menu-group.css.dev.js.map +7 -0
- package/src/menu-group.css.js +4 -0
- package/src/menu-group.css.js.map +7 -0
- package/src/menu-item-overrides.css.d.ts +2 -0
- package/src/menu-item-overrides.css.dev.js +7 -0
- package/src/menu-item-overrides.css.dev.js.map +7 -0
- package/src/menu-item-overrides.css.js +4 -0
- package/src/menu-item-overrides.css.js.map +7 -0
- package/src/menu-item.css.d.ts +2 -0
- package/src/menu-item.css.dev.js +7 -0
- package/src/menu-item.css.dev.js.map +7 -0
- package/src/menu-item.css.js +4 -0
- package/src/menu-item.css.js.map +7 -0
- package/src/menu-overrides.css.d.ts +2 -0
- package/src/menu-overrides.css.dev.js +7 -0
- package/src/menu-overrides.css.dev.js.map +7 -0
- package/src/menu-overrides.css.js +4 -0
- package/src/menu-overrides.css.js.map +7 -0
- package/src/menu.css.d.ts +2 -0
- package/src/menu.css.dev.js +7 -0
- package/src/menu.css.dev.js.map +7 -0
- package/src/menu.css.js +4 -0
- package/src/menu.css.js.map +7 -0
- package/src/spectrum-checkmark.css.d.ts +2 -0
- package/src/spectrum-checkmark.css.dev.js +7 -0
- package/src/spectrum-checkmark.css.dev.js.map +7 -0
- package/src/spectrum-checkmark.css.js +4 -0
- package/src/spectrum-checkmark.css.js.map +7 -0
- package/src/spectrum-chevron.css.d.ts +2 -0
- package/src/spectrum-chevron.css.dev.js +7 -0
- package/src/spectrum-chevron.css.dev.js.map +7 -0
- package/src/spectrum-chevron.css.js +4 -0
- package/src/spectrum-chevron.css.js.map +7 -0
- package/src/spectrum-config.js +652 -0
- package/src/spectrum-menu-divider.css.d.ts +2 -0
- package/src/spectrum-menu-divider.css.dev.js +7 -0
- package/src/spectrum-menu-divider.css.dev.js.map +7 -0
- package/src/spectrum-menu-divider.css.js +4 -0
- package/src/spectrum-menu-divider.css.js.map +7 -0
- package/src/spectrum-menu-item.css.d.ts +2 -0
- package/src/spectrum-menu-item.css.dev.js +7 -0
- package/src/spectrum-menu-item.css.dev.js.map +7 -0
- package/src/spectrum-menu-item.css.js +4 -0
- package/src/spectrum-menu-item.css.js.map +7 -0
- package/src/spectrum-menu-sectionHeading.css.d.ts +2 -0
- package/src/spectrum-menu-sectionHeading.css.dev.js +7 -0
- package/src/spectrum-menu-sectionHeading.css.dev.js.map +7 -0
- package/src/spectrum-menu-sectionHeading.css.js +4 -0
- package/src/spectrum-menu-sectionHeading.css.js.map +7 -0
- package/src/spectrum-menu.css.d.ts +2 -0
- package/src/spectrum-menu.css.dev.js +7 -0
- package/src/spectrum-menu.css.dev.js.map +7 -0
- package/src/spectrum-menu.css.js +4 -0
- package/src/spectrum-menu.css.js.map +7 -0
package/README.md
ADDED
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
## Description
|
|
2
|
+
|
|
3
|
+
An `<sp-menu>` is used for creating a menu list. The various elements inside a menu are given as `<sp-menu-group>`, `<sp-menu-item>`, or `<sp-menu-divider>`. Often a `<sp-menu>` element will appear in a `<sp-popover>` element so that it displays as a togglig menu.
|
|
4
|
+
|
|
5
|
+
### Usage
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@spectrum-web-components/menu)
|
|
8
|
+
[](https://bundlephobia.com/result?p=@spectrum-web-components/menu)
|
|
9
|
+
[](https://webcomponents.dev/edit/collection/fO75441E1Q5ZlI0e9pgq/FikFeTXNsYhxAVmCz2f4/src/index.ts)
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
yarn add @spectrum-web-components/menu
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Import the side effectful registration of `<sp-menu>`, `<sp-menu-group>`, `<sp-menu-item>`, or `<sp-menu-divider>` individually as follows:
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
import '@spectrum-web-components/menu/sp-menu.js';
|
|
19
|
+
import '@spectrum-web-components/menu/sp-menu-group.js';
|
|
20
|
+
import '@spectrum-web-components/menu/sp-menu-item.js';
|
|
21
|
+
import '@spectrum-web-components/menu/sp-menu-divider.js';
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
When looking to leverage the `Menu`, `MenuGroup`, `MenuItem`, or `MenuDivider` base classes as a type and/or for extension purposes, do so via:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
import {
|
|
28
|
+
Menu,
|
|
29
|
+
MenuGroup,
|
|
30
|
+
MenuItem,
|
|
31
|
+
MenuDivider
|
|
32
|
+
} from '@spectrum-web-components/menu';
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
<!-- prettier-ignore -->
|
|
38
|
+
```html
|
|
39
|
+
<sp-menu>
|
|
40
|
+
<sp-menu-item>
|
|
41
|
+
Deselect
|
|
42
|
+
</sp-menu-item>
|
|
43
|
+
<sp-menu-item>
|
|
44
|
+
Select inverse
|
|
45
|
+
</sp-menu-item>
|
|
46
|
+
<sp-menu-item>
|
|
47
|
+
Feather...
|
|
48
|
+
</sp-menu-item>
|
|
49
|
+
<sp-menu-item>
|
|
50
|
+
Select and mask...
|
|
51
|
+
</sp-menu-item>
|
|
52
|
+
<sp-menu-item>
|
|
53
|
+
Save selection
|
|
54
|
+
</sp-menu-item>
|
|
55
|
+
<sp-menu-item disabled>
|
|
56
|
+
Make work path
|
|
57
|
+
</sp-menu-item>
|
|
58
|
+
</sp-menu>
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Often an `<sp-menu>` element will be delivered inside of an `<sp-popover>` element when displaying it above other content.
|
|
62
|
+
|
|
63
|
+
```html
|
|
64
|
+
<sp-popover open style="position: relative">
|
|
65
|
+
<sp-menu>
|
|
66
|
+
<sp-menu-item value="item-1">Deselect</sp-menu-item>
|
|
67
|
+
<sp-menu-item value="item-2">Select inverse</sp-menu-item>
|
|
68
|
+
<sp-menu-item value="item-3">Feather...</sp-menu-item>
|
|
69
|
+
<sp-menu-item value="item-4">Select and mask...</sp-menu-item>
|
|
70
|
+
<sp-menu-item value="item-5">Save selection</sp-menu-item>
|
|
71
|
+
<sp-menu-item value="item-6" disabled>Make work path</sp-menu-item>
|
|
72
|
+
</sp-menu>
|
|
73
|
+
</sp-popover>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Managing a selection
|
|
77
|
+
|
|
78
|
+
The `<sp-menu>` element can be instructed to maintain a selection via the `selects` attribute. Depending on the chosen algorithm, the `<sp-menu>` element will hold a `value` property and manage the `selected` state of its `<sp-menu-item>` descendants.
|
|
79
|
+
|
|
80
|
+
### selects="single"
|
|
81
|
+
|
|
82
|
+
When `selects` is set to `single`, the `<sp-menu>` element will maintain one selected item after an initial selection is made.
|
|
83
|
+
|
|
84
|
+
```html
|
|
85
|
+
<p>
|
|
86
|
+
The value of the `<sp-menu>` element is:
|
|
87
|
+
<span id="single-value"></span>
|
|
88
|
+
</p>
|
|
89
|
+
<sp-menu
|
|
90
|
+
label="Choose a shape"
|
|
91
|
+
selects="single"
|
|
92
|
+
onchange="this.previousElementSibling.querySelector('#single-value').textContent=this.value"
|
|
93
|
+
>
|
|
94
|
+
<sp-menu-item value="item-1">Square</sp-menu-item>
|
|
95
|
+
<sp-menu-item value="item-2">Triangle</sp-menu-item>
|
|
96
|
+
<sp-menu-item value="item-3">Parallelogram</sp-menu-item>
|
|
97
|
+
<sp-menu-item value="item-4">Star</sp-menu-item>
|
|
98
|
+
<sp-menu-item value="item-5">Hexagon</sp-menu-item>
|
|
99
|
+
<sp-menu-item value="item-6" disabled>Circle</sp-menu-item>
|
|
100
|
+
</sp-menu>
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### selects="multiple"
|
|
104
|
+
|
|
105
|
+
When `selects` is set to `multiple`, the `<sp-menu>` element will maintain zero or more selected items.
|
|
106
|
+
|
|
107
|
+
```html
|
|
108
|
+
<p>
|
|
109
|
+
The value of the `<sp-menu>` element is:
|
|
110
|
+
<span id="multiple-value">item-3,item-4</span>
|
|
111
|
+
</p>
|
|
112
|
+
<sp-menu
|
|
113
|
+
label="Choose some fruit"
|
|
114
|
+
selects="multiple"
|
|
115
|
+
onchange="this.previousElementSibling.querySelector('#multiple-value').textContent=this.value"
|
|
116
|
+
>
|
|
117
|
+
<sp-menu-item value="item-1">Apple</sp-menu-item>
|
|
118
|
+
<sp-menu-item value="item-2">Banana</sp-menu-item>
|
|
119
|
+
<sp-menu-item value="item-3" selected>Goji berry</sp-menu-item>
|
|
120
|
+
<sp-menu-item value="item-4" selected>Grapes</sp-menu-item>
|
|
121
|
+
<sp-menu-item value="item-5" disabled>Kumquat</sp-menu-item>
|
|
122
|
+
<sp-menu-item value="item-6">Orange</sp-menu-item>
|
|
123
|
+
</sp-menu>
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### selects="inherit"
|
|
127
|
+
|
|
128
|
+
When `selects` is set to `inherit`, the `<sp-menu>` element will allow its `<sp-menu-item>` children to participate in the selection of its nearest `<sp-menu>` ancestor.
|
|
129
|
+
|
|
130
|
+
```html
|
|
131
|
+
<p>
|
|
132
|
+
The value of the `<sp-menu>` element is:
|
|
133
|
+
<span id="inherit-value">item-3 || item-4 || item-8 || item-11</span>
|
|
134
|
+
</p>
|
|
135
|
+
<sp-menu
|
|
136
|
+
label="Choose some groceries"
|
|
137
|
+
selects="multiple"
|
|
138
|
+
value-separator=" || "
|
|
139
|
+
onchange="this.previousElementSibling.querySelector('#inherit-value').textContent=this.value"
|
|
140
|
+
>
|
|
141
|
+
<sp-menu label="Fruit" selects="inherit">
|
|
142
|
+
<sp-menu-item value="item-1">Apple</sp-menu-item>
|
|
143
|
+
<sp-menu-item value="item-2">Banana</sp-menu-item>
|
|
144
|
+
<sp-menu-item value="item-3" selected>Goji berry</sp-menu-item>
|
|
145
|
+
<sp-menu-item value="item-4" selected>Grapes</sp-menu-item>
|
|
146
|
+
<sp-menu-item value="item-5" disabled>Kumquat</sp-menu-item>
|
|
147
|
+
<sp-menu-item value="item-6">Orange</sp-menu-item>
|
|
148
|
+
</sp-menu>
|
|
149
|
+
<sp-menu label="Vegetables" selects="inherit">
|
|
150
|
+
<sp-menu-item value="item-7">Carrot</sp-menu-item>
|
|
151
|
+
<sp-menu-item value="item-8" selected>Garlic</sp-menu-item>
|
|
152
|
+
<sp-menu-item value="item-9" disabled>Lettuce</sp-menu-item>
|
|
153
|
+
<sp-menu-item value="item-10">Onion</sp-menu-item>
|
|
154
|
+
<sp-menu-item value="item-11" selected>Potato</sp-menu-item>
|
|
155
|
+
<sp-menu-item value="item-12">Tomato</sp-menu-item>
|
|
156
|
+
</sp-menu>
|
|
157
|
+
</sp-menu>
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## "change" event
|
|
161
|
+
|
|
162
|
+
Whether `<sp-menu>` carries a selection or not, when one of the `<sp-menu-item>` children that it manages is activated the `<sp-menu>` element will dispatch a `change` event. At dispatch time, even when a selection is not held due to the absence of the `selects` attribute, the `value` of the `<sp-menu>` will correspond to the `<sp-menu-item>` that was activated. When the `selects` attribute is present, this `value` will be persisted beyond the lifecycle of the `change` event. When `selects="multiple"` the values of multiple items will be comma separated unless otherwise set via the `value-separator` attribute.
|
|
163
|
+
|
|
164
|
+
Note: The `change` event is only dispatched on a left mouse click or Enter/Space keypress. Right/Middle mouse clicks will not dispatch the `change` event.
|
package/package.json
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@spectrum-web-components/menu",
|
|
3
|
+
"version": "0.0.0-20241209155954",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"access": "public"
|
|
6
|
+
},
|
|
7
|
+
"description": "",
|
|
8
|
+
"license": "Apache-2.0",
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "https://github.com/adobe/spectrum-web-components.git",
|
|
12
|
+
"directory": "packages/menu"
|
|
13
|
+
},
|
|
14
|
+
"author": "",
|
|
15
|
+
"homepage": "https://opensource.adobe.com/spectrum-web-components/components/menu",
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/adobe/spectrum-web-components/issues"
|
|
18
|
+
},
|
|
19
|
+
"main": "./src/index.js",
|
|
20
|
+
"module": "./src/index.js",
|
|
21
|
+
"type": "module",
|
|
22
|
+
"exports": {
|
|
23
|
+
".": {
|
|
24
|
+
"development": "./src/index.dev.js",
|
|
25
|
+
"default": "./src/index.js"
|
|
26
|
+
},
|
|
27
|
+
"./package.json": "./package.json",
|
|
28
|
+
"./src/Menu.js": {
|
|
29
|
+
"development": "./src/Menu.dev.js",
|
|
30
|
+
"default": "./src/Menu.js"
|
|
31
|
+
},
|
|
32
|
+
"./src/MenuDivider.js": {
|
|
33
|
+
"development": "./src/MenuDivider.dev.js",
|
|
34
|
+
"default": "./src/MenuDivider.js"
|
|
35
|
+
},
|
|
36
|
+
"./src/MenuGroup.js": {
|
|
37
|
+
"development": "./src/MenuGroup.dev.js",
|
|
38
|
+
"default": "./src/MenuGroup.js"
|
|
39
|
+
},
|
|
40
|
+
"./src/MenuItem.js": {
|
|
41
|
+
"development": "./src/MenuItem.dev.js",
|
|
42
|
+
"default": "./src/MenuItem.js"
|
|
43
|
+
},
|
|
44
|
+
"./src/checkmark-overrides.css.js": "./src/checkmark-overrides.css.js",
|
|
45
|
+
"./src/chevron-overrides.css.js": "./src/chevron-overrides.css.js",
|
|
46
|
+
"./src/index.js": {
|
|
47
|
+
"development": "./src/index.dev.js",
|
|
48
|
+
"default": "./src/index.js"
|
|
49
|
+
},
|
|
50
|
+
"./src/menu-divider-overrides.css.js": "./src/menu-divider-overrides.css.js",
|
|
51
|
+
"./src/menu-divider.css.js": "./src/menu-divider.css.js",
|
|
52
|
+
"./src/menu-group.css.js": "./src/menu-group.css.js",
|
|
53
|
+
"./src/menu-item-overrides.css.js": "./src/menu-item-overrides.css.js",
|
|
54
|
+
"./src/menu-item.css.js": "./src/menu-item.css.js",
|
|
55
|
+
"./src/menu-overrides.css.js": "./src/menu-overrides.css.js",
|
|
56
|
+
"./src/menu.css.js": "./src/menu.css.js",
|
|
57
|
+
"./sp-menu.js": {
|
|
58
|
+
"development": "./sp-menu.dev.js",
|
|
59
|
+
"default": "./sp-menu.js"
|
|
60
|
+
},
|
|
61
|
+
"./sp-menu-divider.js": {
|
|
62
|
+
"development": "./sp-menu-divider.dev.js",
|
|
63
|
+
"default": "./sp-menu-divider.js"
|
|
64
|
+
},
|
|
65
|
+
"./sp-menu-group.js": {
|
|
66
|
+
"development": "./sp-menu-group.dev.js",
|
|
67
|
+
"default": "./sp-menu-group.js"
|
|
68
|
+
},
|
|
69
|
+
"./sp-menu-item.js": {
|
|
70
|
+
"development": "./sp-menu-item.dev.js",
|
|
71
|
+
"default": "./sp-menu-item.js"
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
"scripts": {
|
|
75
|
+
"test": "echo \"Error: run tests from mono-repo root.\" && exit 1"
|
|
76
|
+
},
|
|
77
|
+
"files": [
|
|
78
|
+
"**/*.d.ts",
|
|
79
|
+
"**/*.js",
|
|
80
|
+
"**/*.js.map",
|
|
81
|
+
"custom-elements.json",
|
|
82
|
+
"!stories/",
|
|
83
|
+
"!test/"
|
|
84
|
+
],
|
|
85
|
+
"keywords": [
|
|
86
|
+
"spectrum css",
|
|
87
|
+
"web components",
|
|
88
|
+
"lit-element",
|
|
89
|
+
"lit-html"
|
|
90
|
+
],
|
|
91
|
+
"dependencies": {
|
|
92
|
+
"@lit-labs/observers": "^2.0.2",
|
|
93
|
+
"@spectrum-web-components/action-button": "0.0.0-20241209155954",
|
|
94
|
+
"@spectrum-web-components/base": "0.0.0-20241209155954",
|
|
95
|
+
"@spectrum-web-components/divider": "0.0.0-20241209155954",
|
|
96
|
+
"@spectrum-web-components/icon": "0.0.0-20241209155954",
|
|
97
|
+
"@spectrum-web-components/icons-ui": "0.0.0-20241209155954",
|
|
98
|
+
"@spectrum-web-components/overlay": "0.0.0-20241209155954",
|
|
99
|
+
"@spectrum-web-components/popover": "0.0.0-20241209155954",
|
|
100
|
+
"@spectrum-web-components/reactive-controllers": "0.0.0-20241209155954",
|
|
101
|
+
"@spectrum-web-components/shared": "0.0.0-20241209155954"
|
|
102
|
+
},
|
|
103
|
+
"devDependencies": {
|
|
104
|
+
"@spectrum-css/menu": "^8.0.0-s2-foundations.16"
|
|
105
|
+
},
|
|
106
|
+
"types": "./src/index.d.ts",
|
|
107
|
+
"customElements": "custom-elements.json",
|
|
108
|
+
"sideEffects": [
|
|
109
|
+
"./sp-*.js",
|
|
110
|
+
"./**/*.dev.js"
|
|
111
|
+
]
|
|
112
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu-divider.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { MenuDivider } from './src/MenuDivider.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-divider', MenuDivider);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu-divider': MenuDivider;\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAWA,SAAS,mBAAmB;AAC5B,SAAS,qBAAqB;AAE9B,cAAc,mBAAmB,WAAW;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu-divider.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { MenuDivider } from './src/MenuDivider.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-divider', MenuDivider);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu-divider': MenuDivider;\n }\n}\n"],
|
|
5
|
+
"mappings": "aAWA,OAAS,eAAAA,MAAmB,uBAC5B,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,kBAAmBD,CAAW",
|
|
6
|
+
"names": ["MenuDivider", "defineElement"]
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu-group.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { MenuGroup } from './src/MenuGroup.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-group', MenuGroup);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu-group': MenuGroup;\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAWA,SAAS,iBAAiB;AAC1B,SAAS,qBAAqB;AAE9B,cAAc,iBAAiB,SAAS;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/sp-menu-group.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu-group.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { MenuGroup } from './src/MenuGroup.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-group', MenuGroup);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu-group': MenuGroup;\n }\n}\n"],
|
|
5
|
+
"mappings": "aAWA,OAAS,aAAAA,MAAiB,qBAC1B,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,gBAAiBD,CAAS",
|
|
6
|
+
"names": ["MenuGroup", "defineElement"]
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu-item.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { MenuItem } from './src/MenuItem.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-item', MenuItem);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu-item': MenuItem;\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAWA,SAAS,gBAAgB;AACzB,SAAS,qBAAqB;AAE9B,cAAc,gBAAgB,QAAQ;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/sp-menu-item.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu-item.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { MenuItem } from './src/MenuItem.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu-item', MenuItem);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu-item': MenuItem;\n }\n}\n"],
|
|
5
|
+
"mappings": "aAWA,OAAS,YAAAA,MAAgB,oBACzB,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,eAAgBD,CAAQ",
|
|
6
|
+
"names": ["MenuItem", "defineElement"]
|
|
7
|
+
}
|
package/sp-menu.d.ts
ADDED
package/sp-menu.dev.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { Menu } from './src/Menu.dev.js'\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu', Menu);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu': Menu;\n }\n}\n"],
|
|
5
|
+
"mappings": ";AAWA,SAAS,YAAY;AACrB,SAAS,qBAAqB;AAE9B,cAAc,WAAW,IAAI;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/sp-menu.js
ADDED
package/sp-menu.js.map
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["sp-menu.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { Menu } from './src/Menu.js';\nimport { defineElement } from '@spectrum-web-components/base/src/define-element.js';\n\ndefineElement('sp-menu', Menu);\n\ndeclare global {\n interface HTMLElementTagNameMap {\n 'sp-menu': Menu;\n }\n}\n"],
|
|
5
|
+
"mappings": "aAWA,OAAS,QAAAA,MAAY,gBACrB,OAAS,iBAAAC,MAAqB,sDAE9BA,EAAc,UAAWD,CAAI",
|
|
6
|
+
"names": ["Menu", "defineElement"]
|
|
7
|
+
}
|
package/src/Menu.d.ts
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { CSSResultArray, PropertyValues, SpectrumElement, TemplateResult } from '@spectrum-web-components/base';
|
|
2
|
+
import { MenuItem } from './MenuItem.js';
|
|
3
|
+
export interface MenuChildItem {
|
|
4
|
+
menuItem: MenuItem;
|
|
5
|
+
managed: boolean;
|
|
6
|
+
active: boolean;
|
|
7
|
+
focusable: boolean;
|
|
8
|
+
focusRoot: Menu;
|
|
9
|
+
}
|
|
10
|
+
declare const Menu_base: typeof SpectrumElement & {
|
|
11
|
+
new (...args: any[]): import("@spectrum-web-components/base").SizedElementInterface;
|
|
12
|
+
prototype: import("@spectrum-web-components/base").SizedElementInterface;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Spectrum Menu Component
|
|
16
|
+
* @element sp-menu
|
|
17
|
+
*
|
|
18
|
+
* @slot - menu items to be listed in the menu
|
|
19
|
+
* @fires change - Announces that the `value` of the element has changed
|
|
20
|
+
* @attr selects - whether the element has a specific selection algorithm that it applies
|
|
21
|
+
* to its item descendants. `single` allows only one descendent to be selected at a time.
|
|
22
|
+
* `multiple` allows many descendants to be selected. `inherit` will be applied dynamically
|
|
23
|
+
* when an ancestor of this element is actively managing the selection of its descendents.
|
|
24
|
+
* When the `selects` attribute is not present a `value` will not be maintained and the Menu
|
|
25
|
+
* Item children of this Menu will not have their `selected` state managed.
|
|
26
|
+
*/
|
|
27
|
+
export declare class Menu extends Menu_base {
|
|
28
|
+
static get styles(): CSSResultArray;
|
|
29
|
+
private get isSubmenu();
|
|
30
|
+
label: string;
|
|
31
|
+
ignore: boolean;
|
|
32
|
+
selects: undefined | 'inherit' | 'single' | 'multiple';
|
|
33
|
+
value: string;
|
|
34
|
+
valueSeparator: string;
|
|
35
|
+
get selected(): string[];
|
|
36
|
+
set selected(selected: string[]);
|
|
37
|
+
protected _selected: string[];
|
|
38
|
+
selectedItems: MenuItem[];
|
|
39
|
+
menuSlot: HTMLSlotElement;
|
|
40
|
+
private childItemSet;
|
|
41
|
+
focusedItemIndex: number;
|
|
42
|
+
focusInItemIndex: number;
|
|
43
|
+
private selectedItemsMap;
|
|
44
|
+
get childItems(): MenuItem[];
|
|
45
|
+
private cachedChildItems;
|
|
46
|
+
private updateCachedMenuItems;
|
|
47
|
+
/**
|
|
48
|
+
* Hide this getter from web-component-analyzer until
|
|
49
|
+
* https://github.com/runem/web-component-analyzer/issues/131
|
|
50
|
+
* has been addressed.
|
|
51
|
+
*
|
|
52
|
+
* @private
|
|
53
|
+
*/
|
|
54
|
+
get childRole(): string;
|
|
55
|
+
protected get ownRole(): string;
|
|
56
|
+
private resolvedSelects?;
|
|
57
|
+
private resolvedRole?;
|
|
58
|
+
/**
|
|
59
|
+
* When a descendant `<sp-menu-item>` element is added or updated it will dispatch
|
|
60
|
+
* this event to announce its presence in the DOM. During the CAPTURE phase the first
|
|
61
|
+
* Menu based element that the event encounters will manage the focus state of the
|
|
62
|
+
* dispatching `<sp-menu-item>` element.
|
|
63
|
+
* @param event
|
|
64
|
+
*/
|
|
65
|
+
private onFocusableItemAddedOrUpdated;
|
|
66
|
+
/**
|
|
67
|
+
* When a descendant `<sp-menu-item>` element is added or updated it will dispatch
|
|
68
|
+
* this event to announce its presence in the DOM. During the BUBBLE phase the first
|
|
69
|
+
* Menu based element that the event encounters that does not inherit selection will
|
|
70
|
+
* manage the selection state of the dispatching `<sp-menu-item>` element.
|
|
71
|
+
* @param event
|
|
72
|
+
*/
|
|
73
|
+
private onSelectableItemAddedOrUpdated;
|
|
74
|
+
private addChildItem;
|
|
75
|
+
private removeChildItem;
|
|
76
|
+
constructor();
|
|
77
|
+
focus({ preventScroll }?: FocusOptions): void;
|
|
78
|
+
private pointerUpTarget;
|
|
79
|
+
private handleClick;
|
|
80
|
+
private handlePointerup;
|
|
81
|
+
private handlePointerBasedSelection;
|
|
82
|
+
handleFocusin(event: FocusEvent): void;
|
|
83
|
+
startListeningToKeyboard(): void;
|
|
84
|
+
handleBlur(event: FocusEvent): void;
|
|
85
|
+
stopListeningToKeyboard(): void;
|
|
86
|
+
private descendentOverlays;
|
|
87
|
+
protected handleDescendentOverlayOpened(event: Event): void;
|
|
88
|
+
protected handleDescendentOverlayClosed(event: Event): void;
|
|
89
|
+
handleSubmenuClosed: (event: Event) => void;
|
|
90
|
+
handleSubmenuOpened: (event: Event) => void;
|
|
91
|
+
selectOrToggleItem(targetItem: MenuItem): Promise<void>;
|
|
92
|
+
protected navigateWithinMenu(event: KeyboardEvent): void;
|
|
93
|
+
protected navigateBetweenRelatedMenus(event: KeyboardEvent): void;
|
|
94
|
+
handleKeydown(event: KeyboardEvent): void;
|
|
95
|
+
focusMenuItemByOffset(offset: number): MenuItem;
|
|
96
|
+
private prepareToCleanUp;
|
|
97
|
+
private _hasUpdatedSelectedItemIndex;
|
|
98
|
+
updateSelectedItemIndex(): void;
|
|
99
|
+
private _willUpdateItems;
|
|
100
|
+
private handleItemsChanged;
|
|
101
|
+
private updateCache;
|
|
102
|
+
private updateItemFocus;
|
|
103
|
+
closeDescendentOverlays(): void;
|
|
104
|
+
private forwardFocusVisibleToItem;
|
|
105
|
+
private handleSlotchange;
|
|
106
|
+
protected renderMenuItemSlot(): TemplateResult;
|
|
107
|
+
render(): TemplateResult;
|
|
108
|
+
protected firstUpdated(changed: PropertyValues): void;
|
|
109
|
+
protected updated(changes: PropertyValues<this>): void;
|
|
110
|
+
protected selectsChanged(): void;
|
|
111
|
+
connectedCallback(): void;
|
|
112
|
+
disconnectedCallback(): void;
|
|
113
|
+
protected childItemsUpdated: Promise<unknown[]>;
|
|
114
|
+
protected cacheUpdated: Promise<void>;
|
|
115
|
+
protected resolveCacheUpdated: () => void;
|
|
116
|
+
protected getUpdateComplete(): Promise<boolean>;
|
|
117
|
+
}
|
|
118
|
+
export {};
|