@aurodesignsystem-dev/auro-accordion 0.0.0-pr200.1 → 0.0.0-pr205.0

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/demo/api.md CHANGED
@@ -6,45 +6,46 @@
6
6
  Auro-accordion provides users a way to have collapsible content on a page.
7
7
  Use auro-accordion-group if you want to have auto closing accordion components when others are selected.
8
8
 
9
- ## Properties
9
+ ### Properties & Attributes
10
10
 
11
- | Property | Attribute | Type | Default | Description |
12
- |--------------|--------------|-----------|---------|--------------------------------------------------|
13
- | [alignRight](#alignRight) | `alignRight` | `Boolean` | | If set, the trigger content will align right. |
14
- | [chevron](#chevron) | `chevron` | `String` | | Sets chevron variant option. Possible values are: `none`, `right`. |
15
- | [disabled](#disabled) | `disabled` | `Boolean` | | If set, the accordion is disabled and have reduced opacity. |
16
- | [emphasis](#emphasis) | `emphasis` | `Boolean` | | If set, emphasis styles will be applied to the auro-accordions. |
17
- | [expanded](#expanded) | `expanded` | `Boolean` | false | If set, the accordion is expanded. |
18
- | [grouped](#grouped) | `grouped` | `Boolean` | | Attribute will be set on accordion when it appears in an accordion group. |
19
- | [variant](#variant) | `variant` | `String` | | Sets accordion variant option. Possible values are: `sm`, `lg`. |
20
-
21
- ## Methods
22
-
23
- | Method | Type | Description |
24
- |----------|------------|--------------------------------------------------|
25
- | [toggle](#toggle) | `(): void` | Toggles the visibility of the accordion content. |
26
-
27
- ## Events
28
-
29
- | Event | Type | Description |
30
- |------------------|---------------------------------------|--------------------------------------------------|
31
- | [toggleExpanded](#toggleExpanded) | `CustomEvent<{ expanded: boolean; }>` | Notifies that the accordion has been expanded or closed. |
11
+ | Properties | Attributes | Type | Default | Description |
12
+ | --- | --- | --- | --- | --- |
13
+ expanded | expanded | boolean | false | If set, the accordion is expanded.
14
+ alignRight | alignRight | boolean | | If set, the trigger content will align right.
15
+ emphasis | emphasis | boolean | | If set, emphasis styles will be applied to the auro-accordions.
16
+ grouped | grouped | boolean | | Attribute will be set on accordion when it appears in an accordion group.
17
+ chevron | chevron | string | | Sets chevron variant option. Possible values are: `none`, `right`.
18
+ variant | variant | string | | Sets accordion variant option. Possible values are: `sm`, `lg`.
19
+ disabled | disabled | boolean | | If set, the accordion is disabled and have reduced opacity.
20
+
21
+ ### Methods
32
22
 
33
- ## Slots
23
+ | Name | Parameters | Return | Description |
24
+ | --- | --- | --- | --- |
25
+ register | `name` (string) - The name of element that you want to register to. | | This will register this element with the browser.
26
+ toggle | None | | Toggles the visibility of the accordion content.
27
+
28
+ ### Events
34
29
 
35
- | Name | Description |
36
- |-----------|---------------------------------------------|
37
- | | Default slot for the accordion content. |
38
- | [trigger](#trigger) | Defines the content of the trigger element. |
30
+ | Name | Description |
31
+ | --- | --- |
32
+ toggleExpanded | Notifies that the accordion has been expanded or closed.
33
+
34
+ ### Slots
39
35
 
40
- ## CSS Shadow Parts
36
+ | Name | Description |
37
+ | --- | --- |
38
+ (default) | Default slot for the accordion content.
39
+ trigger | Defines the content of the trigger element.
40
+
41
+ ### CSS Shadow Parts
41
42
 
42
- | Part | Description |
43
- |-------------|-------------------------------------|
44
- | [accordion](#accordion) | Apply CSS to Accordion wrapper. |
45
- | [chevron](#chevron) | Apply CSS to chevron icon. |
46
- | [content](#content) | Apply CSS to the accordion content. |
47
- | [trigger](#trigger) | Apply CSS to trigger element. |
43
+ | Name | Description |
44
+ | --- | --- |
45
+ accordion | Apply CSS to Accordion wrapper.
46
+ trigger | Apply CSS to trigger element.
47
+ chevron | Apply CSS to chevron icon.
48
+ content | Apply CSS to the accordion content.
48
49
  <!-- AURO-GENERATED-CONTENT:END -->
49
50
 
50
51
  ## Accordion API Examples