@aurodesignsystem-dev/auro-alert 0.0.0-pr123.0 → 0.0.0-pr124.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/dist/index.d.ts CHANGED
@@ -77,40 +77,28 @@ type BaseProps<T extends HTMLElement> = {
77
77
  type BaseEvents = {};
78
78
 
79
79
  export type AuroAlertProps = {
80
- /** If present, the component will be hidden both visually and from screen readers */
80
+ /** Hides the alert both visually and from screen readers. */
81
81
  hidden?: AuroAlert["hidden"];
82
- /** If present, the component will be hidden from screen readers, but seen visually */
83
- hiddenaudible?: AuroAlert["hiddenAudible"];
84
- /** If present, the component will be hidden from screen readers, but seen visually */
82
+ /** Hides the alert from screen readers while keeping it visible. */
85
83
  hiddenAudible?: AuroAlert["hiddenAudible"];
86
- /** If present, the component will be hidden visually, but still read by screen readers */
87
- hiddenvisually?: AuroAlert["hiddenVisually"];
88
- /** If present, the component will be hidden visually, but still read by screen readers */
84
+ /** Hides the alert visually while keeping it available to screen readers. */
89
85
  hiddenVisually?: AuroAlert["hiddenVisually"];
90
- /** Removes icon from alert UI when `type` attribute is set */
91
- noicon?: AuroAlert["noIcon"];
92
- /** Removes icon from alert UI when `type` attribute is set */
86
+ /** Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon. */
93
87
  noIcon?: AuroAlert["noIcon"];
94
- /** Component will render visually based on which type value is set */
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. */
95
89
  type?: AuroAlert["type"];
96
90
  };
97
91
 
98
92
  export type AuroAlertSolidJsProps = {
99
- /** If present, the component will be hidden both visually and from screen readers */
93
+ /** Hides the alert both visually and from screen readers. */
100
94
  "prop:hidden"?: AuroAlert["hidden"];
101
- /** If present, the component will be hidden from screen readers, but seen visually */
102
- "bool:hiddenaudible"?: AuroAlert["hiddenAudible"];
103
- /** If present, the component will be hidden from screen readers, but seen visually */
95
+ /** Hides the alert from screen readers while keeping it visible. */
104
96
  "prop:hiddenAudible"?: AuroAlert["hiddenAudible"];
105
- /** If present, the component will be hidden visually, but still read by screen readers */
106
- "bool:hiddenvisually"?: AuroAlert["hiddenVisually"];
107
- /** If present, the component will be hidden visually, but still read by screen readers */
97
+ /** Hides the alert visually while keeping it available to screen readers. */
108
98
  "prop:hiddenVisually"?: AuroAlert["hiddenVisually"];
109
- /** Removes icon from alert UI when `type` attribute is set */
110
- "bool:noicon"?: AuroAlert["noIcon"];
111
- /** Removes icon from alert UI when `type` attribute is set */
99
+ /** Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon. */
112
100
  "prop:noIcon"?: AuroAlert["noIcon"];
113
- /** Component will render visually based on which type value is set */
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. */
114
102
  "prop:type"?: AuroAlert["type"];
115
103
 
116
104
  /** Set the innerHTML of the element */
@@ -121,17 +109,28 @@ export type AuroAlertSolidJsProps = {
121
109
 
122
110
  export type CustomElements = {
123
111
  /**
124
- * The `auro-alert` element is used to provide contextual feedback messages for typical user actions.
112
+ * Shows an inline message that gives feedback about a user action, such as an error, success, warning, or information message.
113
+ *
114
+ * **Key capabilities**
115
+ * - **Alert types**: Set `type` to `error`, `information`, `success`, or `warning` to change the icon and border color.
116
+ * - **Optional icon**: Set `noIcon` to remove the icon.
117
+ * - **Hiding**: Set `hidden` to hide the alert from everyone, `hiddenVisually` to hide it visually but keep it available to screen readers, or `hiddenAudible` to keep it visible but hidden from screen readers.
118
+ * - **Custom content**: The default slot accepts any content, and each `<p>` tag starts a new line.
119
+ *
120
+ * **Example**
121
+ * ```html
122
+ * <auro-alert type="success">Your changes are saved.</auro-alert>
123
+ * ```
125
124
  *
126
125
  * ## Attributes & Properties
127
126
  *
128
127
  * Component attributes and properties that can be applied to the element or by using JavaScript.
129
128
  *
130
- * - `hidden`: If present, the component will be hidden both visually and from screen readers
131
- * - `hiddenaudible`/`hiddenAudible`: If present, the component will be hidden from screen readers, but seen visually
132
- * - `hiddenvisually`/`hiddenVisually`: If present, the component will be hidden visually, but still read by screen readers
133
- * - `noicon`/`noIcon`: Removes icon from alert UI when `type` attribute is set
134
- * - `type`: Component will render visually based on which type value is set
129
+ * - `hidden`: Hides the alert both visually and from screen readers.
130
+ * - `hiddenAudible`: Hides the alert from screen readers while keeping it visible.
131
+ * - `hiddenVisually`: Hides the alert visually while keeping it available to screen readers.
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.
135
134
  *
136
135
  * ## Slots
137
136
  *
@@ -143,31 +142,42 @@ export type CustomElements = {
143
142
  *
144
143
  * Methods that can be called to access component functionality.
145
144
  *
146
- * - `register(name?: string = "auro-alert") => void`: This will register this element with the browser.
145
+ * - `register(name?: string = "auro-alert") => void`: Registers the element with the browser under a tag name.
147
146
  *
148
147
  * ## CSS Parts
149
148
  *
150
149
  * Custom selectors for styling elements within the component.
151
150
  *
152
- * - `alert`: Use for customizing the style of the alert container
153
- * - `alert-content`: Use for customizing the style of the alert content
151
+ * - `alert`: The outer container that holds the icon and the message.
152
+ * - `alert-content`: The area next to the icon that holds the alert message.
154
153
  */
155
154
  "auro-alert": Partial<AuroAlertProps & BaseProps<AuroAlert> & BaseEvents>;
156
155
  };
157
156
 
158
157
  export type CustomElementsSolidJs = {
159
158
  /**
160
- * The `auro-alert` element is used to provide contextual feedback messages for typical user actions.
159
+ * Shows an inline message that gives feedback about a user action, such as an error, success, warning, or information message.
160
+ *
161
+ * **Key capabilities**
162
+ * - **Alert types**: Set `type` to `error`, `information`, `success`, or `warning` to change the icon and border color.
163
+ * - **Optional icon**: Set `noIcon` to remove the icon.
164
+ * - **Hiding**: Set `hidden` to hide the alert from everyone, `hiddenVisually` to hide it visually but keep it available to screen readers, or `hiddenAudible` to keep it visible but hidden from screen readers.
165
+ * - **Custom content**: The default slot accepts any content, and each `<p>` tag starts a new line.
166
+ *
167
+ * **Example**
168
+ * ```html
169
+ * <auro-alert type="success">Your changes are saved.</auro-alert>
170
+ * ```
161
171
  *
162
172
  * ## Attributes & Properties
163
173
  *
164
174
  * Component attributes and properties that can be applied to the element or by using JavaScript.
165
175
  *
166
- * - `hidden`: If present, the component will be hidden both visually and from screen readers
167
- * - `hiddenaudible`/`hiddenAudible`: If present, the component will be hidden from screen readers, but seen visually
168
- * - `hiddenvisually`/`hiddenVisually`: If present, the component will be hidden visually, but still read by screen readers
169
- * - `noicon`/`noIcon`: Removes icon from alert UI when `type` attribute is set
170
- * - `type`: Component will render visually based on which type value is set
176
+ * - `hidden`: Hides the alert both visually and from screen readers.
177
+ * - `hiddenAudible`: Hides the alert from screen readers while keeping it visible.
178
+ * - `hiddenVisually`: Hides the alert visually while keeping it available to screen readers.
179
+ * - `noIcon`: Removes the icon from the alert. Applies only when `type` is set, because an alert without a type has no icon.
180
+ * - `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.
171
181
  *
172
182
  * ## Slots
173
183
  *
@@ -179,14 +189,14 @@ export type CustomElementsSolidJs = {
179
189
  *
180
190
  * Methods that can be called to access component functionality.
181
191
  *
182
- * - `register(name?: string = "auro-alert") => void`: This will register this element with the browser.
192
+ * - `register(name?: string = "auro-alert") => void`: Registers the element with the browser under a tag name.
183
193
  *
184
194
  * ## CSS Parts
185
195
  *
186
196
  * Custom selectors for styling elements within the component.
187
197
  *
188
- * - `alert`: Use for customizing the style of the alert container
189
- * - `alert-content`: Use for customizing the style of the alert content
198
+ * - `alert`: The outer container that holds the icon and the message.
199
+ * - `alert-content`: The area next to the icon that holds the alert message.
190
200
  */
191
201
  "auro-alert": Partial<
192
202
  AuroAlertProps & AuroAlertSolidJsProps & BaseProps<AuroAlert> & BaseEvents
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- export{A as AuroAlert}from"./auro-alert-Cxqj9ihp.js";import"lit/static-html.js";import"lit";import"lit/directives/class-map.js";import"lit/directives/if-defined.js";
1
+ export{A as AuroAlert}from"./auro-alert-BUDoiSly.js";import"lit/static-html.js";import"lit";import"lit/directives/class-map.js";import"lit/directives/if-defined.js";
@@ -1 +1 @@
1
- import{A as i}from"./auro-alert-Cxqj9ihp.js";import"lit/static-html.js";import"lit";import"lit/directives/class-map.js";import"lit/directives/if-defined.js";i.register();
1
+ import{A as i}from"./auro-alert-BUDoiSly.js";import"lit/static-html.js";import"lit";import"lit/directives/class-map.js";import"lit/directives/if-defined.js";i.register();
package/package.json CHANGED
@@ -8,7 +8,7 @@
8
8
  "================================================================================"
9
9
  ],
10
10
  "name": "@aurodesignsystem-dev/auro-alert",
11
- "version": "0.0.0-pr123.0",
11
+ "version": "0.0.0-pr124.0",
12
12
  "description": "auro-alert HTML custom element",
13
13
  "repository": {
14
14
  "type": "git",
@@ -25,11 +25,11 @@
25
25
  "lit": "^3.3.3"
26
26
  },
27
27
  "devDependencies": {
28
- "@aurodesignsystem/auro-cli": "^5.0.0",
29
- "@aurodesignsystem/auro-config": "^1.3.1",
30
- "@aurodesignsystem/auro-icon": "^9.2.0",
28
+ "@aurodesignsystem/auro-cli": "^5.7.0",
29
+ "@aurodesignsystem/auro-config": "^1.3.2",
30
+ "@aurodesignsystem/auro-icon": "^9.2.1",
31
31
  "@aurodesignsystem/auro-library": "^5.14.4",
32
- "@aurodesignsystem/design-tokens": "^9.4.1",
32
+ "@aurodesignsystem/design-tokens": "^9.4.3",
33
33
  "@aurodesignsystem/webcorestylesheets": "^12.0.1",
34
34
  "husky": "^9.1.7"
35
35
  },
@@ -51,8 +51,7 @@
51
51
  "web components"
52
52
  ],
53
53
  "scripts": {
54
- "build": "auro build && npm run cem:check",
55
- "cem:check": "auro cem-check --strict",
54
+ "build": "auro build",
56
55
  "build:version": "node ./scripts/version.mjs",
57
56
  "dev": "auro dev -w -s",
58
57
  "dev:open": "auro dev -w -s --open",
@@ -83,7 +82,6 @@
83
82
  "files": [
84
83
  "dist/**/*",
85
84
  "demo/**/*",
86
- "custom-elements.json",
87
85
  "CHANGELOG.md",
88
86
  "README.md",
89
87
  "LICENSE",
@@ -1,245 +0,0 @@
1
- {
2
- "schemaVersion": "1.0.0",
3
- "readme": "",
4
- "modules": [
5
- {
6
- "kind": "javascript-module",
7
- "path": "src/auro-alert.js",
8
- "declarations": [
9
- {
10
- "kind": "class",
11
- "description": "The `auro-alert` element is used to provide contextual feedback messages for typical user actions.",
12
- "name": "AuroAlert",
13
- "cssParts": [
14
- {
15
- "description": "Use for customizing the style of the alert container",
16
- "name": "alert"
17
- },
18
- {
19
- "description": "Use for customizing the style of the alert content",
20
- "name": "alert-content"
21
- }
22
- ],
23
- "slots": [
24
- {
25
- "description": "Provide text for the alert. If using multiple lines, separate each line with `<p>` tags.",
26
- "name": ""
27
- }
28
- ],
29
- "members": [
30
- {
31
- "kind": "method",
32
- "name": "generateIconHtml",
33
- "parameters": [
34
- {
35
- "name": "category",
36
- "description": "The category of the icon.",
37
- "type": {
38
- "text": "string"
39
- }
40
- },
41
- {
42
- "name": "name",
43
- "description": "The name of the icon.",
44
- "type": {
45
- "text": "string"
46
- }
47
- }
48
- ],
49
- "privacy": "private",
50
- "return": {
51
- "type": {
52
- "text": "string"
53
- }
54
- }
55
- },
56
- {
57
- "kind": "field",
58
- "name": "hidden",
59
- "privacy": "public",
60
- "type": {
61
- "text": "boolean"
62
- },
63
- "description": "If present, the component will be hidden both visually and from screen readers",
64
- "attribute": "hidden",
65
- "reflects": true
66
- },
67
- {
68
- "kind": "field",
69
- "name": "hiddenAudible",
70
- "privacy": "public",
71
- "type": {
72
- "text": "boolean"
73
- },
74
- "description": "If present, the component will be hidden from screen readers, but seen visually",
75
- "attribute": "hiddenaudible",
76
- "reflects": true
77
- },
78
- {
79
- "kind": "field",
80
- "name": "hiddenVisually",
81
- "privacy": "public",
82
- "type": {
83
- "text": "boolean"
84
- },
85
- "description": "If present, the component will be hidden visually, but still read by screen readers",
86
- "attribute": "hiddenvisually",
87
- "reflects": true
88
- },
89
- {
90
- "kind": "field",
91
- "name": "iconTag",
92
- "privacy": "private",
93
- "type": {
94
- "text": "string"
95
- }
96
- },
97
- {
98
- "kind": "field",
99
- "name": "noIcon",
100
- "privacy": "public",
101
- "type": {
102
- "text": "boolean"
103
- },
104
- "description": "Removes icon from alert UI when `type` attribute is set",
105
- "attribute": "noicon",
106
- "reflects": true
107
- },
108
- {
109
- "kind": "method",
110
- "name": "register",
111
- "static": true,
112
- "parameters": [
113
- {
114
- "name": "name",
115
- "default": "\"auro-alert\"",
116
- "description": "The name of the element that you want to register.",
117
- "optional": true,
118
- "type": {
119
- "text": "string"
120
- }
121
- }
122
- ],
123
- "description": "This will register this element with the browser.",
124
- "type": {
125
- "text": "register(name?: string = \"auro-alert\") => void"
126
- }
127
- },
128
- {
129
- "kind": "field",
130
- "name": "runtimeUtils",
131
- "privacy": "private",
132
- "default": "new AuroLibraryRuntimeUtils()"
133
- },
134
- {
135
- "kind": "field",
136
- "name": "type",
137
- "privacy": "public",
138
- "type": {
139
- "text": "'information' | 'error' | 'success' | 'warning'"
140
- },
141
- "description": "Component will render visually based on which type value is set",
142
- "attribute": "type",
143
- "reflects": true
144
- }
145
- ],
146
- "attributes": [
147
- {
148
- "name": "hidden",
149
- "type": {
150
- "text": "boolean"
151
- },
152
- "description": "If present, the component will be hidden both visually and from screen readers",
153
- "fieldName": "hidden"
154
- },
155
- {
156
- "name": "hiddenaudible",
157
- "type": {
158
- "text": "boolean"
159
- },
160
- "description": "If present, the component will be hidden from screen readers, but seen visually",
161
- "fieldName": "hiddenAudible"
162
- },
163
- {
164
- "name": "hiddenvisually",
165
- "type": {
166
- "text": "boolean"
167
- },
168
- "description": "If present, the component will be hidden visually, but still read by screen readers",
169
- "fieldName": "hiddenVisually"
170
- },
171
- {
172
- "name": "noicon",
173
- "type": {
174
- "text": "boolean"
175
- },
176
- "description": "Removes icon from alert UI when `type` attribute is set",
177
- "fieldName": "noIcon"
178
- },
179
- {
180
- "name": "type",
181
- "type": {
182
- "text": "'information' | 'error' | 'success' | 'warning'"
183
- },
184
- "description": "Component will render visually based on which type value is set",
185
- "fieldName": "type"
186
- }
187
- ],
188
- "superclass": {
189
- "name": "AuroElement",
190
- "package": "@aurodesignsystem/webcorestylesheets/dist/auroElement/auroElement.mjs"
191
- },
192
- "tagName": "auro-alert",
193
- "customElement": true,
194
- "modulePath": "src/auro-alert.js"
195
- }
196
- ],
197
- "exports": [
198
- {
199
- "kind": "js",
200
- "name": "AuroAlert",
201
- "declaration": {
202
- "name": "AuroAlert",
203
- "module": "src/auro-alert.js"
204
- }
205
- }
206
- ]
207
- },
208
- {
209
- "kind": "javascript-module",
210
- "path": "src/iconVersion.js",
211
- "declarations": [],
212
- "exports": [
213
- {
214
- "kind": "js",
215
- "name": "default",
216
- "declaration": {
217
- "name": "9.2.0",
218
- "module": "src/iconVersion.js"
219
- }
220
- }
221
- ]
222
- },
223
- {
224
- "kind": "javascript-module",
225
- "path": "src/index.js",
226
- "declarations": [],
227
- "exports": [
228
- {
229
- "kind": "js",
230
- "name": "AuroAlert",
231
- "declaration": {
232
- "name": "AuroAlert",
233
- "module": "src/index.js"
234
- }
235
- }
236
- ]
237
- },
238
- {
239
- "kind": "javascript-module",
240
- "path": "src/registered.js",
241
- "declarations": [],
242
- "exports": []
243
- }
244
- ]
245
- }