@uni-design-system/uni-mcp 4.2.0 → 4.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/dist/{chunk-VQE52XFX.js → chunk-WCJS2FYS.js} +322 -177
- package/dist/chunk-WCJS2FYS.js.map +1 -0
- package/dist/http.js +1 -1
- package/dist/server.js +1 -1
- package/dist/stdio.js +1 -1
- package/package.json +2 -2
- package/dist/chunk-VQE52XFX.js.map +0 -1
|
@@ -7,8 +7,8 @@ import { z } from "zod";
|
|
|
7
7
|
// src/data/uni-index.json
|
|
8
8
|
var uni_index_default = {
|
|
9
9
|
meta: {
|
|
10
|
-
version: "6.0.
|
|
11
|
-
builtAt: "2026-07-
|
|
10
|
+
version: "6.0.1",
|
|
11
|
+
builtAt: "2026-07-24T15:08:54.365Z",
|
|
12
12
|
frameworks: [
|
|
13
13
|
"angular"
|
|
14
14
|
],
|
|
@@ -27,7 +27,7 @@ var uni_index_default = {
|
|
|
27
27
|
summary: "",
|
|
28
28
|
description: "",
|
|
29
29
|
category: "feedback",
|
|
30
|
-
version: "6.0.
|
|
30
|
+
version: "6.0.1",
|
|
31
31
|
bindings: {
|
|
32
32
|
angular: {
|
|
33
33
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -82,7 +82,7 @@ var uni_index_default = {
|
|
|
82
82
|
}
|
|
83
83
|
],
|
|
84
84
|
guidelines: {
|
|
85
|
-
whenToUse: "",
|
|
85
|
+
whenToUse: "The Alert is used to communicate a state that affects a system, feature or page.\nFor instance, alerts can be used to display errors or any unexpected results from a user's action.",
|
|
86
86
|
dos: [],
|
|
87
87
|
donts: [],
|
|
88
88
|
accessibility: []
|
|
@@ -101,7 +101,7 @@ var uni_index_default = {
|
|
|
101
101
|
summary: "",
|
|
102
102
|
description: "",
|
|
103
103
|
category: "components",
|
|
104
|
-
version: "6.0.
|
|
104
|
+
version: "6.0.1",
|
|
105
105
|
bindings: {
|
|
106
106
|
angular: {
|
|
107
107
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -141,10 +141,13 @@ var uni_index_default = {
|
|
|
141
141
|
}
|
|
142
142
|
],
|
|
143
143
|
guidelines: {
|
|
144
|
-
whenToUse: "",
|
|
144
|
+
whenToUse: "Horizontal application bar for the top of a page or section. Project controls with the\n`leading` attribute (menu button, logo) and actions with `trailing` (pushed to the far\nedge); pass `title` or project your own center content. Surface color, height, the\ndivider rule, title typography and spacing all resolve from the theme's `appBar`\noptions, and `sticky` pins the bar to the top of its scroll container.\nPlace it inside your page's `<header>` landmark. It pairs with the Drawer \u2014 see the\nDrawer docs for the full dashboard-shell recipe.",
|
|
145
145
|
dos: [],
|
|
146
146
|
donts: [],
|
|
147
|
-
accessibility: [
|
|
147
|
+
accessibility: [
|
|
148
|
+
"The bar is a styled container, not a landmark \u2014 place it inside your page's `<header>` element.",
|
|
149
|
+
"Give leading/trailing icon buttons text content or `ariaLabel` so they announce."
|
|
150
|
+
]
|
|
148
151
|
},
|
|
149
152
|
relatedTokens: []
|
|
150
153
|
},
|
|
@@ -155,7 +158,7 @@ var uni_index_default = {
|
|
|
155
158
|
summary: "",
|
|
156
159
|
description: "",
|
|
157
160
|
category: "components",
|
|
158
|
-
version: "6.0.
|
|
161
|
+
version: "6.0.1",
|
|
159
162
|
bindings: {
|
|
160
163
|
angular: {
|
|
161
164
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -213,10 +216,13 @@ var uni_index_default = {
|
|
|
213
216
|
}
|
|
214
217
|
],
|
|
215
218
|
guidelines: {
|
|
216
|
-
whenToUse: "",
|
|
219
|
+
whenToUse: "Identity avatar with a graceful fallback chain: the image when it loads, initials\nderived from `name` when it doesn't (or was never given), and a themed symbol as the\nlast resort. The name doubles as the accessible label; avatars with no name are marked\ndecorative automatically.\nVariants color initials from the role's container tokens, so avatars follow the brand\npalette in light and dark. The corner radius is the theme's `avatar.options.borderRadius`\ntoken \u2014 circles by default, squares under a `sharp` shape language.",
|
|
217
220
|
dos: [],
|
|
218
221
|
donts: [],
|
|
219
|
-
accessibility: [
|
|
222
|
+
accessibility: [
|
|
223
|
+
'With a `name`, the avatar is `role="img"` labelled by that name; purely decorative avatars are `aria-hidden`.',
|
|
224
|
+
'The group is a `role="group"`; the "+N" chip reads as text.'
|
|
225
|
+
]
|
|
220
226
|
},
|
|
221
227
|
relatedTokens: [
|
|
222
228
|
"avatar.behavior.borderRadius",
|
|
@@ -231,7 +237,7 @@ var uni_index_default = {
|
|
|
231
237
|
summary: "",
|
|
232
238
|
description: "",
|
|
233
239
|
category: "components",
|
|
234
|
-
version: "6.0.
|
|
240
|
+
version: "6.0.1",
|
|
235
241
|
bindings: {
|
|
236
242
|
angular: {
|
|
237
243
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -264,7 +270,7 @@ var uni_index_default = {
|
|
|
264
270
|
summary: "",
|
|
265
271
|
description: "",
|
|
266
272
|
category: "primitives",
|
|
267
|
-
version: "6.0.
|
|
273
|
+
version: "6.0.1",
|
|
268
274
|
bindings: {
|
|
269
275
|
angular: {
|
|
270
276
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -327,10 +333,14 @@ var uni_index_default = {
|
|
|
327
333
|
}
|
|
328
334
|
],
|
|
329
335
|
guidelines: {
|
|
330
|
-
whenToUse: "",
|
|
336
|
+
whenToUse: "The Background component is a flexible container that allows you to add and control background images in your application.\nIt provides various options for positioning and sizing the background image while maintaining a clean and responsive layout.",
|
|
331
337
|
dos: [],
|
|
332
338
|
donts: [],
|
|
333
|
-
accessibility: [
|
|
339
|
+
accessibility: [
|
|
340
|
+
"Ensure any text overlaid on the background has sufficient contrast",
|
|
341
|
+
"Don't rely on background images to convey important information",
|
|
342
|
+
"Consider providing alternative visual styles for users who prefer reduced motion"
|
|
343
|
+
]
|
|
334
344
|
},
|
|
335
345
|
relatedTokens: []
|
|
336
346
|
},
|
|
@@ -341,7 +351,7 @@ var uni_index_default = {
|
|
|
341
351
|
summary: "",
|
|
342
352
|
description: "",
|
|
343
353
|
category: "feedback",
|
|
344
|
-
version: "6.0.
|
|
354
|
+
version: "6.0.1",
|
|
345
355
|
bindings: {
|
|
346
356
|
angular: {
|
|
347
357
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -406,7 +416,7 @@ var uni_index_default = {
|
|
|
406
416
|
}
|
|
407
417
|
],
|
|
408
418
|
guidelines: {
|
|
409
|
-
whenToUse: "",
|
|
419
|
+
whenToUse: "Badges are used to highlight an item's status for quick recognition.",
|
|
410
420
|
dos: [],
|
|
411
421
|
donts: [],
|
|
412
422
|
accessibility: []
|
|
@@ -422,7 +432,7 @@ var uni_index_default = {
|
|
|
422
432
|
summary: "",
|
|
423
433
|
description: "",
|
|
424
434
|
category: "directives",
|
|
425
|
-
version: "6.0.
|
|
435
|
+
version: "6.0.1",
|
|
426
436
|
bindings: {
|
|
427
437
|
angular: {
|
|
428
438
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -446,7 +456,7 @@ var uni_index_default = {
|
|
|
446
456
|
summary: "",
|
|
447
457
|
description: "",
|
|
448
458
|
category: "layout",
|
|
449
|
-
version: "6.0.
|
|
459
|
+
version: "6.0.1",
|
|
450
460
|
bindings: {
|
|
451
461
|
angular: {
|
|
452
462
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -795,7 +805,7 @@ var uni_index_default = {
|
|
|
795
805
|
}
|
|
796
806
|
],
|
|
797
807
|
guidelines: {
|
|
798
|
-
whenToUse: "",
|
|
808
|
+
whenToUse: "Box is the base Layout component. It is highly configurable.\nEach layout component extends the Box component while providing presets to support their application.",
|
|
799
809
|
dos: [],
|
|
800
810
|
donts: [],
|
|
801
811
|
accessibility: []
|
|
@@ -809,7 +819,7 @@ var uni_index_default = {
|
|
|
809
819
|
summary: "",
|
|
810
820
|
description: "",
|
|
811
821
|
category: "components",
|
|
812
|
-
version: "6.0.
|
|
822
|
+
version: "6.0.1",
|
|
813
823
|
bindings: {
|
|
814
824
|
angular: {
|
|
815
825
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -853,10 +863,15 @@ var uni_index_default = {
|
|
|
853
863
|
}
|
|
854
864
|
],
|
|
855
865
|
guidelines: {
|
|
856
|
-
whenToUse: "",
|
|
866
|
+
whenToUse: "Breadcrumbs show where the current page sits in the hierarchy and give one-click\npassage back up the trail. The component renders the WAI-ARIA pattern: a labelled\n`nav` landmark wrapping an ordered list, with the last item marked as the current page\nand separators hidden from assistive tech.\nItems with `href` render as real links. For SPA routing, omit `href` and handle\n`itemClicked` \u2014 items render as link-styled buttons instead. Typography, link and\ncurrent-page colors, the separator symbol, and spacing all resolve from the theme's\n`breadcrumb` options.",
|
|
857
867
|
dos: [],
|
|
858
868
|
donts: [],
|
|
859
|
-
accessibility: [
|
|
869
|
+
accessibility: [
|
|
870
|
+
"Renders the WAI-ARIA pattern: a labelled `nav` landmark wrapping an ordered list.",
|
|
871
|
+
'The last item is `aria-current="page"` and not a link.',
|
|
872
|
+
"Separators are `aria-hidden` \u2014 screen readers hear the trail, not the chevrons.",
|
|
873
|
+
"Set `ariaLabel` when a page has more than one breadcrumb nav."
|
|
874
|
+
]
|
|
860
875
|
},
|
|
861
876
|
relatedTokens: [
|
|
862
877
|
"breadcrumb.behavior.typeface",
|
|
@@ -873,7 +888,7 @@ var uni_index_default = {
|
|
|
873
888
|
summary: "",
|
|
874
889
|
description: "",
|
|
875
890
|
category: "primitives",
|
|
876
|
-
version: "6.0.
|
|
891
|
+
version: "6.0.1",
|
|
877
892
|
bindings: {
|
|
878
893
|
angular: {
|
|
879
894
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -996,10 +1011,13 @@ var uni_index_default = {
|
|
|
996
1011
|
}
|
|
997
1012
|
],
|
|
998
1013
|
guidelines: {
|
|
999
|
-
whenToUse: "",
|
|
1014
|
+
whenToUse: "Button is a clickable interactive element that triggers a response.\nYou can place text and icons inside of a button.\nButtons are often used for form submissions and to toggle elements into view.",
|
|
1000
1015
|
dos: [],
|
|
1001
1016
|
donts: [],
|
|
1002
|
-
accessibility: [
|
|
1017
|
+
accessibility: [
|
|
1018
|
+
"A real `<button>` element \u2014 native focus, Enter/Space activation, and `disabled` semantics.",
|
|
1019
|
+
"`aria-busy` is set while `loading`; the spinner and symbols are decorative."
|
|
1020
|
+
]
|
|
1003
1021
|
},
|
|
1004
1022
|
relatedTokens: [
|
|
1005
1023
|
"button.behavior.borderRadius",
|
|
@@ -1013,7 +1031,7 @@ var uni_index_default = {
|
|
|
1013
1031
|
summary: "",
|
|
1014
1032
|
description: "",
|
|
1015
1033
|
category: "primitives",
|
|
1016
|
-
version: "6.0.
|
|
1034
|
+
version: "6.0.1",
|
|
1017
1035
|
bindings: {
|
|
1018
1036
|
angular: {
|
|
1019
1037
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1029,10 +1047,12 @@ var uni_index_default = {
|
|
|
1029
1047
|
}
|
|
1030
1048
|
],
|
|
1031
1049
|
guidelines: {
|
|
1032
|
-
whenToUse: "",
|
|
1050
|
+
whenToUse: "The `ButtonGroup` component is used to group related buttons. It applies some base styling to the nested buttons.\nIf this is not desirable, consider using the `Row` component.",
|
|
1033
1051
|
dos: [],
|
|
1034
1052
|
donts: [],
|
|
1035
|
-
accessibility: [
|
|
1053
|
+
accessibility: [
|
|
1054
|
+
"Group the related actions; each button keeps its own accessible name."
|
|
1055
|
+
]
|
|
1036
1056
|
},
|
|
1037
1057
|
relatedTokens: []
|
|
1038
1058
|
},
|
|
@@ -1043,7 +1063,7 @@ var uni_index_default = {
|
|
|
1043
1063
|
summary: "",
|
|
1044
1064
|
description: "",
|
|
1045
1065
|
category: "layout",
|
|
1046
|
-
version: "6.0.
|
|
1066
|
+
version: "6.0.1",
|
|
1047
1067
|
bindings: {
|
|
1048
1068
|
angular: {
|
|
1049
1069
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1072,7 +1092,7 @@ var uni_index_default = {
|
|
|
1072
1092
|
}
|
|
1073
1093
|
],
|
|
1074
1094
|
guidelines: {
|
|
1075
|
-
whenToUse: "",
|
|
1095
|
+
whenToUse: "Content container with a themed frame: the border resolves from the **border\nprimitive named by its variant** (`borders.primary` \u2026 `borders.success`), the corner\nradius from the `card` theme options, and an optional elevation shadow. Compose with\nCard Header and Card Content for the standard anatomy \u2014 or point `options.border` at\na custom primitive to restyle every card in the theme at once.",
|
|
1076
1096
|
dos: [],
|
|
1077
1097
|
donts: [],
|
|
1078
1098
|
accessibility: []
|
|
@@ -1088,7 +1108,7 @@ var uni_index_default = {
|
|
|
1088
1108
|
summary: "",
|
|
1089
1109
|
description: "",
|
|
1090
1110
|
category: "layout",
|
|
1091
|
-
version: "6.0.
|
|
1111
|
+
version: "6.0.1",
|
|
1092
1112
|
bindings: {
|
|
1093
1113
|
angular: {
|
|
1094
1114
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1112,7 +1132,7 @@ var uni_index_default = {
|
|
|
1112
1132
|
summary: "",
|
|
1113
1133
|
description: "",
|
|
1114
1134
|
category: "layout",
|
|
1115
|
-
version: "6.0.
|
|
1135
|
+
version: "6.0.1",
|
|
1116
1136
|
bindings: {
|
|
1117
1137
|
angular: {
|
|
1118
1138
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1153,7 +1173,7 @@ var uni_index_default = {
|
|
|
1153
1173
|
summary: "",
|
|
1154
1174
|
description: "",
|
|
1155
1175
|
category: "layout",
|
|
1156
|
-
version: "6.0.
|
|
1176
|
+
version: "6.0.1",
|
|
1157
1177
|
bindings: {
|
|
1158
1178
|
angular: {
|
|
1159
1179
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1194,7 +1214,7 @@ var uni_index_default = {
|
|
|
1194
1214
|
}
|
|
1195
1215
|
],
|
|
1196
1216
|
guidelines: {
|
|
1197
|
-
whenToUse: "",
|
|
1217
|
+
whenToUse: "`Center` is a layout component that centers its child within itself.\n`Center` is an extension to the `Box` component and has all the `Box` attributes available to it.",
|
|
1198
1218
|
dos: [],
|
|
1199
1219
|
donts: [],
|
|
1200
1220
|
accessibility: []
|
|
@@ -1208,7 +1228,7 @@ var uni_index_default = {
|
|
|
1208
1228
|
summary: "",
|
|
1209
1229
|
description: "",
|
|
1210
1230
|
category: "forms",
|
|
1211
|
-
version: "6.0.
|
|
1231
|
+
version: "6.0.1",
|
|
1212
1232
|
bindings: {
|
|
1213
1233
|
angular: {
|
|
1214
1234
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1320,10 +1340,18 @@ var uni_index_default = {
|
|
|
1320
1340
|
}
|
|
1321
1341
|
],
|
|
1322
1342
|
guidelines: {
|
|
1323
|
-
whenToUse: "",
|
|
1324
|
-
dos: [
|
|
1325
|
-
|
|
1326
|
-
|
|
1343
|
+
whenToUse: 'Binary choice control for forms: check to opt in, submit to apply. It implements\n`FormCheckboxControl` for the Signal Forms `[field]` directive (or bind\n`[(checked)]` directly), exposes `aria-invalid` once touched, and supports an\n`indeterminate` model for "select all" parents \u2014 cleared automatically on the next\nuser interaction, matching native behavior.\nThe box color, check stroke (the variant\'s paired on-color), and size resolve from\nthe `checkbox` theme options.',
|
|
1344
|
+
dos: [
|
|
1345
|
+
"Use for choices that apply when the form is submitted"
|
|
1346
|
+
],
|
|
1347
|
+
donts: [
|
|
1348
|
+
"Use for instant on/off effects \u2014 that is a toggle"
|
|
1349
|
+
],
|
|
1350
|
+
accessibility: [
|
|
1351
|
+
'Semantic `<input type="checkbox">` + `<label>`; Space toggles.',
|
|
1352
|
+
"`aria-invalid` reflects the error state once the field was touched or is dirty.",
|
|
1353
|
+
'The indeterminate visual state is carried by the native `indeterminate` property, announced as "mixed".'
|
|
1354
|
+
]
|
|
1327
1355
|
},
|
|
1328
1356
|
relatedTokens: [
|
|
1329
1357
|
"checkbox.behavior.size",
|
|
@@ -1337,7 +1365,7 @@ var uni_index_default = {
|
|
|
1337
1365
|
summary: "",
|
|
1338
1366
|
description: "",
|
|
1339
1367
|
category: "feedback",
|
|
1340
|
-
version: "6.0.
|
|
1368
|
+
version: "6.0.1",
|
|
1341
1369
|
bindings: {
|
|
1342
1370
|
angular: {
|
|
1343
1371
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1384,7 +1412,7 @@ var uni_index_default = {
|
|
|
1384
1412
|
summary: "",
|
|
1385
1413
|
description: "",
|
|
1386
1414
|
category: "forms",
|
|
1387
|
-
version: "6.0.
|
|
1415
|
+
version: "6.0.1",
|
|
1388
1416
|
bindings: {
|
|
1389
1417
|
angular: {
|
|
1390
1418
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1453,7 +1481,7 @@ var uni_index_default = {
|
|
|
1453
1481
|
}
|
|
1454
1482
|
],
|
|
1455
1483
|
guidelines: {
|
|
1456
|
-
whenToUse: "",
|
|
1484
|
+
whenToUse: 'The Data Search input filters a `UniDatasource` as the user types. With a client-side\n`UniRecordDatasource` it applies a predicate over the record\'s fields; with a\n`UniServerSideDatasource` it sends a filter object to the data loader. Pass `fields` to\nrestrict the search to specific columns. A clear button resets the filter.\nIt pairs with the [Data Table](?path=/docs/components-data-table--docs) \u2014 see its\n"With Search" story.',
|
|
1457
1485
|
dos: [],
|
|
1458
1486
|
donts: [],
|
|
1459
1487
|
accessibility: []
|
|
@@ -1467,7 +1495,7 @@ var uni_index_default = {
|
|
|
1467
1495
|
summary: "",
|
|
1468
1496
|
description: "",
|
|
1469
1497
|
category: "data",
|
|
1470
|
-
version: "6.0.
|
|
1498
|
+
version: "6.0.1",
|
|
1471
1499
|
bindings: {
|
|
1472
1500
|
angular: {
|
|
1473
1501
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1550,10 +1578,14 @@ var uni_index_default = {
|
|
|
1550
1578
|
}
|
|
1551
1579
|
],
|
|
1552
1580
|
guidelines: {
|
|
1553
|
-
whenToUse: "",
|
|
1581
|
+
whenToUse: "Data grid for structured records: sortable column headers (Sort Header), paging\n(Paginator), field-scoped search (Data Search), row interaction, sticky columns,\nand expandable detail rows \u2014 all themed through the `dataTable` options, which\npoint at shared tokens for surfaces, borders, and typography.",
|
|
1554
1582
|
dos: [],
|
|
1555
1583
|
donts: [],
|
|
1556
|
-
accessibility: [
|
|
1584
|
+
accessibility: [
|
|
1585
|
+
'Column headers use `scope="col"`; sortable headers are real buttons with `aria-sort` on the `<th>`.',
|
|
1586
|
+
'The loading overlay is a `role="status"` region and the table is `aria-busy` while loading.',
|
|
1587
|
+
"Collapsed detail rows are `inert`, out of the accessibility tree until expanded."
|
|
1588
|
+
]
|
|
1557
1589
|
},
|
|
1558
1590
|
relatedTokens: []
|
|
1559
1591
|
},
|
|
@@ -1564,7 +1596,7 @@ var uni_index_default = {
|
|
|
1564
1596
|
summary: "",
|
|
1565
1597
|
description: "",
|
|
1566
1598
|
category: "forms",
|
|
1567
|
-
version: "6.0.
|
|
1599
|
+
version: "6.0.1",
|
|
1568
1600
|
bindings: {
|
|
1569
1601
|
angular: {
|
|
1570
1602
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1673,10 +1705,13 @@ var uni_index_default = {
|
|
|
1673
1705
|
}
|
|
1674
1706
|
],
|
|
1675
1707
|
guidelines: {
|
|
1676
|
-
whenToUse: "",
|
|
1708
|
+
whenToUse: "A themed text input that emits its `change` output only after the user pauses typing\n(400 ms by default) and only when the value actually changed \u2014 a signal-based\ndebounce with no rxjs involved. The live value is exposed as the `value` signal, and\n`clear()` empties the field immediately (cancelling any pending emit).\nIt wears the shared input chrome (color, border, typeface, focus ring) via the input\nbox, and offers `pre-input` / `post-input` attribute slots for adornments plus ARIA\npassthrough inputs (`role`, `ariaExpanded`, `ariaControls`, `ariaActivedescendant`)\nso composite widgets can annotate the real input element.\nUsed by the [Search Input](?path=/docs/components-forms-search-input--docs), which\nprojects its magnifier and clear button through the slots and drives the combobox\nARIA through the passthroughs.",
|
|
1677
1709
|
dos: [],
|
|
1678
1710
|
donts: [],
|
|
1679
|
-
accessibility: [
|
|
1711
|
+
accessibility: [
|
|
1712
|
+
"Set `label` \u2014 it becomes the accessible name (`aria-label`) of the inner input.",
|
|
1713
|
+
"The ARIA passthrough inputs (`role`, `ariaExpanded`, `ariaControls`,"
|
|
1714
|
+
]
|
|
1680
1715
|
},
|
|
1681
1716
|
relatedTokens: []
|
|
1682
1717
|
},
|
|
@@ -1687,7 +1722,7 @@ var uni_index_default = {
|
|
|
1687
1722
|
summary: "",
|
|
1688
1723
|
description: "",
|
|
1689
1724
|
category: "feedback",
|
|
1690
|
-
version: "6.0.
|
|
1725
|
+
version: "6.0.1",
|
|
1691
1726
|
bindings: {
|
|
1692
1727
|
angular: {
|
|
1693
1728
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1740,10 +1775,14 @@ var uni_index_default = {
|
|
|
1740
1775
|
}
|
|
1741
1776
|
],
|
|
1742
1777
|
guidelines: {
|
|
1743
|
-
whenToUse: "",
|
|
1778
|
+
whenToUse: "Enhanced modal dialog that extends the native HTML `<dialog>` element with built-in animations, composition components, and accessibility features.\n### Features\n- **Native HTML Dialog**: Built on the standard dialog element with full semantic support\n- **Smooth Animations**: Automatic fade transitions for open/close states\n- **Composition Components**: Optional `DialogHeader` and `DialogButtons` for consistent layouts\n- **Programmatic Control**: Open/close methods plus show property binding\n- **Backdrop Handling**: Click-outside-to-close with customizable behavior\n- **Accessibility**: Full keyboard navigation, focus trapping, and screen reader support",
|
|
1744
1779
|
dos: [],
|
|
1745
1780
|
donts: [],
|
|
1746
|
-
accessibility: [
|
|
1781
|
+
accessibility: [
|
|
1782
|
+
"Focus trapping and keyboard navigation (Tab, Escape, Enter)",
|
|
1783
|
+
"Screen reader announcements",
|
|
1784
|
+
"Semantic dialog roles"
|
|
1785
|
+
]
|
|
1747
1786
|
},
|
|
1748
1787
|
relatedTokens: [
|
|
1749
1788
|
"dialog.behavior.borderRadius",
|
|
@@ -1761,7 +1800,7 @@ var uni_index_default = {
|
|
|
1761
1800
|
summary: "",
|
|
1762
1801
|
description: "",
|
|
1763
1802
|
category: "feedback",
|
|
1764
|
-
version: "6.0.
|
|
1803
|
+
version: "6.0.1",
|
|
1765
1804
|
bindings: {
|
|
1766
1805
|
angular: {
|
|
1767
1806
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1846,7 +1885,7 @@ var uni_index_default = {
|
|
|
1846
1885
|
summary: "",
|
|
1847
1886
|
description: "",
|
|
1848
1887
|
category: "feedback",
|
|
1849
|
-
version: "6.0.
|
|
1888
|
+
version: "6.0.1",
|
|
1850
1889
|
bindings: {
|
|
1851
1890
|
angular: {
|
|
1852
1891
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1870,7 +1909,7 @@ var uni_index_default = {
|
|
|
1870
1909
|
summary: "",
|
|
1871
1910
|
description: "",
|
|
1872
1911
|
category: "layout",
|
|
1873
|
-
version: "6.0.
|
|
1912
|
+
version: "6.0.1",
|
|
1874
1913
|
bindings: {
|
|
1875
1914
|
angular: {
|
|
1876
1915
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1912,7 +1951,7 @@ var uni_index_default = {
|
|
|
1912
1951
|
}
|
|
1913
1952
|
],
|
|
1914
1953
|
guidelines: {
|
|
1915
|
-
whenToUse: "",
|
|
1954
|
+
whenToUse: "Dividers are used to visually separate content in a list or group.",
|
|
1916
1955
|
dos: [],
|
|
1917
1956
|
donts: [],
|
|
1918
1957
|
accessibility: []
|
|
@@ -1926,7 +1965,7 @@ var uni_index_default = {
|
|
|
1926
1965
|
summary: "",
|
|
1927
1966
|
description: "",
|
|
1928
1967
|
category: "directives",
|
|
1929
|
-
version: "6.0.
|
|
1968
|
+
version: "6.0.1",
|
|
1930
1969
|
bindings: {
|
|
1931
1970
|
angular: {
|
|
1932
1971
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -1958,7 +1997,7 @@ var uni_index_default = {
|
|
|
1958
1997
|
summary: "",
|
|
1959
1998
|
description: "",
|
|
1960
1999
|
category: "components",
|
|
1961
|
-
version: "6.0.
|
|
2000
|
+
version: "6.0.1",
|
|
1962
2001
|
bindings: {
|
|
1963
2002
|
angular: {
|
|
1964
2003
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2012,10 +2051,14 @@ var uni_index_default = {
|
|
|
2012
2051
|
}
|
|
2013
2052
|
],
|
|
2014
2053
|
guidelines: {
|
|
2015
|
-
whenToUse: "",
|
|
2054
|
+
whenToUse: "Navigation drawer with two modes sharing one content slot:\n- **`side`** renders an in-flow `<aside>` that pushes page content \u2014 the classic\n dashboard sidenav. Opening and closing animates its width; a divider border primitive\n separates it from the content, and it is hidden from assistive tech while closed.\n- **`over`** renders a native `<dialog>` in the top layer: focus trapping, Escape, and\n the scrim backdrop come from the platform, and the panel slides in from its edge\n (`position`: `start` or `end`).\n`[(open)]` is two-way; Escape and backdrop clicks keep it in sync. Surface, width,\ndivider, elevation, padding and backdrop all resolve from the theme's `drawer` options.",
|
|
2016
2055
|
dos: [],
|
|
2017
2056
|
donts: [],
|
|
2018
|
-
accessibility: [
|
|
2057
|
+
accessibility: [
|
|
2058
|
+
"Overlay mode is a native `<dialog>`: focus is trapped by `showModal()`, Escape closes, and the backdrop click closes \u2014 all kept in sync with `[(open)]`.",
|
|
2059
|
+
'Give the overlay an accessible name via `ariaLabel` (defaults to "Navigation").',
|
|
2060
|
+
"A closed side drawer is `aria-hidden`, so its links leave the accessibility tree."
|
|
2061
|
+
]
|
|
2019
2062
|
},
|
|
2020
2063
|
relatedTokens: [
|
|
2021
2064
|
"drawer.behavior.color",
|
|
@@ -2033,7 +2076,7 @@ var uni_index_default = {
|
|
|
2033
2076
|
summary: "",
|
|
2034
2077
|
description: "",
|
|
2035
2078
|
category: "components",
|
|
2036
|
-
version: "6.0.
|
|
2079
|
+
version: "6.0.1",
|
|
2037
2080
|
bindings: {
|
|
2038
2081
|
angular: {
|
|
2039
2082
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2122,7 +2165,7 @@ var uni_index_default = {
|
|
|
2122
2165
|
summary: "",
|
|
2123
2166
|
description: "",
|
|
2124
2167
|
category: "layout",
|
|
2125
|
-
version: "6.0.
|
|
2168
|
+
version: "6.0.1",
|
|
2126
2169
|
bindings: {
|
|
2127
2170
|
angular: {
|
|
2128
2171
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2161,10 +2204,12 @@ var uni_index_default = {
|
|
|
2161
2204
|
}
|
|
2162
2205
|
],
|
|
2163
2206
|
guidelines: {
|
|
2164
|
-
whenToUse: "",
|
|
2207
|
+
whenToUse: "Expand is a group of components that can be used in concert to expand/collapse sections of information.\nThe Expand component is transparent in nature and can nest any element to collapse it out of view.\nThe Expand Toggle is an optional convenience element that can be used to trigger the expand/collapse animation.\nIt has been designed to work with the Card Header.",
|
|
2165
2208
|
dos: [],
|
|
2166
2209
|
donts: [],
|
|
2167
|
-
accessibility: [
|
|
2210
|
+
accessibility: [
|
|
2211
|
+
"The toggle carries `aria-expanded` and `aria-controls` for its region (wired automatically inside Expand Area)."
|
|
2212
|
+
]
|
|
2168
2213
|
},
|
|
2169
2214
|
relatedTokens: []
|
|
2170
2215
|
},
|
|
@@ -2175,7 +2220,7 @@ var uni_index_default = {
|
|
|
2175
2220
|
summary: "",
|
|
2176
2221
|
description: "",
|
|
2177
2222
|
category: "layout",
|
|
2178
|
-
version: "6.0.
|
|
2223
|
+
version: "6.0.1",
|
|
2179
2224
|
bindings: {
|
|
2180
2225
|
angular: {
|
|
2181
2226
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2232,7 +2277,7 @@ var uni_index_default = {
|
|
|
2232
2277
|
}
|
|
2233
2278
|
],
|
|
2234
2279
|
guidelines: {
|
|
2235
|
-
whenToUse: "",
|
|
2280
|
+
whenToUse: "The batteries-included collapsible: a themed surface with a header row, an Expand\nToggle, and a content region wired together \u2014 `aria-expanded`/`aria-controls`\nhandled automatically. For custom collapse layouts, compose the lower-level Expand\nand Expand Toggle directly.",
|
|
2236
2281
|
dos: [],
|
|
2237
2282
|
donts: [],
|
|
2238
2283
|
accessibility: []
|
|
@@ -2246,7 +2291,7 @@ var uni_index_default = {
|
|
|
2246
2291
|
summary: "",
|
|
2247
2292
|
description: "",
|
|
2248
2293
|
category: "forms",
|
|
2249
|
-
version: "6.0.
|
|
2294
|
+
version: "6.0.1",
|
|
2250
2295
|
bindings: {
|
|
2251
2296
|
angular: {
|
|
2252
2297
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2278,7 +2323,7 @@ var uni_index_default = {
|
|
|
2278
2323
|
}
|
|
2279
2324
|
],
|
|
2280
2325
|
guidelines: {
|
|
2281
|
-
whenToUse: "",
|
|
2326
|
+
whenToUse: 'The Expand Toggle is a chevron icon button that controls collapsed/expanded state. It pairs\nwith the [Expand](?path=/docs/components-expand--docs) component: bind the toggle\'s\n`collapsed` model to the Expand\'s `collapsed` input to build collapsible sections.\nThe icon rotates 180\xB0 between states and shows an "Expand"/"Collapse" tooltip.',
|
|
2282
2327
|
dos: [],
|
|
2283
2328
|
donts: [],
|
|
2284
2329
|
accessibility: []
|
|
@@ -2292,7 +2337,7 @@ var uni_index_default = {
|
|
|
2292
2337
|
summary: "",
|
|
2293
2338
|
description: "",
|
|
2294
2339
|
category: "forms",
|
|
2295
|
-
version: "6.0.
|
|
2340
|
+
version: "6.0.1",
|
|
2296
2341
|
bindings: {
|
|
2297
2342
|
angular: {
|
|
2298
2343
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2434,10 +2479,12 @@ var uni_index_default = {
|
|
|
2434
2479
|
}
|
|
2435
2480
|
],
|
|
2436
2481
|
guidelines: {
|
|
2437
|
-
whenToUse: "",
|
|
2482
|
+
whenToUse: "The File Drop Zone component is used in uploading files.",
|
|
2438
2483
|
dos: [],
|
|
2439
2484
|
donts: [],
|
|
2440
|
-
accessibility: [
|
|
2485
|
+
accessibility: [
|
|
2486
|
+
'Without a browse button, the zone itself is `role="button"` with `tabindex="0"` and Enter/Space activation.'
|
|
2487
|
+
]
|
|
2441
2488
|
},
|
|
2442
2489
|
relatedTokens: []
|
|
2443
2490
|
},
|
|
@@ -2448,7 +2495,7 @@ var uni_index_default = {
|
|
|
2448
2495
|
summary: "",
|
|
2449
2496
|
description: "",
|
|
2450
2497
|
category: "layout",
|
|
2451
|
-
version: "6.0.
|
|
2498
|
+
version: "6.0.1",
|
|
2452
2499
|
bindings: {
|
|
2453
2500
|
angular: {
|
|
2454
2501
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2531,7 +2578,7 @@ var uni_index_default = {
|
|
|
2531
2578
|
}
|
|
2532
2579
|
],
|
|
2533
2580
|
guidelines: {
|
|
2534
|
-
whenToUse: "",
|
|
2581
|
+
whenToUse: "Grid is a layout component used for composing elements in a grid-like pattern.\nLike tables, grid layouts align elements into columns and rows.\nHowever, grids allow for more control when spanning elements across columns and rows.",
|
|
2535
2582
|
dos: [],
|
|
2536
2583
|
donts: [],
|
|
2537
2584
|
accessibility: []
|
|
@@ -2545,7 +2592,7 @@ var uni_index_default = {
|
|
|
2545
2592
|
summary: "",
|
|
2546
2593
|
description: "",
|
|
2547
2594
|
category: "layout",
|
|
2548
|
-
version: "6.0.
|
|
2595
|
+
version: "6.0.1",
|
|
2549
2596
|
bindings: {
|
|
2550
2597
|
angular: {
|
|
2551
2598
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2577,7 +2624,7 @@ var uni_index_default = {
|
|
|
2577
2624
|
summary: "",
|
|
2578
2625
|
description: "",
|
|
2579
2626
|
category: "primitives",
|
|
2580
|
-
version: "6.0.
|
|
2627
|
+
version: "6.0.1",
|
|
2581
2628
|
bindings: {
|
|
2582
2629
|
angular: {
|
|
2583
2630
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2608,10 +2655,13 @@ var uni_index_default = {
|
|
|
2608
2655
|
}
|
|
2609
2656
|
],
|
|
2610
2657
|
guidelines: {
|
|
2611
|
-
whenToUse: "",
|
|
2658
|
+
whenToUse: "Icons are adaptive svg images. Instead of defining a size or color attributes, Icons\nwill grow to the space allotted to them and use the current color of its parent element.\nHowever, it is possible to statically set the icon color.",
|
|
2612
2659
|
dos: [],
|
|
2613
2660
|
donts: [],
|
|
2614
|
-
accessibility: [
|
|
2661
|
+
accessibility: [
|
|
2662
|
+
"Icons are decorative (`aria-hidden`) \u2014 the parent control carries the accessible name.",
|
|
2663
|
+
"Icons come from the theme's `icons` map (masked with `currentColor`); unknown names render nothing."
|
|
2664
|
+
]
|
|
2615
2665
|
},
|
|
2616
2666
|
relatedTokens: []
|
|
2617
2667
|
},
|
|
@@ -2622,7 +2672,7 @@ var uni_index_default = {
|
|
|
2622
2672
|
summary: "",
|
|
2623
2673
|
description: "",
|
|
2624
2674
|
category: "primitives",
|
|
2625
|
-
version: "6.0.
|
|
2675
|
+
version: "6.0.1",
|
|
2626
2676
|
bindings: {
|
|
2627
2677
|
angular: {
|
|
2628
2678
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2708,10 +2758,13 @@ var uni_index_default = {
|
|
|
2708
2758
|
}
|
|
2709
2759
|
],
|
|
2710
2760
|
guidelines: {
|
|
2711
|
-
whenToUse: "",
|
|
2761
|
+
whenToUse: "A square, icon-only button for toolbars, bars, and tight layouts. Renders a real\n`<button>` around a symbol or icon, with ghost as the default variant so it sits\nquietly on any surface. Because there is no visible text, the accessible name comes\nfrom projected (visually hidden) text or `ariaLabel`.",
|
|
2712
2762
|
dos: [],
|
|
2713
2763
|
donts: [],
|
|
2714
|
-
accessibility: [
|
|
2764
|
+
accessibility: [
|
|
2765
|
+
"Icon-only buttons need a name: project text (rendered visually hidden) or set `ariaLabel`.",
|
|
2766
|
+
"The icon/symbol itself is decorative (`aria-hidden`)."
|
|
2767
|
+
]
|
|
2715
2768
|
},
|
|
2716
2769
|
relatedTokens: []
|
|
2717
2770
|
},
|
|
@@ -2722,7 +2775,7 @@ var uni_index_default = {
|
|
|
2722
2775
|
summary: "",
|
|
2723
2776
|
description: "",
|
|
2724
2777
|
category: "forms",
|
|
2725
|
-
version: "6.0.
|
|
2778
|
+
version: "6.0.1",
|
|
2726
2779
|
bindings: {
|
|
2727
2780
|
angular: {
|
|
2728
2781
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2834,10 +2887,15 @@ var uni_index_default = {
|
|
|
2834
2887
|
}
|
|
2835
2888
|
],
|
|
2836
2889
|
guidelines: {
|
|
2837
|
-
whenToUse: "",
|
|
2890
|
+
whenToUse: "Single-line text field with the shared input chrome (themed color, border, typeface,\nfocus ring, error state). It implements `FormValueControl<string>`: bind a Signal\nForms field with `[field]`, or drive `[(value)]` directly. Errors style the field\nonly after the user has interacted (touched or dirty), and `required` syncs from\n`required()` validators automatically.\nProject adornments with the `pre-input` / `post-input` slots. For multi-line text\nuse Textarea; for search semantics use Search Input.",
|
|
2838
2891
|
dos: [],
|
|
2839
2892
|
donts: [],
|
|
2840
|
-
accessibility: [
|
|
2893
|
+
accessibility: [
|
|
2894
|
+
"`label` is required and becomes the accessible name (`aria-label`).",
|
|
2895
|
+
"`aria-invalid` reflects the error state once the field was touched or is dirty.",
|
|
2896
|
+
"`aria-required` mirrors the `required` state synced from validators.",
|
|
2897
|
+
"Link external error text with `ariaDescribedBy`."
|
|
2898
|
+
]
|
|
2841
2899
|
},
|
|
2842
2900
|
relatedTokens: [
|
|
2843
2901
|
"input.behavior.typeFace",
|
|
@@ -2862,7 +2920,7 @@ var uni_index_default = {
|
|
|
2862
2920
|
summary: "",
|
|
2863
2921
|
description: "",
|
|
2864
2922
|
category: "forms",
|
|
2865
|
-
version: "6.0.
|
|
2923
|
+
version: "6.0.1",
|
|
2866
2924
|
bindings: {
|
|
2867
2925
|
angular: {
|
|
2868
2926
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2921,7 +2979,7 @@ var uni_index_default = {
|
|
|
2921
2979
|
}
|
|
2922
2980
|
],
|
|
2923
2981
|
guidelines: {
|
|
2924
|
-
whenToUse: "",
|
|
2982
|
+
whenToUse: "The Input Box is the themed shell shared by all text-like form controls\n([Input](?path=/docs/components-forms-input--docs),\n[Select](?path=/docs/components-forms-select--docs), Multi Select Dropdown). It projects any\nnative `input` or `select` element, strips the platform's default styling, and applies the\n`input` component theme options: colors, border, radius, focus outline, and the error and\ndisabled states.\nUse it directly when composing a custom form control that should match the design system's\ninput styling.",
|
|
2925
2983
|
dos: [],
|
|
2926
2984
|
donts: [],
|
|
2927
2985
|
accessibility: []
|
|
@@ -2935,7 +2993,7 @@ var uni_index_default = {
|
|
|
2935
2993
|
summary: "",
|
|
2936
2994
|
description: "",
|
|
2937
2995
|
category: "components",
|
|
2938
|
-
version: "6.0.
|
|
2996
|
+
version: "6.0.1",
|
|
2939
2997
|
bindings: {
|
|
2940
2998
|
angular: {
|
|
2941
2999
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -2991,7 +3049,7 @@ var uni_index_default = {
|
|
|
2991
3049
|
}
|
|
2992
3050
|
],
|
|
2993
3051
|
guidelines: {
|
|
2994
|
-
whenToUse: "",
|
|
3052
|
+
whenToUse: "The JSON View component provides a simple way to display JSON data in a formatted, readable manner. It renders the JSON in a textarea element, making it easy for users to view and copy the content. The component automatically formats the JSON with proper indentation for better readability.",
|
|
2995
3053
|
dos: [],
|
|
2996
3054
|
donts: [],
|
|
2997
3055
|
accessibility: []
|
|
@@ -3005,7 +3063,7 @@ var uni_index_default = {
|
|
|
3005
3063
|
summary: "",
|
|
3006
3064
|
description: "",
|
|
3007
3065
|
category: "layout",
|
|
3008
|
-
version: "6.0.
|
|
3066
|
+
version: "6.0.1",
|
|
3009
3067
|
bindings: {
|
|
3010
3068
|
angular: {
|
|
3011
3069
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3065,10 +3123,13 @@ var uni_index_default = {
|
|
|
3065
3123
|
}
|
|
3066
3124
|
],
|
|
3067
3125
|
guidelines: {
|
|
3068
|
-
whenToUse: "",
|
|
3126
|
+
whenToUse: "Menus can be linked to any component, but it is recommended to use either the `text-button` or `icon-button` component.\nMenus are populated by creating an array of Menu Items (`MenuItem[]`) and binding it to the `Menu` component.\nActions are optional as the `Menu` component also emits the clicked menu item via the `menuItemClicked` output attribute.\n### Menu Item Interface\n```\nMenuItem {\n label: string;\n symbolName?: string;\n action?: () => void;\n}\n```",
|
|
3069
3127
|
dos: [],
|
|
3070
3128
|
donts: [],
|
|
3071
|
-
accessibility: [
|
|
3129
|
+
accessibility: [
|
|
3130
|
+
"Full ARIA menu pattern: arrows and Home/End move, first-letter typeahead jumps, Enter/Space activates.",
|
|
3131
|
+
"ArrowDown/ArrowUp on the trigger opens onto the first/last item; focus returns to the trigger on close."
|
|
3132
|
+
]
|
|
3072
3133
|
},
|
|
3073
3134
|
relatedTokens: []
|
|
3074
3135
|
},
|
|
@@ -3079,7 +3140,7 @@ var uni_index_default = {
|
|
|
3079
3140
|
summary: "",
|
|
3080
3141
|
description: "",
|
|
3081
3142
|
category: "layout",
|
|
3082
|
-
version: "6.0.
|
|
3143
|
+
version: "6.0.1",
|
|
3083
3144
|
bindings: {
|
|
3084
3145
|
angular: {
|
|
3085
3146
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3195,7 +3256,7 @@ var uni_index_default = {
|
|
|
3195
3256
|
summary: "",
|
|
3196
3257
|
description: "",
|
|
3197
3258
|
category: "forms",
|
|
3198
|
-
version: "6.0.
|
|
3259
|
+
version: "6.0.1",
|
|
3199
3260
|
bindings: {
|
|
3200
3261
|
angular: {
|
|
3201
3262
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3266,10 +3327,13 @@ var uni_index_default = {
|
|
|
3266
3327
|
}
|
|
3267
3328
|
],
|
|
3268
3329
|
guidelines: {
|
|
3269
|
-
whenToUse: "",
|
|
3330
|
+
whenToUse: "Inline multiple-choice: every option visible as a toggleable item, selection\nemitted as an array. Reach for it when the option set is small enough to show all\nat once and seeing the full set helps the choice; when space is tight or options\nare many, use Multi Select Dropdown instead.",
|
|
3270
3331
|
dos: [],
|
|
3271
3332
|
donts: [],
|
|
3272
|
-
accessibility: [
|
|
3333
|
+
accessibility: [
|
|
3334
|
+
"Options are real checkboxes in a labelled group \u2014 Space toggles, Tab moves between them.",
|
|
3335
|
+
"Selection state is announced per option."
|
|
3336
|
+
]
|
|
3273
3337
|
},
|
|
3274
3338
|
relatedTokens: []
|
|
3275
3339
|
},
|
|
@@ -3280,7 +3344,7 @@ var uni_index_default = {
|
|
|
3280
3344
|
summary: "",
|
|
3281
3345
|
description: "",
|
|
3282
3346
|
category: "forms",
|
|
3283
|
-
version: "6.0.
|
|
3347
|
+
version: "6.0.1",
|
|
3284
3348
|
bindings: {
|
|
3285
3349
|
angular: {
|
|
3286
3350
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3397,10 +3461,14 @@ var uni_index_default = {
|
|
|
3397
3461
|
}
|
|
3398
3462
|
],
|
|
3399
3463
|
guidelines: {
|
|
3400
|
-
whenToUse: "",
|
|
3464
|
+
whenToUse: "Multiple choice behind a compact trigger: a disclosure popover containing a search\nfield, checkbox options, and a Done action. Implements `FormValueControl` with an\narray value for Signal Forms, and shows a summarized selection in the trigger.\nThe popover surface, radius, and elevation resolve from the\n`multiSelectDropdown` theme options.",
|
|
3401
3465
|
dos: [],
|
|
3402
3466
|
donts: [],
|
|
3403
|
-
accessibility: [
|
|
3467
|
+
accessibility: [
|
|
3468
|
+
'The trigger is a disclosure (`aria-haspopup="dialog"`, `aria-expanded`); the popover contains native focusables Tab reaches normally.',
|
|
3469
|
+
"The search input is labelled; options are real checkboxes announced with their state.",
|
|
3470
|
+
"Escape closes the popover and returns focus to the trigger."
|
|
3471
|
+
]
|
|
3404
3472
|
},
|
|
3405
3473
|
relatedTokens: []
|
|
3406
3474
|
},
|
|
@@ -3411,7 +3479,7 @@ var uni_index_default = {
|
|
|
3411
3479
|
summary: "",
|
|
3412
3480
|
description: "",
|
|
3413
3481
|
category: "feedback",
|
|
3414
|
-
version: "6.0.
|
|
3482
|
+
version: "6.0.1",
|
|
3415
3483
|
bindings: {
|
|
3416
3484
|
angular: {
|
|
3417
3485
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3636,10 +3704,15 @@ var uni_index_default = {
|
|
|
3636
3704
|
}
|
|
3637
3705
|
],
|
|
3638
3706
|
guidelines: {
|
|
3639
|
-
whenToUse: "",
|
|
3707
|
+
whenToUse: 'Attention indicator anchored to whatever it wraps \u2014 an icon button, a nav item, an\navatar. Three shapes: `dot` (something is new), `count` (how many), and `pill`\n(counts that need room); `maxCount` caps the display ("99+"). Position it on any\ncorner of the wrapped content.\nRadius and offset resolve from the `notificationBadge` theme options; the badge\nwears the active `variant` color.',
|
|
3640
3708
|
dos: [],
|
|
3641
|
-
donts: [
|
|
3642
|
-
|
|
3709
|
+
donts: [
|
|
3710
|
+
"Convey urgency by color alone \u2014 the count/dot shape carries the signal"
|
|
3711
|
+
],
|
|
3712
|
+
accessibility: [
|
|
3713
|
+
'The visual badge is hidden from assistive tech; a visually-hidden text announcement carries the meaning ("3 notifications").',
|
|
3714
|
+
"Provide `ariaLabel` context when the wrapped control's purpose isn't obvious from its own name."
|
|
3715
|
+
]
|
|
3643
3716
|
},
|
|
3644
3717
|
relatedTokens: []
|
|
3645
3718
|
},
|
|
@@ -3650,7 +3723,7 @@ var uni_index_default = {
|
|
|
3650
3723
|
summary: "",
|
|
3651
3724
|
description: "",
|
|
3652
3725
|
category: "feedback",
|
|
3653
|
-
version: "6.0.
|
|
3726
|
+
version: "6.0.1",
|
|
3654
3727
|
bindings: {
|
|
3655
3728
|
angular: {
|
|
3656
3729
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3674,7 +3747,7 @@ var uni_index_default = {
|
|
|
3674
3747
|
summary: "",
|
|
3675
3748
|
description: "",
|
|
3676
3749
|
category: "data",
|
|
3677
|
-
version: "6.0.
|
|
3750
|
+
version: "6.0.1",
|
|
3678
3751
|
bindings: {
|
|
3679
3752
|
angular: {
|
|
3680
3753
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3734,10 +3807,13 @@ var uni_index_default = {
|
|
|
3734
3807
|
}
|
|
3735
3808
|
],
|
|
3736
3809
|
guidelines: {
|
|
3737
|
-
whenToUse: "",
|
|
3810
|
+
whenToUse: "The Paginator drives page navigation for any `UniDatasource`: first/previous/next/last\nbuttons, truncated page numbers, an editable page size, and a page jumper. Each section can\nbe toggled independently, so it can render as a full control bar or a minimal pager \u2014 the\n[Data Table](?path=/docs/components-data-table--docs) stories use one paginator in the header\nfor page size and another in the footer for page numbers.",
|
|
3738
3811
|
dos: [],
|
|
3739
3812
|
donts: [],
|
|
3740
|
-
accessibility: [
|
|
3813
|
+
accessibility: [
|
|
3814
|
+
'A `role="navigation"` landmark; pages are real buttons with `aria-current="page"` on the active one.',
|
|
3815
|
+
"The page-number input is labelled."
|
|
3816
|
+
]
|
|
3741
3817
|
},
|
|
3742
3818
|
relatedTokens: [
|
|
3743
3819
|
"paginator.behavior.gap",
|
|
@@ -3756,7 +3832,7 @@ var uni_index_default = {
|
|
|
3756
3832
|
summary: "",
|
|
3757
3833
|
description: "",
|
|
3758
3834
|
category: "layout",
|
|
3759
|
-
version: "6.0.
|
|
3835
|
+
version: "6.0.1",
|
|
3760
3836
|
bindings: {
|
|
3761
3837
|
angular: {
|
|
3762
3838
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3789,10 +3865,12 @@ var uni_index_default = {
|
|
|
3789
3865
|
}
|
|
3790
3866
|
],
|
|
3791
3867
|
guidelines: {
|
|
3792
|
-
whenToUse: "",
|
|
3868
|
+
whenToUse: "Popover is a non-modal dialog that floats around a trigger.\nAny type of content can be added inside a popover; however, it is most suitable for short callouts or compact actions.\n**Note:** It is important to add the `trigger` attribute to the item you want to open and be referenced to the Popover.",
|
|
3793
3869
|
dos: [],
|
|
3794
3870
|
donts: [],
|
|
3795
|
-
accessibility: [
|
|
3871
|
+
accessibility: [
|
|
3872
|
+
"The trigger carries `aria-expanded` and `aria-controls`; light-dismiss comes from the native popover."
|
|
3873
|
+
]
|
|
3796
3874
|
},
|
|
3797
3875
|
relatedTokens: []
|
|
3798
3876
|
},
|
|
@@ -3803,7 +3881,7 @@ var uni_index_default = {
|
|
|
3803
3881
|
summary: "",
|
|
3804
3882
|
description: "",
|
|
3805
3883
|
category: "feedback",
|
|
3806
|
-
version: "6.0.
|
|
3884
|
+
version: "6.0.1",
|
|
3807
3885
|
bindings: {
|
|
3808
3886
|
angular: {
|
|
3809
3887
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3851,10 +3929,12 @@ var uni_index_default = {
|
|
|
3851
3929
|
}
|
|
3852
3930
|
],
|
|
3853
3931
|
guidelines: {
|
|
3854
|
-
whenToUse: "",
|
|
3932
|
+
whenToUse: "The progress bar is a graphical way of representing progress to completion.",
|
|
3855
3933
|
dos: [],
|
|
3856
3934
|
donts: [],
|
|
3857
|
-
accessibility: [
|
|
3935
|
+
accessibility: [
|
|
3936
|
+
'`role="progressbar"` with `aria-valuenow`/`min`/`max`; name it with `ariaLabel`.'
|
|
3937
|
+
]
|
|
3858
3938
|
},
|
|
3859
3939
|
relatedTokens: []
|
|
3860
3940
|
},
|
|
@@ -3865,7 +3945,7 @@ var uni_index_default = {
|
|
|
3865
3945
|
summary: "",
|
|
3866
3946
|
description: "",
|
|
3867
3947
|
category: "feedback",
|
|
3868
|
-
version: "6.0.
|
|
3948
|
+
version: "6.0.1",
|
|
3869
3949
|
bindings: {
|
|
3870
3950
|
angular: {
|
|
3871
3951
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -3905,10 +3985,12 @@ var uni_index_default = {
|
|
|
3905
3985
|
}
|
|
3906
3986
|
],
|
|
3907
3987
|
guidelines: {
|
|
3908
|
-
whenToUse: "",
|
|
3988
|
+
whenToUse: "The progress gauge is a graphical way of representing progress to completion as well as scoring or ranking.",
|
|
3909
3989
|
dos: [],
|
|
3910
3990
|
donts: [],
|
|
3911
|
-
accessibility: [
|
|
3991
|
+
accessibility: [
|
|
3992
|
+
'`role="progressbar"` with `aria-valuenow`/`min`/`max`; name it with `ariaLabel`. The SVG is decorative.'
|
|
3993
|
+
]
|
|
3912
3994
|
},
|
|
3913
3995
|
relatedTokens: []
|
|
3914
3996
|
},
|
|
@@ -3919,7 +4001,7 @@ var uni_index_default = {
|
|
|
3919
4001
|
summary: "",
|
|
3920
4002
|
description: "",
|
|
3921
4003
|
category: "forms",
|
|
3922
|
-
version: "6.0.
|
|
4004
|
+
version: "6.0.1",
|
|
3923
4005
|
bindings: {
|
|
3924
4006
|
angular: {
|
|
3925
4007
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4044,10 +4126,18 @@ var uni_index_default = {
|
|
|
4044
4126
|
}
|
|
4045
4127
|
],
|
|
4046
4128
|
guidelines: {
|
|
4047
|
-
whenToUse: "",
|
|
4048
|
-
dos: [
|
|
4049
|
-
|
|
4050
|
-
|
|
4129
|
+
whenToUse: "Single choice among a small set of visible options. The component renders the whole\ngroup from an `options` array (`{ label, value, disabled? }`), implements\n`FormValueControl<string>` for Signal Forms, and defaults each group to a unique\n`name` so multiple groups on a page never collide.\nRing, fill, and size resolve from the `radio` theme options; the selected dot wears\nthe active `variant` color.",
|
|
4130
|
+
dos: [
|
|
4131
|
+
"Use for 2\u20135 mutually exclusive options that should all be visible"
|
|
4132
|
+
],
|
|
4133
|
+
donts: [
|
|
4134
|
+
"Use for long option lists \u2014 that is a select"
|
|
4135
|
+
],
|
|
4136
|
+
accessibility: [
|
|
4137
|
+
'`role="radiogroup"` labelled by the group label via `aria-labelledby`.',
|
|
4138
|
+
"Native radio inputs: arrow keys move selection within the group, Tab moves out.",
|
|
4139
|
+
"`aria-invalid` reflects the error state once the group was touched or is dirty."
|
|
4140
|
+
]
|
|
4051
4141
|
},
|
|
4052
4142
|
relatedTokens: [
|
|
4053
4143
|
"radio.behavior.size",
|
|
@@ -4062,7 +4152,7 @@ var uni_index_default = {
|
|
|
4062
4152
|
summary: "",
|
|
4063
4153
|
description: "",
|
|
4064
4154
|
category: "directives",
|
|
4065
|
-
version: "6.0.
|
|
4155
|
+
version: "6.0.1",
|
|
4066
4156
|
bindings: {
|
|
4067
4157
|
angular: {
|
|
4068
4158
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4086,7 +4176,7 @@ var uni_index_default = {
|
|
|
4086
4176
|
summary: "",
|
|
4087
4177
|
description: "",
|
|
4088
4178
|
category: "layout",
|
|
4089
|
-
version: "6.0.
|
|
4179
|
+
version: "6.0.1",
|
|
4090
4180
|
bindings: {
|
|
4091
4181
|
angular: {
|
|
4092
4182
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4127,7 +4217,7 @@ var uni_index_default = {
|
|
|
4127
4217
|
}
|
|
4128
4218
|
],
|
|
4129
4219
|
guidelines: {
|
|
4130
|
-
whenToUse: "",
|
|
4220
|
+
whenToUse: "`Row` is a layout component used to group elements in a horizontal arrangement and applies a uniform space between them.\n`Row` is an extension to the `Box` component and has all the `Box` attributes available to it.",
|
|
4131
4221
|
dos: [],
|
|
4132
4222
|
donts: [],
|
|
4133
4223
|
accessibility: []
|
|
@@ -4141,7 +4231,7 @@ var uni_index_default = {
|
|
|
4141
4231
|
summary: "",
|
|
4142
4232
|
description: "",
|
|
4143
4233
|
category: "layout",
|
|
4144
|
-
version: "6.0.
|
|
4234
|
+
version: "6.0.1",
|
|
4145
4235
|
bindings: {
|
|
4146
4236
|
angular: {
|
|
4147
4237
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4274,7 +4364,7 @@ var uni_index_default = {
|
|
|
4274
4364
|
}
|
|
4275
4365
|
],
|
|
4276
4366
|
guidelines: {
|
|
4277
|
-
whenToUse: "",
|
|
4367
|
+
whenToUse: "A scroll container with themed, consistent scrollbars across browsers \u2014 thin\nEmotion-styled WebKit scrollbars with a `scrollbar-width`/`scrollbar-color`\nfallback. It detects scrollable state via ResizeObserver (the `scrollable` output)\nand offers `scrollToTop`/`scrollToBottom` for programmatic control.",
|
|
4278
4368
|
dos: [],
|
|
4279
4369
|
donts: [],
|
|
4280
4370
|
accessibility: []
|
|
@@ -4288,7 +4378,7 @@ var uni_index_default = {
|
|
|
4288
4378
|
summary: "",
|
|
4289
4379
|
description: "",
|
|
4290
4380
|
category: "forms",
|
|
4291
|
-
version: "6.0.
|
|
4381
|
+
version: "6.0.1",
|
|
4292
4382
|
bindings: {
|
|
4293
4383
|
angular: {
|
|
4294
4384
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4381,10 +4471,14 @@ var uni_index_default = {
|
|
|
4381
4471
|
}
|
|
4382
4472
|
],
|
|
4383
4473
|
guidelines: {
|
|
4384
|
-
whenToUse: "",
|
|
4474
|
+
whenToUse: "Generic search field wearing the shared input chrome: a decorative leading magnifier,\na clear button while there's a query, and Enter to submit (`search`). `change` emits\ndebounced as the user types \u2014 use it to refresh results or the `suggestions` input.\nWith `suggestions`, the field becomes an ARIA combobox: entries render in a listbox\nunder the field, ArrowUp/Down move the highlight, Enter selects (emitting both\n`suggestionSelected` and `search`), and Escape closes the list first, then clears the\nquery. The suggestion list's surface, elevation and radius resolve from the theme's\n`searchInput` options, alongside the search/clear symbols.",
|
|
4385
4475
|
dos: [],
|
|
4386
4476
|
donts: [],
|
|
4387
|
-
accessibility: [
|
|
4477
|
+
accessibility: [
|
|
4478
|
+
"The field is an ARIA combobox: `aria-expanded`, `aria-controls`, and `aria-activedescendant` track the suggestion listbox.",
|
|
4479
|
+
"ArrowUp/ArrowDown move the active option, Enter selects, Escape closes the list first and clears the query second.",
|
|
4480
|
+
'The magnifier is decorative; the clear button has an accessible name ("Clear search").'
|
|
4481
|
+
]
|
|
4388
4482
|
},
|
|
4389
4483
|
relatedTokens: []
|
|
4390
4484
|
},
|
|
@@ -4395,7 +4489,7 @@ var uni_index_default = {
|
|
|
4395
4489
|
summary: "",
|
|
4396
4490
|
description: "",
|
|
4397
4491
|
category: "forms",
|
|
4398
|
-
version: "6.0.
|
|
4492
|
+
version: "6.0.1",
|
|
4399
4493
|
bindings: {
|
|
4400
4494
|
angular: {
|
|
4401
4495
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4514,10 +4608,13 @@ var uni_index_default = {
|
|
|
4514
4608
|
}
|
|
4515
4609
|
],
|
|
4516
4610
|
guidelines: {
|
|
4517
|
-
whenToUse: "",
|
|
4611
|
+
whenToUse: "Single choice from a list, on a native `<select>` \u2014 platform pickers on mobile,\nplatform keyboard behavior everywhere. Options are typed generically\n(`options: T[]` with `optionLabel`/`optionValue` accessors), and the component\nimplements `FormValueControl` for the Signal Forms `[field]` directive. Errors\nstyle the field only after interaction, matching Input.\nFor choosing several, use Multi Select; for type-to-filter over large sets, use\nSearch Input's type-ahead.",
|
|
4518
4612
|
dos: [],
|
|
4519
4613
|
donts: [],
|
|
4520
|
-
accessibility: [
|
|
4614
|
+
accessibility: [
|
|
4615
|
+
"Native `<select>`: platform keyboard interaction and mobile pickers for free.",
|
|
4616
|
+
"`label` becomes the accessible name; `aria-invalid` reflects the touched error state."
|
|
4617
|
+
]
|
|
4521
4618
|
},
|
|
4522
4619
|
relatedTokens: []
|
|
4523
4620
|
},
|
|
@@ -4528,7 +4625,7 @@ var uni_index_default = {
|
|
|
4528
4625
|
summary: "",
|
|
4529
4626
|
description: "",
|
|
4530
4627
|
category: "components",
|
|
4531
|
-
version: "6.0.
|
|
4628
|
+
version: "6.0.1",
|
|
4532
4629
|
bindings: {
|
|
4533
4630
|
angular: {
|
|
4534
4631
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4598,10 +4695,15 @@ var uni_index_default = {
|
|
|
4598
4695
|
}
|
|
4599
4696
|
],
|
|
4600
4697
|
guidelines: {
|
|
4601
|
-
whenToUse: "",
|
|
4698
|
+
whenToUse: "Loading placeholder that sketches the shape of incoming content: `text` renders one or\nmore lines (ending on a short line, as real copy would), `rect` stands in for media and\ncharts, `circle` for avatars. Skeletons paint with the theme's surface tokens so they\nsit naturally on any brand in both modes, and the shimmer sweep only animates for users\nwho allow motion \u2014 under `prefers-reduced-motion` it degrades to calm static blocks.\nSkeletons are `aria-hidden`; announce loading on the container (e.g. `aria-busy`)\nwhere your app knows what is actually loading.",
|
|
4602
4699
|
dos: [],
|
|
4603
|
-
donts: [
|
|
4604
|
-
|
|
4700
|
+
donts: [
|
|
4701
|
+
"Announce individual skeletons to assistive tech \u2014 they are decorative placeholders"
|
|
4702
|
+
],
|
|
4703
|
+
accessibility: [
|
|
4704
|
+
"Skeletons are `aria-hidden` \u2014 announce loading on the container (e.g. `aria-busy`) where your app knows what is loading.",
|
|
4705
|
+
"The shimmer respects `prefers-reduced-motion`, degrading to static blocks."
|
|
4706
|
+
]
|
|
4605
4707
|
},
|
|
4606
4708
|
relatedTokens: [
|
|
4607
4709
|
"skeleton.behavior.color",
|
|
@@ -4619,7 +4721,7 @@ var uni_index_default = {
|
|
|
4619
4721
|
summary: "",
|
|
4620
4722
|
description: "",
|
|
4621
4723
|
category: "forms",
|
|
4622
|
-
version: "6.0.
|
|
4724
|
+
version: "6.0.1",
|
|
4623
4725
|
bindings: {
|
|
4624
4726
|
angular: {
|
|
4625
4727
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4732,10 +4834,14 @@ var uni_index_default = {
|
|
|
4732
4834
|
}
|
|
4733
4835
|
],
|
|
4734
4836
|
guidelines: {
|
|
4735
|
-
whenToUse: "",
|
|
4837
|
+
whenToUse: 'Range slider for picking a number within bounds. It renders a native\n`<input type="range">`, so keyboard interaction (arrows, Home/End, Page Up/Down) and\nthe ARIA slider contract come from the platform. The same Signal Forms contract as\nInput applies \u2014 bind with the `[field]` directive or drive `[(value)]` directly.\nFill and thumb color, track color, radii and geometry resolve from the theme\'s\n`slider` options; the fill level rides a CSS custom property, so dragging never\nregenerates styles.',
|
|
4736
4838
|
dos: [],
|
|
4737
4839
|
donts: [],
|
|
4738
|
-
accessibility: [
|
|
4840
|
+
accessibility: [
|
|
4841
|
+
'Native `<input type="range">`: arrows, Home/End, and Page Up/Down come from the platform, and the ARIA slider contract (valuenow/min/max) is native.',
|
|
4842
|
+
"`label` is required and becomes the accessible name.",
|
|
4843
|
+
"Expose the current value textually nearby and link it with `ariaDescribedBy` when the number matters."
|
|
4844
|
+
]
|
|
4739
4845
|
},
|
|
4740
4846
|
relatedTokens: [
|
|
4741
4847
|
"slider.behavior.color",
|
|
@@ -4752,7 +4858,7 @@ var uni_index_default = {
|
|
|
4752
4858
|
summary: "",
|
|
4753
4859
|
description: "",
|
|
4754
4860
|
category: "feedback",
|
|
4755
|
-
version: "6.0.
|
|
4861
|
+
version: "6.0.1",
|
|
4756
4862
|
bindings: {
|
|
4757
4863
|
angular: {
|
|
4758
4864
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4826,7 +4932,7 @@ var uni_index_default = {
|
|
|
4826
4932
|
}
|
|
4827
4933
|
],
|
|
4828
4934
|
guidelines: {
|
|
4829
|
-
whenToUse: "",
|
|
4935
|
+
whenToUse: "The Snackbar component is used to give feedback to users after an action has taken place.\nIt appears near the bottom center of the screen temporarily and floats above the UI to not affect the application's layout.\nA side action can be defined (e.g. undoing a process or navigating to the details of a newly created record).",
|
|
4830
4936
|
dos: [],
|
|
4831
4937
|
donts: [],
|
|
4832
4938
|
accessibility: []
|
|
@@ -4844,7 +4950,7 @@ var uni_index_default = {
|
|
|
4844
4950
|
summary: "",
|
|
4845
4951
|
description: "",
|
|
4846
4952
|
category: "data",
|
|
4847
|
-
version: "6.0.
|
|
4953
|
+
version: "6.0.1",
|
|
4848
4954
|
bindings: {
|
|
4849
4955
|
angular: {
|
|
4850
4956
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4889,7 +4995,7 @@ var uni_index_default = {
|
|
|
4889
4995
|
}
|
|
4890
4996
|
],
|
|
4891
4997
|
guidelines: {
|
|
4892
|
-
whenToUse: "",
|
|
4998
|
+
whenToUse: "The Sort Header wraps a column heading and cycles the bound datasource's sort state\n(ascending \u2192 descending \u2192 unsorted) when clicked. An animated arrow indicates the current\nsort direction. It is used by the [Data Table](?path=/docs/components-data-table--docs)\nfor sortable columns, but can wrap any header content bound to a `UniDatasource`.",
|
|
4893
4999
|
dos: [],
|
|
4894
5000
|
donts: [],
|
|
4895
5001
|
accessibility: []
|
|
@@ -4903,7 +5009,7 @@ var uni_index_default = {
|
|
|
4903
5009
|
summary: "",
|
|
4904
5010
|
description: "",
|
|
4905
5011
|
category: "layout",
|
|
4906
|
-
version: "6.0.
|
|
5012
|
+
version: "6.0.1",
|
|
4907
5013
|
bindings: {
|
|
4908
5014
|
angular: {
|
|
4909
5015
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -4944,7 +5050,7 @@ var uni_index_default = {
|
|
|
4944
5050
|
}
|
|
4945
5051
|
],
|
|
4946
5052
|
guidelines: {
|
|
4947
|
-
whenToUse: "",
|
|
5053
|
+
whenToUse: "`Stack` is a layout component used to group elements in a vertical arrangement and applies a uniform space between them.\n`Stack` is an extension to the `Box` component and has all the `Box` attributes available to it.",
|
|
4948
5054
|
dos: [],
|
|
4949
5055
|
donts: [],
|
|
4950
5056
|
accessibility: []
|
|
@@ -4958,7 +5064,7 @@ var uni_index_default = {
|
|
|
4958
5064
|
summary: "",
|
|
4959
5065
|
description: "",
|
|
4960
5066
|
category: "components",
|
|
4961
|
-
version: "6.0.
|
|
5067
|
+
version: "6.0.1",
|
|
4962
5068
|
bindings: {
|
|
4963
5069
|
angular: {
|
|
4964
5070
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5029,10 +5135,15 @@ var uni_index_default = {
|
|
|
5029
5135
|
}
|
|
5030
5136
|
],
|
|
5031
5137
|
guidelines: {
|
|
5032
|
-
whenToUse: "",
|
|
5138
|
+
whenToUse: 'The KPI tile a dashboard leads with: a muted label, a large headline value (numbers\nauto-compact \u2014 `48234` renders "48.2K"), an optional signed delta, and an optional\ndecorative sparkline.\nThe delta\'s color is decided by **direction \xD7 whether up is good**, never direction\nalone \u2014 set `upIsGood` to `false` for measures like churn, errors, or cost, and a\nfalling number correctly reads as good news. The arrow is accompanied by\nscreen-reader text ("up"/"down"), so state never relies on color alone, and `caption`\nnames the comparison period.\nFrame (surface, border primitive, radius), typography (the type scale\'s `stat` role\nfor values), delta inks (the semantic `success`/`error`), and sparkline colors all\nresolve from the theme\'s `stat` options.',
|
|
5033
5139
|
dos: [],
|
|
5034
|
-
donts: [
|
|
5035
|
-
|
|
5140
|
+
donts: [
|
|
5141
|
+
"Rely on delta color alone \u2014 the arrow + wording carry direction for everyone"
|
|
5142
|
+
],
|
|
5143
|
+
accessibility: [
|
|
5144
|
+
'The delta arrow is decorative; screen readers hear "up"/"down" in words instead.',
|
|
5145
|
+
"The sparkline is `aria-hidden` \u2014 the value and delta carry the information."
|
|
5146
|
+
]
|
|
5036
5147
|
},
|
|
5037
5148
|
relatedTokens: [
|
|
5038
5149
|
"stat.behavior.labelTypeface",
|
|
@@ -5055,7 +5166,7 @@ var uni_index_default = {
|
|
|
5055
5166
|
summary: "",
|
|
5056
5167
|
description: "",
|
|
5057
5168
|
category: "primitives",
|
|
5058
|
-
version: "6.0.
|
|
5169
|
+
version: "6.0.1",
|
|
5059
5170
|
bindings: {
|
|
5060
5171
|
angular: {
|
|
5061
5172
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5107,10 +5218,12 @@ var uni_index_default = {
|
|
|
5107
5218
|
}
|
|
5108
5219
|
],
|
|
5109
5220
|
guidelines: {
|
|
5110
|
-
whenToUse: "",
|
|
5221
|
+
whenToUse: "The Symbol Component integrates the latest [Material Symbols](https://fonts.google.com/icons?icon.platform=web&icon.style=Rounded&icon.set=Material+Symbols&query=les).\nMaterial Symbols consolidates over 3,275 glyphs (icons) in a single font file with a wide range of design variants.\nSymbols are available in three styles and four adjustable variable font styles (fill, weight, grade, and optical size).",
|
|
5111
5222
|
dos: [],
|
|
5112
5223
|
donts: [],
|
|
5113
|
-
accessibility: [
|
|
5224
|
+
accessibility: [
|
|
5225
|
+
"Symbols are decorative (`aria-hidden`) \u2014 the parent control carries the accessible name."
|
|
5226
|
+
]
|
|
5114
5227
|
},
|
|
5115
5228
|
relatedTokens: [
|
|
5116
5229
|
"symbol.behavior.fill",
|
|
@@ -5126,7 +5239,7 @@ var uni_index_default = {
|
|
|
5126
5239
|
summary: "",
|
|
5127
5240
|
description: "",
|
|
5128
5241
|
category: "components",
|
|
5129
|
-
version: "6.0.
|
|
5242
|
+
version: "6.0.1",
|
|
5130
5243
|
bindings: {
|
|
5131
5244
|
angular: {
|
|
5132
5245
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5166,7 +5279,7 @@ var uni_index_default = {
|
|
|
5166
5279
|
summary: "",
|
|
5167
5280
|
description: "",
|
|
5168
5281
|
category: "components",
|
|
5169
|
-
version: "6.0.
|
|
5282
|
+
version: "6.0.1",
|
|
5170
5283
|
bindings: {
|
|
5171
5284
|
angular: {
|
|
5172
5285
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5196,10 +5309,20 @@ var uni_index_default = {
|
|
|
5196
5309
|
}
|
|
5197
5310
|
],
|
|
5198
5311
|
guidelines: {
|
|
5199
|
-
whenToUse: "",
|
|
5200
|
-
dos: [
|
|
5201
|
-
|
|
5202
|
-
|
|
5312
|
+
whenToUse: "Tabs organize peer views behind a single switcher. Each `uni-tab` supplies a label and\nits panel content; only the selected panel is instantiated, so heavy tab content costs\nnothing until visited.\nThe default tokens render underline tabs; a theme that sets `borderRadius: 'max'` and\nan `activeColor` gets segmented pills without any component changes.",
|
|
5313
|
+
dos: [
|
|
5314
|
+
"Use for peer views of the same subject (details, activity, settings)",
|
|
5315
|
+
"Keep labels to one or two words"
|
|
5316
|
+
],
|
|
5317
|
+
donts: [
|
|
5318
|
+
"Nest tabs inside tabs",
|
|
5319
|
+
"Use tabs for sequential steps \u2014 that is a stepper"
|
|
5320
|
+
],
|
|
5321
|
+
accessibility: [
|
|
5322
|
+
"Full WAI-ARIA tabs pattern: `tablist`/`tab`/`tabpanel` roles with wired",
|
|
5323
|
+
"Arrow keys move between tabs with selection following focus, wrapping at the ends;",
|
|
5324
|
+
"Roving tabindex: only the selected tab sits in the tab order; the panel itself is"
|
|
5325
|
+
]
|
|
5203
5326
|
},
|
|
5204
5327
|
relatedTokens: [
|
|
5205
5328
|
"tabs.behavior.typeface",
|
|
@@ -5220,7 +5343,7 @@ var uni_index_default = {
|
|
|
5220
5343
|
summary: "",
|
|
5221
5344
|
description: "",
|
|
5222
5345
|
category: "data",
|
|
5223
|
-
version: "6.0.
|
|
5346
|
+
version: "6.0.1",
|
|
5224
5347
|
bindings: {
|
|
5225
5348
|
angular: {
|
|
5226
5349
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5273,7 +5396,7 @@ var uni_index_default = {
|
|
|
5273
5396
|
}
|
|
5274
5397
|
],
|
|
5275
5398
|
guidelines: {
|
|
5276
|
-
whenToUse: "",
|
|
5399
|
+
whenToUse: "Compact label for classifying content \u2014 categories, states, filters. Tags are\ndisplay-only chips that wear the active variant's colors; for removable,\ntype-to-add chips (a future input variant), see the roadmap.",
|
|
5277
5400
|
dos: [],
|
|
5278
5401
|
donts: [],
|
|
5279
5402
|
accessibility: []
|
|
@@ -5287,7 +5410,7 @@ var uni_index_default = {
|
|
|
5287
5410
|
summary: "",
|
|
5288
5411
|
description: "",
|
|
5289
5412
|
category: "primitives",
|
|
5290
|
-
version: "6.0.
|
|
5413
|
+
version: "6.0.1",
|
|
5291
5414
|
bindings: {
|
|
5292
5415
|
angular: {
|
|
5293
5416
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5368,10 +5491,17 @@ var uni_index_default = {
|
|
|
5368
5491
|
}
|
|
5369
5492
|
],
|
|
5370
5493
|
guidelines: {
|
|
5371
|
-
whenToUse: "",
|
|
5372
|
-
dos: [
|
|
5373
|
-
|
|
5374
|
-
|
|
5494
|
+
whenToUse: 'The typography primitive, applied as an **attribute on any element** so your HTML\nsemantics stay intact. The attribute value is the typeface \u2014\n`<h1 uni-text="display-small">` \u2014 and `[uni-text]="role()"` binds it dynamically.\nWith no value, the typeface is inferred from the host element (`h1` \u2192\n`headline-large`, `p` \u2192 `body-1-long`, `small` \u2192 `caption`, `blockquote` \u2192 `quote`,\nfalling back to `title-small`), so plain semantic markup is correctly set with zero\nconfiguration. `color` takes any theme color token; `align`, `nowrap`, `maxWidth`,\nand `ellipsis` handle common text layout.',
|
|
5495
|
+
dos: [
|
|
5496
|
+
"Reach for semantic elements first and let the element-aware defaults set the type"
|
|
5497
|
+
],
|
|
5498
|
+
donts: [
|
|
5499
|
+
'Use `span uni-text="headline-large"` where a real heading belongs'
|
|
5500
|
+
],
|
|
5501
|
+
accessibility: [
|
|
5502
|
+
"Text never replaces your elements \u2014 headings stay `h1`\u2013`h6`, paragraphs stay `p`,",
|
|
5503
|
+
"Type is styling only: pick the element for meaning, the typeface for appearance"
|
|
5504
|
+
]
|
|
5375
5505
|
},
|
|
5376
5506
|
relatedTokens: []
|
|
5377
5507
|
},
|
|
@@ -5382,7 +5512,7 @@ var uni_index_default = {
|
|
|
5382
5512
|
summary: "",
|
|
5383
5513
|
description: "",
|
|
5384
5514
|
category: "primitives",
|
|
5385
|
-
version: "6.0.
|
|
5515
|
+
version: "6.0.1",
|
|
5386
5516
|
bindings: {
|
|
5387
5517
|
angular: {
|
|
5388
5518
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5492,10 +5622,13 @@ var uni_index_default = {
|
|
|
5492
5622
|
}
|
|
5493
5623
|
],
|
|
5494
5624
|
guidelines: {
|
|
5495
|
-
whenToUse: "",
|
|
5625
|
+
whenToUse: "Multi-line text field with the same Signal Forms contract as Input \u2014 use it anywhere\nfree-form text runs past one line (comments, descriptions, feedback). It shares Input's\nthemed chrome (color, border, error state, focus outline, typeface) and adds\ntextarea-specific behavior from the theme's `textarea` options: default `rows` and the\nCSS `resize` mode. Bind it to a form with the `[field]` directive, or drive `[(value)]`\ndirectly.",
|
|
5496
5626
|
dos: [],
|
|
5497
5627
|
donts: [],
|
|
5498
|
-
accessibility: [
|
|
5628
|
+
accessibility: [
|
|
5629
|
+
"`label` is required and becomes the accessible name (`aria-label`).",
|
|
5630
|
+
"Error state is exposed as `aria-invalid` once the field was touched or is dirty; wire your error text with `ariaDescribedBy`."
|
|
5631
|
+
]
|
|
5499
5632
|
},
|
|
5500
5633
|
relatedTokens: [
|
|
5501
5634
|
"textarea.behavior.rows",
|
|
@@ -5509,7 +5642,7 @@ var uni_index_default = {
|
|
|
5509
5642
|
summary: "",
|
|
5510
5643
|
description: "",
|
|
5511
5644
|
category: "primitives",
|
|
5512
|
-
version: "6.0.
|
|
5645
|
+
version: "6.0.1",
|
|
5513
5646
|
bindings: {
|
|
5514
5647
|
angular: {
|
|
5515
5648
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5539,7 +5672,7 @@ var uni_index_default = {
|
|
|
5539
5672
|
summary: "",
|
|
5540
5673
|
description: "",
|
|
5541
5674
|
category: "forms",
|
|
5542
|
-
version: "6.0.
|
|
5675
|
+
version: "6.0.1",
|
|
5543
5676
|
bindings: {
|
|
5544
5677
|
angular: {
|
|
5545
5678
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5643,10 +5776,18 @@ var uni_index_default = {
|
|
|
5643
5776
|
}
|
|
5644
5777
|
],
|
|
5645
5778
|
guidelines: {
|
|
5646
|
-
whenToUse: "",
|
|
5647
|
-
dos: [
|
|
5648
|
-
|
|
5649
|
-
|
|
5779
|
+
whenToUse: "A switch-style control for turning an option on or off with immediate effect \u2014\nprefer it over a checkbox when the change applies instantly (settings, feature\nswitches) rather than as part of a submitted form. It implements\n`FormCheckboxControl`, so it binds with the Signal Forms `[field]` directive or a\ndirect `[(checked)]` model.\nTrack, knob, and size resolve from the `toggle` theme options; the checked state\nwears the active `variant` color.",
|
|
5780
|
+
dos: [
|
|
5781
|
+
"Use for instant on/off effects (settings, feature switches)"
|
|
5782
|
+
],
|
|
5783
|
+
donts: [
|
|
5784
|
+
"Use in submitted forms where nothing happens until save \u2014 that is a checkbox"
|
|
5785
|
+
],
|
|
5786
|
+
accessibility: [
|
|
5787
|
+
'Semantic `<input type="checkbox">` with `role="switch"`, properly associated with its label.',
|
|
5788
|
+
"Space toggles; focus indicators are provided for keyboard navigation.",
|
|
5789
|
+
"Screen readers announce the label and on/off state."
|
|
5790
|
+
]
|
|
5650
5791
|
},
|
|
5651
5792
|
relatedTokens: [
|
|
5652
5793
|
"toggle.behavior.size",
|
|
@@ -5661,7 +5802,7 @@ var uni_index_default = {
|
|
|
5661
5802
|
summary: "",
|
|
5662
5803
|
description: "",
|
|
5663
5804
|
category: "feedback",
|
|
5664
|
-
version: "6.0.
|
|
5805
|
+
version: "6.0.1",
|
|
5665
5806
|
bindings: {
|
|
5666
5807
|
angular: {
|
|
5667
5808
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5717,10 +5858,14 @@ var uni_index_default = {
|
|
|
5717
5858
|
}
|
|
5718
5859
|
],
|
|
5719
5860
|
guidelines: {
|
|
5720
|
-
whenToUse: "",
|
|
5861
|
+
whenToUse: "A tooltip is a brief, informative message that appears when a user interacts with an element.\nIf using a tooltip within a body of text, set the `inlineText` option to `true`.",
|
|
5721
5862
|
dos: [],
|
|
5722
5863
|
donts: [],
|
|
5723
|
-
accessibility: [
|
|
5864
|
+
accessibility: [
|
|
5865
|
+
'`role="tooltip"` linked to the trigger via `aria-describedby` (wired once \u2014 the bubble is always in the DOM).',
|
|
5866
|
+
"Shows on keyboard focus, hides on blur and Escape; stays open while hovered (WCAG 1.4.13).",
|
|
5867
|
+
'Non-focusable triggers get `tabindex="0"` so keyboard users can reach the tooltip.'
|
|
5868
|
+
]
|
|
5724
5869
|
},
|
|
5725
5870
|
relatedTokens: [
|
|
5726
5871
|
"tooltip.behavior.borderRadius",
|
|
@@ -5736,7 +5881,7 @@ var uni_index_default = {
|
|
|
5736
5881
|
summary: "",
|
|
5737
5882
|
description: "",
|
|
5738
5883
|
category: "layout",
|
|
5739
|
-
version: "6.0.
|
|
5884
|
+
version: "6.0.1",
|
|
5740
5885
|
bindings: {
|
|
5741
5886
|
angular: {
|
|
5742
5887
|
importPath: "@uni-design-system/uni-angular",
|
|
@@ -5769,7 +5914,7 @@ var uni_index_default = {
|
|
|
5769
5914
|
}
|
|
5770
5915
|
],
|
|
5771
5916
|
guidelines: {
|
|
5772
|
-
whenToUse: "",
|
|
5917
|
+
whenToUse: "Used to add space between elements and wraps automatically if there isn't enough space.",
|
|
5773
5918
|
dos: [],
|
|
5774
5919
|
donts: [],
|
|
5775
5920
|
accessibility: []
|
|
@@ -11984,4 +12129,4 @@ export {
|
|
|
11984
12129
|
meta,
|
|
11985
12130
|
createUniServer
|
|
11986
12131
|
};
|
|
11987
|
-
//# sourceMappingURL=chunk-
|
|
12132
|
+
//# sourceMappingURL=chunk-WCJS2FYS.js.map
|