@aurodesignsystem-dev/auro-accordion 0.0.0-pr257.0 → 0.0.0-pr258.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/README.md +18 -18
- package/custom-elements.json +131 -47
- package/demo/api.md +121 -76
- package/demo/api.min.js +202 -77
- package/demo/index.md +9 -9
- package/demo/index.min.js +202 -77
- package/demo/readme.md +18 -18
- package/dist/auro-accordion-CMUr8BI0.js +142 -0
- package/dist/index.d.ts +192 -77
- package/dist/index.js +1 -1
- package/dist/registered.js +1 -1
- package/package.json +8 -9
- package/dist/auro-accordion-D7rNefWr.js +0 -121
package/README.md
CHANGED
|
@@ -12,29 +12,29 @@ The following sections are editable by making changes to the following files:
|
|
|
12
12
|
| SECTION | DESCRIPTION | FILE LOCATION |
|
|
13
13
|
|------------------------|---------------------------------------------------|-------------------------------------|
|
|
14
14
|
| Description | Description of the component | `./docs/partials/description.md` |
|
|
15
|
-
| Use
|
|
16
|
-
| Additional
|
|
17
|
-
| Component
|
|
15
|
+
| Use cases | Examples for when to use this component | `./docs/partials/useCases.md` |
|
|
16
|
+
| Additional information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
|
|
17
|
+
| Component example code | HTML sample code of the components use | `./apiExamples/basic.html` |
|
|
18
18
|
-->
|
|
19
19
|
|
|
20
20
|
# Accordion
|
|
21
21
|
|
|
22
22
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
|
|
23
23
|
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
24
|
-
|
|
24
|
+
An [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) that shows or hides a large section of content when someone selects a smaller trigger.
|
|
25
25
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
26
26
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
27
27
|
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
28
28
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
29
29
|
|
|
30
|
-
## Use
|
|
30
|
+
## Use cases
|
|
31
31
|
|
|
32
32
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
33
33
|
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
34
|
-
|
|
34
|
+
Use `<auro-accordion>` when people need to:
|
|
35
35
|
|
|
36
|
-
-
|
|
37
|
-
-
|
|
36
|
+
- Show or hide a long section of content from a short headline.
|
|
37
|
+
- Keep long, in-page content out of the way when its length would distract from the main experience.
|
|
38
38
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
39
39
|
|
|
40
40
|
## Install
|
|
@@ -49,10 +49,10 @@ The `<auro-accordion>` element should be used in situations where users may:
|
|
|
49
49
|
|
|
50
50
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
51
51
|
|
|
52
|
-
### Define
|
|
52
|
+
### Define dependency in project
|
|
53
53
|
|
|
54
54
|
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
|
|
55
|
-
|
|
55
|
+
Import the component in each project that uses `<auro-accordion>`.
|
|
56
56
|
|
|
57
57
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
58
58
|
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
|
|
@@ -64,13 +64,13 @@ Defining the dependency within each project that is using the `<auro-accordion>`
|
|
|
64
64
|
### Use CDN
|
|
65
65
|
|
|
66
66
|
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
|
|
67
|
-
|
|
67
|
+
If your project can't process JS assets, use the pre-processed assets. Legacy browsers, such as IE11, aren't supported.
|
|
68
68
|
|
|
69
69
|
<pre class="language-html"><code class="language-html"><script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/+esm"></script></code></pre>
|
|
70
70
|
|
|
71
71
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
72
72
|
|
|
73
|
-
## Basic
|
|
73
|
+
## Basic example
|
|
74
74
|
|
|
75
75
|
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
|
|
76
76
|
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
|
|
@@ -92,16 +92,16 @@ In cases where the project is not able to process JS assets, there are pre-proce
|
|
|
92
92
|
</auro-accordion></code></pre>
|
|
93
93
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
94
94
|
|
|
95
|
-
## Custom
|
|
95
|
+
## Custom component registration for version management
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
Every Auro component has two key parts: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition.
|
|
98
98
|
The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
|
|
99
99
|
|
|
100
|
-
|
|
100
|
+
Installing the component as described in the Install section imports the class and registers the component globally for you.
|
|
101
101
|
|
|
102
|
-
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions),
|
|
102
|
+
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), register the class manually under a custom element name to avoid conflicts.
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
To do this, import only the component class and call the `register(name)` method with a unique name:
|
|
105
105
|
|
|
106
106
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
|
|
107
107
|
<!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
|
|
@@ -112,7 +112,7 @@ import { AuroAccordion, AuroAccordionGroup } from '@aurodesignsystem/auro-accord
|
|
|
112
112
|
AuroAccordion.register('custom-accordion');
|
|
113
113
|
AuroAccordionGroup.register('custom-accordion-group');</code></pre>
|
|
114
114
|
|
|
115
|
-
This
|
|
115
|
+
This creates the custom elements `<custom-accordion>` and `<custom-accordion-group>`, which behave exactly like `<auro-accordion>` and `<auro-accordion-group>`, allowing both sets of components to coexist on the same page without interfering with each other.
|
|
116
116
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
117
117
|
<div class="exampleWrapper exampleWrapper--flex">
|
|
118
118
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./apiExamples/custom.html) -->
|
package/custom-elements.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"declarations": [
|
|
9
9
|
{
|
|
10
10
|
"kind": "class",
|
|
11
|
-
"description": "
|
|
11
|
+
"description": "The button that expands and collapses an accordion.",
|
|
12
12
|
"name": "AuroAccordionButton",
|
|
13
13
|
"members": [
|
|
14
14
|
{
|
|
@@ -30,14 +30,14 @@
|
|
|
30
30
|
{
|
|
31
31
|
"name": "name",
|
|
32
32
|
"default": "\"auro-accordion-button\"",
|
|
33
|
-
"description": "The name
|
|
33
|
+
"description": "The tag name to register the element under.",
|
|
34
34
|
"optional": true,
|
|
35
35
|
"type": {
|
|
36
36
|
"text": "string"
|
|
37
37
|
}
|
|
38
38
|
}
|
|
39
39
|
],
|
|
40
|
-
"description": "
|
|
40
|
+
"description": "Registers the element with the browser under a tag name."
|
|
41
41
|
}
|
|
42
42
|
],
|
|
43
43
|
"attributes": [
|
|
@@ -73,8 +73,14 @@
|
|
|
73
73
|
"declarations": [
|
|
74
74
|
{
|
|
75
75
|
"kind": "class",
|
|
76
|
-
"description": "
|
|
76
|
+
"description": "Groups accordions so that opening one closes the others.\n\n**Key capabilities:**\n- **Several open at once**: Set `noToggleExpanded` to let more than one accordion stay open.\n- **Disable all**: Set `disabled` to turn off every accordion in the group.\n- **Emphasis**: Set `emphasis` to add the emphasis border to every accordion and move each chevron to the right.\n- **Trigger size**: Set `variant` to `sm`, `lg`, or `min` to size every trigger.\n\n**Example:**\n```html\n<auro-accordion-group>\n <auro-accordion>\n <span slot=\"trigger\">Trigger</span>\n <p>Content</p>\n </auro-accordion>\n</auro-accordion-group>\n```",
|
|
77
77
|
"name": "AuroAccordionGroup",
|
|
78
|
+
"slots": [
|
|
79
|
+
{
|
|
80
|
+
"description": "The `auro-accordion` elements to group.",
|
|
81
|
+
"name": ""
|
|
82
|
+
}
|
|
83
|
+
],
|
|
78
84
|
"members": [
|
|
79
85
|
{
|
|
80
86
|
"kind": "field",
|
|
@@ -83,7 +89,7 @@
|
|
|
83
89
|
"type": {
|
|
84
90
|
"text": "boolean"
|
|
85
91
|
},
|
|
86
|
-
"description": "
|
|
92
|
+
"description": "Turns off every accordion in the group. Disabled triggers are shown in a muted color and can't be selected.",
|
|
87
93
|
"attribute": "disabled",
|
|
88
94
|
"reflects": true
|
|
89
95
|
},
|
|
@@ -94,19 +100,21 @@
|
|
|
94
100
|
"type": {
|
|
95
101
|
"text": "boolean"
|
|
96
102
|
},
|
|
97
|
-
"description": "
|
|
103
|
+
"description": "Adds the emphasis border to every accordion in the group and moves each chevron to the right.",
|
|
98
104
|
"attribute": "emphasis",
|
|
99
105
|
"reflects": true
|
|
100
106
|
},
|
|
101
107
|
{
|
|
102
108
|
"kind": "method",
|
|
103
109
|
"name": "handleItems",
|
|
104
|
-
"description": "
|
|
110
|
+
"description": "Gets the accordions in the group and stores them in `items`.",
|
|
105
111
|
"privacy": "private"
|
|
106
112
|
},
|
|
107
113
|
{
|
|
108
114
|
"kind": "method",
|
|
109
|
-
"name": "handleSlotContentChange"
|
|
115
|
+
"name": "handleSlotContentChange",
|
|
116
|
+
"description": "Called when the slotted accordions change. Applies the group's emphasis and variant settings to each accordion and marks each as grouped.",
|
|
117
|
+
"privacy": "private"
|
|
110
118
|
},
|
|
111
119
|
{
|
|
112
120
|
"kind": "method",
|
|
@@ -114,15 +122,27 @@
|
|
|
114
122
|
"parameters": [
|
|
115
123
|
{
|
|
116
124
|
"name": "event",
|
|
117
|
-
"description": "
|
|
125
|
+
"description": "The `toggleExpanded` event.",
|
|
118
126
|
"type": {
|
|
119
127
|
"text": "object"
|
|
120
128
|
}
|
|
121
129
|
}
|
|
122
130
|
],
|
|
123
|
-
"description": "
|
|
131
|
+
"description": "Called when an accordion in the group expands or collapses. Closes the other accordions unless `noToggleExpanded` is set, then scrolls the group into view if it's out of view.",
|
|
124
132
|
"privacy": "private"
|
|
125
133
|
},
|
|
134
|
+
{
|
|
135
|
+
"kind": "field",
|
|
136
|
+
"name": "noToggleExpanded",
|
|
137
|
+
"privacy": "public",
|
|
138
|
+
"type": {
|
|
139
|
+
"text": "boolean"
|
|
140
|
+
},
|
|
141
|
+
"description": "Lets several accordions in the group stay open at the same time. By default, opening one accordion closes the others.",
|
|
142
|
+
"default": "false",
|
|
143
|
+
"attribute": "notoggleexpanded",
|
|
144
|
+
"reflects": true
|
|
145
|
+
},
|
|
126
146
|
{
|
|
127
147
|
"kind": "method",
|
|
128
148
|
"name": "register",
|
|
@@ -131,14 +151,14 @@
|
|
|
131
151
|
{
|
|
132
152
|
"name": "name",
|
|
133
153
|
"default": "\"auro-accordion-group\"",
|
|
134
|
-
"description": "The name
|
|
154
|
+
"description": "The tag name to register the element under.",
|
|
135
155
|
"optional": true,
|
|
136
156
|
"type": {
|
|
137
157
|
"text": "string"
|
|
138
158
|
}
|
|
139
159
|
}
|
|
140
160
|
],
|
|
141
|
-
"description": "
|
|
161
|
+
"description": "Registers the element with the browser under a tag name. Register the group as the accordion's tag name plus `-group`, so the group can find its accordions."
|
|
142
162
|
},
|
|
143
163
|
{
|
|
144
164
|
"kind": "field",
|
|
@@ -152,6 +172,28 @@
|
|
|
152
172
|
"description": "Updates the disabled state of all child `<auro-accordion>` elements\nto match the disabled state of the `<auro-accordion-group>` element.",
|
|
153
173
|
"privacy": "private"
|
|
154
174
|
},
|
|
175
|
+
{
|
|
176
|
+
"kind": "method",
|
|
177
|
+
"name": "updateEmphasisState",
|
|
178
|
+
"parameters": [
|
|
179
|
+
{
|
|
180
|
+
"name": "previous",
|
|
181
|
+
"description": "The previous value of `emphasis`.",
|
|
182
|
+
"optional": true,
|
|
183
|
+
"type": {
|
|
184
|
+
"text": "boolean"
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
],
|
|
188
|
+
"description": "Applies or removes the emphasis styles on all child `<auro-accordion>` elements\nto match the emphasis state of the `<auro-accordion-group>` element.",
|
|
189
|
+
"privacy": "private"
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"kind": "method",
|
|
193
|
+
"name": "updateVariantState",
|
|
194
|
+
"description": "Updates the variant of all child `<auro-accordion>` elements\nto match the variant of the `<auro-accordion-group>` element.",
|
|
195
|
+
"privacy": "private"
|
|
196
|
+
},
|
|
155
197
|
{
|
|
156
198
|
"kind": "field",
|
|
157
199
|
"name": "variant",
|
|
@@ -159,7 +201,7 @@
|
|
|
159
201
|
"type": {
|
|
160
202
|
"text": "'sm' | 'lg' | 'min'"
|
|
161
203
|
},
|
|
162
|
-
"description": "Sets the
|
|
204
|
+
"description": "Sets the trigger size for every accordion in the group. Use `sm` for smaller triggers, `lg` for larger ones, or `min` to remove all trigger padding so the slotted content sets each size.",
|
|
163
205
|
"attribute": "variant",
|
|
164
206
|
"reflects": true
|
|
165
207
|
}
|
|
@@ -170,7 +212,7 @@
|
|
|
170
212
|
"type": {
|
|
171
213
|
"text": "boolean"
|
|
172
214
|
},
|
|
173
|
-
"description": "
|
|
215
|
+
"description": "Turns off every accordion in the group. Disabled triggers are shown in a muted color and can't be selected.",
|
|
174
216
|
"fieldName": "disabled"
|
|
175
217
|
},
|
|
176
218
|
{
|
|
@@ -178,15 +220,24 @@
|
|
|
178
220
|
"type": {
|
|
179
221
|
"text": "boolean"
|
|
180
222
|
},
|
|
181
|
-
"description": "
|
|
223
|
+
"description": "Adds the emphasis border to every accordion in the group and moves each chevron to the right.",
|
|
182
224
|
"fieldName": "emphasis"
|
|
183
225
|
},
|
|
226
|
+
{
|
|
227
|
+
"name": "notoggleexpanded",
|
|
228
|
+
"type": {
|
|
229
|
+
"text": "boolean"
|
|
230
|
+
},
|
|
231
|
+
"description": "Lets several accordions in the group stay open at the same time. By default, opening one accordion closes the others.",
|
|
232
|
+
"default": "false",
|
|
233
|
+
"fieldName": "noToggleExpanded"
|
|
234
|
+
},
|
|
184
235
|
{
|
|
185
236
|
"name": "variant",
|
|
186
237
|
"type": {
|
|
187
238
|
"text": "'sm' | 'lg' | 'min'"
|
|
188
239
|
},
|
|
189
|
-
"description": "Sets the
|
|
240
|
+
"description": "Sets the trigger size for every accordion in the group. Use `sm` for smaller triggers, `lg` for larger ones, or `min` to remove all trigger padding so the slotted content sets each size.",
|
|
190
241
|
"fieldName": "variant"
|
|
191
242
|
}
|
|
192
243
|
],
|
|
@@ -195,7 +246,8 @@
|
|
|
195
246
|
"package": "lit"
|
|
196
247
|
},
|
|
197
248
|
"tagName": "auro-accordion-group",
|
|
198
|
-
"customElement": true
|
|
249
|
+
"customElement": true,
|
|
250
|
+
"summary": "A wrapper that closes other accordions when one opens and shares size, emphasis, and disabled settings."
|
|
199
251
|
}
|
|
200
252
|
],
|
|
201
253
|
"exports": [
|
|
@@ -215,33 +267,63 @@
|
|
|
215
267
|
"declarations": [
|
|
216
268
|
{
|
|
217
269
|
"kind": "class",
|
|
218
|
-
"description": "
|
|
270
|
+
"description": "An accordion that shows or hides a section of content when someone selects its trigger.\n\n**Key capabilities:**\n- **Chevron placement**: Use `chevron=\"right\"` to move the chevron to the right end of the trigger or `chevron=\"none\"` to hide it.\n- **Trigger size**: Set `variant` to `sm`, `lg`, or `min` to change the trigger size.\n- **Expand upward**: Set `expandUp` to reveal the content above the trigger.\n- **Grouping**: Wrap accordions in `auro-accordion-group` so opening one closes the others.\n\n**Example:**\n```html\n<auro-accordion>\n <span slot=\"trigger\">Trigger</span>\n <p>Content</p>\n</auro-accordion>\n```",
|
|
219
271
|
"name": "AuroAccordion",
|
|
272
|
+
"cssProperties": [
|
|
273
|
+
{
|
|
274
|
+
"description": "Color of the left border beside the expanded content. Applies only when `emphasis` is set.",
|
|
275
|
+
"name": "--ds-auro-accordion-content-border-color"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"description": "Color of the divider below each accordion in a group. Applies only inside `auro-accordion-group`.",
|
|
279
|
+
"name": "--ds-auro-accordion-group-border-color"
|
|
280
|
+
},
|
|
281
|
+
{
|
|
282
|
+
"description": "Color of the trigger's border, including the ring shown when the trigger has keyboard focus.",
|
|
283
|
+
"name": "--ds-auro-accordion-trigger-border-color"
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
"description": "Color of the trigger text.",
|
|
287
|
+
"name": "--ds-auro-accordion-trigger-color"
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"description": "Color of the chevron icon.",
|
|
291
|
+
"name": "--ds-auro-accordion-trigger-icon-color"
|
|
292
|
+
}
|
|
293
|
+
],
|
|
220
294
|
"cssParts": [
|
|
221
295
|
{
|
|
222
|
-
"description": "
|
|
296
|
+
"description": "The wrapper around the trigger and the content.",
|
|
223
297
|
"name": "accordion"
|
|
224
298
|
},
|
|
225
299
|
{
|
|
226
|
-
"description": "
|
|
300
|
+
"description": "The chevron icon in the trigger. Doesn't exist when `chevron=\"none\"`.",
|
|
227
301
|
"name": "chevron"
|
|
228
302
|
},
|
|
229
303
|
{
|
|
230
|
-
"description": "
|
|
304
|
+
"description": "The container that holds the expanded content.",
|
|
231
305
|
"name": "content"
|
|
232
306
|
},
|
|
233
307
|
{
|
|
234
|
-
"description": "
|
|
308
|
+
"description": "The inner container around the expanded content that sets its padding.",
|
|
309
|
+
"name": "contentWrapper"
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"description": "The button that expands and collapses the accordion.",
|
|
235
313
|
"name": "trigger"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"description": "The element that holds the content slotted into `trigger`.",
|
|
317
|
+
"name": "triggerSlot"
|
|
236
318
|
}
|
|
237
319
|
],
|
|
238
320
|
"slots": [
|
|
239
321
|
{
|
|
240
|
-
"description": "
|
|
322
|
+
"description": "The content revealed when the accordion expands.",
|
|
241
323
|
"name": ""
|
|
242
324
|
},
|
|
243
325
|
{
|
|
244
|
-
"description": "
|
|
326
|
+
"description": "The text or content shown in the trigger, such as a short heading. Use presentational content only, because the trigger is a native `<button>`.",
|
|
245
327
|
"name": "trigger"
|
|
246
328
|
}
|
|
247
329
|
],
|
|
@@ -253,7 +335,7 @@
|
|
|
253
335
|
"type": {
|
|
254
336
|
"text": "boolean"
|
|
255
337
|
},
|
|
256
|
-
"description": "
|
|
338
|
+
"description": "Aligns the trigger to the right edge of the accordion's container.",
|
|
257
339
|
"attribute": "alignright",
|
|
258
340
|
"reflects": true
|
|
259
341
|
},
|
|
@@ -274,7 +356,7 @@
|
|
|
274
356
|
"type": {
|
|
275
357
|
"text": "'none' | 'right'"
|
|
276
358
|
},
|
|
277
|
-
"description": "Sets chevron
|
|
359
|
+
"description": "Sets where the chevron appears. Use `right` to place it at the right end of the trigger, or `none` to hide it. When not set, the chevron appears before the trigger text.",
|
|
278
360
|
"attribute": "chevron",
|
|
279
361
|
"reflects": true
|
|
280
362
|
},
|
|
@@ -285,7 +367,7 @@
|
|
|
285
367
|
"type": {
|
|
286
368
|
"text": "boolean"
|
|
287
369
|
},
|
|
288
|
-
"description": "
|
|
370
|
+
"description": "Turns the accordion off. A disabled trigger is shown in a muted color and can't be selected to expand or collapse the content. Calling `toggle()` or setting `expanded` still works.",
|
|
289
371
|
"attribute": "disabled",
|
|
290
372
|
"reflects": true
|
|
291
373
|
},
|
|
@@ -296,7 +378,7 @@
|
|
|
296
378
|
"type": {
|
|
297
379
|
"text": "boolean"
|
|
298
380
|
},
|
|
299
|
-
"description": "
|
|
381
|
+
"description": "Adds a highlighted left border to the trigger and the expanded content. Set `emphasis` on `auro-accordion-group` instead to also move each chevron to the right.",
|
|
300
382
|
"attribute": "emphasis",
|
|
301
383
|
"reflects": true
|
|
302
384
|
},
|
|
@@ -307,7 +389,7 @@
|
|
|
307
389
|
"type": {
|
|
308
390
|
"text": "boolean"
|
|
309
391
|
},
|
|
310
|
-
"description": "
|
|
392
|
+
"description": "Expands the accordion to show its content.",
|
|
311
393
|
"default": "false",
|
|
312
394
|
"attribute": "expanded",
|
|
313
395
|
"reflects": true
|
|
@@ -319,7 +401,7 @@
|
|
|
319
401
|
"type": {
|
|
320
402
|
"text": "boolean"
|
|
321
403
|
},
|
|
322
|
-
"description": "
|
|
404
|
+
"description": "Reveals the expanded content above the trigger instead of below it.",
|
|
323
405
|
"attribute": "expandup",
|
|
324
406
|
"reflects": true
|
|
325
407
|
},
|
|
@@ -355,7 +437,7 @@
|
|
|
355
437
|
"type": {
|
|
356
438
|
"text": "boolean"
|
|
357
439
|
},
|
|
358
|
-
"description": "
|
|
440
|
+
"description": "Marks the accordion as part of a group and adds a divider below it. The group sets this automatically.",
|
|
359
441
|
"attribute": "grouped",
|
|
360
442
|
"reflects": true
|
|
361
443
|
},
|
|
@@ -387,14 +469,14 @@
|
|
|
387
469
|
{
|
|
388
470
|
"name": "name",
|
|
389
471
|
"default": "\"auro-accordion\"",
|
|
390
|
-
"description": "The name
|
|
472
|
+
"description": "The tag name to register the element under.",
|
|
391
473
|
"optional": true,
|
|
392
474
|
"type": {
|
|
393
475
|
"text": "string"
|
|
394
476
|
}
|
|
395
477
|
}
|
|
396
478
|
],
|
|
397
|
-
"description": "
|
|
479
|
+
"description": "Registers the element with the browser under a tag name. Also registers the group element as that name plus `-group`."
|
|
398
480
|
},
|
|
399
481
|
{
|
|
400
482
|
"kind": "method",
|
|
@@ -426,7 +508,7 @@
|
|
|
426
508
|
{
|
|
427
509
|
"kind": "method",
|
|
428
510
|
"name": "toggle",
|
|
429
|
-
"description": "
|
|
511
|
+
"description": "Expands the accordion if it's collapsed, or collapses it if it's expanded, and fires `toggleExpanded`. Works even when the accordion is disabled."
|
|
430
512
|
},
|
|
431
513
|
{
|
|
432
514
|
"kind": "field",
|
|
@@ -435,7 +517,7 @@
|
|
|
435
517
|
"type": {
|
|
436
518
|
"text": "'sm' | 'lg' | 'min'"
|
|
437
519
|
},
|
|
438
|
-
"description": "Sets
|
|
520
|
+
"description": "Sets the size of the trigger. Use `sm` for a smaller trigger, `lg` for a larger one, or `min` to remove all trigger padding so the slotted content sets the size, ideally with `chevron=\"none\"`. Omit it for the default, medium size.",
|
|
439
521
|
"attribute": "variant",
|
|
440
522
|
"reflects": true
|
|
441
523
|
}
|
|
@@ -446,7 +528,7 @@
|
|
|
446
528
|
"type": {
|
|
447
529
|
"text": "CustomEvent"
|
|
448
530
|
},
|
|
449
|
-
"description": "
|
|
531
|
+
"description": "Fires when someone expands or collapses the accordion, or when `toggle()` is called. Doesn't fire when `expanded` is set directly. `detail.expanded` holds the new state."
|
|
450
532
|
}
|
|
451
533
|
],
|
|
452
534
|
"attributes": [
|
|
@@ -455,7 +537,7 @@
|
|
|
455
537
|
"type": {
|
|
456
538
|
"text": "boolean"
|
|
457
539
|
},
|
|
458
|
-
"description": "
|
|
540
|
+
"description": "Aligns the trigger to the right edge of the accordion's container.",
|
|
459
541
|
"fieldName": "alignRight"
|
|
460
542
|
},
|
|
461
543
|
{
|
|
@@ -463,7 +545,7 @@
|
|
|
463
545
|
"type": {
|
|
464
546
|
"text": "'none' | 'right'"
|
|
465
547
|
},
|
|
466
|
-
"description": "Sets chevron
|
|
548
|
+
"description": "Sets where the chevron appears. Use `right` to place it at the right end of the trigger, or `none` to hide it. When not set, the chevron appears before the trigger text.",
|
|
467
549
|
"fieldName": "chevron"
|
|
468
550
|
},
|
|
469
551
|
{
|
|
@@ -471,7 +553,7 @@
|
|
|
471
553
|
"type": {
|
|
472
554
|
"text": "boolean"
|
|
473
555
|
},
|
|
474
|
-
"description": "
|
|
556
|
+
"description": "Turns the accordion off. A disabled trigger is shown in a muted color and can't be selected to expand or collapse the content. Calling `toggle()` or setting `expanded` still works.",
|
|
475
557
|
"fieldName": "disabled"
|
|
476
558
|
},
|
|
477
559
|
{
|
|
@@ -479,7 +561,7 @@
|
|
|
479
561
|
"type": {
|
|
480
562
|
"text": "boolean"
|
|
481
563
|
},
|
|
482
|
-
"description": "
|
|
564
|
+
"description": "Adds a highlighted left border to the trigger and the expanded content. Set `emphasis` on `auro-accordion-group` instead to also move each chevron to the right.",
|
|
483
565
|
"fieldName": "emphasis"
|
|
484
566
|
},
|
|
485
567
|
{
|
|
@@ -487,7 +569,7 @@
|
|
|
487
569
|
"type": {
|
|
488
570
|
"text": "boolean"
|
|
489
571
|
},
|
|
490
|
-
"description": "
|
|
572
|
+
"description": "Expands the accordion to show its content.",
|
|
491
573
|
"default": "false",
|
|
492
574
|
"fieldName": "expanded"
|
|
493
575
|
},
|
|
@@ -496,7 +578,7 @@
|
|
|
496
578
|
"type": {
|
|
497
579
|
"text": "boolean"
|
|
498
580
|
},
|
|
499
|
-
"description": "
|
|
581
|
+
"description": "Reveals the expanded content above the trigger instead of below it.",
|
|
500
582
|
"fieldName": "expandUp"
|
|
501
583
|
},
|
|
502
584
|
{
|
|
@@ -504,7 +586,7 @@
|
|
|
504
586
|
"type": {
|
|
505
587
|
"text": "boolean"
|
|
506
588
|
},
|
|
507
|
-
"description": "
|
|
589
|
+
"description": "Marks the accordion as part of a group and adds a divider below it. The group sets this automatically.",
|
|
508
590
|
"fieldName": "grouped"
|
|
509
591
|
},
|
|
510
592
|
{
|
|
@@ -512,7 +594,7 @@
|
|
|
512
594
|
"type": {
|
|
513
595
|
"text": "'sm' | 'lg' | 'min'"
|
|
514
596
|
},
|
|
515
|
-
"description": "Sets
|
|
597
|
+
"description": "Sets the size of the trigger. Use `sm` for a smaller trigger, `lg` for a larger one, or `min` to remove all trigger padding so the slotted content sets the size, ideally with `chevron=\"none\"`. Omit it for the default, medium size.",
|
|
516
598
|
"fieldName": "variant"
|
|
517
599
|
}
|
|
518
600
|
],
|
|
@@ -521,7 +603,8 @@
|
|
|
521
603
|
"package": "lit"
|
|
522
604
|
},
|
|
523
605
|
"tagName": "auro-accordion",
|
|
524
|
-
"customElement": true
|
|
606
|
+
"customElement": true,
|
|
607
|
+
"summary": "An accessible accordion with chevron, size, and expand-up options."
|
|
525
608
|
}
|
|
526
609
|
],
|
|
527
610
|
"exports": [
|
|
@@ -544,7 +627,7 @@
|
|
|
544
627
|
"kind": "js",
|
|
545
628
|
"name": "default",
|
|
546
629
|
"declaration": {
|
|
547
|
-
"name": "9.2.
|
|
630
|
+
"name": "9.2.1",
|
|
548
631
|
"module": "src/iconVersion.js"
|
|
549
632
|
}
|
|
550
633
|
}
|
|
@@ -579,5 +662,6 @@
|
|
|
579
662
|
"declarations": [],
|
|
580
663
|
"exports": []
|
|
581
664
|
}
|
|
582
|
-
]
|
|
665
|
+
],
|
|
666
|
+
"package": "@aurodesignsystem-dev/auro-accordion@0.0.0-pr258.1"
|
|
583
667
|
}
|