@spectrum-web-components/contextual-help 1.2.0-beta.1 → 1.2.0-beta.2
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 +236 -0
- package/package.json +8 -8
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "sp-contextual-help.js",
|
|
8
|
+
"declarations": [],
|
|
9
|
+
"exports": [
|
|
10
|
+
{
|
|
11
|
+
"kind": "custom-element-definition",
|
|
12
|
+
"name": "sp-contextual-help",
|
|
13
|
+
"declaration": {
|
|
14
|
+
"name": "ContextualHelp",
|
|
15
|
+
"module": "/src/ContextualHelp.js"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"kind": "javascript-module",
|
|
22
|
+
"path": "src/ContextualHelp.js",
|
|
23
|
+
"declarations": [
|
|
24
|
+
{
|
|
25
|
+
"kind": "class",
|
|
26
|
+
"description": "Spectrum Contextual help provides additional information about\nthe state of either an adjacent component or an entire view.",
|
|
27
|
+
"name": "ContextualHelp",
|
|
28
|
+
"slots": [
|
|
29
|
+
{
|
|
30
|
+
"description": "content to display as the heading of the popover",
|
|
31
|
+
"name": "heading"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"description": "content to display in the popover",
|
|
35
|
+
"name": "Text"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"description": "link to additional informations",
|
|
39
|
+
"name": "link"
|
|
40
|
+
}
|
|
41
|
+
],
|
|
42
|
+
"members": [
|
|
43
|
+
{
|
|
44
|
+
"kind": "field",
|
|
45
|
+
"name": "isMobile",
|
|
46
|
+
"privacy": "public",
|
|
47
|
+
"default": "new MatchMediaController(this, IS_MOBILE)"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"kind": "field",
|
|
51
|
+
"name": "label",
|
|
52
|
+
"type": {
|
|
53
|
+
"text": "string | undefined"
|
|
54
|
+
},
|
|
55
|
+
"privacy": "public",
|
|
56
|
+
"description": "Provides an accessible name for the action button trigger.",
|
|
57
|
+
"parameters": [
|
|
58
|
+
{
|
|
59
|
+
"name": "label",
|
|
60
|
+
"type": {
|
|
61
|
+
"text": "String"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
],
|
|
65
|
+
"attribute": "label"
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"kind": "field",
|
|
69
|
+
"name": "variant",
|
|
70
|
+
"type": {
|
|
71
|
+
"text": "'info' | 'help'"
|
|
72
|
+
},
|
|
73
|
+
"privacy": "public",
|
|
74
|
+
"default": "'info'",
|
|
75
|
+
"description": "The `variant` property applies specific styling on the action button trigger.",
|
|
76
|
+
"parameters": [
|
|
77
|
+
{
|
|
78
|
+
"name": "variant",
|
|
79
|
+
"type": {
|
|
80
|
+
"text": "String"
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
],
|
|
84
|
+
"attribute": "variant"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"kind": "field",
|
|
88
|
+
"name": "placement",
|
|
89
|
+
"type": {
|
|
90
|
+
"text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
|
|
91
|
+
},
|
|
92
|
+
"privacy": "public",
|
|
93
|
+
"default": "'bottom-start'",
|
|
94
|
+
"attribute": "placement",
|
|
95
|
+
"reflects": true
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"kind": "field",
|
|
99
|
+
"name": "offset",
|
|
100
|
+
"type": {
|
|
101
|
+
"text": "number | [number, number]"
|
|
102
|
+
},
|
|
103
|
+
"privacy": "public",
|
|
104
|
+
"default": "0",
|
|
105
|
+
"description": "The `offset` property accepts either a single number, to\ndefine the offset of the Popover along the main axis from\nthe action button, or 2-tuple, to define the offset along the\nmain axis and the cross axis.",
|
|
106
|
+
"attribute": "offset"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"kind": "field",
|
|
110
|
+
"name": "open",
|
|
111
|
+
"type": {
|
|
112
|
+
"text": "boolean"
|
|
113
|
+
},
|
|
114
|
+
"default": "false",
|
|
115
|
+
"attribute": "open"
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"kind": "field",
|
|
119
|
+
"name": "buttonAriaLabel",
|
|
120
|
+
"type": {
|
|
121
|
+
"text": "string"
|
|
122
|
+
},
|
|
123
|
+
"privacy": "public",
|
|
124
|
+
"readonly": true
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"kind": "method",
|
|
128
|
+
"name": "renderOverlayContent",
|
|
129
|
+
"privacy": "private",
|
|
130
|
+
"return": {
|
|
131
|
+
"type": {
|
|
132
|
+
"text": "TemplateResult"
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"kind": "method",
|
|
138
|
+
"name": "handleSlottableRequest",
|
|
139
|
+
"privacy": "private",
|
|
140
|
+
"return": {
|
|
141
|
+
"type": {
|
|
142
|
+
"text": "void"
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"parameters": [
|
|
146
|
+
{
|
|
147
|
+
"name": "event",
|
|
148
|
+
"type": {
|
|
149
|
+
"text": "SlottableRequestEvent"
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
]
|
|
153
|
+
}
|
|
154
|
+
],
|
|
155
|
+
"attributes": [
|
|
156
|
+
{
|
|
157
|
+
"name": "placement",
|
|
158
|
+
"type": {
|
|
159
|
+
"text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
|
|
160
|
+
},
|
|
161
|
+
"default": "'bottom-start'",
|
|
162
|
+
"fieldName": "placement",
|
|
163
|
+
"attribute": "placement"
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "label",
|
|
167
|
+
"type": {
|
|
168
|
+
"text": "string | undefined"
|
|
169
|
+
},
|
|
170
|
+
"description": "Provides an accessible name for the action button trigger.",
|
|
171
|
+
"parameters": [
|
|
172
|
+
{
|
|
173
|
+
"name": "label",
|
|
174
|
+
"type": {
|
|
175
|
+
"text": "String"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
],
|
|
179
|
+
"fieldName": "label"
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"name": "variant",
|
|
183
|
+
"type": {
|
|
184
|
+
"text": "'info' | 'help'"
|
|
185
|
+
},
|
|
186
|
+
"default": "'info'",
|
|
187
|
+
"description": "The `variant` property applies specific styling on the action button trigger.",
|
|
188
|
+
"parameters": [
|
|
189
|
+
{
|
|
190
|
+
"name": "variant",
|
|
191
|
+
"type": {
|
|
192
|
+
"text": "String"
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
],
|
|
196
|
+
"fieldName": "variant"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "offset",
|
|
200
|
+
"type": {
|
|
201
|
+
"text": "number | [number, number]"
|
|
202
|
+
},
|
|
203
|
+
"default": "0",
|
|
204
|
+
"description": "The `offset` property accepts either a single number, to\ndefine the offset of the Popover along the main axis from\nthe action button, or 2-tuple, to define the offset along the\nmain axis and the cross axis.",
|
|
205
|
+
"fieldName": "offset"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"name": "open",
|
|
209
|
+
"type": {
|
|
210
|
+
"text": "boolean"
|
|
211
|
+
},
|
|
212
|
+
"default": "false",
|
|
213
|
+
"fieldName": "open"
|
|
214
|
+
}
|
|
215
|
+
],
|
|
216
|
+
"superclass": {
|
|
217
|
+
"name": "SpectrumElement",
|
|
218
|
+
"package": "@spectrum-web-components/base"
|
|
219
|
+
},
|
|
220
|
+
"tagName": "sp-contextual-help",
|
|
221
|
+
"customElement": true
|
|
222
|
+
}
|
|
223
|
+
],
|
|
224
|
+
"exports": [
|
|
225
|
+
{
|
|
226
|
+
"kind": "js",
|
|
227
|
+
"name": "ContextualHelp",
|
|
228
|
+
"declaration": {
|
|
229
|
+
"name": "ContextualHelp",
|
|
230
|
+
"module": "src/ContextualHelp.js"
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
]
|
|
234
|
+
}
|
|
235
|
+
]
|
|
236
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spectrum-web-components/contextual-help",
|
|
3
|
-
"version": "1.2.0-beta.
|
|
3
|
+
"version": "1.2.0-beta.2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -58,12 +58,12 @@
|
|
|
58
58
|
"lit-html"
|
|
59
59
|
],
|
|
60
60
|
"dependencies": {
|
|
61
|
-
"@spectrum-web-components/action-button": "^1.2.0-beta.
|
|
62
|
-
"@spectrum-web-components/base": "^1.2.0-beta.
|
|
63
|
-
"@spectrum-web-components/dialog": "^1.2.0-beta.
|
|
64
|
-
"@spectrum-web-components/icons-workflow": "^1.2.0-beta.
|
|
65
|
-
"@spectrum-web-components/overlay": "^1.2.0-beta.
|
|
66
|
-
"@spectrum-web-components/popover": "^1.2.0-beta.
|
|
61
|
+
"@spectrum-web-components/action-button": "^1.2.0-beta.2",
|
|
62
|
+
"@spectrum-web-components/base": "^1.2.0-beta.2",
|
|
63
|
+
"@spectrum-web-components/dialog": "^1.2.0-beta.2",
|
|
64
|
+
"@spectrum-web-components/icons-workflow": "^1.2.0-beta.2",
|
|
65
|
+
"@spectrum-web-components/overlay": "^1.2.0-beta.2",
|
|
66
|
+
"@spectrum-web-components/popover": "^1.2.0-beta.2"
|
|
67
67
|
},
|
|
68
68
|
"devDependencies": {
|
|
69
69
|
"@spectrum-css/contextualhelp": "4.0.0-s2-foundations.16"
|
|
@@ -75,5 +75,5 @@
|
|
|
75
75
|
"./**/*.dev.js",
|
|
76
76
|
"./**/*.dev.js"
|
|
77
77
|
],
|
|
78
|
-
"gitHead": "
|
|
78
|
+
"gitHead": "c0c67a3bdce0642f6a60d11a62fdcb6c1909ca62"
|
|
79
79
|
}
|