@twentyfirstmedia/elements 0.5.0 → 0.7.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/custom-elements.json +3717 -215
- package/dist/elements.d.ts +634 -19
- package/dist/elements.global.js +24 -24
- package/dist/elements.js +24 -24
- package/dist/vscode.html-custom-data.json +1081 -38
- package/package.json +2 -2
|
@@ -224,6 +224,18 @@
|
|
|
224
224
|
{
|
|
225
225
|
"name": "label",
|
|
226
226
|
"description": "(string)"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"name": "layout",
|
|
230
|
+
"description": "`list`: one compact row per option (small picture or icon beside the label), e.g. on phones. (\"grid\" | \"list\")",
|
|
231
|
+
"values": [
|
|
232
|
+
{
|
|
233
|
+
"name": "grid"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"name": "list"
|
|
237
|
+
}
|
|
238
|
+
]
|
|
227
239
|
}
|
|
228
240
|
],
|
|
229
241
|
"references": [
|
|
@@ -810,6 +822,11 @@
|
|
|
810
822
|
{
|
|
811
823
|
"name": "width",
|
|
812
824
|
"description": "(number)"
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"name": "compact",
|
|
828
|
+
"description": "Only the workspace's mark, its name as the accessible name (a collapsed sidebar). (boolean)",
|
|
829
|
+
"valueSet": "v"
|
|
813
830
|
}
|
|
814
831
|
],
|
|
815
832
|
"references": [
|
|
@@ -894,6 +911,14 @@
|
|
|
894
911
|
"name": "qr",
|
|
895
912
|
"description": "(ReactNode)"
|
|
896
913
|
},
|
|
914
|
+
{
|
|
915
|
+
"name": "qr-value",
|
|
916
|
+
"description": "The otpauth:// link: the kit draws its QR code (instead of `qr`). (string)"
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"name": "trust-device",
|
|
920
|
+
"description": "A \"Trust this device\" checkbox under the code field; a string replaces its label. (boolean | string)"
|
|
921
|
+
},
|
|
897
922
|
{
|
|
898
923
|
"name": "secret",
|
|
899
924
|
"description": "(string)"
|
|
@@ -907,50 +932,760 @@
|
|
|
907
932
|
"description": "(0 | 1 | 2)"
|
|
908
933
|
},
|
|
909
934
|
{
|
|
910
|
-
"name": "scan-text",
|
|
935
|
+
"name": "scan-text",
|
|
936
|
+
"description": "(string)"
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
"name": "codes-text",
|
|
940
|
+
"description": "(string)"
|
|
941
|
+
}
|
|
942
|
+
],
|
|
943
|
+
"references": [
|
|
944
|
+
{
|
|
945
|
+
"name": "Docs",
|
|
946
|
+
"url": "https://ui.twentyfirst.media/halo/components/TwoFactorSetup/"
|
|
947
|
+
}
|
|
948
|
+
]
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "tf-color-field",
|
|
952
|
+
"description": "The ColorField component as a custom element.",
|
|
953
|
+
"attributes": [
|
|
954
|
+
{
|
|
955
|
+
"name": "label",
|
|
956
|
+
"description": "(ReactNode)"
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"name": "value",
|
|
960
|
+
"description": "(string)"
|
|
961
|
+
},
|
|
962
|
+
{
|
|
963
|
+
"name": "default-value",
|
|
964
|
+
"description": "(string)"
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "against",
|
|
968
|
+
"description": "(string | false)"
|
|
969
|
+
},
|
|
970
|
+
{
|
|
971
|
+
"name": "hint",
|
|
972
|
+
"description": "(ReactNode)"
|
|
973
|
+
}
|
|
974
|
+
],
|
|
975
|
+
"references": [
|
|
976
|
+
{
|
|
977
|
+
"name": "Docs",
|
|
978
|
+
"url": "https://ui.twentyfirst.media/halo/components/ColorField/"
|
|
979
|
+
}
|
|
980
|
+
]
|
|
981
|
+
},
|
|
982
|
+
{
|
|
983
|
+
"name": "tf-qr-code",
|
|
984
|
+
"description": "A QR code drawn as SVG and encoded on the device, so the text (a sign-in secret, an invite link) never goes to a service.",
|
|
985
|
+
"attributes": [
|
|
986
|
+
{
|
|
987
|
+
"name": "value",
|
|
988
|
+
"description": "The text to encode: an otpauth:// link, a URL … (string)"
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
"name": "level",
|
|
992
|
+
"description": "Error correction: L, M (default), Q or H. (\"L\" | \"M\" | \"Q\" | \"H\")",
|
|
993
|
+
"values": [
|
|
994
|
+
{
|
|
995
|
+
"name": "L"
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
"name": "M"
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"name": "Q"
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
"name": "H"
|
|
1005
|
+
}
|
|
1006
|
+
]
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
"name": "size",
|
|
1010
|
+
"description": "Width and height (default: the width of its container). (number | string)"
|
|
1011
|
+
},
|
|
1012
|
+
{
|
|
1013
|
+
"name": "quiet",
|
|
1014
|
+
"description": "Light modules around the code (default 4, the standard quiet zone). (number)"
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "label",
|
|
1018
|
+
"description": "Accessible name (default \"QR code\"). (string)"
|
|
1019
|
+
}
|
|
1020
|
+
],
|
|
1021
|
+
"references": [
|
|
1022
|
+
{
|
|
1023
|
+
"name": "Docs",
|
|
1024
|
+
"url": "https://ui.twentyfirst.media/halo/components/QrCode/"
|
|
1025
|
+
}
|
|
1026
|
+
]
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "tf-habit-tracker",
|
|
1030
|
+
"description": "Habits with their last days as a row of marks: done, missed or no entry, today's mark a toggle.",
|
|
1031
|
+
"attributes": [
|
|
1032
|
+
{
|
|
1033
|
+
"name": "habits",
|
|
1034
|
+
"description": "(Habit[])"
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"name": "day-labels",
|
|
1038
|
+
"description": "Labels of the day columns, oldest first (default: weekday initials ending today). (string[])"
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "label",
|
|
1042
|
+
"description": "Accessible name of the list (default \"Habits\"). (string)"
|
|
1043
|
+
}
|
|
1044
|
+
],
|
|
1045
|
+
"references": [
|
|
1046
|
+
{
|
|
1047
|
+
"name": "Docs",
|
|
1048
|
+
"url": "https://ui.twentyfirst.media/halo/components/HabitTracker/"
|
|
1049
|
+
}
|
|
1050
|
+
]
|
|
1051
|
+
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "tf-mood-picker",
|
|
1054
|
+
"description": "A five-step mood scale with faces and words, as a radio group.",
|
|
1055
|
+
"attributes": [
|
|
1056
|
+
{
|
|
1057
|
+
"name": "value",
|
|
1058
|
+
"description": "(MoodLevel | null)"
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "default-value",
|
|
1062
|
+
"description": "(MoodLevel | null)"
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"name": "label",
|
|
1066
|
+
"description": "The question (default \"How are you feeling?\"). (ReactNode)"
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "levels",
|
|
1070
|
+
"description": "Words for the five levels, lowest first (default Awful, Low, Okay, Good, Great). ([string, string, string, string, string])"
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
"name": "compact",
|
|
1074
|
+
"description": "Only the faces; the words stay as accessible names. (boolean)",
|
|
1075
|
+
"valueSet": "v"
|
|
1076
|
+
}
|
|
1077
|
+
],
|
|
1078
|
+
"references": [
|
|
1079
|
+
{
|
|
1080
|
+
"name": "Docs",
|
|
1081
|
+
"url": "https://ui.twentyfirst.media/halo/components/MoodPicker/"
|
|
1082
|
+
}
|
|
1083
|
+
]
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "tf-vital-tile",
|
|
1087
|
+
"description": "One health value with its healthy range: the value, a band with the normal zone and a marker, a status in words (in range, below, above) and an optional trend.",
|
|
1088
|
+
"attributes": [
|
|
1089
|
+
{
|
|
1090
|
+
"name": "surface",
|
|
1091
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"name": "label",
|
|
1095
|
+
"description": "(string)"
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"name": "value",
|
|
1099
|
+
"description": "(number)"
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"name": "unit",
|
|
1103
|
+
"description": "(string)"
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"name": "icon",
|
|
1107
|
+
"description": "(IconName)"
|
|
1108
|
+
},
|
|
1109
|
+
{
|
|
1110
|
+
"name": "normal",
|
|
1111
|
+
"description": "The healthy range [low, high]; the tile says whether the value is below, in or above it. ([number, number])"
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"name": "scale",
|
|
1115
|
+
"description": "The whole scale of the band [min, max] (default: the normal range with room on both sides). ([number, number])"
|
|
1116
|
+
},
|
|
1117
|
+
{
|
|
1118
|
+
"name": "trend",
|
|
1119
|
+
"description": "Recent values, oldest first, drawn as a sparkline. (number[])"
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
"name": "caption",
|
|
1123
|
+
"description": "Under the value: when it was measured, the source … (ReactNode)"
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"name": "digits",
|
|
1127
|
+
"description": "Digits after the decimal point (default 0). (number)"
|
|
1128
|
+
}
|
|
1129
|
+
],
|
|
1130
|
+
"references": [
|
|
1131
|
+
{
|
|
1132
|
+
"name": "Docs",
|
|
1133
|
+
"url": "https://ui.twentyfirst.media/halo/components/VitalTile/"
|
|
1134
|
+
}
|
|
1135
|
+
]
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"name": "tf-activity-rings",
|
|
1139
|
+
"description": "Concentric progress rings for daily goals (move, exercise, stand, steps, water) with a legend.",
|
|
1140
|
+
"attributes": [
|
|
1141
|
+
{
|
|
1142
|
+
"name": "rings",
|
|
1143
|
+
"description": "Outer ring first. (ActivityRing[])"
|
|
1144
|
+
},
|
|
1145
|
+
{
|
|
1146
|
+
"name": "size",
|
|
1147
|
+
"description": "Diameter of the rings (default 132). (number)"
|
|
1148
|
+
},
|
|
1149
|
+
{
|
|
1150
|
+
"name": "legend",
|
|
1151
|
+
"description": "Hide the legend beside the rings. (boolean)",
|
|
1152
|
+
"valueSet": "v"
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "label",
|
|
1156
|
+
"description": "Accessible name (default \"Activity\"). (string)"
|
|
1157
|
+
}
|
|
1158
|
+
],
|
|
1159
|
+
"references": [
|
|
1160
|
+
{
|
|
1161
|
+
"name": "Docs",
|
|
1162
|
+
"url": "https://ui.twentyfirst.media/halo/components/ActivityRings/"
|
|
1163
|
+
}
|
|
1164
|
+
]
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"name": "tf-sleep-chart",
|
|
1168
|
+
"description": "A night as sleep stages over time, one lane per stage (awake, REM, light, deep), with the time asleep and the time per stage.",
|
|
1169
|
+
"attributes": [
|
|
1170
|
+
{
|
|
1171
|
+
"name": "segments",
|
|
1172
|
+
"description": "The night in order, from falling asleep to getting up. (SleepSegment[])"
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"name": "label",
|
|
1176
|
+
"description": "Accessible name (default \"Sleep stages\"). (string)"
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
"name": "summary",
|
|
1180
|
+
"description": "Hide the totals per stage under the chart. (boolean)",
|
|
1181
|
+
"valueSet": "v"
|
|
1182
|
+
}
|
|
1183
|
+
],
|
|
1184
|
+
"references": [
|
|
1185
|
+
{
|
|
1186
|
+
"name": "Docs",
|
|
1187
|
+
"url": "https://ui.twentyfirst.media/halo/components/SleepChart/"
|
|
1188
|
+
}
|
|
1189
|
+
]
|
|
1190
|
+
},
|
|
1191
|
+
{
|
|
1192
|
+
"name": "tf-medication-list",
|
|
1193
|
+
"description": "Today's doses in order, each with its time, name, dose, a status in words and a \"taken\" button.",
|
|
1194
|
+
"attributes": [
|
|
1195
|
+
{
|
|
1196
|
+
"name": "items",
|
|
1197
|
+
"description": "(MedicationItem[])"
|
|
1198
|
+
},
|
|
1199
|
+
{
|
|
1200
|
+
"name": "label",
|
|
1201
|
+
"description": "Accessible name (default \"Medication\"). (string)"
|
|
1202
|
+
}
|
|
1203
|
+
],
|
|
1204
|
+
"references": [
|
|
1205
|
+
{
|
|
1206
|
+
"name": "Docs",
|
|
1207
|
+
"url": "https://ui.twentyfirst.media/halo/components/MedicationList/"
|
|
1208
|
+
}
|
|
1209
|
+
]
|
|
1210
|
+
},
|
|
1211
|
+
{
|
|
1212
|
+
"name": "tf-journal-entry",
|
|
1213
|
+
"description": "A journal or diary entry: the date, the mood of the day, a title, the text and tags, with room for actions such as edit or share.",
|
|
1214
|
+
"attributes": [
|
|
1215
|
+
{
|
|
1216
|
+
"name": "surface",
|
|
1217
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1218
|
+
},
|
|
1219
|
+
{
|
|
1220
|
+
"name": "date",
|
|
1221
|
+
"description": "(Date | string | number)"
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "title",
|
|
1225
|
+
"description": "(string)"
|
|
1226
|
+
},
|
|
1227
|
+
{
|
|
1228
|
+
"name": "mood",
|
|
1229
|
+
"description": "(MoodLevel)"
|
|
1230
|
+
},
|
|
1231
|
+
{
|
|
1232
|
+
"name": "tags",
|
|
1233
|
+
"description": "(string[])"
|
|
1234
|
+
},
|
|
1235
|
+
{
|
|
1236
|
+
"name": "actions",
|
|
1237
|
+
"description": "Buttons at the end (edit, share …). (ReactNode)"
|
|
1238
|
+
}
|
|
1239
|
+
],
|
|
1240
|
+
"references": [
|
|
1241
|
+
{
|
|
1242
|
+
"name": "Docs",
|
|
1243
|
+
"url": "https://ui.twentyfirst.media/halo/components/JournalEntry/"
|
|
1244
|
+
}
|
|
1245
|
+
]
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
"name": "tf-goal-card",
|
|
1249
|
+
"description": "A goal with its progress toward a target, a due date, milestones and a note.",
|
|
1250
|
+
"attributes": [
|
|
1251
|
+
{
|
|
1252
|
+
"name": "surface",
|
|
1253
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"name": "title",
|
|
1257
|
+
"description": "(string)"
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"name": "value",
|
|
1261
|
+
"description": "(number)"
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
"name": "target",
|
|
1265
|
+
"description": "(number)"
|
|
1266
|
+
},
|
|
1267
|
+
{
|
|
1268
|
+
"name": "format",
|
|
1269
|
+
"description": "How to show value and target (default number). (\"number\" | \"money\" | \"percent\")",
|
|
1270
|
+
"values": [
|
|
1271
|
+
{
|
|
1272
|
+
"name": "number"
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
"name": "money"
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
"name": "percent"
|
|
1279
|
+
}
|
|
1280
|
+
]
|
|
1281
|
+
},
|
|
1282
|
+
{
|
|
1283
|
+
"name": "unit",
|
|
1284
|
+
"description": "Unit after numbers (\"km\", \"books\"). (string)"
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
"name": "currency",
|
|
1288
|
+
"description": "(string)"
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
"name": "due",
|
|
1292
|
+
"description": "(Date | string | number)"
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"name": "icon",
|
|
1296
|
+
"description": "(IconName)"
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "tint",
|
|
1300
|
+
"description": "(Tint)"
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
"name": "milestones",
|
|
1304
|
+
"description": "({ label: string; done?: boolean }[])"
|
|
1305
|
+
},
|
|
1306
|
+
{
|
|
1307
|
+
"name": "note",
|
|
1308
|
+
"description": "A note under the progress (\"€250 a month keeps you on track\"). (ReactNode)"
|
|
1309
|
+
}
|
|
1310
|
+
],
|
|
1311
|
+
"references": [
|
|
1312
|
+
{
|
|
1313
|
+
"name": "Docs",
|
|
1314
|
+
"url": "https://ui.twentyfirst.media/halo/components/GoalCard/"
|
|
1315
|
+
}
|
|
1316
|
+
]
|
|
1317
|
+
},
|
|
1318
|
+
{
|
|
1319
|
+
"name": "tf-insight-card",
|
|
1320
|
+
"description": "Something the assistant noticed: what, where it comes from, why it is shown and what to do.",
|
|
1321
|
+
"attributes": [
|
|
1322
|
+
{
|
|
1323
|
+
"name": "surface",
|
|
1324
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1325
|
+
},
|
|
1326
|
+
{
|
|
1327
|
+
"name": "title",
|
|
1328
|
+
"description": "(string)"
|
|
1329
|
+
},
|
|
1330
|
+
{
|
|
1331
|
+
"name": "icon",
|
|
1332
|
+
"description": "(IconName)"
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
"name": "tone",
|
|
1336
|
+
"description": "(\"info\" | \"success\" | \"warning\" | \"highlight\")",
|
|
1337
|
+
"values": [
|
|
1338
|
+
{
|
|
1339
|
+
"name": "info"
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"name": "success"
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"name": "warning"
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"name": "highlight"
|
|
1349
|
+
}
|
|
1350
|
+
]
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "meta",
|
|
1354
|
+
"description": "Above the title: area and time (\"Money · 2 h ago\"). (ReactNode)"
|
|
1355
|
+
},
|
|
1356
|
+
{
|
|
1357
|
+
"name": "sources",
|
|
1358
|
+
"description": "Where the insight comes from, as chips (like chat sources). (Source[])"
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"name": "why",
|
|
1362
|
+
"description": "Why the assistant shows it; folded away behind \"Why am I seeing this?\". (ReactNode)"
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
"name": "accept-label",
|
|
1366
|
+
"description": "(string)"
|
|
1367
|
+
}
|
|
1368
|
+
],
|
|
1369
|
+
"references": [
|
|
1370
|
+
{
|
|
1371
|
+
"name": "Docs",
|
|
1372
|
+
"url": "https://ui.twentyfirst.media/halo/components/InsightCard/"
|
|
1373
|
+
}
|
|
1374
|
+
]
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "tf-consent-list",
|
|
1378
|
+
"description": "What each connected source lets the assistant read or do: one card per source with its purpose, last use and a switch per scope, plus \"Revoke access\".",
|
|
1379
|
+
"attributes": [
|
|
1380
|
+
{
|
|
1381
|
+
"name": "surface",
|
|
1382
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
"name": "connectors",
|
|
1386
|
+
"description": "(ConsentConnector[])"
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"name": "label",
|
|
1390
|
+
"description": "Accessible name (default \"Data access\"). (string)"
|
|
1391
|
+
}
|
|
1392
|
+
],
|
|
1393
|
+
"references": [
|
|
1394
|
+
{
|
|
1395
|
+
"name": "Docs",
|
|
1396
|
+
"url": "https://ui.twentyfirst.media/halo/components/ConsentList/"
|
|
1397
|
+
}
|
|
1398
|
+
]
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
"name": "tf-budget-list",
|
|
1402
|
+
"description": "Spending per category against its limit: spent and limit, a bar, and what is left or over in words.",
|
|
1403
|
+
"attributes": [
|
|
1404
|
+
{
|
|
1405
|
+
"name": "categories",
|
|
1406
|
+
"description": "(BudgetCategory[])"
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
"name": "currency",
|
|
1410
|
+
"description": "(string)"
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"name": "label",
|
|
1414
|
+
"description": "Accessible name (default \"Budgets\"). (string)"
|
|
1415
|
+
}
|
|
1416
|
+
],
|
|
1417
|
+
"references": [
|
|
1418
|
+
{
|
|
1419
|
+
"name": "Docs",
|
|
1420
|
+
"url": "https://ui.twentyfirst.media/halo/components/BudgetList/"
|
|
1421
|
+
}
|
|
1422
|
+
]
|
|
1423
|
+
},
|
|
1424
|
+
{
|
|
1425
|
+
"name": "tf-subscription-list",
|
|
1426
|
+
"description": "Recurring payments with their next charge, trial and cancelled states, and what they cost together a month and a year.",
|
|
1427
|
+
"attributes": [
|
|
1428
|
+
{
|
|
1429
|
+
"name": "items",
|
|
1430
|
+
"description": "(Subscription[])"
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"name": "currency",
|
|
1434
|
+
"description": "(string)"
|
|
1435
|
+
},
|
|
1436
|
+
{
|
|
1437
|
+
"name": "totals",
|
|
1438
|
+
"description": "Hide the monthly and yearly totals. (boolean)",
|
|
1439
|
+
"valueSet": "v"
|
|
1440
|
+
},
|
|
1441
|
+
{
|
|
1442
|
+
"name": "label",
|
|
1443
|
+
"description": "Accessible name (default \"Subscriptions\"). (string)"
|
|
1444
|
+
}
|
|
1445
|
+
],
|
|
1446
|
+
"references": [
|
|
1447
|
+
{
|
|
1448
|
+
"name": "Docs",
|
|
1449
|
+
"url": "https://ui.twentyfirst.media/halo/components/SubscriptionList/"
|
|
1450
|
+
}
|
|
1451
|
+
]
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"name": "tf-net-worth-card",
|
|
1455
|
+
"description": "What you own minus what you owe: the total, its change and trend, and the assets and liabilities behind it.",
|
|
1456
|
+
"attributes": [
|
|
1457
|
+
{
|
|
1458
|
+
"name": "surface",
|
|
1459
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"name": "assets",
|
|
1463
|
+
"description": "({ label: string; value: number; icon?: IconName }[])"
|
|
1464
|
+
},
|
|
1465
|
+
{
|
|
1466
|
+
"name": "liabilities",
|
|
1467
|
+
"description": "({ label: string; value: number; icon?: IconName }[])"
|
|
1468
|
+
},
|
|
1469
|
+
{
|
|
1470
|
+
"name": "history",
|
|
1471
|
+
"description": "Net worth over time, oldest first. (number[])"
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"name": "change",
|
|
1475
|
+
"description": "Change over `changeLabel` (e.g. +1,240 \"since October\"). (number)"
|
|
1476
|
+
},
|
|
1477
|
+
{
|
|
1478
|
+
"name": "change-label",
|
|
1479
|
+
"description": "(string)"
|
|
1480
|
+
},
|
|
1481
|
+
{
|
|
1482
|
+
"name": "currency",
|
|
1483
|
+
"description": "(string)"
|
|
1484
|
+
},
|
|
1485
|
+
{
|
|
1486
|
+
"name": "title",
|
|
1487
|
+
"description": "(string)"
|
|
1488
|
+
}
|
|
1489
|
+
],
|
|
1490
|
+
"references": [
|
|
1491
|
+
{
|
|
1492
|
+
"name": "Docs",
|
|
1493
|
+
"url": "https://ui.twentyfirst.media/halo/components/NetWorthCard/"
|
|
1494
|
+
}
|
|
1495
|
+
]
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
"name": "tf-deadline-list",
|
|
1499
|
+
"description": "Bills, renewals, notice periods and expiring documents in date order, each with \"Today\", \"In 12 days\" or \"Overdue by 3 days\" in words.",
|
|
1500
|
+
"attributes": [
|
|
1501
|
+
{
|
|
1502
|
+
"name": "items",
|
|
1503
|
+
"description": "(DeadlineItem[])"
|
|
1504
|
+
},
|
|
1505
|
+
{
|
|
1506
|
+
"name": "today",
|
|
1507
|
+
"description": "The day to count from (default: now). Set it for server rendering and stable output. (Date | string | number)"
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"name": "soon",
|
|
1511
|
+
"description": "Days ahead that count as soon (default 14). (number)"
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
"name": "currency",
|
|
1515
|
+
"description": "(string)"
|
|
1516
|
+
},
|
|
1517
|
+
{
|
|
1518
|
+
"name": "label",
|
|
1519
|
+
"description": "Accessible name (default \"Deadlines\"). (string)"
|
|
1520
|
+
}
|
|
1521
|
+
],
|
|
1522
|
+
"references": [
|
|
1523
|
+
{
|
|
1524
|
+
"name": "Docs",
|
|
1525
|
+
"url": "https://ui.twentyfirst.media/halo/components/DeadlineList/"
|
|
1526
|
+
}
|
|
1527
|
+
]
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"name": "tf-policy-card",
|
|
1531
|
+
"description": "One insurance policy: type and insurer, sum insured, premium, deductible, policy number, renewal date and status (active, pending, expiring, lapsed), with room for actions.",
|
|
1532
|
+
"attributes": [
|
|
1533
|
+
{
|
|
1534
|
+
"name": "surface",
|
|
1535
|
+
"description": "`\"glass\"`: translucent glass over a backdrop (`Ambient`, a photo, a map); `\"solid\"` opts out inside a glass `UIProvider`. (Surface)"
|
|
1536
|
+
},
|
|
1537
|
+
{
|
|
1538
|
+
"name": "type",
|
|
1539
|
+
"description": "The kind of insurance: \"Household contents\", \"Liability\" … (string)"
|
|
1540
|
+
},
|
|
1541
|
+
{
|
|
1542
|
+
"name": "insurer",
|
|
1543
|
+
"description": "(string)"
|
|
1544
|
+
},
|
|
1545
|
+
{
|
|
1546
|
+
"name": "icon",
|
|
1547
|
+
"description": "(IconName)"
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
"name": "tint",
|
|
1551
|
+
"description": "(Tint)"
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"name": "policy-number",
|
|
1555
|
+
"description": "(string)"
|
|
1556
|
+
},
|
|
1557
|
+
{
|
|
1558
|
+
"name": "mask-number",
|
|
1559
|
+
"description": "Show only the last four characters of the policy number. (boolean)",
|
|
1560
|
+
"valueSet": "v"
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"name": "coverage",
|
|
1564
|
+
"description": "Sum insured: a number (money) or text (\"unlimited\"). (number | ReactNode)"
|
|
1565
|
+
},
|
|
1566
|
+
{
|
|
1567
|
+
"name": "premium",
|
|
1568
|
+
"description": "({ amount: number; period: \"month\" | \"quarter\" | \"year\" })"
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"name": "deductible",
|
|
1572
|
+
"description": "(number)"
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "renews",
|
|
1576
|
+
"description": "(Date | string | number)"
|
|
1577
|
+
},
|
|
1578
|
+
{
|
|
1579
|
+
"name": "status",
|
|
1580
|
+
"description": "(\"active\" | \"pending\" | \"expiring\" | \"lapsed\")",
|
|
1581
|
+
"values": [
|
|
1582
|
+
{
|
|
1583
|
+
"name": "active"
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
"name": "pending"
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"name": "expiring"
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
"name": "lapsed"
|
|
1593
|
+
}
|
|
1594
|
+
]
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"name": "currency",
|
|
1598
|
+
"description": "(string)"
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"name": "actions",
|
|
1602
|
+
"description": "Buttons at the foot (documents, report a claim …). (ReactNode)"
|
|
1603
|
+
}
|
|
1604
|
+
],
|
|
1605
|
+
"references": [
|
|
1606
|
+
{
|
|
1607
|
+
"name": "Docs",
|
|
1608
|
+
"url": "https://ui.twentyfirst.media/halo/components/PolicyCard/"
|
|
1609
|
+
}
|
|
1610
|
+
]
|
|
1611
|
+
},
|
|
1612
|
+
{
|
|
1613
|
+
"name": "tf-coverage-matrix",
|
|
1614
|
+
"description": "Life risks and whether a policy covers them: covered, partly or not covered, with the policy and a note, and a count of each above the table.",
|
|
1615
|
+
"attributes": [
|
|
1616
|
+
{
|
|
1617
|
+
"name": "rows",
|
|
1618
|
+
"description": "(CoverageRow[])"
|
|
1619
|
+
},
|
|
1620
|
+
{
|
|
1621
|
+
"name": "label",
|
|
1622
|
+
"description": "Accessible name and caption (default \"Coverage\"). (string)"
|
|
1623
|
+
}
|
|
1624
|
+
],
|
|
1625
|
+
"references": [
|
|
1626
|
+
{
|
|
1627
|
+
"name": "Docs",
|
|
1628
|
+
"url": "https://ui.twentyfirst.media/halo/components/CoverageMatrix/"
|
|
1629
|
+
}
|
|
1630
|
+
]
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"name": "tf-claim-timeline",
|
|
1634
|
+
"description": "An insurance claim from report to payout: steps that are done, current, still to come or failed, with dates and notes, and the amount claimed.",
|
|
1635
|
+
"attributes": [
|
|
1636
|
+
{
|
|
1637
|
+
"name": "title",
|
|
1638
|
+
"description": "(string)"
|
|
1639
|
+
},
|
|
1640
|
+
{
|
|
1641
|
+
"name": "meta",
|
|
1642
|
+
"description": "Reference and insurer under the title. (ReactNode)"
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
"name": "amount",
|
|
1646
|
+
"description": "(number)"
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"name": "currency",
|
|
911
1650
|
"description": "(string)"
|
|
912
1651
|
},
|
|
913
1652
|
{
|
|
914
|
-
"name": "
|
|
915
|
-
"description": "(
|
|
1653
|
+
"name": "steps",
|
|
1654
|
+
"description": "(ClaimStep[])"
|
|
916
1655
|
}
|
|
917
1656
|
],
|
|
918
1657
|
"references": [
|
|
919
1658
|
{
|
|
920
1659
|
"name": "Docs",
|
|
921
|
-
"url": "https://ui.twentyfirst.media/halo/components/
|
|
1660
|
+
"url": "https://ui.twentyfirst.media/halo/components/ClaimTimeline/"
|
|
922
1661
|
}
|
|
923
1662
|
]
|
|
924
1663
|
},
|
|
925
1664
|
{
|
|
926
|
-
"name": "tf-
|
|
927
|
-
"description": "
|
|
1665
|
+
"name": "tf-document-list",
|
|
1666
|
+
"description": "Important papers (IDs, contracts, policies, certificates) with category, holder and expiry: \"Expired\", \"Expires in 19 days\" or \"Valid until May 2031\".",
|
|
928
1667
|
"attributes": [
|
|
929
1668
|
{
|
|
930
|
-
"name": "
|
|
931
|
-
"description": "(
|
|
932
|
-
},
|
|
933
|
-
{
|
|
934
|
-
"name": "value",
|
|
935
|
-
"description": "(string)"
|
|
1669
|
+
"name": "documents",
|
|
1670
|
+
"description": "(LifeDocument[])"
|
|
936
1671
|
},
|
|
937
1672
|
{
|
|
938
|
-
"name": "
|
|
939
|
-
"description": "(string)"
|
|
1673
|
+
"name": "today",
|
|
1674
|
+
"description": "The day to count expiry from (default: now). (Date | string | number)"
|
|
940
1675
|
},
|
|
941
1676
|
{
|
|
942
|
-
"name": "
|
|
943
|
-
"description": "(
|
|
1677
|
+
"name": "soon",
|
|
1678
|
+
"description": "Days ahead that count as expiring soon (default 60). (number)"
|
|
944
1679
|
},
|
|
945
1680
|
{
|
|
946
|
-
"name": "
|
|
947
|
-
"description": "(
|
|
1681
|
+
"name": "label",
|
|
1682
|
+
"description": "Accessible name (default \"Documents\"). (string)"
|
|
948
1683
|
}
|
|
949
1684
|
],
|
|
950
1685
|
"references": [
|
|
951
1686
|
{
|
|
952
1687
|
"name": "Docs",
|
|
953
|
-
"url": "https://ui.twentyfirst.media/halo/components/
|
|
1688
|
+
"url": "https://ui.twentyfirst.media/halo/components/DocumentList/"
|
|
954
1689
|
}
|
|
955
1690
|
]
|
|
956
1691
|
},
|
|
@@ -2322,12 +3057,7 @@
|
|
|
2322
3057
|
{
|
|
2323
3058
|
"name": "tf-typing-dots",
|
|
2324
3059
|
"description": "The TypingDots component as a custom element.",
|
|
2325
|
-
"attributes": [
|
|
2326
|
-
{
|
|
2327
|
-
"name": "label",
|
|
2328
|
-
"description": "(string)"
|
|
2329
|
-
}
|
|
2330
|
-
],
|
|
3060
|
+
"attributes": [],
|
|
2331
3061
|
"references": [
|
|
2332
3062
|
{
|
|
2333
3063
|
"name": "Docs",
|
|
@@ -3030,6 +3760,11 @@
|
|
|
3030
3760
|
{
|
|
3031
3761
|
"name": "current",
|
|
3032
3762
|
"description": "(number)"
|
|
3763
|
+
},
|
|
3764
|
+
{
|
|
3765
|
+
"name": "compact",
|
|
3766
|
+
"description": "Numbers only, with the label of the current step (screen readers still hear every label). Narrow containers (up to 560px) get this on their own. (boolean)",
|
|
3767
|
+
"valueSet": "v"
|
|
3033
3768
|
}
|
|
3034
3769
|
],
|
|
3035
3770
|
"references": [
|
|
@@ -3096,7 +3831,15 @@
|
|
|
3096
3831
|
},
|
|
3097
3832
|
{
|
|
3098
3833
|
"name": "price",
|
|
3099
|
-
"description": "(number | null)"
|
|
3834
|
+
"description": "A number is formatted as money (0 = \"Free\", null = \"Let's talk\"); any other node is shown as it is, e.g. a placeholder (\"—\") or a price the app formatted itself. (number | null | ReactNode)"
|
|
3835
|
+
},
|
|
3836
|
+
{
|
|
3837
|
+
"name": "price-prefix",
|
|
3838
|
+
"description": "Before the price, e.g. \"from\". (ReactNode)"
|
|
3839
|
+
},
|
|
3840
|
+
{
|
|
3841
|
+
"name": "price-note",
|
|
3842
|
+
"description": "Under the price: net or gross, billed yearly, VAT note … (ReactNode)"
|
|
3100
3843
|
},
|
|
3101
3844
|
{
|
|
3102
3845
|
"name": "was",
|
|
@@ -3132,6 +3875,14 @@
|
|
|
3132
3875
|
"name": "disabled",
|
|
3133
3876
|
"description": "Disable the button, e.g. while a checkout starts or when the plan cannot be picked. (boolean)",
|
|
3134
3877
|
"valueSet": "v"
|
|
3878
|
+
},
|
|
3879
|
+
{
|
|
3880
|
+
"name": "href",
|
|
3881
|
+
"description": "The action as a link (checkout or sign-up page), with `linkAs` for a router's link. (string)"
|
|
3882
|
+
},
|
|
3883
|
+
{
|
|
3884
|
+
"name": "link-as",
|
|
3885
|
+
"description": "(ElementType)"
|
|
3135
3886
|
}
|
|
3136
3887
|
],
|
|
3137
3888
|
"references": [
|
|
@@ -3156,6 +3907,11 @@
|
|
|
3156
3907
|
{
|
|
3157
3908
|
"name": "delay",
|
|
3158
3909
|
"description": "(number)"
|
|
3910
|
+
},
|
|
3911
|
+
{
|
|
3912
|
+
"name": "animate",
|
|
3913
|
+
"description": "`false`: show the value without counting (it is always the value on the server). (boolean)",
|
|
3914
|
+
"valueSet": "v"
|
|
3159
3915
|
}
|
|
3160
3916
|
],
|
|
3161
3917
|
"references": [
|
|
@@ -3342,7 +4098,11 @@
|
|
|
3342
4098
|
"attributes": [
|
|
3343
4099
|
{
|
|
3344
4100
|
"name": "crumbs",
|
|
3345
|
-
"description": "(string[])"
|
|
4101
|
+
"description": "A breadcrumb above the title (see `Breadcrumb`): labels, or items with `href`/`onClick`. ((string | Crumb)[])"
|
|
4102
|
+
},
|
|
4103
|
+
{
|
|
4104
|
+
"name": "crumb-link-as",
|
|
4105
|
+
"description": "The element crumb links render as, e.g. Next.js `Link`. (ElementType)"
|
|
3346
4106
|
},
|
|
3347
4107
|
{
|
|
3348
4108
|
"name": "title",
|
|
@@ -3405,6 +4165,11 @@
|
|
|
3405
4165
|
"name": "animate",
|
|
3406
4166
|
"description": "(boolean)",
|
|
3407
4167
|
"valueSet": "v"
|
|
4168
|
+
},
|
|
4169
|
+
{
|
|
4170
|
+
"name": "stack",
|
|
4171
|
+
"description": "Cards instead of columns when the table's box is narrow (up to 600px): every row stacks its cells, each with its column label. Without it narrow tables scroll sideways. (boolean)",
|
|
4172
|
+
"valueSet": "v"
|
|
3408
4173
|
}
|
|
3409
4174
|
],
|
|
3410
4175
|
"references": [
|
|
@@ -3459,6 +4224,26 @@
|
|
|
3459
4224
|
"name": "active",
|
|
3460
4225
|
"description": "(boolean)",
|
|
3461
4226
|
"valueSet": "v"
|
|
4227
|
+
},
|
|
4228
|
+
{
|
|
4229
|
+
"name": "href",
|
|
4230
|
+
"description": "Makes the row a link (with `linkAs` for a router's link). (string)"
|
|
4231
|
+
},
|
|
4232
|
+
{
|
|
4233
|
+
"name": "link-as",
|
|
4234
|
+
"description": "(ElementType)"
|
|
4235
|
+
},
|
|
4236
|
+
{
|
|
4237
|
+
"name": "actions",
|
|
4238
|
+
"description": "Buttons of the row's own (rename, remove …), outside the clickable area so nothing interactive is nested. Without `onClick` and `href` the row is not interactive at all. (ReactNode)"
|
|
4239
|
+
},
|
|
4240
|
+
{
|
|
4241
|
+
"name": "title-lines",
|
|
4242
|
+
"description": "Lines the title may take before it ends in an ellipsis (default: it wraps freely). (number)"
|
|
4243
|
+
},
|
|
4244
|
+
{
|
|
4245
|
+
"name": "subtitle-lines",
|
|
4246
|
+
"description": "Lines the subtitle may take (default 1); badges and facts wrap within them. (number)"
|
|
3462
4247
|
}
|
|
3463
4248
|
],
|
|
3464
4249
|
"references": [
|
|
@@ -4414,6 +5199,15 @@
|
|
|
4414
5199
|
}
|
|
4415
5200
|
]
|
|
4416
5201
|
},
|
|
5202
|
+
{
|
|
5203
|
+
"name": "action",
|
|
5204
|
+
"description": "An interactive control at the end of the field (an `IconButton`: clear, copy, locate …). Unlike `suffix` it can be clicked, and it stays when the field shows an error or success mark. (ReactNode)"
|
|
5205
|
+
},
|
|
5206
|
+
{
|
|
5207
|
+
"name": "reveal",
|
|
5208
|
+
"description": "For `type=\"password\"`: a button that shows and hides the password (default true). (boolean)",
|
|
5209
|
+
"valueSet": "v"
|
|
5210
|
+
},
|
|
4417
5211
|
{
|
|
4418
5212
|
"name": "name",
|
|
4419
5213
|
"description": "Field name inside a `Form`: the field shows that name's validation message. (string)"
|
|
@@ -4828,6 +5622,15 @@
|
|
|
4828
5622
|
"description": "(boolean)",
|
|
4829
5623
|
"valueSet": "v"
|
|
4830
5624
|
},
|
|
5625
|
+
{
|
|
5626
|
+
"name": "clear-on-error",
|
|
5627
|
+
"description": "Empties the cells when `error` turns on, ready for the next try (default true). (boolean)",
|
|
5628
|
+
"valueSet": "v"
|
|
5629
|
+
},
|
|
5630
|
+
{
|
|
5631
|
+
"name": "ref",
|
|
5632
|
+
"description": "`ref.current.reset()` empties the cells on demand. (Ref<OtpInputHandle>)"
|
|
5633
|
+
},
|
|
4831
5634
|
{
|
|
4832
5635
|
"name": "label",
|
|
4833
5636
|
"description": "(string)"
|
|
@@ -4869,6 +5672,15 @@
|
|
|
4869
5672
|
"name": "multiple",
|
|
4870
5673
|
"description": "(boolean)",
|
|
4871
5674
|
"valueSet": "v"
|
|
5675
|
+
},
|
|
5676
|
+
{
|
|
5677
|
+
"name": "disabled",
|
|
5678
|
+
"description": "No picking or dropping; the list stays visible. (boolean)",
|
|
5679
|
+
"valueSet": "v"
|
|
5680
|
+
},
|
|
5681
|
+
{
|
|
5682
|
+
"name": "name",
|
|
5683
|
+
"description": "Takes part in a surrounding form under this name: the listed files are submitted with it. (string)"
|
|
4872
5684
|
}
|
|
4873
5685
|
],
|
|
4874
5686
|
"references": [
|
|
@@ -5449,11 +6261,33 @@
|
|
|
5449
6261
|
},
|
|
5450
6262
|
{
|
|
5451
6263
|
"name": "shortcut",
|
|
5452
|
-
"description": "(string)"
|
|
6264
|
+
"description": "The key hint, e.g. \"⌘K\" (hidden on touch screens). (string)"
|
|
6265
|
+
},
|
|
6266
|
+
{
|
|
6267
|
+
"name": "bind-shortcut",
|
|
6268
|
+
"description": "⌘/Ctrl + the hint's last key (K for \"⌘K\") focuses the field, except while typing elsewhere. (boolean)",
|
|
6269
|
+
"valueSet": "v"
|
|
5453
6270
|
},
|
|
5454
6271
|
{
|
|
5455
6272
|
"name": "value",
|
|
5456
6273
|
"description": "(string)"
|
|
6274
|
+
},
|
|
6275
|
+
{
|
|
6276
|
+
"name": "default-value",
|
|
6277
|
+
"description": "(string)"
|
|
6278
|
+
},
|
|
6279
|
+
{
|
|
6280
|
+
"name": "name",
|
|
6281
|
+
"description": "(string)"
|
|
6282
|
+
},
|
|
6283
|
+
{
|
|
6284
|
+
"name": "auto-focus",
|
|
6285
|
+
"description": "(boolean)",
|
|
6286
|
+
"valueSet": "v"
|
|
6287
|
+
},
|
|
6288
|
+
{
|
|
6289
|
+
"name": "input-props",
|
|
6290
|
+
"description": "For a search with suggestions (combobox): role, aria-controls, aria-activedescendant … (InputHTMLAttributes<HTMLInputElement>)"
|
|
5457
6291
|
}
|
|
5458
6292
|
],
|
|
5459
6293
|
"references": [
|
|
@@ -5592,6 +6426,18 @@
|
|
|
5592
6426
|
"description": "(boolean)",
|
|
5593
6427
|
"valueSet": "v"
|
|
5594
6428
|
},
|
|
6429
|
+
{
|
|
6430
|
+
"name": "size",
|
|
6431
|
+
"description": "`sm`: a compact trigger, e.g. a sort menu next to a heading. (\"sm\" | \"md\")",
|
|
6432
|
+
"values": [
|
|
6433
|
+
{
|
|
6434
|
+
"name": "sm"
|
|
6435
|
+
},
|
|
6436
|
+
{
|
|
6437
|
+
"name": "md"
|
|
6438
|
+
}
|
|
6439
|
+
]
|
|
6440
|
+
},
|
|
5595
6441
|
{
|
|
5596
6442
|
"name": "label",
|
|
5597
6443
|
"description": "(string)"
|
|
@@ -5828,7 +6674,15 @@
|
|
|
5828
6674
|
},
|
|
5829
6675
|
{
|
|
5830
6676
|
"name": "start",
|
|
5831
|
-
"description": "(number)"
|
|
6677
|
+
"description": "First image when uncontrolled. (number)"
|
|
6678
|
+
},
|
|
6679
|
+
{
|
|
6680
|
+
"name": "index",
|
|
6681
|
+
"description": "The shown image (controlled, 0-based), with `onIndexChange`. (number)"
|
|
6682
|
+
},
|
|
6683
|
+
{
|
|
6684
|
+
"name": "label",
|
|
6685
|
+
"description": "Accessible name of the gallery (default \"Images\"), e.g. the listing's title. (string)"
|
|
5832
6686
|
},
|
|
5833
6687
|
{
|
|
5834
6688
|
"name": "ratio",
|
|
@@ -5955,7 +6809,15 @@
|
|
|
5955
6809
|
"attributes": [
|
|
5956
6810
|
{
|
|
5957
6811
|
"name": "items",
|
|
5958
|
-
"description": "(string[])"
|
|
6812
|
+
"description": "The trail; the last one is the current page. Items with `href` are links, with `onClick` buttons. ((string | Crumb)[])"
|
|
6813
|
+
},
|
|
6814
|
+
{
|
|
6815
|
+
"name": "link-as",
|
|
6816
|
+
"description": "The element links render as (default `a`), e.g. Next.js `Link`. (ElementType)"
|
|
6817
|
+
},
|
|
6818
|
+
{
|
|
6819
|
+
"name": "label",
|
|
6820
|
+
"description": "Accessible name of the navigation (default \"Breadcrumb\"). (string)"
|
|
5959
6821
|
}
|
|
5960
6822
|
],
|
|
5961
6823
|
"references": [
|
|
@@ -5980,6 +6842,14 @@
|
|
|
5980
6842
|
{
|
|
5981
6843
|
"name": "default-page",
|
|
5982
6844
|
"description": "Start page when uncontrolled (default 1). (number)"
|
|
6845
|
+
},
|
|
6846
|
+
{
|
|
6847
|
+
"name": "link-as",
|
|
6848
|
+
"description": "The element links render as (default `a`), e.g. Next.js `Link`. (ElementType)"
|
|
6849
|
+
},
|
|
6850
|
+
{
|
|
6851
|
+
"name": "label",
|
|
6852
|
+
"description": "Accessible name of the navigation (default \"Pagination\"), e.g. \"Search results pages\". (string)"
|
|
5983
6853
|
}
|
|
5984
6854
|
],
|
|
5985
6855
|
"references": [
|
|
@@ -6031,7 +6901,7 @@
|
|
|
6031
6901
|
},
|
|
6032
6902
|
{
|
|
6033
6903
|
"name": "tf-sidebar",
|
|
6034
|
-
"description": "App navigation down the side: groups with headings, counts, one level of nested pages and a collapsed mode with icons only.",
|
|
6904
|
+
"description": "App navigation down the side: groups with headings, counts and badges, one level of nested pages, links, item menus and a collapsed mode with icons only.",
|
|
6035
6905
|
"attributes": [
|
|
6036
6906
|
{
|
|
6037
6907
|
"name": "groups",
|
|
@@ -6041,6 +6911,21 @@
|
|
|
6041
6911
|
"name": "current",
|
|
6042
6912
|
"description": "Id (or label) of the current page. (string)"
|
|
6043
6913
|
},
|
|
6914
|
+
{
|
|
6915
|
+
"name": "variant",
|
|
6916
|
+
"description": "`floating` (default): a card with rounded corners and a shadow. `attached`: full height, flush with the edge of the screen, divided by a line. `shell`: on the dark frame of `AppShell`. (\"floating\" | \"attached\" | \"shell\")",
|
|
6917
|
+
"values": [
|
|
6918
|
+
{
|
|
6919
|
+
"name": "floating"
|
|
6920
|
+
},
|
|
6921
|
+
{
|
|
6922
|
+
"name": "attached"
|
|
6923
|
+
},
|
|
6924
|
+
{
|
|
6925
|
+
"name": "shell"
|
|
6926
|
+
}
|
|
6927
|
+
]
|
|
6928
|
+
},
|
|
6044
6929
|
{
|
|
6045
6930
|
"name": "collapsed",
|
|
6046
6931
|
"description": "Icons only. (boolean)",
|
|
@@ -6051,17 +6936,52 @@
|
|
|
6051
6936
|
"description": "(boolean)",
|
|
6052
6937
|
"valueSet": "v"
|
|
6053
6938
|
},
|
|
6939
|
+
{
|
|
6940
|
+
"name": "storage-key",
|
|
6941
|
+
"description": "Remember the collapsed state in the browser under this key. (string)"
|
|
6942
|
+
},
|
|
6943
|
+
{
|
|
6944
|
+
"name": "shortcut",
|
|
6945
|
+
"description": "⌘B (Ctrl+B) collapses and expands the sidebar, except while typing in a field. (boolean)",
|
|
6946
|
+
"valueSet": "v"
|
|
6947
|
+
},
|
|
6948
|
+
{
|
|
6949
|
+
"name": "link-as",
|
|
6950
|
+
"description": "The element items with an `href` render as (default `a`), e.g. Next.js `Link`. (ElementType)"
|
|
6951
|
+
},
|
|
6952
|
+
{
|
|
6953
|
+
"name": "mobile-open",
|
|
6954
|
+
"description": "On phones (up to 760px wide): whether the drawer is open (controlled). (boolean)",
|
|
6955
|
+
"valueSet": "v"
|
|
6956
|
+
},
|
|
6054
6957
|
{
|
|
6055
6958
|
"name": "header",
|
|
6056
|
-
"description": "Top of the sidebar (brand,
|
|
6959
|
+
"description": "Top of the sidebar (brand, `WorkspaceSwitcher`); a function gets the collapsed state. (ReactNode | ((state: { collapsed: boolean }) => ReactNode))"
|
|
6057
6960
|
},
|
|
6058
6961
|
{
|
|
6059
6962
|
"name": "footer",
|
|
6060
|
-
"description": "Bottom of the sidebar (
|
|
6963
|
+
"description": "Bottom of the sidebar (`UserMenu`, settings); a function gets the collapsed state. (ReactNode | ((state: { collapsed: boolean }) => ReactNode))"
|
|
6964
|
+
},
|
|
6965
|
+
{
|
|
6966
|
+
"name": "as",
|
|
6967
|
+
"description": "`nav` (default) for app navigation. `aside` for filters, settings or other tools beside the content: a complementary region instead of a navigation landmark. (\"nav\" | \"aside\")",
|
|
6968
|
+
"values": [
|
|
6969
|
+
{
|
|
6970
|
+
"name": "nav"
|
|
6971
|
+
},
|
|
6972
|
+
{
|
|
6973
|
+
"name": "aside"
|
|
6974
|
+
}
|
|
6975
|
+
]
|
|
6976
|
+
},
|
|
6977
|
+
{
|
|
6978
|
+
"name": "collapsible",
|
|
6979
|
+
"description": "Offers the collapse button and the icons-only mode (default true; filters usually set false). (boolean)",
|
|
6980
|
+
"valueSet": "v"
|
|
6061
6981
|
},
|
|
6062
6982
|
{
|
|
6063
6983
|
"name": "label",
|
|
6064
|
-
"description": "Accessible name of the navigation. (string)"
|
|
6984
|
+
"description": "Accessible name of the navigation (or the aside). (string)"
|
|
6065
6985
|
}
|
|
6066
6986
|
],
|
|
6067
6987
|
"references": [
|
|
@@ -6071,6 +6991,51 @@
|
|
|
6071
6991
|
}
|
|
6072
6992
|
]
|
|
6073
6993
|
},
|
|
6994
|
+
{
|
|
6995
|
+
"name": "tf-user-menu",
|
|
6996
|
+
"description": "The signed-in account at the foot of a sidebar: avatar, name and email, opening a menu with profile, settings and sign-out.",
|
|
6997
|
+
"attributes": [
|
|
6998
|
+
{
|
|
6999
|
+
"name": "name",
|
|
7000
|
+
"description": "(string)"
|
|
7001
|
+
},
|
|
7002
|
+
{
|
|
7003
|
+
"name": "email",
|
|
7004
|
+
"description": "(string)"
|
|
7005
|
+
},
|
|
7006
|
+
{
|
|
7007
|
+
"name": "avatar",
|
|
7008
|
+
"description": "Picture URL; initials otherwise. (string)"
|
|
7009
|
+
},
|
|
7010
|
+
{
|
|
7011
|
+
"name": "items",
|
|
7012
|
+
"description": "The menu: profile, settings, sign out … ((MenuItem | \"-\")[])"
|
|
7013
|
+
},
|
|
7014
|
+
{
|
|
7015
|
+
"name": "compact",
|
|
7016
|
+
"description": "Only the avatar (a collapsed sidebar). (boolean)",
|
|
7017
|
+
"valueSet": "v"
|
|
7018
|
+
},
|
|
7019
|
+
{
|
|
7020
|
+
"name": "side",
|
|
7021
|
+
"description": "Where the menu opens (default `top`, for the foot of a sidebar). (\"top\" | \"bottom\")",
|
|
7022
|
+
"values": [
|
|
7023
|
+
{
|
|
7024
|
+
"name": "top"
|
|
7025
|
+
},
|
|
7026
|
+
{
|
|
7027
|
+
"name": "bottom"
|
|
7028
|
+
}
|
|
7029
|
+
]
|
|
7030
|
+
}
|
|
7031
|
+
],
|
|
7032
|
+
"references": [
|
|
7033
|
+
{
|
|
7034
|
+
"name": "Docs",
|
|
7035
|
+
"url": "https://ui.twentyfirst.media/halo/components/UserMenu/"
|
|
7036
|
+
}
|
|
7037
|
+
]
|
|
7038
|
+
},
|
|
6074
7039
|
{
|
|
6075
7040
|
"name": "tf-connection-card",
|
|
6076
7041
|
"description": "Connected services and the live connection: ConnectionCard and ConnectionBanner.",
|
|
@@ -6810,6 +7775,11 @@
|
|
|
6810
7775
|
"name": "md"
|
|
6811
7776
|
}
|
|
6812
7777
|
]
|
|
7778
|
+
},
|
|
7779
|
+
{
|
|
7780
|
+
"name": "block",
|
|
7781
|
+
"description": "Fills the width and shares it evenly; labels end in an ellipsis when space runs short. (boolean)",
|
|
7782
|
+
"valueSet": "v"
|
|
6813
7783
|
}
|
|
6814
7784
|
],
|
|
6815
7785
|
"references": [
|
|
@@ -7272,7 +8242,7 @@
|
|
|
7272
8242
|
"attributes": [
|
|
7273
8243
|
{
|
|
7274
8244
|
"name": "brand",
|
|
7275
|
-
"description": "(
|
|
8245
|
+
"description": "The product name, or a node (a logo mark with the name). (ReactNode)"
|
|
7276
8246
|
},
|
|
7277
8247
|
{
|
|
7278
8248
|
"name": "tag",
|
|
@@ -7318,6 +8288,25 @@
|
|
|
7318
8288
|
{
|
|
7319
8289
|
"name": "bottom",
|
|
7320
8290
|
"description": "(RailItem[])"
|
|
8291
|
+
},
|
|
8292
|
+
{
|
|
8293
|
+
"name": "expanded",
|
|
8294
|
+
"description": "Names next to the icons (controlled); every button has a tooltip while collapsed. (boolean)",
|
|
8295
|
+
"valueSet": "v"
|
|
8296
|
+
},
|
|
8297
|
+
{
|
|
8298
|
+
"name": "default-expanded",
|
|
8299
|
+
"description": "(boolean)",
|
|
8300
|
+
"valueSet": "v"
|
|
8301
|
+
},
|
|
8302
|
+
{
|
|
8303
|
+
"name": "toggle",
|
|
8304
|
+
"description": "A button at the foot that expands and collapses the rail. (boolean)",
|
|
8305
|
+
"valueSet": "v"
|
|
8306
|
+
},
|
|
8307
|
+
{
|
|
8308
|
+
"name": "label",
|
|
8309
|
+
"description": "Accessible name of the rail (default \"Tools\"). (string)"
|
|
7321
8310
|
}
|
|
7322
8311
|
],
|
|
7323
8312
|
"references": [
|
|
@@ -7375,9 +8364,30 @@
|
|
|
7375
8364
|
"name": "bottom",
|
|
7376
8365
|
"description": "Bar along the bottom edge (dock, playback, a summary). (ReactNode)"
|
|
7377
8366
|
},
|
|
8367
|
+
{
|
|
8368
|
+
"name": "controls",
|
|
8369
|
+
"description": "Controls of the background (zoom, compass, locate) in the free corner above the bottom bar. (ReactNode)"
|
|
8370
|
+
},
|
|
8371
|
+
{
|
|
8372
|
+
"name": "attribution",
|
|
8373
|
+
"description": "Source notes of the background (map attribution), under `controls`, clear of every slot. (ReactNode)"
|
|
8374
|
+
},
|
|
8375
|
+
{
|
|
8376
|
+
"name": "start-width",
|
|
8377
|
+
"description": "Width of the start column (default 320px) and of the end column (default 340px). (number | string)"
|
|
8378
|
+
},
|
|
8379
|
+
{
|
|
8380
|
+
"name": "end-width",
|
|
8381
|
+
"description": "(number | string)"
|
|
8382
|
+
},
|
|
8383
|
+
{
|
|
8384
|
+
"name": "end-sheet",
|
|
8385
|
+
"description": "Below 720px of width the end slot becomes a bottom sheet over the background, with a handle that expands and collapses it (default true). `false` stacks it with the others. (boolean)",
|
|
8386
|
+
"valueSet": "v"
|
|
8387
|
+
},
|
|
7378
8388
|
{
|
|
7379
8389
|
"name": "height",
|
|
7380
|
-
"description": "Height of the layout (default 640). Below 720px of width the slots stack: top, start, end, bottom. (number | string)"
|
|
8390
|
+
"description": "Height of the layout (default 640). Below 720px of width the slots stack: top, start, end, bottom. The layout sets `--floating-safe-top/-start/-end/-bottom` (px) to the space its slots take, so map libraries can keep their own controls clear of them. (number | string)"
|
|
7381
8391
|
},
|
|
7382
8392
|
{
|
|
7383
8393
|
"name": "surface",
|
|
@@ -7440,7 +8450,7 @@
|
|
|
7440
8450
|
},
|
|
7441
8451
|
{
|
|
7442
8452
|
"name": "brand",
|
|
7443
|
-
"description": "(
|
|
8453
|
+
"description": "The product name, or a node (a logo mark with the name; collapsed sidebars show it whole). (ReactNode)"
|
|
7444
8454
|
},
|
|
7445
8455
|
{
|
|
7446
8456
|
"name": "tag",
|
|
@@ -7486,6 +8496,34 @@
|
|
|
7486
8496
|
{
|
|
7487
8497
|
"name": "rail-bottom",
|
|
7488
8498
|
"description": "(RailItem[])"
|
|
8499
|
+
},
|
|
8500
|
+
{
|
|
8501
|
+
"name": "navigation",
|
|
8502
|
+
"description": "`top` (default): navigation in the top bar, tools in the side rail. `sidebar`: a labelled sidebar on the frame, with groups, nesting and a drawer on phones. (\"top\" | \"sidebar\")",
|
|
8503
|
+
"values": [
|
|
8504
|
+
{
|
|
8505
|
+
"name": "top"
|
|
8506
|
+
},
|
|
8507
|
+
{
|
|
8508
|
+
"name": "sidebar"
|
|
8509
|
+
}
|
|
8510
|
+
]
|
|
8511
|
+
},
|
|
8512
|
+
{
|
|
8513
|
+
"name": "sidebar-groups",
|
|
8514
|
+
"description": "With `navigation=\"sidebar\"`: groups instead of the flat `nav` list. (SidebarGroup[])"
|
|
8515
|
+
},
|
|
8516
|
+
{
|
|
8517
|
+
"name": "sidebar",
|
|
8518
|
+
"description": "With `navigation=\"sidebar\"`: more sidebar props (collapsed, storageKey, shortcut, linkAs …). (Partial<Omit<SidebarProps, \"variant\" | \"groups\">>)"
|
|
8519
|
+
},
|
|
8520
|
+
{
|
|
8521
|
+
"name": "workspaces",
|
|
8522
|
+
"description": "With `navigation=\"sidebar\"`: the workspace switcher at the top instead of the brand. (WorkspaceSwitcherProps)"
|
|
8523
|
+
},
|
|
8524
|
+
{
|
|
8525
|
+
"name": "user-menu",
|
|
8526
|
+
"description": "The account menu's entries (with `navigation=\"sidebar\"` at the foot of the sidebar). ((MenuItem | \"-\")[])"
|
|
7489
8527
|
}
|
|
7490
8528
|
],
|
|
7491
8529
|
"references": [
|
|
@@ -7559,7 +8597,7 @@
|
|
|
7559
8597
|
},
|
|
7560
8598
|
{
|
|
7561
8599
|
"name": "categories",
|
|
7562
|
-
"description": "({ id: string; label: string; text?:
|
|
8600
|
+
"description": "({ id: string; label: string; /** What the category covers; may hold a link to the details. */ text?: ReactNode; required?: boolean; default?: boolean; }[])"
|
|
7563
8601
|
},
|
|
7564
8602
|
{
|
|
7565
8603
|
"name": "open",
|
|
@@ -7570,6 +8608,11 @@
|
|
|
7570
8608
|
"name": "inline",
|
|
7571
8609
|
"description": "(boolean)",
|
|
7572
8610
|
"valueSet": "v"
|
|
8611
|
+
},
|
|
8612
|
+
{
|
|
8613
|
+
"name": "equal-choice",
|
|
8614
|
+
"description": "\"Only necessary\" and \"Accept all\" with the same weight (both secondary buttons), as German data protection authorities expect on the first layer. (boolean)",
|
|
8615
|
+
"valueSet": "v"
|
|
7573
8616
|
}
|
|
7574
8617
|
],
|
|
7575
8618
|
"references": [
|