@aurodesignsystem-dev/auro-alert 0.0.0-pr124.3 → 0.0.0-pr124.4
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 +7 -7
- package/demo/api.min.js +2 -1
- package/demo/index.min.js +2 -1
- package/dist/index.d.ts +4 -4
- package/package.json +1 -1
package/demo/api.md
CHANGED
|
@@ -16,13 +16,13 @@ Shows an inline message that gives feedback about a user action, such as an erro
|
|
|
16
16
|
|
|
17
17
|
### Properties and attributes
|
|
18
18
|
|
|
19
|
-
| Properties | Attributes | Modifiers | Type | Default | Relevant when | Description
|
|
20
|
-
| -------------- | -------------- | --------- | -------------------------------------------------- | ------- | ------------- |
|
|
21
|
-
| hidden | hidden | | boolean | | | Hides the alert both visually and from screen readers.
|
|
22
|
-
| hiddenAudible | hiddenAudible | | boolean | | | Hides the alert from screen readers while keeping it visible.
|
|
23
|
-
| hiddenVisually | hiddenVisually | | boolean | | | Hides the alert visually while keeping it available to screen readers.
|
|
24
|
-
| noIcon | noIcon | | boolean | | `type` | Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon.
|
|
25
|
-
| type | type | | `information` \| `error` \| `success` \| `warning` | | | Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
19
|
+
| Properties | Attributes | Modifiers | Type | Default | Relevant when | Description |
|
|
20
|
+
| -------------- | -------------- | --------- | -------------------------------------------------- | ------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
+
| hidden | hidden | | boolean | | | Hides the alert both visually and from screen readers. |
|
|
22
|
+
| hiddenAudible | hiddenAudible | | boolean | | | Hides the alert from screen readers while keeping it visible. |
|
|
23
|
+
| hiddenVisually | hiddenVisually | | boolean | | | Hides the alert visually while keeping it available to screen readers. |
|
|
24
|
+
| noIcon | noIcon | | boolean | | `type` | Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon. |
|
|
25
|
+
| type | type | | `information` \| `error` \| `success` \| `warning` | | | Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically. |
|
|
26
26
|
|
|
27
27
|
### Methods
|
|
28
28
|
|
package/demo/api.min.js
CHANGED
|
@@ -344,7 +344,8 @@ class AuroAlert extends AuroElement {
|
|
|
344
344
|
},
|
|
345
345
|
|
|
346
346
|
/**
|
|
347
|
-
* Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
347
|
+
* Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
348
|
+
* @type {'information' | 'error' | 'success' | 'warning'}
|
|
348
349
|
*/
|
|
349
350
|
type: {
|
|
350
351
|
type: String,
|
package/demo/index.min.js
CHANGED
|
@@ -344,7 +344,8 @@ class AuroAlert extends AuroElement {
|
|
|
344
344
|
},
|
|
345
345
|
|
|
346
346
|
/**
|
|
347
|
-
* Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
347
|
+
* Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
348
|
+
* @type {'information' | 'error' | 'success' | 'warning'}
|
|
348
349
|
*/
|
|
349
350
|
type: {
|
|
350
351
|
type: String,
|
package/dist/index.d.ts
CHANGED
|
@@ -85,7 +85,7 @@ export type AuroAlertProps = {
|
|
|
85
85
|
hiddenVisually?: AuroAlert["hiddenVisually"];
|
|
86
86
|
/** Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon. */
|
|
87
87
|
noIcon?: AuroAlert["noIcon"];
|
|
88
|
-
/** Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
88
|
+
/** Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically. */
|
|
89
89
|
type?: AuroAlert["type"];
|
|
90
90
|
};
|
|
91
91
|
|
|
@@ -98,7 +98,7 @@ export type AuroAlertSolidJsProps = {
|
|
|
98
98
|
"prop:hiddenVisually"?: AuroAlert["hiddenVisually"];
|
|
99
99
|
/** Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon. */
|
|
100
100
|
"prop:noIcon"?: AuroAlert["noIcon"];
|
|
101
|
-
/** Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
101
|
+
/** Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically. */
|
|
102
102
|
"prop:type"?: AuroAlert["type"];
|
|
103
103
|
|
|
104
104
|
/** Set the innerHTML of the element */
|
|
@@ -130,7 +130,7 @@ export type CustomElements = {
|
|
|
130
130
|
* - `hiddenAudible`: Hides the alert from screen readers while keeping it visible.
|
|
131
131
|
* - `hiddenVisually`: Hides the alert visually while keeping it available to screen readers.
|
|
132
132
|
* - `noIcon`: Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon.
|
|
133
|
-
* - `type`: Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
133
|
+
* - `type`: Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
134
134
|
*
|
|
135
135
|
* ## Slots
|
|
136
136
|
*
|
|
@@ -186,7 +186,7 @@ export type CustomElementsSolidJs = {
|
|
|
186
186
|
* - `hiddenAudible`: Hides the alert from screen readers while keeping it visible.
|
|
187
187
|
* - `hiddenVisually`: Hides the alert visually while keeping it available to screen readers.
|
|
188
188
|
* - `noIcon`: Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon.
|
|
189
|
-
* - `type`: Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
189
|
+
* - `type`: Sets the alert's purpose, which controls its icon and border color: `error`, `warning`, `success`, or `information`. Without a value, the alert shows no icon and uses a default border color. Screen readers announce `error`, `success`, and `warning` alerts right away because they set `role="alert"`, but `information` alerts set no role, so screen readers don't announce them automatically.
|
|
190
190
|
*
|
|
191
191
|
* ## Slots
|
|
192
192
|
*
|
package/package.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"================================================================================"
|
|
9
9
|
],
|
|
10
10
|
"name": "@aurodesignsystem-dev/auro-alert",
|
|
11
|
-
"version": "0.0.0-pr124.
|
|
11
|
+
"version": "0.0.0-pr124.4",
|
|
12
12
|
"description": "auro-alert HTML custom element",
|
|
13
13
|
"repository": {
|
|
14
14
|
"type": "git",
|