@aurodesignsystem/auro-dialog 2.2.0 → 2.3.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/CHANGELOG.md +19 -0
- package/README.md +12 -12
- package/demo/api.md +32 -32
- package/demo/api.min.js +1197 -54
- package/demo/index.md +14 -14
- package/demo/index.min.js +1192 -49
- package/dist/auro-dialog__bundled.js +260 -10
- package/package.json +2 -2
package/demo/index.md
CHANGED
|
@@ -6,8 +6,8 @@ This file is generated based on a template fetched from `./docs/partials/index.m
|
|
|
6
6
|
|
|
7
7
|
# Dialog
|
|
8
8
|
|
|
9
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src
|
|
10
|
-
<!-- The below content is automatically added from
|
|
9
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
|
|
10
|
+
<!-- The below content is automatically added from ./../docs/partials/description.md -->
|
|
11
11
|
The `<auro-dialog>` component is an intrusive interactive component, not passive. The component is best used when there is a requirement the user be made aware of the content being shown, moving focus from the main content to the dialog content.
|
|
12
12
|
|
|
13
13
|
The component also supports a modal (blocking) state where the user must interact with the content of the component in order to continue. Passive dismissal of the content is not allowed. Users of this state must add a trigger for the user to move beyond this content.
|
|
@@ -17,8 +17,8 @@ Auro holds the opinions of the [Nielsen Norman Group](https://www.nngroup.com/ar
|
|
|
17
17
|
|
|
18
18
|
## auro-dialog use cases
|
|
19
19
|
|
|
20
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src
|
|
21
|
-
<!-- The below content is automatically added from
|
|
20
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) -->
|
|
21
|
+
<!-- The below content is automatically added from ./../docs/partials/useCases.md -->
|
|
22
22
|
The `<auro-dialog>` component should be used in situations where users may:
|
|
23
23
|
|
|
24
24
|
* Be prompted to take an action before doing anything else or going back
|
|
@@ -27,8 +27,8 @@ The `<auro-dialog>` component should be used in situations where users may:
|
|
|
27
27
|
|
|
28
28
|
## Additional Information
|
|
29
29
|
|
|
30
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src
|
|
31
|
-
<!-- The below content is automatically added from
|
|
30
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/readmeAddlInfo.md) -->
|
|
31
|
+
<!-- The below content is automatically added from ./../docs/partials/readmeAddlInfo.md -->
|
|
32
32
|
**Important Notice**: This component no longer lives within the `auro-interruption` repository, as that is now being deprecated. `<auro-dialog>` is now a standalone component and users will be required to install it seperately. See the [Install Page](https://auro.alaskaair.com/components/auro/dialog/install) for instructions on how to install the component.
|
|
33
33
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
34
34
|
|
|
@@ -75,8 +75,8 @@ It should be noted that the `footer` slot is reserved for the placement of actio
|
|
|
75
75
|
## Example(s)
|
|
76
76
|
|
|
77
77
|
<div class="exampleWrapper">
|
|
78
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src
|
|
79
|
-
<!-- The below content is automatically added from
|
|
78
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
|
|
79
|
+
<!-- The below content is automatically added from ./../apiExamples/basic.html -->
|
|
80
80
|
<div>
|
|
81
81
|
<auro-button id="openBasic">Open default dialog</auro-button>
|
|
82
82
|
</div>
|
|
@@ -101,8 +101,8 @@ It should be noted that the `footer` slot is reserved for the placement of actio
|
|
|
101
101
|
</div>
|
|
102
102
|
<auro-accordion alignRight>
|
|
103
103
|
<span slot="trigger">See code</span>
|
|
104
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src
|
|
105
|
-
<!-- The below code snippet is automatically added from
|
|
104
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
|
|
105
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
|
|
106
106
|
|
|
107
107
|
```html
|
|
108
108
|
<div>
|
|
@@ -145,8 +145,8 @@ AuroDialog.register('custom-dialog');
|
|
|
145
145
|
This will create a new custom element that you can use in your HTML that will function identically to the `auro-dialog` element.
|
|
146
146
|
|
|
147
147
|
<div class="exampleWrapper">
|
|
148
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src
|
|
149
|
-
<!-- The below content is automatically added from
|
|
148
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/custom.html) -->
|
|
149
|
+
<!-- The below content is automatically added from ./../apiExamples/custom.html -->
|
|
150
150
|
<div>
|
|
151
151
|
<auro-button id="openCustom">Open default dialog</auro-button>
|
|
152
152
|
</div>
|
|
@@ -171,8 +171,8 @@ This will create a new custom element that you can use in your HTML that will fu
|
|
|
171
171
|
</div>
|
|
172
172
|
<auro-accordion alignRight>
|
|
173
173
|
<span slot="trigger">See code</span>
|
|
174
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src
|
|
175
|
-
<!-- The below code snippet is automatically added from
|
|
174
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/custom.html) -->
|
|
175
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/custom.html -->
|
|
176
176
|
|
|
177
177
|
```html
|
|
178
178
|
<div>
|