@nordhealth/components 2.15.0 → 2.15.2
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/custom-elements.json +1450 -1445
- package/lib/{AutocompleteMixin-c8018288.js → AutocompleteMixin-5163f8db.js} +2 -2
- package/lib/{AutocompleteMixin-c8018288.js.map → AutocompleteMixin-5163f8db.js.map} +1 -1
- package/lib/Avatar.js +1 -1
- package/lib/Badge.js +1 -1
- package/lib/Banner.js +1 -1
- package/lib/Banner.js.map +1 -1
- package/lib/Button.js +1 -1
- package/lib/ButtonGroup.js +1 -1
- package/lib/{Calendar-55de6612.js → Calendar-88644376.js} +2 -2
- package/lib/{Calendar-55de6612.js.map → Calendar-88644376.js.map} +1 -1
- package/lib/Calendar.js +1 -1
- package/lib/Card.js +1 -1
- package/lib/Checkbox.js +1 -1
- package/lib/CommandMenu.js +1 -1
- package/lib/CommandMenu.js.map +1 -1
- package/lib/CommandMenuAction.js +1 -1
- package/lib/CommandMenuAction.js.map +1 -1
- package/lib/{Component-d4d6fa77.js → Component-449e40fb.js} +2 -2
- package/lib/Component-449e40fb.js.map +1 -0
- package/lib/DatePicker.js +1 -1
- package/lib/Divider.js +1 -1
- package/lib/Divider.js.map +1 -1
- package/lib/Drawer.js +1 -1
- package/lib/Dropdown.js +1 -1
- package/lib/DropdownGroup.js +1 -1
- package/lib/DropdownItem.js +1 -1
- package/lib/EmptyState.js +1 -1
- package/lib/Fieldset.js +1 -1
- package/lib/FocusableMixin-32631bff.js +2 -0
- package/lib/{FocusableMixin-fc1e2a13.js.map → FocusableMixin-32631bff.js.map} +1 -1
- package/lib/{FormAssociatedMixin-ad4d6c08.js → FormAssociatedMixin-dc7ee1d9.js} +2 -2
- package/lib/{FormAssociatedMixin-ad4d6c08.js.map → FormAssociatedMixin-dc7ee1d9.js.map} +1 -1
- package/lib/{FormField-c733b196.js → FormField-413f22f5.js} +2 -2
- package/lib/FormField-413f22f5.js.map +1 -0
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Icon.js +1 -1
- package/lib/IconManager.js +1 -1
- package/lib/Input.js +1 -1
- package/lib/{InputMixin-1564ca2a.js → InputMixin-7fa755e1.js} +2 -2
- package/lib/{InputMixin-1564ca2a.js.map → InputMixin-7fa755e1.js.map} +1 -1
- package/lib/Layout.js +1 -1
- package/lib/{LightDomController-3b7b1f44.js → LightDomController-052f446a.js} +2 -2
- package/lib/{LightDomController-3b7b1f44.js.map → LightDomController-052f446a.js.map} +1 -1
- package/lib/Modal.js +1 -1
- package/lib/NavGroup.js +1 -1
- package/lib/NavItem.js +1 -1
- package/lib/NavToggle.js +1 -1
- package/lib/NavToggle.js.map +1 -1
- package/lib/Navigation.js +1 -1
- package/lib/{Popout-66e0a6a6.js → Popout-c0d2cb72.js} +2 -2
- package/lib/Popout-c0d2cb72.js.map +1 -0
- package/lib/Popout.js +1 -1
- package/lib/ProgressBar.js +1 -1
- package/lib/Qrcode.js +1 -1
- package/lib/Radio.js +1 -1
- package/lib/Range.js +1 -1
- package/lib/Select.js +1 -1
- package/lib/{SizeMixin-9da6dc81.js → SizeMixin-4d04817d.js} +2 -2
- package/lib/{SizeMixin-9da6dc81.js.map → SizeMixin-4d04817d.js.map} +1 -1
- package/lib/Skeleton.js +1 -1
- package/lib/Spinner.js +1 -1
- package/lib/Stack.js +1 -1
- package/lib/{Sticky-64b0b58a.js → Sticky-c4cf185e.js} +2 -2
- package/lib/Sticky-c4cf185e.js.map +1 -0
- package/lib/Tab.js +1 -1
- package/lib/TabGroup.js +1 -1
- package/lib/TabPanel.js +1 -1
- package/lib/Table.js +1 -1
- package/lib/{TextField-6a272cd7.js → TextField-ca819c35.js} +2 -2
- package/lib/{TextField-6a272cd7.js.map → TextField-ca819c35.js.map} +1 -1
- package/lib/Textarea.js +1 -1
- package/lib/Toast.js +1 -1
- package/lib/ToastGroup.js +1 -1
- package/lib/Toggle.js +1 -1
- package/lib/Tooltip.js +1 -1
- package/lib/VisuallyHidden.js +1 -1
- package/lib/bundle.js +9 -8
- package/lib/bundle.js.map +1 -1
- package/lib/class-map-21152cee.js +7 -0
- package/lib/{class-map-1bc3148f.js.map → class-map-21152cee.js.map} +1 -1
- package/lib/{collection-a0cd49b2.js → collection-7eee4e72.js} +2 -2
- package/lib/{collection-a0cd49b2.js.map → collection-7eee4e72.js.map} +1 -1
- package/lib/cond-2da54107.js +2 -0
- package/lib/{cond-8e7df9cf.js.map → cond-2da54107.js.map} +1 -1
- package/lib/{if-defined-718a58b2.js → if-defined-720964c0.js} +2 -2
- package/lib/{if-defined-718a58b2.js.map → if-defined-720964c0.js.map} +1 -1
- package/lib/index.js +1 -1
- package/lib/positioning-3bbd3548.js +2 -0
- package/lib/positioning-3bbd3548.js.map +1 -0
- package/lib/query-assigned-elements-cf502539.js +35 -0
- package/lib/query-assigned-elements-cf502539.js.map +1 -0
- package/lib/{ref-4265fcf9.js → ref-c44e9f3c.js} +4 -4
- package/lib/{ref-4265fcf9.js.map → ref-c44e9f3c.js.map} +1 -1
- package/lib/src/popout/Popout.d.ts +1 -0
- package/lib/{style-map-c63c0180.js → style-map-2e8fcab6.js} +2 -2
- package/lib/{style-map-c63c0180.js.map → style-map-2e8fcab6.js.map} +1 -1
- package/package.json +2 -2
- package/lib/Component-d4d6fa77.js.map +0 -1
- package/lib/FocusableMixin-fc1e2a13.js +0 -2
- package/lib/FormField-c733b196.js.map +0 -1
- package/lib/Popout-66e0a6a6.js.map +0 -1
- package/lib/Sticky-64b0b58a.js.map +0 -1
- package/lib/class-map-1bc3148f.js +0 -7
- package/lib/cond-8e7df9cf.js +0 -2
- package/lib/positioning-acf73137.js +0 -2
- package/lib/positioning-acf73137.js.map +0 -1
- package/lib/query-assigned-elements-89f41e17.js +0 -34
- package/lib/query-assigned-elements-89f41e17.js.map +0 -1
package/custom-elements.json
CHANGED
|
@@ -568,6 +568,93 @@
|
|
|
568
568
|
}
|
|
569
569
|
]
|
|
570
570
|
},
|
|
571
|
+
{
|
|
572
|
+
"kind": "javascript-module",
|
|
573
|
+
"path": "src/badge/Badge.ts",
|
|
574
|
+
"declarations": [
|
|
575
|
+
{
|
|
576
|
+
"kind": "class",
|
|
577
|
+
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
578
|
+
"name": "Badge",
|
|
579
|
+
"slots": [
|
|
580
|
+
{
|
|
581
|
+
"description": "The badge content.",
|
|
582
|
+
"name": ""
|
|
583
|
+
}
|
|
584
|
+
],
|
|
585
|
+
"members": [
|
|
586
|
+
{
|
|
587
|
+
"kind": "field",
|
|
588
|
+
"name": "type",
|
|
589
|
+
"type": {
|
|
590
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
591
|
+
},
|
|
592
|
+
"default": "\"neutral\"",
|
|
593
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
594
|
+
"attribute": "type",
|
|
595
|
+
"reflects": true
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"kind": "field",
|
|
599
|
+
"name": "progress",
|
|
600
|
+
"type": {
|
|
601
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
602
|
+
},
|
|
603
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
604
|
+
"attribute": "progress"
|
|
605
|
+
}
|
|
606
|
+
],
|
|
607
|
+
"attributes": [
|
|
608
|
+
{
|
|
609
|
+
"name": "type",
|
|
610
|
+
"type": {
|
|
611
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
612
|
+
},
|
|
613
|
+
"default": "\"neutral\"",
|
|
614
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
615
|
+
"fieldName": "type"
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
"name": "progress",
|
|
619
|
+
"type": {
|
|
620
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
621
|
+
},
|
|
622
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
623
|
+
"fieldName": "progress"
|
|
624
|
+
}
|
|
625
|
+
],
|
|
626
|
+
"superclass": {
|
|
627
|
+
"name": "LitElement",
|
|
628
|
+
"package": "lit"
|
|
629
|
+
},
|
|
630
|
+
"localization": [],
|
|
631
|
+
"status": "ready",
|
|
632
|
+
"category": "text",
|
|
633
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s clear to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
634
|
+
"examples": [],
|
|
635
|
+
"tagName": "nord-badge",
|
|
636
|
+
"customElement": true
|
|
637
|
+
}
|
|
638
|
+
],
|
|
639
|
+
"exports": [
|
|
640
|
+
{
|
|
641
|
+
"kind": "js",
|
|
642
|
+
"name": "default",
|
|
643
|
+
"declaration": {
|
|
644
|
+
"name": "Badge",
|
|
645
|
+
"module": "src/badge/Badge.ts"
|
|
646
|
+
}
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"kind": "custom-element-definition",
|
|
650
|
+
"name": "nord-badge",
|
|
651
|
+
"declaration": {
|
|
652
|
+
"name": "Badge",
|
|
653
|
+
"module": "src/badge/Badge.ts"
|
|
654
|
+
}
|
|
655
|
+
}
|
|
656
|
+
]
|
|
657
|
+
},
|
|
571
658
|
{
|
|
572
659
|
"kind": "javascript-module",
|
|
573
660
|
"path": "src/banner/Banner.ts",
|
|
@@ -1314,744 +1401,432 @@
|
|
|
1314
1401
|
},
|
|
1315
1402
|
{
|
|
1316
1403
|
"kind": "javascript-module",
|
|
1317
|
-
"path": "src/
|
|
1404
|
+
"path": "src/calendar/Calendar.ts",
|
|
1318
1405
|
"declarations": [
|
|
1319
1406
|
{
|
|
1320
1407
|
"kind": "class",
|
|
1321
|
-
"description": "
|
|
1322
|
-
"name": "
|
|
1323
|
-
"
|
|
1408
|
+
"description": "Calendar allows user to pick a date. It comes with built-in\nfunctionality that allows you to set a minimum and a maximum allowed date.\nPlease note that the date must be passed in ISO-8601 format.",
|
|
1409
|
+
"name": "Calendar",
|
|
1410
|
+
"cssProperties": [
|
|
1324
1411
|
{
|
|
1325
|
-
"description": "
|
|
1326
|
-
"name": ""
|
|
1412
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1413
|
+
"name": "--n-calendar-border-radius",
|
|
1414
|
+
"default": "var(--n-border-radius)"
|
|
1415
|
+
},
|
|
1416
|
+
{
|
|
1417
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1418
|
+
"name": "--n-calendar-box-shadow",
|
|
1419
|
+
"default": "var(--n-box-shadow-popout)"
|
|
1327
1420
|
}
|
|
1328
1421
|
],
|
|
1329
1422
|
"members": [
|
|
1330
1423
|
{
|
|
1331
1424
|
"kind": "field",
|
|
1332
|
-
"name": "
|
|
1425
|
+
"name": "monthSelectNode",
|
|
1333
1426
|
"type": {
|
|
1334
|
-
"text": "
|
|
1427
|
+
"text": "HTMLElement"
|
|
1335
1428
|
},
|
|
1336
|
-
"
|
|
1337
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1338
|
-
"attribute": "type",
|
|
1339
|
-
"reflects": true
|
|
1429
|
+
"privacy": "private"
|
|
1340
1430
|
},
|
|
1341
1431
|
{
|
|
1342
1432
|
"kind": "field",
|
|
1343
|
-
"name": "
|
|
1344
|
-
"type": {
|
|
1345
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
1346
|
-
},
|
|
1347
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
1348
|
-
"attribute": "progress"
|
|
1349
|
-
}
|
|
1350
|
-
],
|
|
1351
|
-
"attributes": [
|
|
1352
|
-
{
|
|
1353
|
-
"name": "type",
|
|
1433
|
+
"name": "focusedDayNode",
|
|
1354
1434
|
"type": {
|
|
1355
|
-
"text": "
|
|
1435
|
+
"text": "HTMLButtonElement"
|
|
1356
1436
|
},
|
|
1357
|
-
"
|
|
1358
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1359
|
-
"fieldName": "type"
|
|
1437
|
+
"privacy": "private"
|
|
1360
1438
|
},
|
|
1361
1439
|
{
|
|
1362
|
-
"
|
|
1363
|
-
"
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
1367
|
-
"fieldName": "progress"
|
|
1368
|
-
}
|
|
1369
|
-
],
|
|
1370
|
-
"superclass": {
|
|
1371
|
-
"name": "LitElement",
|
|
1372
|
-
"package": "lit"
|
|
1373
|
-
},
|
|
1374
|
-
"localization": [],
|
|
1375
|
-
"status": "ready",
|
|
1376
|
-
"category": "text",
|
|
1377
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s clear to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
1378
|
-
"examples": [],
|
|
1379
|
-
"tagName": "nord-badge",
|
|
1380
|
-
"customElement": true
|
|
1381
|
-
}
|
|
1382
|
-
],
|
|
1383
|
-
"exports": [
|
|
1384
|
-
{
|
|
1385
|
-
"kind": "js",
|
|
1386
|
-
"name": "default",
|
|
1387
|
-
"declaration": {
|
|
1388
|
-
"name": "Badge",
|
|
1389
|
-
"module": "src/badge/Badge.ts"
|
|
1390
|
-
}
|
|
1391
|
-
},
|
|
1392
|
-
{
|
|
1393
|
-
"kind": "custom-element-definition",
|
|
1394
|
-
"name": "nord-badge",
|
|
1395
|
-
"declaration": {
|
|
1396
|
-
"name": "Badge",
|
|
1397
|
-
"module": "src/badge/Badge.ts"
|
|
1398
|
-
}
|
|
1399
|
-
}
|
|
1400
|
-
]
|
|
1401
|
-
},
|
|
1402
|
-
{
|
|
1403
|
-
"kind": "javascript-module",
|
|
1404
|
-
"path": "src/checkbox/Checkbox.ts",
|
|
1405
|
-
"declarations": [
|
|
1406
|
-
{
|
|
1407
|
-
"kind": "class",
|
|
1408
|
-
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
1409
|
-
"name": "Checkbox",
|
|
1410
|
-
"slots": [
|
|
1411
|
-
{
|
|
1412
|
-
"description": "Use when a label requires more than plain text.",
|
|
1413
|
-
"name": "label"
|
|
1440
|
+
"kind": "field",
|
|
1441
|
+
"name": "direction",
|
|
1442
|
+
"privacy": "private",
|
|
1443
|
+
"default": "new DirectionController(this)"
|
|
1414
1444
|
},
|
|
1415
1445
|
{
|
|
1416
|
-
"
|
|
1417
|
-
"name": "
|
|
1446
|
+
"kind": "field",
|
|
1447
|
+
"name": "swipe",
|
|
1448
|
+
"privacy": "private",
|
|
1449
|
+
"default": "new SwipeController(this, {\n matchesGesture: isHorizontalSwipe,\n onSwipeEnd: ({ distX }) => this.addMonths(distX < 0 ? 1 : -1),\n })"
|
|
1418
1450
|
},
|
|
1419
1451
|
{
|
|
1420
|
-
"
|
|
1421
|
-
"name": "
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
"members": [
|
|
1452
|
+
"kind": "field",
|
|
1453
|
+
"name": "shortcuts",
|
|
1454
|
+
"privacy": "private"
|
|
1455
|
+
},
|
|
1425
1456
|
{
|
|
1426
1457
|
"kind": "field",
|
|
1427
|
-
"name": "
|
|
1428
|
-
"privacy": "
|
|
1429
|
-
"
|
|
1430
|
-
"name": "FormAssociatedMixin",
|
|
1431
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1432
|
-
}
|
|
1458
|
+
"name": "localize",
|
|
1459
|
+
"privacy": "private",
|
|
1460
|
+
"default": "new LocalizeController<\"nord-calendar\">(this, {\n onLangChange: () => this.handleLangChange(),\n })"
|
|
1433
1461
|
},
|
|
1434
1462
|
{
|
|
1435
1463
|
"kind": "field",
|
|
1436
|
-
"name": "
|
|
1464
|
+
"name": "dateFormatShort",
|
|
1437
1465
|
"type": {
|
|
1438
|
-
"text": "
|
|
1466
|
+
"text": "Intl.DateTimeFormat"
|
|
1439
1467
|
},
|
|
1440
|
-
"
|
|
1441
|
-
"description": "
|
|
1442
|
-
"attribute": "indeterminate"
|
|
1468
|
+
"privacy": "private",
|
|
1469
|
+
"description": "Whilst dateAdapter is used for handling the formatting/parsing dates in the input,\nthese are used to format dates exclusively for the benefit of screen readers.\n\nWe prefer DateTimeFormat over date.toLocaleDateString, as the former has\nbetter performance when formatting large number of dates. See:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleDateString#Performance"
|
|
1443
1470
|
},
|
|
1444
1471
|
{
|
|
1445
1472
|
"kind": "field",
|
|
1446
|
-
"name": "
|
|
1473
|
+
"name": "monthNames",
|
|
1447
1474
|
"type": {
|
|
1448
|
-
"text": "
|
|
1475
|
+
"text": "string[]"
|
|
1449
1476
|
},
|
|
1450
|
-
"
|
|
1451
|
-
"description": "Controls whether the checkbox is checked or not.",
|
|
1452
|
-
"attribute": "checked"
|
|
1477
|
+
"privacy": "private"
|
|
1453
1478
|
},
|
|
1454
1479
|
{
|
|
1455
|
-
"kind": "
|
|
1456
|
-
"name": "
|
|
1457
|
-
"
|
|
1458
|
-
|
|
1459
|
-
{
|
|
1460
|
-
"name": "e",
|
|
1461
|
-
"type": {
|
|
1462
|
-
"text": "Event"
|
|
1463
|
-
}
|
|
1464
|
-
}
|
|
1465
|
-
],
|
|
1466
|
-
"return": {
|
|
1467
|
-
"type": {
|
|
1468
|
-
"text": "void"
|
|
1469
|
-
}
|
|
1480
|
+
"kind": "field",
|
|
1481
|
+
"name": "monthNamesShort",
|
|
1482
|
+
"type": {
|
|
1483
|
+
"text": "string[]"
|
|
1470
1484
|
},
|
|
1471
|
-
"
|
|
1472
|
-
"name": "FormAssociatedMixin",
|
|
1473
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1474
|
-
}
|
|
1485
|
+
"privacy": "private"
|
|
1475
1486
|
},
|
|
1476
1487
|
{
|
|
1477
1488
|
"kind": "field",
|
|
1478
|
-
"name": "
|
|
1489
|
+
"name": "dayNames",
|
|
1479
1490
|
"type": {
|
|
1480
|
-
"text": "
|
|
1491
|
+
"text": "string[]"
|
|
1481
1492
|
},
|
|
1482
|
-
"
|
|
1483
|
-
"description": "The size of the component.",
|
|
1484
|
-
"attribute": "size",
|
|
1485
|
-
"reflects": true,
|
|
1486
|
-
"inheritedFrom": {
|
|
1487
|
-
"name": "SizeMixin",
|
|
1488
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
1489
|
-
}
|
|
1490
|
-
},
|
|
1491
|
-
{
|
|
1492
|
-
"kind": "field",
|
|
1493
|
-
"name": "labelSlot",
|
|
1494
|
-
"privacy": "protected",
|
|
1495
|
-
"default": "new SlotController(this, \"label\")",
|
|
1496
|
-
"inheritedFrom": {
|
|
1497
|
-
"name": "FormAssociatedMixin",
|
|
1498
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1499
|
-
}
|
|
1500
|
-
},
|
|
1501
|
-
{
|
|
1502
|
-
"kind": "field",
|
|
1503
|
-
"name": "errorSlot",
|
|
1504
|
-
"privacy": "protected",
|
|
1505
|
-
"default": "new SlotController(this, \"error\")",
|
|
1506
|
-
"inheritedFrom": {
|
|
1507
|
-
"name": "FormAssociatedMixin",
|
|
1508
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1509
|
-
}
|
|
1510
|
-
},
|
|
1511
|
-
{
|
|
1512
|
-
"kind": "field",
|
|
1513
|
-
"name": "hintSlot",
|
|
1514
|
-
"privacy": "protected",
|
|
1515
|
-
"default": "new SlotController(this, \"hint\")",
|
|
1516
|
-
"inheritedFrom": {
|
|
1517
|
-
"name": "FormAssociatedMixin",
|
|
1518
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1519
|
-
}
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
"kind": "field",
|
|
1523
|
-
"name": "formData",
|
|
1524
|
-
"privacy": "protected",
|
|
1525
|
-
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
1526
|
-
"inheritedFrom": {
|
|
1527
|
-
"name": "FormAssociatedMixin",
|
|
1528
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1529
|
-
}
|
|
1493
|
+
"privacy": "private"
|
|
1530
1494
|
},
|
|
1531
1495
|
{
|
|
1532
1496
|
"kind": "field",
|
|
1533
|
-
"name": "
|
|
1497
|
+
"name": "dayNamesShort",
|
|
1534
1498
|
"type": {
|
|
1535
|
-
"text": "string"
|
|
1499
|
+
"text": "string[]"
|
|
1536
1500
|
},
|
|
1537
|
-
"privacy": "
|
|
1538
|
-
"default": "\"input\"",
|
|
1539
|
-
"inheritedFrom": {
|
|
1540
|
-
"name": "FormAssociatedMixin",
|
|
1541
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1542
|
-
}
|
|
1501
|
+
"privacy": "private"
|
|
1543
1502
|
},
|
|
1544
1503
|
{
|
|
1545
1504
|
"kind": "field",
|
|
1546
|
-
"name": "
|
|
1505
|
+
"name": "value",
|
|
1547
1506
|
"type": {
|
|
1548
1507
|
"text": "string"
|
|
1549
1508
|
},
|
|
1550
|
-
"
|
|
1551
|
-
"
|
|
1552
|
-
"
|
|
1553
|
-
"name": "FormAssociatedMixin",
|
|
1554
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1555
|
-
}
|
|
1509
|
+
"default": "\"\"",
|
|
1510
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1511
|
+
"attribute": "value"
|
|
1556
1512
|
},
|
|
1557
1513
|
{
|
|
1558
1514
|
"kind": "field",
|
|
1559
|
-
"name": "
|
|
1515
|
+
"name": "firstDayOfWeek",
|
|
1560
1516
|
"type": {
|
|
1561
|
-
"text": "
|
|
1517
|
+
"text": "DaysOfWeek"
|
|
1562
1518
|
},
|
|
1563
|
-
"
|
|
1564
|
-
"
|
|
1565
|
-
"inheritedFrom": {
|
|
1566
|
-
"name": "FormAssociatedMixin",
|
|
1567
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1568
|
-
}
|
|
1519
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1520
|
+
"attribute": "firstDayOfWeek"
|
|
1569
1521
|
},
|
|
1570
1522
|
{
|
|
1571
1523
|
"kind": "field",
|
|
1572
|
-
"name": "
|
|
1524
|
+
"name": "min",
|
|
1573
1525
|
"type": {
|
|
1574
1526
|
"text": "string"
|
|
1575
1527
|
},
|
|
1576
1528
|
"default": "\"\"",
|
|
1577
|
-
"description": "
|
|
1578
|
-
"attribute": "
|
|
1579
|
-
"inheritedFrom": {
|
|
1580
|
-
"name": "FormAssociatedMixin",
|
|
1581
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1582
|
-
}
|
|
1529
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property.",
|
|
1530
|
+
"attribute": "min"
|
|
1583
1531
|
},
|
|
1584
1532
|
{
|
|
1585
1533
|
"kind": "field",
|
|
1586
|
-
"name": "
|
|
1534
|
+
"name": "max",
|
|
1587
1535
|
"type": {
|
|
1588
|
-
"text": "string
|
|
1536
|
+
"text": "string"
|
|
1589
1537
|
},
|
|
1590
|
-
"
|
|
1591
|
-
"
|
|
1592
|
-
"
|
|
1593
|
-
"name": "FormAssociatedMixin",
|
|
1594
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1595
|
-
}
|
|
1538
|
+
"default": "\"\"",
|
|
1539
|
+
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
1540
|
+
"attribute": "max"
|
|
1596
1541
|
},
|
|
1597
1542
|
{
|
|
1598
1543
|
"kind": "field",
|
|
1599
|
-
"name": "
|
|
1544
|
+
"name": "expand",
|
|
1600
1545
|
"type": {
|
|
1601
1546
|
"text": "boolean"
|
|
1602
1547
|
},
|
|
1603
1548
|
"default": "false",
|
|
1604
|
-
"description": "
|
|
1605
|
-
"attribute": "
|
|
1606
|
-
"
|
|
1607
|
-
"name": "FormAssociatedMixin",
|
|
1608
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1609
|
-
}
|
|
1549
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1550
|
+
"attribute": "expand",
|
|
1551
|
+
"reflects": true
|
|
1610
1552
|
},
|
|
1611
1553
|
{
|
|
1612
1554
|
"kind": "field",
|
|
1613
|
-
"name": "
|
|
1555
|
+
"name": "isDateDisabled",
|
|
1614
1556
|
"type": {
|
|
1615
|
-
"text": "
|
|
1557
|
+
"text": "DatePredicate"
|
|
1616
1558
|
},
|
|
1617
|
-
"
|
|
1618
|
-
"
|
|
1619
|
-
"inheritedFrom": {
|
|
1620
|
-
"name": "FormAssociatedMixin",
|
|
1621
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1622
|
-
}
|
|
1559
|
+
"default": "isDateDisabled",
|
|
1560
|
+
"description": "Controls which days are disabled and therefore disallowed.\nFor example, this can be used to disallow selection of weekends."
|
|
1623
1561
|
},
|
|
1624
1562
|
{
|
|
1625
1563
|
"kind": "field",
|
|
1626
|
-
"name": "
|
|
1564
|
+
"name": "isDateHighlighted",
|
|
1627
1565
|
"type": {
|
|
1628
|
-
"text": "string |
|
|
1566
|
+
"text": "(date: Date) => string | boolean"
|
|
1629
1567
|
},
|
|
1630
|
-
"
|
|
1631
|
-
"
|
|
1632
|
-
"inheritedFrom": {
|
|
1633
|
-
"name": "FormAssociatedMixin",
|
|
1634
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1635
|
-
}
|
|
1568
|
+
"default": "isDateHighlighted",
|
|
1569
|
+
"description": "Controls which days are highlighted with a small indicator.\nReturning a \"falsy\" value will not show an indicator.\nReturning \"truthy\" value will show the indicator, but without an accessible label.\nReturning a string will show the indicator, and use the string as accessible label.\nIt is recommended to return a string rather than a truthy value whenever possible."
|
|
1636
1570
|
},
|
|
1637
1571
|
{
|
|
1638
1572
|
"kind": "field",
|
|
1639
|
-
"name": "
|
|
1573
|
+
"name": "activeFocus",
|
|
1640
1574
|
"type": {
|
|
1641
1575
|
"text": "boolean"
|
|
1642
1576
|
},
|
|
1643
|
-
"
|
|
1644
|
-
"
|
|
1645
|
-
"attribute": "required",
|
|
1646
|
-
"inheritedFrom": {
|
|
1647
|
-
"name": "FormAssociatedMixin",
|
|
1648
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1649
|
-
}
|
|
1577
|
+
"privacy": "private",
|
|
1578
|
+
"default": "false"
|
|
1650
1579
|
},
|
|
1651
1580
|
{
|
|
1652
1581
|
"kind": "field",
|
|
1653
|
-
"name": "
|
|
1654
|
-
"
|
|
1655
|
-
|
|
1656
|
-
},
|
|
1657
|
-
"default": "false",
|
|
1658
|
-
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
1659
|
-
"attribute": "hide-required",
|
|
1660
|
-
"inheritedFrom": {
|
|
1661
|
-
"name": "FormAssociatedMixin",
|
|
1662
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1663
|
-
}
|
|
1664
|
-
},
|
|
1665
|
-
{
|
|
1666
|
-
"kind": "method",
|
|
1667
|
-
"name": "handleInput",
|
|
1668
|
-
"privacy": "protected",
|
|
1669
|
-
"parameters": [
|
|
1670
|
-
{
|
|
1671
|
-
"name": "e",
|
|
1672
|
-
"type": {
|
|
1673
|
-
"text": "Event"
|
|
1674
|
-
}
|
|
1675
|
-
}
|
|
1676
|
-
],
|
|
1677
|
-
"inheritedFrom": {
|
|
1678
|
-
"name": "FormAssociatedMixin",
|
|
1679
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1680
|
-
}
|
|
1582
|
+
"name": "focusedDay",
|
|
1583
|
+
"privacy": "private",
|
|
1584
|
+
"default": "new Date()"
|
|
1681
1585
|
},
|
|
1682
1586
|
{
|
|
1683
1587
|
"kind": "method",
|
|
1684
|
-
"name": "
|
|
1685
|
-
"privacy": "protected",
|
|
1588
|
+
"name": "focus",
|
|
1686
1589
|
"parameters": [
|
|
1687
1590
|
{
|
|
1688
|
-
"name": "
|
|
1591
|
+
"name": "options",
|
|
1689
1592
|
"optional": true,
|
|
1690
1593
|
"type": {
|
|
1691
|
-
"text": "
|
|
1692
|
-
}
|
|
1594
|
+
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
1595
|
+
},
|
|
1596
|
+
"description": "An object which controls aspects of the focusing process."
|
|
1693
1597
|
}
|
|
1694
1598
|
],
|
|
1695
|
-
"
|
|
1696
|
-
"name": "FormAssociatedMixin",
|
|
1697
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1698
|
-
}
|
|
1599
|
+
"description": "Programmatically move focus to the calendar."
|
|
1699
1600
|
},
|
|
1700
1601
|
{
|
|
1701
1602
|
"kind": "method",
|
|
1702
|
-
"name": "
|
|
1703
|
-
"privacy": "protected"
|
|
1704
|
-
"inheritedFrom": {
|
|
1705
|
-
"name": "FormAssociatedMixin",
|
|
1706
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1707
|
-
}
|
|
1603
|
+
"name": "handleValueChange",
|
|
1604
|
+
"privacy": "protected"
|
|
1708
1605
|
},
|
|
1709
1606
|
{
|
|
1710
1607
|
"kind": "method",
|
|
1711
|
-
"name": "
|
|
1712
|
-
"privacy": "protected"
|
|
1713
|
-
"inheritedFrom": {
|
|
1714
|
-
"name": "FormAssociatedMixin",
|
|
1715
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1716
|
-
}
|
|
1608
|
+
"name": "handleFocusedDayChange",
|
|
1609
|
+
"privacy": "protected"
|
|
1717
1610
|
},
|
|
1718
1611
|
{
|
|
1719
1612
|
"kind": "method",
|
|
1720
|
-
"name": "
|
|
1721
|
-
"privacy": "
|
|
1722
|
-
"inheritedFrom": {
|
|
1723
|
-
"name": "FormAssociatedMixin",
|
|
1724
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1725
|
-
}
|
|
1613
|
+
"name": "handleLangChange",
|
|
1614
|
+
"privacy": "private"
|
|
1726
1615
|
},
|
|
1727
1616
|
{
|
|
1728
1617
|
"kind": "field",
|
|
1729
|
-
"name": "
|
|
1730
|
-
"privacy": "
|
|
1731
|
-
"inheritedFrom": {
|
|
1732
|
-
"name": "FormAssociatedMixin",
|
|
1733
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1734
|
-
}
|
|
1618
|
+
"name": "handleDaySelect",
|
|
1619
|
+
"privacy": "private"
|
|
1735
1620
|
},
|
|
1736
1621
|
{
|
|
1737
|
-
"kind": "
|
|
1738
|
-
"name": "
|
|
1739
|
-
"privacy": "
|
|
1740
|
-
"
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1622
|
+
"kind": "method",
|
|
1623
|
+
"name": "addDays",
|
|
1624
|
+
"privacy": "private",
|
|
1625
|
+
"parameters": [
|
|
1626
|
+
{
|
|
1627
|
+
"name": "days",
|
|
1628
|
+
"type": {
|
|
1629
|
+
"text": "number"
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
]
|
|
1744
1633
|
},
|
|
1745
1634
|
{
|
|
1746
|
-
"kind": "
|
|
1747
|
-
"name": "
|
|
1748
|
-
"
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1758
|
-
}
|
|
1635
|
+
"kind": "method",
|
|
1636
|
+
"name": "addMonths",
|
|
1637
|
+
"privacy": "private",
|
|
1638
|
+
"parameters": [
|
|
1639
|
+
{
|
|
1640
|
+
"name": "months",
|
|
1641
|
+
"type": {
|
|
1642
|
+
"text": "number"
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
]
|
|
1759
1646
|
},
|
|
1760
1647
|
{
|
|
1761
|
-
"kind": "
|
|
1762
|
-
"name": "
|
|
1763
|
-
"
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1648
|
+
"kind": "method",
|
|
1649
|
+
"name": "addYears",
|
|
1650
|
+
"privacy": "private",
|
|
1651
|
+
"parameters": [
|
|
1652
|
+
{
|
|
1653
|
+
"name": "years",
|
|
1654
|
+
"type": {
|
|
1655
|
+
"text": "number"
|
|
1656
|
+
}
|
|
1657
|
+
}
|
|
1658
|
+
]
|
|
1772
1659
|
},
|
|
1773
1660
|
{
|
|
1774
|
-
"kind": "
|
|
1775
|
-
"name": "
|
|
1776
|
-
"
|
|
1777
|
-
"text": "string"
|
|
1778
|
-
},
|
|
1779
|
-
"default": "\"\"",
|
|
1780
|
-
"description": "The value of the form component.",
|
|
1781
|
-
"attribute": "value",
|
|
1782
|
-
"inheritedFrom": {
|
|
1783
|
-
"name": "InputMixin",
|
|
1784
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1785
|
-
}
|
|
1661
|
+
"kind": "method",
|
|
1662
|
+
"name": "startOfWeek",
|
|
1663
|
+
"privacy": "private"
|
|
1786
1664
|
},
|
|
1787
1665
|
{
|
|
1788
|
-
"kind": "
|
|
1789
|
-
"name": "
|
|
1790
|
-
"
|
|
1791
|
-
"inheritedFrom": {
|
|
1792
|
-
"name": "InputMixin",
|
|
1793
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1794
|
-
}
|
|
1666
|
+
"kind": "method",
|
|
1667
|
+
"name": "endOfWeek",
|
|
1668
|
+
"privacy": "private"
|
|
1795
1669
|
},
|
|
1796
1670
|
{
|
|
1797
|
-
"kind": "
|
|
1798
|
-
"name": "
|
|
1799
|
-
"privacy": "
|
|
1800
|
-
"
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1671
|
+
"kind": "method",
|
|
1672
|
+
"name": "setMonth",
|
|
1673
|
+
"privacy": "private",
|
|
1674
|
+
"parameters": [
|
|
1675
|
+
{
|
|
1676
|
+
"name": "month",
|
|
1677
|
+
"type": {
|
|
1678
|
+
"text": "number"
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
]
|
|
1804
1682
|
},
|
|
1805
1683
|
{
|
|
1806
1684
|
"kind": "method",
|
|
1807
|
-
"name": "
|
|
1685
|
+
"name": "setYear",
|
|
1686
|
+
"privacy": "private",
|
|
1808
1687
|
"parameters": [
|
|
1809
1688
|
{
|
|
1810
|
-
"name": "
|
|
1811
|
-
"optional": true,
|
|
1689
|
+
"name": "year",
|
|
1812
1690
|
"type": {
|
|
1813
|
-
"text": "
|
|
1814
|
-
}
|
|
1815
|
-
"description": "An object which controls aspects of the focusing process."
|
|
1691
|
+
"text": "number"
|
|
1692
|
+
}
|
|
1816
1693
|
}
|
|
1817
|
-
]
|
|
1818
|
-
"description": "Programmatically move focus to the component.",
|
|
1819
|
-
"inheritedFrom": {
|
|
1820
|
-
"name": "FocusableMixin",
|
|
1821
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1822
|
-
}
|
|
1694
|
+
]
|
|
1823
1695
|
},
|
|
1824
1696
|
{
|
|
1825
1697
|
"kind": "method",
|
|
1826
|
-
"name": "
|
|
1827
|
-
"
|
|
1828
|
-
"
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1698
|
+
"name": "setFocusedDay",
|
|
1699
|
+
"privacy": "private",
|
|
1700
|
+
"parameters": [
|
|
1701
|
+
{
|
|
1702
|
+
"name": "day",
|
|
1703
|
+
"type": {
|
|
1704
|
+
"text": "Date"
|
|
1705
|
+
}
|
|
1706
|
+
}
|
|
1707
|
+
]
|
|
1832
1708
|
},
|
|
1833
1709
|
{
|
|
1834
|
-
"kind": "
|
|
1835
|
-
"name": "
|
|
1836
|
-
"
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1710
|
+
"kind": "field",
|
|
1711
|
+
"name": "handleMonthSelect",
|
|
1712
|
+
"privacy": "private"
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
"kind": "field",
|
|
1716
|
+
"name": "handleYearSelect",
|
|
1717
|
+
"privacy": "private"
|
|
1718
|
+
},
|
|
1719
|
+
{
|
|
1720
|
+
"kind": "field",
|
|
1721
|
+
"name": "handleNextMonthClick",
|
|
1722
|
+
"privacy": "private"
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
"kind": "field",
|
|
1726
|
+
"name": "handlePreviousMonthClick",
|
|
1727
|
+
"privacy": "private"
|
|
1728
|
+
},
|
|
1729
|
+
{
|
|
1730
|
+
"kind": "field",
|
|
1731
|
+
"name": "enableActiveFocus",
|
|
1732
|
+
"privacy": "private"
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"kind": "field",
|
|
1736
|
+
"name": "disableActiveFocus",
|
|
1737
|
+
"privacy": "private"
|
|
1841
1738
|
}
|
|
1842
1739
|
],
|
|
1843
|
-
"
|
|
1740
|
+
"events": [
|
|
1844
1741
|
{
|
|
1845
|
-
"name": "
|
|
1742
|
+
"name": "nord-focus-date",
|
|
1846
1743
|
"type": {
|
|
1847
|
-
"text": "
|
|
1744
|
+
"text": "DateSelectEvent"
|
|
1848
1745
|
},
|
|
1849
|
-
"
|
|
1850
|
-
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
1851
|
-
"fieldName": "indeterminate"
|
|
1746
|
+
"description": "Dispatched when the calendar's focused date changes."
|
|
1852
1747
|
},
|
|
1853
1748
|
{
|
|
1854
|
-
"name": "checked",
|
|
1855
1749
|
"type": {
|
|
1856
|
-
"text": "
|
|
1750
|
+
"text": "DateSelectEvent"
|
|
1857
1751
|
},
|
|
1858
|
-
"
|
|
1859
|
-
"
|
|
1860
|
-
|
|
1752
|
+
"description": "Dispatched when a date is selected and the value changes.",
|
|
1753
|
+
"name": "change"
|
|
1754
|
+
}
|
|
1755
|
+
],
|
|
1756
|
+
"attributes": [
|
|
1757
|
+
{
|
|
1758
|
+
"name": "value",
|
|
1759
|
+
"type": {
|
|
1760
|
+
"text": "string"
|
|
1761
|
+
},
|
|
1762
|
+
"default": "\"\"",
|
|
1763
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1764
|
+
"fieldName": "value"
|
|
1861
1765
|
},
|
|
1862
1766
|
{
|
|
1863
|
-
"name": "
|
|
1767
|
+
"name": "firstDayOfWeek",
|
|
1864
1768
|
"type": {
|
|
1865
|
-
"text": "
|
|
1769
|
+
"text": "DaysOfWeek"
|
|
1866
1770
|
},
|
|
1867
|
-
"
|
|
1868
|
-
"
|
|
1869
|
-
"fieldName": "size",
|
|
1870
|
-
"inheritedFrom": {
|
|
1871
|
-
"name": "SizeMixin",
|
|
1872
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
1873
|
-
}
|
|
1771
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1772
|
+
"fieldName": "firstDayOfWeek"
|
|
1874
1773
|
},
|
|
1875
1774
|
{
|
|
1876
|
-
"name": "
|
|
1775
|
+
"name": "min",
|
|
1877
1776
|
"type": {
|
|
1878
1777
|
"text": "string"
|
|
1879
1778
|
},
|
|
1880
1779
|
"default": "\"\"",
|
|
1881
|
-
"description": "
|
|
1882
|
-
"fieldName": "
|
|
1883
|
-
"inheritedFrom": {
|
|
1884
|
-
"name": "FormAssociatedMixin",
|
|
1885
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1886
|
-
}
|
|
1780
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property.",
|
|
1781
|
+
"fieldName": "min"
|
|
1887
1782
|
},
|
|
1888
1783
|
{
|
|
1889
|
-
"name": "
|
|
1784
|
+
"name": "max",
|
|
1890
1785
|
"type": {
|
|
1891
|
-
"text": "string
|
|
1786
|
+
"text": "string"
|
|
1892
1787
|
},
|
|
1893
|
-
"
|
|
1894
|
-
"
|
|
1895
|
-
"
|
|
1896
|
-
"name": "FormAssociatedMixin",
|
|
1897
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1898
|
-
}
|
|
1788
|
+
"default": "\"\"",
|
|
1789
|
+
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
1790
|
+
"fieldName": "max"
|
|
1899
1791
|
},
|
|
1900
1792
|
{
|
|
1901
|
-
"name": "
|
|
1793
|
+
"name": "expand",
|
|
1902
1794
|
"type": {
|
|
1903
1795
|
"text": "boolean"
|
|
1904
1796
|
},
|
|
1905
1797
|
"default": "false",
|
|
1906
|
-
"description": "
|
|
1907
|
-
"fieldName": "
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1798
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1799
|
+
"fieldName": "expand"
|
|
1800
|
+
}
|
|
1801
|
+
],
|
|
1802
|
+
"superclass": {
|
|
1803
|
+
"name": "LitElement",
|
|
1804
|
+
"package": "lit"
|
|
1805
|
+
},
|
|
1806
|
+
"localization": [
|
|
1807
|
+
{
|
|
1808
|
+
"name": "prevMonthLabel",
|
|
1809
|
+
"description": "Accessible label for the previous month button."
|
|
1912
1810
|
},
|
|
1913
1811
|
{
|
|
1914
|
-
"name": "
|
|
1915
|
-
"
|
|
1916
|
-
"text": "string | undefined"
|
|
1917
|
-
},
|
|
1918
|
-
"description": "Placeholder text to display within the input.",
|
|
1919
|
-
"fieldName": "placeholder",
|
|
1920
|
-
"inheritedFrom": {
|
|
1921
|
-
"name": "FormAssociatedMixin",
|
|
1922
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1923
|
-
}
|
|
1812
|
+
"name": "nextMonthLabel",
|
|
1813
|
+
"description": "Accessible label for the next month button."
|
|
1924
1814
|
},
|
|
1925
1815
|
{
|
|
1926
|
-
"name": "
|
|
1927
|
-
"
|
|
1928
|
-
"text": "string | undefined"
|
|
1929
|
-
},
|
|
1930
|
-
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
1931
|
-
"fieldName": "error",
|
|
1932
|
-
"inheritedFrom": {
|
|
1933
|
-
"name": "FormAssociatedMixin",
|
|
1934
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1935
|
-
}
|
|
1936
|
-
},
|
|
1937
|
-
{
|
|
1938
|
-
"name": "required",
|
|
1939
|
-
"type": {
|
|
1940
|
-
"text": "boolean"
|
|
1941
|
-
},
|
|
1942
|
-
"default": "false",
|
|
1943
|
-
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
1944
|
-
"fieldName": "required",
|
|
1945
|
-
"inheritedFrom": {
|
|
1946
|
-
"name": "FormAssociatedMixin",
|
|
1947
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1948
|
-
}
|
|
1949
|
-
},
|
|
1950
|
-
{
|
|
1951
|
-
"name": "hide-required",
|
|
1952
|
-
"type": {
|
|
1953
|
-
"text": "boolean"
|
|
1954
|
-
},
|
|
1955
|
-
"default": "false",
|
|
1956
|
-
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
1957
|
-
"fieldName": "hideRequired",
|
|
1958
|
-
"inheritedFrom": {
|
|
1959
|
-
"name": "FormAssociatedMixin",
|
|
1960
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1961
|
-
}
|
|
1962
|
-
},
|
|
1963
|
-
{
|
|
1964
|
-
"name": "disabled",
|
|
1965
|
-
"type": {
|
|
1966
|
-
"text": "boolean"
|
|
1967
|
-
},
|
|
1968
|
-
"default": "false",
|
|
1969
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
1970
|
-
"fieldName": "disabled",
|
|
1971
|
-
"inheritedFrom": {
|
|
1972
|
-
"name": "InputMixin",
|
|
1973
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1974
|
-
}
|
|
1975
|
-
},
|
|
1976
|
-
{
|
|
1977
|
-
"name": "name",
|
|
1978
|
-
"type": {
|
|
1979
|
-
"text": "string | undefined"
|
|
1980
|
-
},
|
|
1981
|
-
"description": "The name of the form component.",
|
|
1982
|
-
"fieldName": "name",
|
|
1983
|
-
"inheritedFrom": {
|
|
1984
|
-
"name": "InputMixin",
|
|
1985
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1986
|
-
}
|
|
1987
|
-
},
|
|
1988
|
-
{
|
|
1989
|
-
"name": "value",
|
|
1990
|
-
"type": {
|
|
1991
|
-
"text": "string"
|
|
1992
|
-
},
|
|
1993
|
-
"default": "\"\"",
|
|
1994
|
-
"description": "The value of the form component.",
|
|
1995
|
-
"fieldName": "value",
|
|
1996
|
-
"inheritedFrom": {
|
|
1997
|
-
"name": "InputMixin",
|
|
1998
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1999
|
-
}
|
|
2000
|
-
}
|
|
2001
|
-
],
|
|
2002
|
-
"mixins": [
|
|
2003
|
-
{
|
|
2004
|
-
"name": "SizeMixin",
|
|
2005
|
-
"module": "/src/common/mixins/SizeMixin.js"
|
|
2006
|
-
},
|
|
2007
|
-
{
|
|
2008
|
-
"name": "FormAssociatedMixin",
|
|
2009
|
-
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
2010
|
-
},
|
|
2011
|
-
{
|
|
2012
|
-
"name": "InputMixin",
|
|
2013
|
-
"module": "/src/common/mixins/InputMixin.js"
|
|
1816
|
+
"name": "monthSelectLabel",
|
|
1817
|
+
"description": "Accessible label for the month select."
|
|
2014
1818
|
},
|
|
2015
1819
|
{
|
|
2016
|
-
"name": "
|
|
2017
|
-
"
|
|
1820
|
+
"name": "yearSelectLabel",
|
|
1821
|
+
"description": "Accessible label for the year select."
|
|
2018
1822
|
}
|
|
2019
1823
|
],
|
|
2020
|
-
"superclass": {
|
|
2021
|
-
"name": "LitElement",
|
|
2022
|
-
"package": "lit"
|
|
2023
|
-
},
|
|
2024
|
-
"localization": [],
|
|
2025
1824
|
"status": "ready",
|
|
2026
|
-
"category": "
|
|
2027
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use
|
|
1825
|
+
"category": "list",
|
|
1826
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n",
|
|
2028
1827
|
"examples": [],
|
|
2029
|
-
"tagName": "nord-
|
|
2030
|
-
"customElement": true
|
|
2031
|
-
"events": [
|
|
2032
|
-
{
|
|
2033
|
-
"name": "input",
|
|
2034
|
-
"type": {
|
|
2035
|
-
"text": "NordEvent"
|
|
2036
|
-
},
|
|
2037
|
-
"description": "Fired as the user types into the input.",
|
|
2038
|
-
"inheritedFrom": {
|
|
2039
|
-
"name": "FormAssociatedMixin",
|
|
2040
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2041
|
-
}
|
|
2042
|
-
},
|
|
2043
|
-
{
|
|
2044
|
-
"name": "change",
|
|
2045
|
-
"type": {
|
|
2046
|
-
"text": "NordEvent"
|
|
2047
|
-
},
|
|
2048
|
-
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
2049
|
-
"inheritedFrom": {
|
|
2050
|
-
"name": "FormAssociatedMixin",
|
|
2051
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2052
|
-
}
|
|
2053
|
-
}
|
|
2054
|
-
]
|
|
1828
|
+
"tagName": "nord-calendar",
|
|
1829
|
+
"customElement": true
|
|
2055
1830
|
}
|
|
2056
1831
|
],
|
|
2057
1832
|
"exports": [
|
|
@@ -2059,16 +1834,65 @@
|
|
|
2059
1834
|
"kind": "js",
|
|
2060
1835
|
"name": "default",
|
|
2061
1836
|
"declaration": {
|
|
2062
|
-
"name": "
|
|
2063
|
-
"module": "src/
|
|
1837
|
+
"name": "Calendar",
|
|
1838
|
+
"module": "src/calendar/Calendar.ts"
|
|
2064
1839
|
}
|
|
2065
1840
|
},
|
|
2066
1841
|
{
|
|
2067
1842
|
"kind": "custom-element-definition",
|
|
2068
|
-
"name": "nord-
|
|
1843
|
+
"name": "nord-calendar",
|
|
2069
1844
|
"declaration": {
|
|
2070
|
-
"name": "
|
|
2071
|
-
"module": "src/
|
|
1845
|
+
"name": "Calendar",
|
|
1846
|
+
"module": "src/calendar/Calendar.ts"
|
|
1847
|
+
}
|
|
1848
|
+
}
|
|
1849
|
+
]
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
"kind": "javascript-module",
|
|
1853
|
+
"path": "src/calendar/DateSelectEvent.ts",
|
|
1854
|
+
"declarations": [
|
|
1855
|
+
{
|
|
1856
|
+
"kind": "class",
|
|
1857
|
+
"description": "",
|
|
1858
|
+
"name": "DateSelectEvent",
|
|
1859
|
+
"superclass": {
|
|
1860
|
+
"name": "NordEvent",
|
|
1861
|
+
"module": "/src/common/events.js"
|
|
1862
|
+
}
|
|
1863
|
+
}
|
|
1864
|
+
],
|
|
1865
|
+
"exports": [
|
|
1866
|
+
{
|
|
1867
|
+
"kind": "js",
|
|
1868
|
+
"name": "DateSelectEvent",
|
|
1869
|
+
"declaration": {
|
|
1870
|
+
"name": "DateSelectEvent",
|
|
1871
|
+
"module": "src/calendar/DateSelectEvent.ts"
|
|
1872
|
+
}
|
|
1873
|
+
}
|
|
1874
|
+
]
|
|
1875
|
+
},
|
|
1876
|
+
{
|
|
1877
|
+
"kind": "javascript-module",
|
|
1878
|
+
"path": "src/calendar/localization.ts",
|
|
1879
|
+
"declarations": [
|
|
1880
|
+
{
|
|
1881
|
+
"kind": "variable",
|
|
1882
|
+
"name": "calendarLocalization",
|
|
1883
|
+
"type": {
|
|
1884
|
+
"text": "object"
|
|
1885
|
+
},
|
|
1886
|
+
"default": "{\n prevMonthLabel: \"Previous month\",\n nextMonthLabel: \"Next month\",\n monthSelectLabel: \"Month\",\n yearSelectLabel: \"Year\",\n}"
|
|
1887
|
+
}
|
|
1888
|
+
],
|
|
1889
|
+
"exports": [
|
|
1890
|
+
{
|
|
1891
|
+
"kind": "js",
|
|
1892
|
+
"name": "default",
|
|
1893
|
+
"declaration": {
|
|
1894
|
+
"name": "calendarLocalization",
|
|
1895
|
+
"module": "src/calendar/localization.ts"
|
|
2072
1896
|
}
|
|
2073
1897
|
}
|
|
2074
1898
|
]
|
|
@@ -2197,432 +2021,657 @@
|
|
|
2197
2021
|
},
|
|
2198
2022
|
{
|
|
2199
2023
|
"kind": "javascript-module",
|
|
2200
|
-
"path": "src/
|
|
2024
|
+
"path": "src/checkbox/Checkbox.ts",
|
|
2201
2025
|
"declarations": [
|
|
2202
2026
|
{
|
|
2203
2027
|
"kind": "class",
|
|
2204
|
-
"description": "
|
|
2205
|
-
"name": "
|
|
2206
|
-
"
|
|
2028
|
+
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
2029
|
+
"name": "Checkbox",
|
|
2030
|
+
"slots": [
|
|
2207
2031
|
{
|
|
2208
|
-
"description": "
|
|
2209
|
-
"name": "
|
|
2210
|
-
"default": "var(--n-border-radius)"
|
|
2032
|
+
"description": "Use when a label requires more than plain text.",
|
|
2033
|
+
"name": "label"
|
|
2211
2034
|
},
|
|
2212
2035
|
{
|
|
2213
|
-
"description": "
|
|
2214
|
-
"name": "
|
|
2215
|
-
|
|
2036
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
2037
|
+
"name": "hint"
|
|
2038
|
+
},
|
|
2039
|
+
{
|
|
2040
|
+
"description": "Optional slot that holds error text for the input.",
|
|
2041
|
+
"name": "error"
|
|
2216
2042
|
}
|
|
2217
2043
|
],
|
|
2218
2044
|
"members": [
|
|
2219
2045
|
{
|
|
2220
2046
|
"kind": "field",
|
|
2221
|
-
"name": "
|
|
2222
|
-
"
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2047
|
+
"name": "formValue",
|
|
2048
|
+
"privacy": "protected",
|
|
2049
|
+
"inheritedFrom": {
|
|
2050
|
+
"name": "FormAssociatedMixin",
|
|
2051
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2052
|
+
}
|
|
2226
2053
|
},
|
|
2227
2054
|
{
|
|
2228
2055
|
"kind": "field",
|
|
2229
|
-
"name": "
|
|
2056
|
+
"name": "indeterminate",
|
|
2230
2057
|
"type": {
|
|
2231
|
-
"text": "
|
|
2058
|
+
"text": "boolean"
|
|
2232
2059
|
},
|
|
2233
|
-
"
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
"kind": "field",
|
|
2237
|
-
"name": "direction",
|
|
2238
|
-
"privacy": "private",
|
|
2239
|
-
"default": "new DirectionController(this)"
|
|
2240
|
-
},
|
|
2241
|
-
{
|
|
2242
|
-
"kind": "field",
|
|
2243
|
-
"name": "swipe",
|
|
2244
|
-
"privacy": "private",
|
|
2245
|
-
"default": "new SwipeController(this, {\n matchesGesture: isHorizontalSwipe,\n onSwipeEnd: ({ distX }) => this.addMonths(distX < 0 ? 1 : -1),\n })"
|
|
2246
|
-
},
|
|
2247
|
-
{
|
|
2248
|
-
"kind": "field",
|
|
2249
|
-
"name": "shortcuts",
|
|
2250
|
-
"privacy": "private"
|
|
2251
|
-
},
|
|
2252
|
-
{
|
|
2253
|
-
"kind": "field",
|
|
2254
|
-
"name": "localize",
|
|
2255
|
-
"privacy": "private",
|
|
2256
|
-
"default": "new LocalizeController<\"nord-calendar\">(this, {\n onLangChange: () => this.handleLangChange(),\n })"
|
|
2060
|
+
"default": "false",
|
|
2061
|
+
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2062
|
+
"attribute": "indeterminate"
|
|
2257
2063
|
},
|
|
2258
2064
|
{
|
|
2259
2065
|
"kind": "field",
|
|
2260
|
-
"name": "
|
|
2066
|
+
"name": "checked",
|
|
2261
2067
|
"type": {
|
|
2262
|
-
"text": "
|
|
2068
|
+
"text": "boolean"
|
|
2263
2069
|
},
|
|
2264
|
-
"
|
|
2265
|
-
"description": "
|
|
2070
|
+
"default": "false",
|
|
2071
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
2072
|
+
"attribute": "checked"
|
|
2266
2073
|
},
|
|
2267
2074
|
{
|
|
2268
|
-
"kind": "
|
|
2269
|
-
"name": "
|
|
2270
|
-
"
|
|
2271
|
-
|
|
2075
|
+
"kind": "method",
|
|
2076
|
+
"name": "handleChange",
|
|
2077
|
+
"privacy": "protected",
|
|
2078
|
+
"parameters": [
|
|
2079
|
+
{
|
|
2080
|
+
"name": "e",
|
|
2081
|
+
"type": {
|
|
2082
|
+
"text": "Event"
|
|
2083
|
+
}
|
|
2084
|
+
}
|
|
2085
|
+
],
|
|
2086
|
+
"return": {
|
|
2087
|
+
"type": {
|
|
2088
|
+
"text": "void"
|
|
2089
|
+
}
|
|
2272
2090
|
},
|
|
2273
|
-
"
|
|
2091
|
+
"inheritedFrom": {
|
|
2092
|
+
"name": "FormAssociatedMixin",
|
|
2093
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2094
|
+
}
|
|
2274
2095
|
},
|
|
2275
2096
|
{
|
|
2276
2097
|
"kind": "field",
|
|
2277
|
-
"name": "
|
|
2098
|
+
"name": "size",
|
|
2278
2099
|
"type": {
|
|
2279
|
-
"text": "
|
|
2100
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
2280
2101
|
},
|
|
2281
|
-
"
|
|
2102
|
+
"default": "\"m\"",
|
|
2103
|
+
"description": "The size of the component.",
|
|
2104
|
+
"attribute": "size",
|
|
2105
|
+
"reflects": true,
|
|
2106
|
+
"inheritedFrom": {
|
|
2107
|
+
"name": "SizeMixin",
|
|
2108
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
2109
|
+
}
|
|
2282
2110
|
},
|
|
2283
2111
|
{
|
|
2284
2112
|
"kind": "field",
|
|
2285
|
-
"name": "
|
|
2286
|
-
"
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
|
|
2113
|
+
"name": "labelSlot",
|
|
2114
|
+
"privacy": "protected",
|
|
2115
|
+
"default": "new SlotController(this, \"label\")",
|
|
2116
|
+
"inheritedFrom": {
|
|
2117
|
+
"name": "FormAssociatedMixin",
|
|
2118
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2119
|
+
}
|
|
2290
2120
|
},
|
|
2291
2121
|
{
|
|
2292
2122
|
"kind": "field",
|
|
2293
|
-
"name": "
|
|
2123
|
+
"name": "errorSlot",
|
|
2124
|
+
"privacy": "protected",
|
|
2125
|
+
"default": "new SlotController(this, \"error\")",
|
|
2126
|
+
"inheritedFrom": {
|
|
2127
|
+
"name": "FormAssociatedMixin",
|
|
2128
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2129
|
+
}
|
|
2130
|
+
},
|
|
2131
|
+
{
|
|
2132
|
+
"kind": "field",
|
|
2133
|
+
"name": "hintSlot",
|
|
2134
|
+
"privacy": "protected",
|
|
2135
|
+
"default": "new SlotController(this, \"hint\")",
|
|
2136
|
+
"inheritedFrom": {
|
|
2137
|
+
"name": "FormAssociatedMixin",
|
|
2138
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2139
|
+
}
|
|
2140
|
+
},
|
|
2141
|
+
{
|
|
2142
|
+
"kind": "field",
|
|
2143
|
+
"name": "formData",
|
|
2144
|
+
"privacy": "protected",
|
|
2145
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
2146
|
+
"inheritedFrom": {
|
|
2147
|
+
"name": "FormAssociatedMixin",
|
|
2148
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2149
|
+
}
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
"kind": "field",
|
|
2153
|
+
"name": "inputId",
|
|
2294
2154
|
"type": {
|
|
2295
|
-
"text": "string
|
|
2155
|
+
"text": "string"
|
|
2296
2156
|
},
|
|
2297
|
-
"privacy": "
|
|
2157
|
+
"privacy": "protected",
|
|
2158
|
+
"default": "\"input\"",
|
|
2159
|
+
"inheritedFrom": {
|
|
2160
|
+
"name": "FormAssociatedMixin",
|
|
2161
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2162
|
+
}
|
|
2298
2163
|
},
|
|
2299
2164
|
{
|
|
2300
2165
|
"kind": "field",
|
|
2301
|
-
"name": "
|
|
2166
|
+
"name": "errorId",
|
|
2302
2167
|
"type": {
|
|
2303
2168
|
"text": "string"
|
|
2304
2169
|
},
|
|
2305
|
-
"
|
|
2306
|
-
"
|
|
2307
|
-
"
|
|
2170
|
+
"privacy": "protected",
|
|
2171
|
+
"default": "\"error\"",
|
|
2172
|
+
"inheritedFrom": {
|
|
2173
|
+
"name": "FormAssociatedMixin",
|
|
2174
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2175
|
+
}
|
|
2308
2176
|
},
|
|
2309
2177
|
{
|
|
2310
2178
|
"kind": "field",
|
|
2311
|
-
"name": "
|
|
2179
|
+
"name": "hintId",
|
|
2312
2180
|
"type": {
|
|
2313
|
-
"text": "
|
|
2181
|
+
"text": "string"
|
|
2314
2182
|
},
|
|
2315
|
-
"
|
|
2316
|
-
"
|
|
2183
|
+
"privacy": "protected",
|
|
2184
|
+
"default": "\"hint\"",
|
|
2185
|
+
"inheritedFrom": {
|
|
2186
|
+
"name": "FormAssociatedMixin",
|
|
2187
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2188
|
+
}
|
|
2317
2189
|
},
|
|
2318
2190
|
{
|
|
2319
2191
|
"kind": "field",
|
|
2320
|
-
"name": "
|
|
2192
|
+
"name": "label",
|
|
2321
2193
|
"type": {
|
|
2322
2194
|
"text": "string"
|
|
2323
2195
|
},
|
|
2324
2196
|
"default": "\"\"",
|
|
2325
|
-
"description": "
|
|
2326
|
-
"attribute": "
|
|
2197
|
+
"description": "Label for the input.",
|
|
2198
|
+
"attribute": "label",
|
|
2199
|
+
"inheritedFrom": {
|
|
2200
|
+
"name": "FormAssociatedMixin",
|
|
2201
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2202
|
+
}
|
|
2327
2203
|
},
|
|
2328
2204
|
{
|
|
2329
2205
|
"kind": "field",
|
|
2330
|
-
"name": "
|
|
2206
|
+
"name": "hint",
|
|
2331
2207
|
"type": {
|
|
2332
|
-
"text": "string"
|
|
2208
|
+
"text": "string | undefined"
|
|
2333
2209
|
},
|
|
2334
|
-
"
|
|
2335
|
-
"
|
|
2336
|
-
"
|
|
2210
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
2211
|
+
"attribute": "hint",
|
|
2212
|
+
"inheritedFrom": {
|
|
2213
|
+
"name": "FormAssociatedMixin",
|
|
2214
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2215
|
+
}
|
|
2337
2216
|
},
|
|
2338
2217
|
{
|
|
2339
2218
|
"kind": "field",
|
|
2340
|
-
"name": "
|
|
2219
|
+
"name": "hideLabel",
|
|
2341
2220
|
"type": {
|
|
2342
2221
|
"text": "boolean"
|
|
2343
2222
|
},
|
|
2344
2223
|
"default": "false",
|
|
2345
|
-
"description": "
|
|
2346
|
-
"attribute": "
|
|
2347
|
-
"
|
|
2224
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
2225
|
+
"attribute": "hide-label",
|
|
2226
|
+
"inheritedFrom": {
|
|
2227
|
+
"name": "FormAssociatedMixin",
|
|
2228
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2229
|
+
}
|
|
2348
2230
|
},
|
|
2349
2231
|
{
|
|
2350
2232
|
"kind": "field",
|
|
2351
|
-
"name": "
|
|
2233
|
+
"name": "placeholder",
|
|
2352
2234
|
"type": {
|
|
2353
|
-
"text": "
|
|
2235
|
+
"text": "string | undefined"
|
|
2354
2236
|
},
|
|
2355
|
-
"
|
|
2356
|
-
"
|
|
2237
|
+
"description": "Placeholder text to display within the input.",
|
|
2238
|
+
"attribute": "placeholder",
|
|
2239
|
+
"inheritedFrom": {
|
|
2240
|
+
"name": "FormAssociatedMixin",
|
|
2241
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2242
|
+
}
|
|
2357
2243
|
},
|
|
2358
2244
|
{
|
|
2359
2245
|
"kind": "field",
|
|
2360
|
-
"name": "
|
|
2246
|
+
"name": "error",
|
|
2361
2247
|
"type": {
|
|
2362
|
-
"text": "
|
|
2248
|
+
"text": "string | undefined"
|
|
2363
2249
|
},
|
|
2364
|
-
"
|
|
2365
|
-
"
|
|
2250
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
2251
|
+
"attribute": "error",
|
|
2252
|
+
"inheritedFrom": {
|
|
2253
|
+
"name": "FormAssociatedMixin",
|
|
2254
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2255
|
+
}
|
|
2366
2256
|
},
|
|
2367
2257
|
{
|
|
2368
2258
|
"kind": "field",
|
|
2369
|
-
"name": "
|
|
2259
|
+
"name": "required",
|
|
2370
2260
|
"type": {
|
|
2371
2261
|
"text": "boolean"
|
|
2372
2262
|
},
|
|
2373
|
-
"
|
|
2374
|
-
"
|
|
2263
|
+
"default": "false",
|
|
2264
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
2265
|
+
"attribute": "required",
|
|
2266
|
+
"inheritedFrom": {
|
|
2267
|
+
"name": "FormAssociatedMixin",
|
|
2268
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2269
|
+
}
|
|
2375
2270
|
},
|
|
2376
2271
|
{
|
|
2377
2272
|
"kind": "field",
|
|
2378
|
-
"name": "
|
|
2379
|
-
"
|
|
2380
|
-
|
|
2273
|
+
"name": "hideRequired",
|
|
2274
|
+
"type": {
|
|
2275
|
+
"text": "boolean"
|
|
2276
|
+
},
|
|
2277
|
+
"default": "false",
|
|
2278
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
2279
|
+
"attribute": "hide-required",
|
|
2280
|
+
"inheritedFrom": {
|
|
2281
|
+
"name": "FormAssociatedMixin",
|
|
2282
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2283
|
+
}
|
|
2381
2284
|
},
|
|
2382
2285
|
{
|
|
2383
2286
|
"kind": "method",
|
|
2384
|
-
"name": "
|
|
2287
|
+
"name": "handleInput",
|
|
2288
|
+
"privacy": "protected",
|
|
2385
2289
|
"parameters": [
|
|
2386
2290
|
{
|
|
2387
|
-
"name": "
|
|
2388
|
-
"optional": true,
|
|
2291
|
+
"name": "e",
|
|
2389
2292
|
"type": {
|
|
2390
|
-
"text": "
|
|
2391
|
-
}
|
|
2392
|
-
"description": "An object which controls aspects of the focusing process."
|
|
2293
|
+
"text": "Event"
|
|
2294
|
+
}
|
|
2393
2295
|
}
|
|
2394
2296
|
],
|
|
2395
|
-
"
|
|
2297
|
+
"inheritedFrom": {
|
|
2298
|
+
"name": "FormAssociatedMixin",
|
|
2299
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2300
|
+
}
|
|
2396
2301
|
},
|
|
2397
2302
|
{
|
|
2398
2303
|
"kind": "method",
|
|
2399
|
-
"name": "
|
|
2400
|
-
"privacy": "protected"
|
|
2304
|
+
"name": "renderLabel",
|
|
2305
|
+
"privacy": "protected",
|
|
2306
|
+
"parameters": [
|
|
2307
|
+
{
|
|
2308
|
+
"name": "additionalContent",
|
|
2309
|
+
"optional": true,
|
|
2310
|
+
"type": {
|
|
2311
|
+
"text": "TemplateResult"
|
|
2312
|
+
}
|
|
2313
|
+
}
|
|
2314
|
+
],
|
|
2315
|
+
"inheritedFrom": {
|
|
2316
|
+
"name": "FormAssociatedMixin",
|
|
2317
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2318
|
+
}
|
|
2401
2319
|
},
|
|
2402
2320
|
{
|
|
2403
2321
|
"kind": "method",
|
|
2404
|
-
"name": "
|
|
2405
|
-
"privacy": "protected"
|
|
2322
|
+
"name": "renderError",
|
|
2323
|
+
"privacy": "protected",
|
|
2324
|
+
"inheritedFrom": {
|
|
2325
|
+
"name": "FormAssociatedMixin",
|
|
2326
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2327
|
+
}
|
|
2406
2328
|
},
|
|
2407
2329
|
{
|
|
2408
2330
|
"kind": "method",
|
|
2409
|
-
"name": "
|
|
2410
|
-
"privacy": "
|
|
2331
|
+
"name": "getDescribedBy",
|
|
2332
|
+
"privacy": "protected",
|
|
2333
|
+
"inheritedFrom": {
|
|
2334
|
+
"name": "FormAssociatedMixin",
|
|
2335
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2336
|
+
}
|
|
2411
2337
|
},
|
|
2412
2338
|
{
|
|
2413
|
-
"kind": "
|
|
2414
|
-
"name": "
|
|
2415
|
-
"privacy": "
|
|
2339
|
+
"kind": "method",
|
|
2340
|
+
"name": "getInvalid",
|
|
2341
|
+
"privacy": "protected",
|
|
2342
|
+
"inheritedFrom": {
|
|
2343
|
+
"name": "FormAssociatedMixin",
|
|
2344
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2345
|
+
}
|
|
2416
2346
|
},
|
|
2417
2347
|
{
|
|
2418
|
-
"kind": "
|
|
2419
|
-
"name": "
|
|
2420
|
-
"privacy": "
|
|
2421
|
-
"
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
"text": "number"
|
|
2426
|
-
}
|
|
2427
|
-
}
|
|
2428
|
-
]
|
|
2348
|
+
"kind": "field",
|
|
2349
|
+
"name": "hasHint",
|
|
2350
|
+
"privacy": "protected",
|
|
2351
|
+
"inheritedFrom": {
|
|
2352
|
+
"name": "FormAssociatedMixin",
|
|
2353
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2354
|
+
}
|
|
2429
2355
|
},
|
|
2430
2356
|
{
|
|
2431
|
-
"kind": "
|
|
2432
|
-
"name": "
|
|
2433
|
-
"privacy": "
|
|
2434
|
-
"
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
"text": "number"
|
|
2439
|
-
}
|
|
2440
|
-
}
|
|
2441
|
-
]
|
|
2357
|
+
"kind": "field",
|
|
2358
|
+
"name": "hasError",
|
|
2359
|
+
"privacy": "protected",
|
|
2360
|
+
"inheritedFrom": {
|
|
2361
|
+
"name": "FormAssociatedMixin",
|
|
2362
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2363
|
+
}
|
|
2442
2364
|
},
|
|
2443
2365
|
{
|
|
2444
|
-
"kind": "
|
|
2445
|
-
"name": "
|
|
2446
|
-
"
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2366
|
+
"kind": "field",
|
|
2367
|
+
"name": "disabled",
|
|
2368
|
+
"type": {
|
|
2369
|
+
"text": "boolean"
|
|
2370
|
+
},
|
|
2371
|
+
"default": "false",
|
|
2372
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
2373
|
+
"attribute": "disabled",
|
|
2374
|
+
"reflects": true,
|
|
2375
|
+
"inheritedFrom": {
|
|
2376
|
+
"name": "InputMixin",
|
|
2377
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2378
|
+
}
|
|
2455
2379
|
},
|
|
2456
2380
|
{
|
|
2457
|
-
"kind": "
|
|
2458
|
-
"name": "
|
|
2459
|
-
"
|
|
2381
|
+
"kind": "field",
|
|
2382
|
+
"name": "name",
|
|
2383
|
+
"type": {
|
|
2384
|
+
"text": "string | undefined"
|
|
2385
|
+
},
|
|
2386
|
+
"description": "The name of the form component.",
|
|
2387
|
+
"attribute": "name",
|
|
2388
|
+
"inheritedFrom": {
|
|
2389
|
+
"name": "InputMixin",
|
|
2390
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2391
|
+
}
|
|
2460
2392
|
},
|
|
2461
2393
|
{
|
|
2462
|
-
"kind": "
|
|
2463
|
-
"name": "
|
|
2464
|
-
"
|
|
2394
|
+
"kind": "field",
|
|
2395
|
+
"name": "value",
|
|
2396
|
+
"type": {
|
|
2397
|
+
"text": "string"
|
|
2398
|
+
},
|
|
2399
|
+
"default": "\"\"",
|
|
2400
|
+
"description": "The value of the form component.",
|
|
2401
|
+
"attribute": "value",
|
|
2402
|
+
"inheritedFrom": {
|
|
2403
|
+
"name": "InputMixin",
|
|
2404
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2405
|
+
}
|
|
2406
|
+
},
|
|
2407
|
+
{
|
|
2408
|
+
"kind": "field",
|
|
2409
|
+
"name": "form",
|
|
2410
|
+
"description": "Gets the form, if any, associated with the form element.",
|
|
2411
|
+
"inheritedFrom": {
|
|
2412
|
+
"name": "InputMixin",
|
|
2413
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2414
|
+
}
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"kind": "field",
|
|
2418
|
+
"name": "focusableRef",
|
|
2419
|
+
"privacy": "protected",
|
|
2420
|
+
"inheritedFrom": {
|
|
2421
|
+
"name": "FocusableMixin",
|
|
2422
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2423
|
+
}
|
|
2465
2424
|
},
|
|
2466
2425
|
{
|
|
2467
2426
|
"kind": "method",
|
|
2468
|
-
"name": "
|
|
2469
|
-
"privacy": "private",
|
|
2427
|
+
"name": "focus",
|
|
2470
2428
|
"parameters": [
|
|
2471
2429
|
{
|
|
2472
|
-
"name": "
|
|
2430
|
+
"name": "options",
|
|
2431
|
+
"optional": true,
|
|
2473
2432
|
"type": {
|
|
2474
|
-
"text": "
|
|
2475
|
-
}
|
|
2433
|
+
"text": "FocusOptions"
|
|
2434
|
+
},
|
|
2435
|
+
"description": "An object which controls aspects of the focusing process."
|
|
2476
2436
|
}
|
|
2477
|
-
]
|
|
2437
|
+
],
|
|
2438
|
+
"description": "Programmatically move focus to the component.",
|
|
2439
|
+
"inheritedFrom": {
|
|
2440
|
+
"name": "FocusableMixin",
|
|
2441
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2442
|
+
}
|
|
2478
2443
|
},
|
|
2479
2444
|
{
|
|
2480
2445
|
"kind": "method",
|
|
2481
|
-
"name": "
|
|
2482
|
-
"
|
|
2483
|
-
"
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
"text": "number"
|
|
2488
|
-
}
|
|
2489
|
-
}
|
|
2490
|
-
]
|
|
2446
|
+
"name": "blur",
|
|
2447
|
+
"description": "Programmatically remove focus from the component.",
|
|
2448
|
+
"inheritedFrom": {
|
|
2449
|
+
"name": "FocusableMixin",
|
|
2450
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2451
|
+
}
|
|
2491
2452
|
},
|
|
2492
2453
|
{
|
|
2493
2454
|
"kind": "method",
|
|
2494
|
-
"name": "
|
|
2495
|
-
"
|
|
2496
|
-
"
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2455
|
+
"name": "click",
|
|
2456
|
+
"description": "Programmatically simulates a click on the component.",
|
|
2457
|
+
"inheritedFrom": {
|
|
2458
|
+
"name": "FocusableMixin",
|
|
2459
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2460
|
+
}
|
|
2461
|
+
}
|
|
2462
|
+
],
|
|
2463
|
+
"attributes": [
|
|
2464
|
+
{
|
|
2465
|
+
"name": "indeterminate",
|
|
2466
|
+
"type": {
|
|
2467
|
+
"text": "boolean"
|
|
2468
|
+
},
|
|
2469
|
+
"default": "false",
|
|
2470
|
+
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2471
|
+
"fieldName": "indeterminate"
|
|
2504
2472
|
},
|
|
2505
2473
|
{
|
|
2506
|
-
"
|
|
2507
|
-
"
|
|
2508
|
-
|
|
2474
|
+
"name": "checked",
|
|
2475
|
+
"type": {
|
|
2476
|
+
"text": "boolean"
|
|
2477
|
+
},
|
|
2478
|
+
"default": "false",
|
|
2479
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
2480
|
+
"fieldName": "checked"
|
|
2509
2481
|
},
|
|
2510
2482
|
{
|
|
2511
|
-
"
|
|
2512
|
-
"
|
|
2513
|
-
|
|
2483
|
+
"name": "size",
|
|
2484
|
+
"type": {
|
|
2485
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
2486
|
+
},
|
|
2487
|
+
"default": "\"m\"",
|
|
2488
|
+
"description": "The size of the component.",
|
|
2489
|
+
"fieldName": "size",
|
|
2490
|
+
"inheritedFrom": {
|
|
2491
|
+
"name": "SizeMixin",
|
|
2492
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
2493
|
+
}
|
|
2514
2494
|
},
|
|
2515
2495
|
{
|
|
2516
|
-
"
|
|
2517
|
-
"
|
|
2518
|
-
|
|
2496
|
+
"name": "label",
|
|
2497
|
+
"type": {
|
|
2498
|
+
"text": "string"
|
|
2499
|
+
},
|
|
2500
|
+
"default": "\"\"",
|
|
2501
|
+
"description": "Label for the input.",
|
|
2502
|
+
"fieldName": "label",
|
|
2503
|
+
"inheritedFrom": {
|
|
2504
|
+
"name": "FormAssociatedMixin",
|
|
2505
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2506
|
+
}
|
|
2519
2507
|
},
|
|
2520
2508
|
{
|
|
2521
|
-
"
|
|
2522
|
-
"
|
|
2523
|
-
|
|
2509
|
+
"name": "hint",
|
|
2510
|
+
"type": {
|
|
2511
|
+
"text": "string | undefined"
|
|
2512
|
+
},
|
|
2513
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
2514
|
+
"fieldName": "hint",
|
|
2515
|
+
"inheritedFrom": {
|
|
2516
|
+
"name": "FormAssociatedMixin",
|
|
2517
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2518
|
+
}
|
|
2524
2519
|
},
|
|
2525
2520
|
{
|
|
2526
|
-
"
|
|
2527
|
-
"
|
|
2528
|
-
|
|
2521
|
+
"name": "hide-label",
|
|
2522
|
+
"type": {
|
|
2523
|
+
"text": "boolean"
|
|
2524
|
+
},
|
|
2525
|
+
"default": "false",
|
|
2526
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
2527
|
+
"fieldName": "hideLabel",
|
|
2528
|
+
"inheritedFrom": {
|
|
2529
|
+
"name": "FormAssociatedMixin",
|
|
2530
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2531
|
+
}
|
|
2529
2532
|
},
|
|
2530
2533
|
{
|
|
2531
|
-
"
|
|
2532
|
-
"
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2534
|
+
"name": "placeholder",
|
|
2535
|
+
"type": {
|
|
2536
|
+
"text": "string | undefined"
|
|
2537
|
+
},
|
|
2538
|
+
"description": "Placeholder text to display within the input.",
|
|
2539
|
+
"fieldName": "placeholder",
|
|
2540
|
+
"inheritedFrom": {
|
|
2541
|
+
"name": "FormAssociatedMixin",
|
|
2542
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2543
|
+
}
|
|
2544
|
+
},
|
|
2537
2545
|
{
|
|
2538
|
-
"name": "
|
|
2546
|
+
"name": "error",
|
|
2539
2547
|
"type": {
|
|
2540
|
-
"text": "
|
|
2548
|
+
"text": "string | undefined"
|
|
2541
2549
|
},
|
|
2542
|
-
"description": "
|
|
2550
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
2551
|
+
"fieldName": "error",
|
|
2552
|
+
"inheritedFrom": {
|
|
2553
|
+
"name": "FormAssociatedMixin",
|
|
2554
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2555
|
+
}
|
|
2543
2556
|
},
|
|
2544
2557
|
{
|
|
2558
|
+
"name": "required",
|
|
2545
2559
|
"type": {
|
|
2546
|
-
"text": "
|
|
2560
|
+
"text": "boolean"
|
|
2547
2561
|
},
|
|
2548
|
-
"
|
|
2549
|
-
"
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2562
|
+
"default": "false",
|
|
2563
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
2564
|
+
"fieldName": "required",
|
|
2565
|
+
"inheritedFrom": {
|
|
2566
|
+
"name": "FormAssociatedMixin",
|
|
2567
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2568
|
+
}
|
|
2569
|
+
},
|
|
2553
2570
|
{
|
|
2554
|
-
"name": "
|
|
2571
|
+
"name": "hide-required",
|
|
2555
2572
|
"type": {
|
|
2556
|
-
"text": "
|
|
2573
|
+
"text": "boolean"
|
|
2557
2574
|
},
|
|
2558
|
-
"default": "
|
|
2559
|
-
"description": "
|
|
2560
|
-
"fieldName": "
|
|
2575
|
+
"default": "false",
|
|
2576
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
2577
|
+
"fieldName": "hideRequired",
|
|
2578
|
+
"inheritedFrom": {
|
|
2579
|
+
"name": "FormAssociatedMixin",
|
|
2580
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2581
|
+
}
|
|
2561
2582
|
},
|
|
2562
2583
|
{
|
|
2563
|
-
"name": "
|
|
2584
|
+
"name": "disabled",
|
|
2564
2585
|
"type": {
|
|
2565
|
-
"text": "
|
|
2586
|
+
"text": "boolean"
|
|
2566
2587
|
},
|
|
2567
|
-
"
|
|
2568
|
-
"
|
|
2588
|
+
"default": "false",
|
|
2589
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
2590
|
+
"fieldName": "disabled",
|
|
2591
|
+
"inheritedFrom": {
|
|
2592
|
+
"name": "InputMixin",
|
|
2593
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2594
|
+
}
|
|
2569
2595
|
},
|
|
2570
2596
|
{
|
|
2571
|
-
"name": "
|
|
2597
|
+
"name": "name",
|
|
2598
|
+
"type": {
|
|
2599
|
+
"text": "string | undefined"
|
|
2600
|
+
},
|
|
2601
|
+
"description": "The name of the form component.",
|
|
2602
|
+
"fieldName": "name",
|
|
2603
|
+
"inheritedFrom": {
|
|
2604
|
+
"name": "InputMixin",
|
|
2605
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2606
|
+
}
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
"name": "value",
|
|
2572
2610
|
"type": {
|
|
2573
2611
|
"text": "string"
|
|
2574
2612
|
},
|
|
2575
2613
|
"default": "\"\"",
|
|
2576
|
-
"description": "
|
|
2577
|
-
"fieldName": "
|
|
2614
|
+
"description": "The value of the form component.",
|
|
2615
|
+
"fieldName": "value",
|
|
2616
|
+
"inheritedFrom": {
|
|
2617
|
+
"name": "InputMixin",
|
|
2618
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2619
|
+
}
|
|
2620
|
+
}
|
|
2621
|
+
],
|
|
2622
|
+
"mixins": [
|
|
2623
|
+
{
|
|
2624
|
+
"name": "SizeMixin",
|
|
2625
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
2626
|
+
},
|
|
2627
|
+
{
|
|
2628
|
+
"name": "FormAssociatedMixin",
|
|
2629
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
2578
2630
|
},
|
|
2579
2631
|
{
|
|
2580
|
-
"name": "
|
|
2581
|
-
"
|
|
2582
|
-
"text": "string"
|
|
2583
|
-
},
|
|
2584
|
-
"default": "\"\"",
|
|
2585
|
-
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
2586
|
-
"fieldName": "max"
|
|
2632
|
+
"name": "InputMixin",
|
|
2633
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
2587
2634
|
},
|
|
2588
2635
|
{
|
|
2589
|
-
"name": "
|
|
2590
|
-
"
|
|
2591
|
-
"text": "boolean"
|
|
2592
|
-
},
|
|
2593
|
-
"default": "false",
|
|
2594
|
-
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
2595
|
-
"fieldName": "expand"
|
|
2636
|
+
"name": "FocusableMixin",
|
|
2637
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
2596
2638
|
}
|
|
2597
2639
|
],
|
|
2598
2640
|
"superclass": {
|
|
2599
2641
|
"name": "LitElement",
|
|
2600
2642
|
"package": "lit"
|
|
2601
2643
|
},
|
|
2602
|
-
"localization": [
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
},
|
|
2644
|
+
"localization": [],
|
|
2645
|
+
"status": "ready",
|
|
2646
|
+
"category": "form",
|
|
2647
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for making it possible to choose one or more options from a limited number of options.\n- Use for “accepting terms of service” and similar functionality.\n- Use in forms to toggle something on or off.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another checkbox when another one is clicked. Only exception is when a checkbox is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nCheckbox labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing checkbox labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n",
|
|
2648
|
+
"examples": [],
|
|
2649
|
+
"tagName": "nord-checkbox",
|
|
2650
|
+
"customElement": true,
|
|
2651
|
+
"events": [
|
|
2611
2652
|
{
|
|
2612
|
-
"name": "
|
|
2613
|
-
"
|
|
2653
|
+
"name": "input",
|
|
2654
|
+
"type": {
|
|
2655
|
+
"text": "NordEvent"
|
|
2656
|
+
},
|
|
2657
|
+
"description": "Fired as the user types into the input.",
|
|
2658
|
+
"inheritedFrom": {
|
|
2659
|
+
"name": "FormAssociatedMixin",
|
|
2660
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2661
|
+
}
|
|
2614
2662
|
},
|
|
2615
2663
|
{
|
|
2616
|
-
"name": "
|
|
2617
|
-
"
|
|
2664
|
+
"name": "change",
|
|
2665
|
+
"type": {
|
|
2666
|
+
"text": "NordEvent"
|
|
2667
|
+
},
|
|
2668
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
2669
|
+
"inheritedFrom": {
|
|
2670
|
+
"name": "FormAssociatedMixin",
|
|
2671
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2672
|
+
}
|
|
2618
2673
|
}
|
|
2619
|
-
]
|
|
2620
|
-
"status": "ready",
|
|
2621
|
-
"category": "list",
|
|
2622
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n",
|
|
2623
|
-
"examples": [],
|
|
2624
|
-
"tagName": "nord-calendar",
|
|
2625
|
-
"customElement": true
|
|
2674
|
+
]
|
|
2626
2675
|
}
|
|
2627
2676
|
],
|
|
2628
2677
|
"exports": [
|
|
@@ -2630,65 +2679,16 @@
|
|
|
2630
2679
|
"kind": "js",
|
|
2631
2680
|
"name": "default",
|
|
2632
2681
|
"declaration": {
|
|
2633
|
-
"name": "
|
|
2634
|
-
"module": "src/
|
|
2682
|
+
"name": "Checkbox",
|
|
2683
|
+
"module": "src/checkbox/Checkbox.ts"
|
|
2635
2684
|
}
|
|
2636
2685
|
},
|
|
2637
2686
|
{
|
|
2638
2687
|
"kind": "custom-element-definition",
|
|
2639
|
-
"name": "nord-
|
|
2640
|
-
"declaration": {
|
|
2641
|
-
"name": "Calendar",
|
|
2642
|
-
"module": "src/calendar/Calendar.ts"
|
|
2643
|
-
}
|
|
2644
|
-
}
|
|
2645
|
-
]
|
|
2646
|
-
},
|
|
2647
|
-
{
|
|
2648
|
-
"kind": "javascript-module",
|
|
2649
|
-
"path": "src/calendar/DateSelectEvent.ts",
|
|
2650
|
-
"declarations": [
|
|
2651
|
-
{
|
|
2652
|
-
"kind": "class",
|
|
2653
|
-
"description": "",
|
|
2654
|
-
"name": "DateSelectEvent",
|
|
2655
|
-
"superclass": {
|
|
2656
|
-
"name": "NordEvent",
|
|
2657
|
-
"module": "/src/common/events.js"
|
|
2658
|
-
}
|
|
2659
|
-
}
|
|
2660
|
-
],
|
|
2661
|
-
"exports": [
|
|
2662
|
-
{
|
|
2663
|
-
"kind": "js",
|
|
2664
|
-
"name": "DateSelectEvent",
|
|
2665
|
-
"declaration": {
|
|
2666
|
-
"name": "DateSelectEvent",
|
|
2667
|
-
"module": "src/calendar/DateSelectEvent.ts"
|
|
2668
|
-
}
|
|
2669
|
-
}
|
|
2670
|
-
]
|
|
2671
|
-
},
|
|
2672
|
-
{
|
|
2673
|
-
"kind": "javascript-module",
|
|
2674
|
-
"path": "src/calendar/localization.ts",
|
|
2675
|
-
"declarations": [
|
|
2676
|
-
{
|
|
2677
|
-
"kind": "variable",
|
|
2678
|
-
"name": "calendarLocalization",
|
|
2679
|
-
"type": {
|
|
2680
|
-
"text": "object"
|
|
2681
|
-
},
|
|
2682
|
-
"default": "{\n prevMonthLabel: \"Previous month\",\n nextMonthLabel: \"Next month\",\n monthSelectLabel: \"Month\",\n yearSelectLabel: \"Year\",\n}"
|
|
2683
|
-
}
|
|
2684
|
-
],
|
|
2685
|
-
"exports": [
|
|
2686
|
-
{
|
|
2687
|
-
"kind": "js",
|
|
2688
|
-
"name": "default",
|
|
2688
|
+
"name": "nord-checkbox",
|
|
2689
2689
|
"declaration": {
|
|
2690
|
-
"name": "
|
|
2691
|
-
"module": "src/
|
|
2690
|
+
"name": "Checkbox",
|
|
2691
|
+
"module": "src/checkbox/Checkbox.ts"
|
|
2692
2692
|
}
|
|
2693
2693
|
}
|
|
2694
2694
|
]
|
|
@@ -8846,6 +8846,73 @@
|
|
|
8846
8846
|
}
|
|
8847
8847
|
]
|
|
8848
8848
|
},
|
|
8849
|
+
{
|
|
8850
|
+
"kind": "javascript-module",
|
|
8851
|
+
"path": "src/nav-group/NavGroup.ts",
|
|
8852
|
+
"declarations": [
|
|
8853
|
+
{
|
|
8854
|
+
"kind": "class",
|
|
8855
|
+
"description": "Navigation group includes all the actions or items in a single\ngroup and is used for grouping items into related categories.",
|
|
8856
|
+
"name": "NavGroup",
|
|
8857
|
+
"slots": [
|
|
8858
|
+
{
|
|
8859
|
+
"description": "The default slot used for the nav items.",
|
|
8860
|
+
"name": ""
|
|
8861
|
+
}
|
|
8862
|
+
],
|
|
8863
|
+
"members": [
|
|
8864
|
+
{
|
|
8865
|
+
"kind": "field",
|
|
8866
|
+
"name": "heading",
|
|
8867
|
+
"type": {
|
|
8868
|
+
"text": "string | undefined"
|
|
8869
|
+
},
|
|
8870
|
+
"description": "Heading and accessible label for the nav group",
|
|
8871
|
+
"attribute": "heading"
|
|
8872
|
+
}
|
|
8873
|
+
],
|
|
8874
|
+
"attributes": [
|
|
8875
|
+
{
|
|
8876
|
+
"name": "heading",
|
|
8877
|
+
"type": {
|
|
8878
|
+
"text": "string | undefined"
|
|
8879
|
+
},
|
|
8880
|
+
"description": "Heading and accessible label for the nav group",
|
|
8881
|
+
"fieldName": "heading"
|
|
8882
|
+
}
|
|
8883
|
+
],
|
|
8884
|
+
"superclass": {
|
|
8885
|
+
"name": "LitElement",
|
|
8886
|
+
"package": "lit"
|
|
8887
|
+
},
|
|
8888
|
+
"localization": [],
|
|
8889
|
+
"status": "ready",
|
|
8890
|
+
"category": "navigation",
|
|
8891
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping other types of content.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
8892
|
+
"examples": [],
|
|
8893
|
+
"tagName": "nord-nav-group",
|
|
8894
|
+
"customElement": true
|
|
8895
|
+
}
|
|
8896
|
+
],
|
|
8897
|
+
"exports": [
|
|
8898
|
+
{
|
|
8899
|
+
"kind": "js",
|
|
8900
|
+
"name": "default",
|
|
8901
|
+
"declaration": {
|
|
8902
|
+
"name": "NavGroup",
|
|
8903
|
+
"module": "src/nav-group/NavGroup.ts"
|
|
8904
|
+
}
|
|
8905
|
+
},
|
|
8906
|
+
{
|
|
8907
|
+
"kind": "custom-element-definition",
|
|
8908
|
+
"name": "nord-nav-group",
|
|
8909
|
+
"declaration": {
|
|
8910
|
+
"name": "NavGroup",
|
|
8911
|
+
"module": "src/nav-group/NavGroup.ts"
|
|
8912
|
+
}
|
|
8913
|
+
}
|
|
8914
|
+
]
|
|
8915
|
+
},
|
|
8849
8916
|
{
|
|
8850
8917
|
"kind": "javascript-module",
|
|
8851
8918
|
"path": "src/nav-item/NavItem.ts",
|
|
@@ -9065,81 +9132,14 @@
|
|
|
9065
9132
|
"text": "boolean"
|
|
9066
9133
|
},
|
|
9067
9134
|
"default": "false",
|
|
9068
|
-
"description": "When the nav items contains a subnav, controls whether the section is expanded or not.\nNote: this is only used if you have nested navigation using the \"subnav\" slot.",
|
|
9069
|
-
"fieldName": "open"
|
|
9070
|
-
}
|
|
9071
|
-
],
|
|
9072
|
-
"mixins": [
|
|
9073
|
-
{
|
|
9074
|
-
"name": "FocusableMixin",
|
|
9075
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
9076
|
-
}
|
|
9077
|
-
],
|
|
9078
|
-
"superclass": {
|
|
9079
|
-
"name": "LitElement",
|
|
9080
|
-
"package": "lit"
|
|
9081
|
-
},
|
|
9082
|
-
"localization": [],
|
|
9083
|
-
"status": "ready",
|
|
9084
|
-
"category": "navigation",
|
|
9085
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use navigation item outside of navigation group and navigation components.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
9086
|
-
"examples": [],
|
|
9087
|
-
"tagName": "nord-nav-item",
|
|
9088
|
-
"customElement": true
|
|
9089
|
-
}
|
|
9090
|
-
],
|
|
9091
|
-
"exports": [
|
|
9092
|
-
{
|
|
9093
|
-
"kind": "js",
|
|
9094
|
-
"name": "default",
|
|
9095
|
-
"declaration": {
|
|
9096
|
-
"name": "NavItem",
|
|
9097
|
-
"module": "src/nav-item/NavItem.ts"
|
|
9098
|
-
}
|
|
9099
|
-
},
|
|
9100
|
-
{
|
|
9101
|
-
"kind": "custom-element-definition",
|
|
9102
|
-
"name": "nord-nav-item",
|
|
9103
|
-
"declaration": {
|
|
9104
|
-
"name": "NavItem",
|
|
9105
|
-
"module": "src/nav-item/NavItem.ts"
|
|
9106
|
-
}
|
|
9107
|
-
}
|
|
9108
|
-
]
|
|
9109
|
-
},
|
|
9110
|
-
{
|
|
9111
|
-
"kind": "javascript-module",
|
|
9112
|
-
"path": "src/nav-group/NavGroup.ts",
|
|
9113
|
-
"declarations": [
|
|
9114
|
-
{
|
|
9115
|
-
"kind": "class",
|
|
9116
|
-
"description": "Navigation group includes all the actions or items in a single\ngroup and is used for grouping items into related categories.",
|
|
9117
|
-
"name": "NavGroup",
|
|
9118
|
-
"slots": [
|
|
9119
|
-
{
|
|
9120
|
-
"description": "The default slot used for the nav items.",
|
|
9121
|
-
"name": ""
|
|
9122
|
-
}
|
|
9123
|
-
],
|
|
9124
|
-
"members": [
|
|
9125
|
-
{
|
|
9126
|
-
"kind": "field",
|
|
9127
|
-
"name": "heading",
|
|
9128
|
-
"type": {
|
|
9129
|
-
"text": "string | undefined"
|
|
9130
|
-
},
|
|
9131
|
-
"description": "Heading and accessible label for the nav group",
|
|
9132
|
-
"attribute": "heading"
|
|
9135
|
+
"description": "When the nav items contains a subnav, controls whether the section is expanded or not.\nNote: this is only used if you have nested navigation using the \"subnav\" slot.",
|
|
9136
|
+
"fieldName": "open"
|
|
9133
9137
|
}
|
|
9134
9138
|
],
|
|
9135
|
-
"
|
|
9139
|
+
"mixins": [
|
|
9136
9140
|
{
|
|
9137
|
-
"name": "
|
|
9138
|
-
"
|
|
9139
|
-
"text": "string | undefined"
|
|
9140
|
-
},
|
|
9141
|
-
"description": "Heading and accessible label for the nav group",
|
|
9142
|
-
"fieldName": "heading"
|
|
9141
|
+
"name": "FocusableMixin",
|
|
9142
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
9143
9143
|
}
|
|
9144
9144
|
],
|
|
9145
9145
|
"superclass": {
|
|
@@ -9149,9 +9149,9 @@
|
|
|
9149
9149
|
"localization": [],
|
|
9150
9150
|
"status": "ready",
|
|
9151
9151
|
"category": "navigation",
|
|
9152
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use
|
|
9152
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use navigation item outside of navigation group and navigation components.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
9153
9153
|
"examples": [],
|
|
9154
|
-
"tagName": "nord-nav-
|
|
9154
|
+
"tagName": "nord-nav-item",
|
|
9155
9155
|
"customElement": true
|
|
9156
9156
|
}
|
|
9157
9157
|
],
|
|
@@ -9160,16 +9160,16 @@
|
|
|
9160
9160
|
"kind": "js",
|
|
9161
9161
|
"name": "default",
|
|
9162
9162
|
"declaration": {
|
|
9163
|
-
"name": "
|
|
9164
|
-
"module": "src/nav-
|
|
9163
|
+
"name": "NavItem",
|
|
9164
|
+
"module": "src/nav-item/NavItem.ts"
|
|
9165
9165
|
}
|
|
9166
9166
|
},
|
|
9167
9167
|
{
|
|
9168
9168
|
"kind": "custom-element-definition",
|
|
9169
|
-
"name": "nord-nav-
|
|
9169
|
+
"name": "nord-nav-item",
|
|
9170
9170
|
"declaration": {
|
|
9171
|
-
"name": "
|
|
9172
|
-
"module": "src/nav-
|
|
9171
|
+
"name": "NavItem",
|
|
9172
|
+
"module": "src/nav-item/NavItem.ts"
|
|
9173
9173
|
}
|
|
9174
9174
|
}
|
|
9175
9175
|
]
|
|
@@ -9391,7 +9391,7 @@
|
|
|
9391
9391
|
"kind": "field",
|
|
9392
9392
|
"name": "anchorElement",
|
|
9393
9393
|
"type": {
|
|
9394
|
-
"text": "
|
|
9394
|
+
"text": "HTMLElement"
|
|
9395
9395
|
},
|
|
9396
9396
|
"privacy": "private"
|
|
9397
9397
|
},
|
|
@@ -9510,6 +9510,11 @@
|
|
|
9510
9510
|
"name": "handleOpenChange",
|
|
9511
9511
|
"privacy": "protected"
|
|
9512
9512
|
},
|
|
9513
|
+
{
|
|
9514
|
+
"kind": "method",
|
|
9515
|
+
"name": "handleAnchorChange",
|
|
9516
|
+
"privacy": "protected"
|
|
9517
|
+
},
|
|
9513
9518
|
{
|
|
9514
9519
|
"kind": "field",
|
|
9515
9520
|
"name": "enableScroll",
|
|
@@ -9703,155 +9708,141 @@
|
|
|
9703
9708
|
},
|
|
9704
9709
|
{
|
|
9705
9710
|
"kind": "javascript-module",
|
|
9706
|
-
"path": "src/
|
|
9711
|
+
"path": "src/progress-bar/ProgressBar.ts",
|
|
9707
9712
|
"declarations": [
|
|
9708
9713
|
{
|
|
9709
9714
|
"kind": "class",
|
|
9710
|
-
"description": "
|
|
9711
|
-
"name": "
|
|
9712
|
-
"
|
|
9715
|
+
"description": "Progress Bar is used to visually represent the completion\nof a task or process. It shows how much of the task has\nbeen completed and how much is still left.",
|
|
9716
|
+
"name": "ProgressBar",
|
|
9717
|
+
"cssProperties": [
|
|
9713
9718
|
{
|
|
9714
|
-
"
|
|
9715
|
-
"name": "
|
|
9716
|
-
"
|
|
9717
|
-
"text": "HTMLElement"
|
|
9718
|
-
},
|
|
9719
|
-
"privacy": "private"
|
|
9719
|
+
"description": "Controls the thickness of the progress bar, using our [spacing tokens](/tokens/#space).",
|
|
9720
|
+
"name": "--n-progress-size",
|
|
9721
|
+
"default": "var(--n-space-s)"
|
|
9720
9722
|
},
|
|
9721
9723
|
{
|
|
9722
|
-
"
|
|
9723
|
-
"name": "
|
|
9724
|
-
"
|
|
9725
|
-
"text": "HTMLElement"
|
|
9726
|
-
},
|
|
9727
|
-
"privacy": "private"
|
|
9724
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
9725
|
+
"name": "--n-progress-border-radius",
|
|
9726
|
+
"default": "var(--n-border-radius-s)"
|
|
9728
9727
|
},
|
|
9728
|
+
{
|
|
9729
|
+
"description": "Controls the color of the progress bar, using [color tokens](/tokens/#color).",
|
|
9730
|
+
"name": "--n-progress-color",
|
|
9731
|
+
"default": "var(--n-color-accent)"
|
|
9732
|
+
}
|
|
9733
|
+
],
|
|
9734
|
+
"members": [
|
|
9729
9735
|
{
|
|
9730
9736
|
"kind": "field",
|
|
9731
9737
|
"name": "value",
|
|
9732
9738
|
"type": {
|
|
9733
|
-
"text": "
|
|
9739
|
+
"text": "number | undefined"
|
|
9734
9740
|
},
|
|
9735
|
-
"
|
|
9736
|
-
"description": "The value of the QR Code, most commonly an URL.",
|
|
9741
|
+
"description": "Specifies how much of the task has been completed. Must be a valid floating\npoint number between 0 and max, or between 0 and 100 if max is omitted. If\nthere is no value, the progress bar is indeterminate; this indicates that\nan activity is ongoing with no indication of how long it’s expected to take.",
|
|
9737
9742
|
"attribute": "value",
|
|
9738
9743
|
"reflects": true
|
|
9739
9744
|
},
|
|
9740
9745
|
{
|
|
9741
9746
|
"kind": "field",
|
|
9742
|
-
"name": "
|
|
9743
|
-
"type": {
|
|
9744
|
-
"text": "string"
|
|
9745
|
-
},
|
|
9746
|
-
"default": "\"\"",
|
|
9747
|
-
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
9748
|
-
"attribute": "label",
|
|
9749
|
-
"reflects": true
|
|
9750
|
-
},
|
|
9751
|
-
{
|
|
9752
|
-
"kind": "field",
|
|
9753
|
-
"name": "size",
|
|
9747
|
+
"name": "max",
|
|
9754
9748
|
"type": {
|
|
9755
9749
|
"text": "number"
|
|
9756
9750
|
},
|
|
9757
|
-
"default": "
|
|
9758
|
-
"description": "
|
|
9759
|
-
"attribute": "
|
|
9751
|
+
"default": "100",
|
|
9752
|
+
"description": "Describes how much work the task indicated by the progress element requires.\nThe max attribute, if present, must have a value greater than 0 and be a\nvalid floating point number.",
|
|
9753
|
+
"attribute": "max",
|
|
9760
9754
|
"reflects": true
|
|
9761
9755
|
},
|
|
9762
9756
|
{
|
|
9763
9757
|
"kind": "field",
|
|
9764
|
-
"name": "
|
|
9758
|
+
"name": "label",
|
|
9765
9759
|
"type": {
|
|
9766
9760
|
"text": "string"
|
|
9767
9761
|
},
|
|
9768
|
-
"default": "\"
|
|
9769
|
-
"description": "
|
|
9770
|
-
"attribute": "
|
|
9762
|
+
"default": "\"Current progress\"",
|
|
9763
|
+
"description": "Accessible label for the progress indicator. Visually hidden, but shown\nfor assistive technology.",
|
|
9764
|
+
"attribute": "label",
|
|
9771
9765
|
"reflects": true
|
|
9772
9766
|
},
|
|
9773
9767
|
{
|
|
9774
9768
|
"kind": "field",
|
|
9775
|
-
"name": "
|
|
9776
|
-
"
|
|
9777
|
-
|
|
9778
|
-
|
|
9779
|
-
|
|
9780
|
-
|
|
9781
|
-
"attribute": "background",
|
|
9782
|
-
"reflects": true
|
|
9769
|
+
"name": "focusableRef",
|
|
9770
|
+
"privacy": "protected",
|
|
9771
|
+
"inheritedFrom": {
|
|
9772
|
+
"name": "FocusableMixin",
|
|
9773
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9774
|
+
}
|
|
9783
9775
|
},
|
|
9784
9776
|
{
|
|
9785
|
-
"kind": "
|
|
9786
|
-
"name": "
|
|
9787
|
-
"
|
|
9788
|
-
|
|
9789
|
-
|
|
9790
|
-
|
|
9791
|
-
|
|
9792
|
-
|
|
9793
|
-
|
|
9777
|
+
"kind": "method",
|
|
9778
|
+
"name": "focus",
|
|
9779
|
+
"parameters": [
|
|
9780
|
+
{
|
|
9781
|
+
"name": "options",
|
|
9782
|
+
"optional": true,
|
|
9783
|
+
"type": {
|
|
9784
|
+
"text": "FocusOptions"
|
|
9785
|
+
},
|
|
9786
|
+
"description": "An object which controls aspects of the focusing process."
|
|
9787
|
+
}
|
|
9788
|
+
],
|
|
9789
|
+
"description": "Programmatically move focus to the component.",
|
|
9790
|
+
"inheritedFrom": {
|
|
9791
|
+
"name": "FocusableMixin",
|
|
9792
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9793
|
+
}
|
|
9794
9794
|
},
|
|
9795
9795
|
{
|
|
9796
9796
|
"kind": "method",
|
|
9797
|
-
"name": "
|
|
9798
|
-
"
|
|
9797
|
+
"name": "blur",
|
|
9798
|
+
"description": "Programmatically remove focus from the component.",
|
|
9799
|
+
"inheritedFrom": {
|
|
9800
|
+
"name": "FocusableMixin",
|
|
9801
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9802
|
+
}
|
|
9803
|
+
},
|
|
9804
|
+
{
|
|
9805
|
+
"kind": "method",
|
|
9806
|
+
"name": "click",
|
|
9807
|
+
"description": "Programmatically simulates a click on the component.",
|
|
9808
|
+
"inheritedFrom": {
|
|
9809
|
+
"name": "FocusableMixin",
|
|
9810
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9811
|
+
}
|
|
9799
9812
|
}
|
|
9800
9813
|
],
|
|
9801
9814
|
"attributes": [
|
|
9802
9815
|
{
|
|
9803
9816
|
"name": "value",
|
|
9804
9817
|
"type": {
|
|
9805
|
-
"text": "
|
|
9818
|
+
"text": "number | undefined"
|
|
9806
9819
|
},
|
|
9807
|
-
"
|
|
9808
|
-
"description": "The value of the QR Code, most commonly an URL.",
|
|
9820
|
+
"description": "Specifies how much of the task has been completed. Must be a valid floating\npoint number between 0 and max, or between 0 and 100 if max is omitted. If\nthere is no value, the progress bar is indeterminate; this indicates that\nan activity is ongoing with no indication of how long it’s expected to take.",
|
|
9809
9821
|
"fieldName": "value"
|
|
9810
9822
|
},
|
|
9811
9823
|
{
|
|
9812
|
-
"name": "
|
|
9813
|
-
"type": {
|
|
9814
|
-
"text": "string"
|
|
9815
|
-
},
|
|
9816
|
-
"default": "\"\"",
|
|
9817
|
-
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
9818
|
-
"fieldName": "label"
|
|
9819
|
-
},
|
|
9820
|
-
{
|
|
9821
|
-
"name": "size",
|
|
9824
|
+
"name": "max",
|
|
9822
9825
|
"type": {
|
|
9823
9826
|
"text": "number"
|
|
9824
9827
|
},
|
|
9825
|
-
"default": "
|
|
9826
|
-
"description": "
|
|
9827
|
-
"fieldName": "
|
|
9828
|
-
},
|
|
9829
|
-
{
|
|
9830
|
-
"name": "color",
|
|
9831
|
-
"type": {
|
|
9832
|
-
"text": "string"
|
|
9833
|
-
},
|
|
9834
|
-
"default": "\"var(--n-color-text)\"",
|
|
9835
|
-
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
9836
|
-
"fieldName": "color"
|
|
9828
|
+
"default": "100",
|
|
9829
|
+
"description": "Describes how much work the task indicated by the progress element requires.\nThe max attribute, if present, must have a value greater than 0 and be a\nvalid floating point number.",
|
|
9830
|
+
"fieldName": "max"
|
|
9837
9831
|
},
|
|
9838
9832
|
{
|
|
9839
|
-
"name": "
|
|
9833
|
+
"name": "label",
|
|
9840
9834
|
"type": {
|
|
9841
9835
|
"text": "string"
|
|
9842
9836
|
},
|
|
9843
|
-
"default": "\"
|
|
9844
|
-
"description": "
|
|
9845
|
-
"fieldName": "
|
|
9846
|
-
}
|
|
9837
|
+
"default": "\"Current progress\"",
|
|
9838
|
+
"description": "Accessible label for the progress indicator. Visually hidden, but shown\nfor assistive technology.",
|
|
9839
|
+
"fieldName": "label"
|
|
9840
|
+
}
|
|
9841
|
+
],
|
|
9842
|
+
"mixins": [
|
|
9847
9843
|
{
|
|
9848
|
-
"name": "
|
|
9849
|
-
"
|
|
9850
|
-
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
9851
|
-
},
|
|
9852
|
-
"default": "\"H\"",
|
|
9853
|
-
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
9854
|
-
"fieldName": "correction"
|
|
9844
|
+
"name": "FocusableMixin",
|
|
9845
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
9855
9846
|
}
|
|
9856
9847
|
],
|
|
9857
9848
|
"superclass": {
|
|
@@ -9860,11 +9851,10 @@
|
|
|
9860
9851
|
},
|
|
9861
9852
|
"localization": [],
|
|
9862
9853
|
"status": "ready",
|
|
9863
|
-
"category": "
|
|
9864
|
-
"
|
|
9865
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to allow people to access information on their smartphone without the need to type.\n- Always provide an alternative way to access the same information.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t hide important information behind a QR Code only.\n\n</div>\n",
|
|
9854
|
+
"category": "feedback",
|
|
9855
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to show the completion status of an ongoing task.\n- Use progress bar when you can determine the percentage of the completed task at any time.\n- Always provide an accessible label when using Progress Bar.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use in constrained spaces indicating indeterminate loading state, see [Spinner](/components/spinner/) instead.\n\n</div>\n",
|
|
9866
9856
|
"examples": [],
|
|
9867
|
-
"tagName": "nord-
|
|
9857
|
+
"tagName": "nord-progress-bar",
|
|
9868
9858
|
"customElement": true
|
|
9869
9859
|
}
|
|
9870
9860
|
],
|
|
@@ -9873,157 +9863,171 @@
|
|
|
9873
9863
|
"kind": "js",
|
|
9874
9864
|
"name": "default",
|
|
9875
9865
|
"declaration": {
|
|
9876
|
-
"name": "
|
|
9877
|
-
"module": "src/
|
|
9866
|
+
"name": "ProgressBar",
|
|
9867
|
+
"module": "src/progress-bar/ProgressBar.ts"
|
|
9878
9868
|
}
|
|
9879
9869
|
},
|
|
9880
9870
|
{
|
|
9881
9871
|
"kind": "custom-element-definition",
|
|
9882
|
-
"name": "nord-
|
|
9872
|
+
"name": "nord-progress-bar",
|
|
9883
9873
|
"declaration": {
|
|
9884
|
-
"name": "
|
|
9885
|
-
"module": "src/
|
|
9874
|
+
"name": "ProgressBar",
|
|
9875
|
+
"module": "src/progress-bar/ProgressBar.ts"
|
|
9886
9876
|
}
|
|
9887
9877
|
}
|
|
9888
9878
|
]
|
|
9889
9879
|
},
|
|
9890
9880
|
{
|
|
9891
9881
|
"kind": "javascript-module",
|
|
9892
|
-
"path": "src/
|
|
9882
|
+
"path": "src/qrcode/Qrcode.ts",
|
|
9893
9883
|
"declarations": [
|
|
9894
9884
|
{
|
|
9895
9885
|
"kind": "class",
|
|
9896
|
-
"description": "
|
|
9897
|
-
"name": "
|
|
9898
|
-
"
|
|
9886
|
+
"description": "QR Code component is used for providing information or links\nto users which they can quickly scan with their smartphone.",
|
|
9887
|
+
"name": "Qrcode",
|
|
9888
|
+
"members": [
|
|
9899
9889
|
{
|
|
9900
|
-
"
|
|
9901
|
-
"name": "
|
|
9902
|
-
"
|
|
9890
|
+
"kind": "field",
|
|
9891
|
+
"name": "canvas",
|
|
9892
|
+
"type": {
|
|
9893
|
+
"text": "HTMLElement"
|
|
9894
|
+
},
|
|
9895
|
+
"privacy": "private"
|
|
9903
9896
|
},
|
|
9904
9897
|
{
|
|
9905
|
-
"
|
|
9906
|
-
"name": "
|
|
9907
|
-
"
|
|
9898
|
+
"kind": "field",
|
|
9899
|
+
"name": "computed",
|
|
9900
|
+
"type": {
|
|
9901
|
+
"text": "HTMLElement"
|
|
9902
|
+
},
|
|
9903
|
+
"privacy": "private"
|
|
9908
9904
|
},
|
|
9909
|
-
{
|
|
9910
|
-
"description": "Controls the color of the progress bar, using [color tokens](/tokens/#color).",
|
|
9911
|
-
"name": "--n-progress-color",
|
|
9912
|
-
"default": "var(--n-color-accent)"
|
|
9913
|
-
}
|
|
9914
|
-
],
|
|
9915
|
-
"members": [
|
|
9916
9905
|
{
|
|
9917
9906
|
"kind": "field",
|
|
9918
9907
|
"name": "value",
|
|
9919
9908
|
"type": {
|
|
9920
|
-
"text": "
|
|
9909
|
+
"text": "string"
|
|
9921
9910
|
},
|
|
9922
|
-
"
|
|
9911
|
+
"default": "\"\"",
|
|
9912
|
+
"description": "The value of the QR Code, most commonly an URL.",
|
|
9923
9913
|
"attribute": "value",
|
|
9924
9914
|
"reflects": true
|
|
9925
9915
|
},
|
|
9926
9916
|
{
|
|
9927
9917
|
"kind": "field",
|
|
9928
|
-
"name": "
|
|
9918
|
+
"name": "label",
|
|
9929
9919
|
"type": {
|
|
9930
|
-
"text": "
|
|
9920
|
+
"text": "string"
|
|
9931
9921
|
},
|
|
9932
|
-
"default": "
|
|
9933
|
-
"description": "
|
|
9934
|
-
"attribute": "
|
|
9922
|
+
"default": "\"\"",
|
|
9923
|
+
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
9924
|
+
"attribute": "label",
|
|
9935
9925
|
"reflects": true
|
|
9936
9926
|
},
|
|
9937
9927
|
{
|
|
9938
9928
|
"kind": "field",
|
|
9939
|
-
"name": "
|
|
9929
|
+
"name": "size",
|
|
9940
9930
|
"type": {
|
|
9941
|
-
"text": "
|
|
9931
|
+
"text": "number"
|
|
9942
9932
|
},
|
|
9943
|
-
"default": "
|
|
9944
|
-
"description": "
|
|
9945
|
-
"attribute": "
|
|
9933
|
+
"default": "128",
|
|
9934
|
+
"description": "The size of the rendered QR Code in pixels.",
|
|
9935
|
+
"attribute": "size",
|
|
9946
9936
|
"reflects": true
|
|
9947
9937
|
},
|
|
9948
9938
|
{
|
|
9949
9939
|
"kind": "field",
|
|
9950
|
-
"name": "
|
|
9951
|
-
"
|
|
9952
|
-
|
|
9953
|
-
|
|
9954
|
-
|
|
9955
|
-
|
|
9940
|
+
"name": "color",
|
|
9941
|
+
"type": {
|
|
9942
|
+
"text": "string"
|
|
9943
|
+
},
|
|
9944
|
+
"default": "\"var(--n-color-text)\"",
|
|
9945
|
+
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
9946
|
+
"attribute": "color",
|
|
9947
|
+
"reflects": true
|
|
9956
9948
|
},
|
|
9957
9949
|
{
|
|
9958
|
-
"kind": "
|
|
9959
|
-
"name": "
|
|
9960
|
-
"
|
|
9961
|
-
|
|
9962
|
-
|
|
9963
|
-
|
|
9964
|
-
|
|
9965
|
-
|
|
9966
|
-
|
|
9967
|
-
"description": "An object which controls aspects of the focusing process."
|
|
9968
|
-
}
|
|
9969
|
-
],
|
|
9970
|
-
"description": "Programmatically move focus to the component.",
|
|
9971
|
-
"inheritedFrom": {
|
|
9972
|
-
"name": "FocusableMixin",
|
|
9973
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9974
|
-
}
|
|
9950
|
+
"kind": "field",
|
|
9951
|
+
"name": "background",
|
|
9952
|
+
"type": {
|
|
9953
|
+
"text": "string"
|
|
9954
|
+
},
|
|
9955
|
+
"default": "\"var(--n-color-surface)\"",
|
|
9956
|
+
"description": "The background color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
9957
|
+
"attribute": "background",
|
|
9958
|
+
"reflects": true
|
|
9975
9959
|
},
|
|
9976
9960
|
{
|
|
9977
|
-
"kind": "
|
|
9978
|
-
"name": "
|
|
9979
|
-
"
|
|
9980
|
-
|
|
9981
|
-
|
|
9982
|
-
|
|
9983
|
-
|
|
9961
|
+
"kind": "field",
|
|
9962
|
+
"name": "correction",
|
|
9963
|
+
"type": {
|
|
9964
|
+
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
9965
|
+
},
|
|
9966
|
+
"default": "\"H\"",
|
|
9967
|
+
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
9968
|
+
"attribute": "correction",
|
|
9969
|
+
"reflects": true
|
|
9984
9970
|
},
|
|
9985
9971
|
{
|
|
9986
9972
|
"kind": "method",
|
|
9987
|
-
"name": "
|
|
9988
|
-
"
|
|
9989
|
-
"inheritedFrom": {
|
|
9990
|
-
"name": "FocusableMixin",
|
|
9991
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9992
|
-
}
|
|
9973
|
+
"name": "generate",
|
|
9974
|
+
"privacy": "private"
|
|
9993
9975
|
}
|
|
9994
9976
|
],
|
|
9995
9977
|
"attributes": [
|
|
9996
9978
|
{
|
|
9997
9979
|
"name": "value",
|
|
9998
9980
|
"type": {
|
|
9999
|
-
"text": "
|
|
9981
|
+
"text": "string"
|
|
10000
9982
|
},
|
|
10001
|
-
"
|
|
9983
|
+
"default": "\"\"",
|
|
9984
|
+
"description": "The value of the QR Code, most commonly an URL.",
|
|
10002
9985
|
"fieldName": "value"
|
|
10003
9986
|
},
|
|
10004
9987
|
{
|
|
10005
|
-
"name": "
|
|
9988
|
+
"name": "label",
|
|
9989
|
+
"type": {
|
|
9990
|
+
"text": "string"
|
|
9991
|
+
},
|
|
9992
|
+
"default": "\"\"",
|
|
9993
|
+
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
9994
|
+
"fieldName": "label"
|
|
9995
|
+
},
|
|
9996
|
+
{
|
|
9997
|
+
"name": "size",
|
|
10006
9998
|
"type": {
|
|
10007
9999
|
"text": "number"
|
|
10008
10000
|
},
|
|
10009
|
-
"default": "
|
|
10010
|
-
"description": "
|
|
10011
|
-
"fieldName": "
|
|
10001
|
+
"default": "128",
|
|
10002
|
+
"description": "The size of the rendered QR Code in pixels.",
|
|
10003
|
+
"fieldName": "size"
|
|
10012
10004
|
},
|
|
10013
10005
|
{
|
|
10014
|
-
"name": "
|
|
10006
|
+
"name": "color",
|
|
10015
10007
|
"type": {
|
|
10016
10008
|
"text": "string"
|
|
10017
10009
|
},
|
|
10018
|
-
"default": "\"
|
|
10019
|
-
"description": "
|
|
10020
|
-
"fieldName": "
|
|
10021
|
-
}
|
|
10022
|
-
],
|
|
10023
|
-
"mixins": [
|
|
10010
|
+
"default": "\"var(--n-color-text)\"",
|
|
10011
|
+
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
10012
|
+
"fieldName": "color"
|
|
10013
|
+
},
|
|
10024
10014
|
{
|
|
10025
|
-
"name": "
|
|
10026
|
-
"
|
|
10015
|
+
"name": "background",
|
|
10016
|
+
"type": {
|
|
10017
|
+
"text": "string"
|
|
10018
|
+
},
|
|
10019
|
+
"default": "\"var(--n-color-surface)\"",
|
|
10020
|
+
"description": "The background color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
10021
|
+
"fieldName": "background"
|
|
10022
|
+
},
|
|
10023
|
+
{
|
|
10024
|
+
"name": "correction",
|
|
10025
|
+
"type": {
|
|
10026
|
+
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
10027
|
+
},
|
|
10028
|
+
"default": "\"H\"",
|
|
10029
|
+
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
10030
|
+
"fieldName": "correction"
|
|
10027
10031
|
}
|
|
10028
10032
|
],
|
|
10029
10033
|
"superclass": {
|
|
@@ -10032,10 +10036,11 @@
|
|
|
10032
10036
|
},
|
|
10033
10037
|
"localization": [],
|
|
10034
10038
|
"status": "ready",
|
|
10035
|
-
"category": "
|
|
10036
|
-
"
|
|
10039
|
+
"category": "image",
|
|
10040
|
+
"displayName": "QR Code",
|
|
10041
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to allow people to access information on their smartphone without the need to type.\n- Always provide an alternative way to access the same information.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t hide important information behind a QR Code only.\n\n</div>\n",
|
|
10037
10042
|
"examples": [],
|
|
10038
|
-
"tagName": "nord-
|
|
10043
|
+
"tagName": "nord-qrcode",
|
|
10039
10044
|
"customElement": true
|
|
10040
10045
|
}
|
|
10041
10046
|
],
|
|
@@ -10044,16 +10049,16 @@
|
|
|
10044
10049
|
"kind": "js",
|
|
10045
10050
|
"name": "default",
|
|
10046
10051
|
"declaration": {
|
|
10047
|
-
"name": "
|
|
10048
|
-
"module": "src/
|
|
10052
|
+
"name": "Qrcode",
|
|
10053
|
+
"module": "src/qrcode/Qrcode.ts"
|
|
10049
10054
|
}
|
|
10050
10055
|
},
|
|
10051
10056
|
{
|
|
10052
10057
|
"kind": "custom-element-definition",
|
|
10053
|
-
"name": "nord-
|
|
10058
|
+
"name": "nord-qrcode",
|
|
10054
10059
|
"declaration": {
|
|
10055
|
-
"name": "
|
|
10056
|
-
"module": "src/
|
|
10060
|
+
"name": "Qrcode",
|
|
10061
|
+
"module": "src/qrcode/Qrcode.ts"
|
|
10057
10062
|
}
|
|
10058
10063
|
}
|
|
10059
10064
|
]
|
|
@@ -12353,112 +12358,18 @@
|
|
|
12353
12358
|
{
|
|
12354
12359
|
"name": "color",
|
|
12355
12360
|
"type": {
|
|
12356
|
-
"text": "string | undefined"
|
|
12357
|
-
},
|
|
12358
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12359
|
-
"fieldName": "color"
|
|
12360
|
-
},
|
|
12361
|
-
{
|
|
12362
|
-
"name": "label",
|
|
12363
|
-
"type": {
|
|
12364
|
-
"text": "string | undefined"
|
|
12365
|
-
},
|
|
12366
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12367
|
-
"fieldName": "label"
|
|
12368
|
-
}
|
|
12369
|
-
],
|
|
12370
|
-
"superclass": {
|
|
12371
|
-
"name": "LitElement",
|
|
12372
|
-
"package": "lit"
|
|
12373
|
-
},
|
|
12374
|
-
"localization": [],
|
|
12375
|
-
"status": "ready",
|
|
12376
|
-
"category": "feedback",
|
|
12377
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for indicating users that their action is being processed.\n- Use the label property to provide an accessible label for the spinner. If no label is supplied, the spinner is hidden from assistive technology.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to show progress. Favor a progress bar instead.\n\n</div>\n",
|
|
12378
|
-
"examples": [],
|
|
12379
|
-
"tagName": "nord-spinner",
|
|
12380
|
-
"customElement": true
|
|
12381
|
-
}
|
|
12382
|
-
],
|
|
12383
|
-
"exports": [
|
|
12384
|
-
{
|
|
12385
|
-
"kind": "js",
|
|
12386
|
-
"name": "default",
|
|
12387
|
-
"declaration": {
|
|
12388
|
-
"name": "Spinner",
|
|
12389
|
-
"module": "src/spinner/Spinner.ts"
|
|
12390
|
-
}
|
|
12391
|
-
},
|
|
12392
|
-
{
|
|
12393
|
-
"kind": "custom-element-definition",
|
|
12394
|
-
"name": "nord-spinner",
|
|
12395
|
-
"declaration": {
|
|
12396
|
-
"name": "Spinner",
|
|
12397
|
-
"module": "src/spinner/Spinner.ts"
|
|
12398
|
-
}
|
|
12399
|
-
}
|
|
12400
|
-
]
|
|
12401
|
-
},
|
|
12402
|
-
{
|
|
12403
|
-
"kind": "javascript-module",
|
|
12404
|
-
"path": "src/tab/Tab.ts",
|
|
12405
|
-
"declarations": [
|
|
12406
|
-
{
|
|
12407
|
-
"kind": "class",
|
|
12408
|
-
"description": "The interactive tab button for use within the tab group component.",
|
|
12409
|
-
"name": "Tab",
|
|
12410
|
-
"cssProperties": [
|
|
12411
|
-
{
|
|
12412
|
-
"description": "Controls the text color of the tab, using our [color tokens](/tokens/#color).",
|
|
12413
|
-
"name": "--n-tab-color",
|
|
12414
|
-
"default": "var(--n-color-text-weak)"
|
|
12415
|
-
},
|
|
12416
|
-
{
|
|
12417
|
-
"description": "Controls the font weight of the tab, using our [font tokens](/tokens/#font).",
|
|
12418
|
-
"name": "--n-tab-font-weight",
|
|
12419
|
-
"default": "var(--n-font-weight)"
|
|
12420
|
-
}
|
|
12421
|
-
],
|
|
12422
|
-
"slots": [
|
|
12423
|
-
{
|
|
12424
|
-
"description": "The tab button content.",
|
|
12425
|
-
"name": ""
|
|
12426
|
-
}
|
|
12427
|
-
],
|
|
12428
|
-
"members": [
|
|
12429
|
-
{
|
|
12430
|
-
"kind": "field",
|
|
12431
|
-
"name": "defaultSlot",
|
|
12432
|
-
"privacy": "private",
|
|
12433
|
-
"default": "new SlotController(this)"
|
|
12434
|
-
},
|
|
12435
|
-
{
|
|
12436
|
-
"kind": "field",
|
|
12437
|
-
"name": "selected",
|
|
12438
|
-
"type": {
|
|
12439
|
-
"text": "boolean"
|
|
12440
|
-
},
|
|
12441
|
-
"default": "false",
|
|
12442
|
-
"description": "Whether the tab item is selected",
|
|
12443
|
-
"attribute": "selected",
|
|
12444
|
-
"reflects": true
|
|
12445
|
-
},
|
|
12446
|
-
{
|
|
12447
|
-
"kind": "method",
|
|
12448
|
-
"name": "handleSelectionChange",
|
|
12449
|
-
"privacy": "protected",
|
|
12450
|
-
"description": "Apply accessible attributes and values to the tab button.\nObserve the selected property if it changes"
|
|
12451
|
-
}
|
|
12452
|
-
],
|
|
12453
|
-
"attributes": [
|
|
12361
|
+
"text": "string | undefined"
|
|
12362
|
+
},
|
|
12363
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12364
|
+
"fieldName": "color"
|
|
12365
|
+
},
|
|
12454
12366
|
{
|
|
12455
|
-
"name": "
|
|
12367
|
+
"name": "label",
|
|
12456
12368
|
"type": {
|
|
12457
|
-
"text": "
|
|
12369
|
+
"text": "string | undefined"
|
|
12458
12370
|
},
|
|
12459
|
-
"
|
|
12460
|
-
"
|
|
12461
|
-
"fieldName": "selected"
|
|
12371
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12372
|
+
"fieldName": "label"
|
|
12462
12373
|
}
|
|
12463
12374
|
],
|
|
12464
12375
|
"superclass": {
|
|
@@ -12467,10 +12378,10 @@
|
|
|
12467
12378
|
},
|
|
12468
12379
|
"localization": [],
|
|
12469
12380
|
"status": "ready",
|
|
12470
|
-
"category": "
|
|
12471
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use
|
|
12381
|
+
"category": "feedback",
|
|
12382
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for indicating users that their action is being processed.\n- Use the label property to provide an accessible label for the spinner. If no label is supplied, the spinner is hidden from assistive technology.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to show progress. Favor a progress bar instead.\n\n</div>\n",
|
|
12472
12383
|
"examples": [],
|
|
12473
|
-
"tagName": "nord-
|
|
12384
|
+
"tagName": "nord-spinner",
|
|
12474
12385
|
"customElement": true
|
|
12475
12386
|
}
|
|
12476
12387
|
],
|
|
@@ -12479,16 +12390,16 @@
|
|
|
12479
12390
|
"kind": "js",
|
|
12480
12391
|
"name": "default",
|
|
12481
12392
|
"declaration": {
|
|
12482
|
-
"name": "
|
|
12483
|
-
"module": "src/
|
|
12393
|
+
"name": "Spinner",
|
|
12394
|
+
"module": "src/spinner/Spinner.ts"
|
|
12484
12395
|
}
|
|
12485
12396
|
},
|
|
12486
12397
|
{
|
|
12487
12398
|
"kind": "custom-element-definition",
|
|
12488
|
-
"name": "nord-
|
|
12399
|
+
"name": "nord-spinner",
|
|
12489
12400
|
"declaration": {
|
|
12490
|
-
"name": "
|
|
12491
|
-
"module": "src/
|
|
12401
|
+
"name": "Spinner",
|
|
12402
|
+
"module": "src/spinner/Spinner.ts"
|
|
12492
12403
|
}
|
|
12493
12404
|
}
|
|
12494
12405
|
]
|
|
@@ -12672,19 +12583,66 @@
|
|
|
12672
12583
|
},
|
|
12673
12584
|
{
|
|
12674
12585
|
"kind": "javascript-module",
|
|
12675
|
-
"path": "src/tab
|
|
12586
|
+
"path": "src/tab/Tab.ts",
|
|
12676
12587
|
"declarations": [
|
|
12677
12588
|
{
|
|
12678
12589
|
"kind": "class",
|
|
12679
|
-
"description": "The
|
|
12680
|
-
"name": "
|
|
12590
|
+
"description": "The interactive tab button for use within the tab group component.",
|
|
12591
|
+
"name": "Tab",
|
|
12592
|
+
"cssProperties": [
|
|
12593
|
+
{
|
|
12594
|
+
"description": "Controls the text color of the tab, using our [color tokens](/tokens/#color).",
|
|
12595
|
+
"name": "--n-tab-color",
|
|
12596
|
+
"default": "var(--n-color-text-weak)"
|
|
12597
|
+
},
|
|
12598
|
+
{
|
|
12599
|
+
"description": "Controls the font weight of the tab, using our [font tokens](/tokens/#font).",
|
|
12600
|
+
"name": "--n-tab-font-weight",
|
|
12601
|
+
"default": "var(--n-font-weight)"
|
|
12602
|
+
}
|
|
12603
|
+
],
|
|
12681
12604
|
"slots": [
|
|
12682
12605
|
{
|
|
12683
|
-
"description": "The tab
|
|
12606
|
+
"description": "The tab button content.",
|
|
12684
12607
|
"name": ""
|
|
12685
12608
|
}
|
|
12686
12609
|
],
|
|
12687
|
-
"members": [
|
|
12610
|
+
"members": [
|
|
12611
|
+
{
|
|
12612
|
+
"kind": "field",
|
|
12613
|
+
"name": "defaultSlot",
|
|
12614
|
+
"privacy": "private",
|
|
12615
|
+
"default": "new SlotController(this)"
|
|
12616
|
+
},
|
|
12617
|
+
{
|
|
12618
|
+
"kind": "field",
|
|
12619
|
+
"name": "selected",
|
|
12620
|
+
"type": {
|
|
12621
|
+
"text": "boolean"
|
|
12622
|
+
},
|
|
12623
|
+
"default": "false",
|
|
12624
|
+
"description": "Whether the tab item is selected",
|
|
12625
|
+
"attribute": "selected",
|
|
12626
|
+
"reflects": true
|
|
12627
|
+
},
|
|
12628
|
+
{
|
|
12629
|
+
"kind": "method",
|
|
12630
|
+
"name": "handleSelectionChange",
|
|
12631
|
+
"privacy": "protected",
|
|
12632
|
+
"description": "Apply accessible attributes and values to the tab button.\nObserve the selected property if it changes"
|
|
12633
|
+
}
|
|
12634
|
+
],
|
|
12635
|
+
"attributes": [
|
|
12636
|
+
{
|
|
12637
|
+
"name": "selected",
|
|
12638
|
+
"type": {
|
|
12639
|
+
"text": "boolean"
|
|
12640
|
+
},
|
|
12641
|
+
"default": "false",
|
|
12642
|
+
"description": "Whether the tab item is selected",
|
|
12643
|
+
"fieldName": "selected"
|
|
12644
|
+
}
|
|
12645
|
+
],
|
|
12688
12646
|
"superclass": {
|
|
12689
12647
|
"name": "LitElement",
|
|
12690
12648
|
"package": "lit"
|
|
@@ -12692,9 +12650,9 @@
|
|
|
12692
12650
|
"localization": [],
|
|
12693
12651
|
"status": "ready",
|
|
12694
12652
|
"category": "navigation",
|
|
12695
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab
|
|
12653
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab component within the tab group component.\n- Use the `selected` option to signify if the tab is selected.\n- Use text, icons and other non-interactive content within the tab.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use the tab component outside of the tab group component.\n- Don't add interactive elements, such as buttons and links, inside the tab component.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular section you wish to show out of order of the tabs UI itself consider using the `selected` option to select the tab but prevent the order of the tabs being affected.\n",
|
|
12696
12654
|
"examples": [],
|
|
12697
|
-
"tagName": "nord-tab
|
|
12655
|
+
"tagName": "nord-tab",
|
|
12698
12656
|
"customElement": true
|
|
12699
12657
|
}
|
|
12700
12658
|
],
|
|
@@ -12703,16 +12661,16 @@
|
|
|
12703
12661
|
"kind": "js",
|
|
12704
12662
|
"name": "default",
|
|
12705
12663
|
"declaration": {
|
|
12706
|
-
"name": "
|
|
12707
|
-
"module": "src/tab
|
|
12664
|
+
"name": "Tab",
|
|
12665
|
+
"module": "src/tab/Tab.ts"
|
|
12708
12666
|
}
|
|
12709
12667
|
},
|
|
12710
12668
|
{
|
|
12711
12669
|
"kind": "custom-element-definition",
|
|
12712
|
-
"name": "nord-tab
|
|
12670
|
+
"name": "nord-tab",
|
|
12713
12671
|
"declaration": {
|
|
12714
|
-
"name": "
|
|
12715
|
-
"module": "src/tab
|
|
12672
|
+
"name": "Tab",
|
|
12673
|
+
"module": "src/tab/Tab.ts"
|
|
12716
12674
|
}
|
|
12717
12675
|
}
|
|
12718
12676
|
]
|
|
@@ -12875,195 +12833,56 @@
|
|
|
12875
12833
|
"privacy": "private",
|
|
12876
12834
|
"parameters": [
|
|
12877
12835
|
{
|
|
12878
|
-
"name": "event",
|
|
12879
|
-
"type": {
|
|
12880
|
-
"text": "KeyboardEvent"
|
|
12881
|
-
}
|
|
12882
|
-
}
|
|
12883
|
-
],
|
|
12884
|
-
"description": "Handle keyboard accessible controls."
|
|
12885
|
-
},
|
|
12886
|
-
{
|
|
12887
|
-
"kind": "method",
|
|
12888
|
-
"name": "updateSelectedTab",
|
|
12889
|
-
"privacy": "private",
|
|
12890
|
-
"parameters": [
|
|
12891
|
-
{
|
|
12892
|
-
"name": "selectedTab",
|
|
12893
|
-
"type": {
|
|
12894
|
-
"text": "Tab"
|
|
12895
|
-
}
|
|
12896
|
-
}
|
|
12897
|
-
],
|
|
12898
|
-
"description": "Update the selected tab button with attributes and values.\nUpdate the tab group state."
|
|
12899
|
-
}
|
|
12900
|
-
],
|
|
12901
|
-
"attributes": [
|
|
12902
|
-
{
|
|
12903
|
-
"name": "label",
|
|
12904
|
-
"type": {
|
|
12905
|
-
"text": "string"
|
|
12906
|
-
},
|
|
12907
|
-
"default": "\"\"",
|
|
12908
|
-
"description": "Adds an accessible label to the tab list container.",
|
|
12909
|
-
"fieldName": "label"
|
|
12910
|
-
},
|
|
12911
|
-
{
|
|
12912
|
-
"name": "padding",
|
|
12913
|
-
"type": {
|
|
12914
|
-
"text": "\"m\" | \"l\" | \"none\" | undefined"
|
|
12915
|
-
},
|
|
12916
|
-
"default": "\"m\"",
|
|
12917
|
-
"description": "Controls the padding of the tab group component.",
|
|
12918
|
-
"fieldName": "padding"
|
|
12919
|
-
},
|
|
12920
|
-
{
|
|
12921
|
-
"name": "sticky",
|
|
12922
|
-
"type": {
|
|
12923
|
-
"text": "boolean"
|
|
12924
|
-
},
|
|
12925
|
-
"default": "false",
|
|
12926
|
-
"description": "Whether the tab list sticks to the top of the tab group as you scroll.",
|
|
12927
|
-
"fieldName": "sticky"
|
|
12928
|
-
}
|
|
12929
|
-
],
|
|
12930
|
-
"superclass": {
|
|
12931
|
-
"name": "LitElement",
|
|
12932
|
-
"package": "lit"
|
|
12933
|
-
},
|
|
12934
|
-
"localization": [],
|
|
12935
|
-
"status": "ready",
|
|
12936
|
-
"category": "navigation",
|
|
12937
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to allow multiple panels to be contained within a single window.\n- Use the tab panel and tab components within the tab group component.\n- Use the tab and tab panel components in order to create a tab group content structure.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use other components to the tab and tab panel within the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n- Don't add a tab or tab panel component without providing an accompanying panel or tab.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the tab component related to the panel to select the tab but prevent the order of the tabs being affected.\n",
|
|
12938
|
-
"examples": [],
|
|
12939
|
-
"tagName": "nord-tab-group",
|
|
12940
|
-
"customElement": true
|
|
12941
|
-
}
|
|
12942
|
-
],
|
|
12943
|
-
"exports": [
|
|
12944
|
-
{
|
|
12945
|
-
"kind": "js",
|
|
12946
|
-
"name": "default",
|
|
12947
|
-
"declaration": {
|
|
12948
|
-
"name": "TabGroup",
|
|
12949
|
-
"module": "src/tab-group/TabGroup.ts"
|
|
12950
|
-
}
|
|
12951
|
-
},
|
|
12952
|
-
{
|
|
12953
|
-
"kind": "custom-element-definition",
|
|
12954
|
-
"name": "nord-tab-group",
|
|
12955
|
-
"declaration": {
|
|
12956
|
-
"name": "TabGroup",
|
|
12957
|
-
"module": "src/tab-group/TabGroup.ts"
|
|
12958
|
-
}
|
|
12959
|
-
}
|
|
12960
|
-
]
|
|
12961
|
-
},
|
|
12962
|
-
{
|
|
12963
|
-
"kind": "javascript-module",
|
|
12964
|
-
"path": "src/toast/Toast.ts",
|
|
12965
|
-
"declarations": [
|
|
12966
|
-
{
|
|
12967
|
-
"kind": "class",
|
|
12968
|
-
"description": "Toasts are non-disruptive messages that appear in the interface\nto provide quick, at-a-glance feedback on the outcome of an action.",
|
|
12969
|
-
"name": "Toast",
|
|
12970
|
-
"slots": [
|
|
12971
|
-
{
|
|
12972
|
-
"description": "Default slot used for the toast text/message.",
|
|
12973
|
-
"name": ""
|
|
12974
|
-
}
|
|
12975
|
-
],
|
|
12976
|
-
"members": [
|
|
12977
|
-
{
|
|
12978
|
-
"kind": "field",
|
|
12979
|
-
"name": "timeoutId",
|
|
12980
|
-
"type": {
|
|
12981
|
-
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
12982
|
-
},
|
|
12983
|
-
"privacy": "private"
|
|
12984
|
-
},
|
|
12985
|
-
{
|
|
12986
|
-
"kind": "field",
|
|
12987
|
-
"name": "events",
|
|
12988
|
-
"privacy": "private",
|
|
12989
|
-
"default": "new EventController(this)"
|
|
12990
|
-
},
|
|
12991
|
-
{
|
|
12992
|
-
"kind": "field",
|
|
12993
|
-
"name": "toast",
|
|
12994
|
-
"type": {
|
|
12995
|
-
"text": "HTMLElement"
|
|
12996
|
-
},
|
|
12997
|
-
"privacy": "private"
|
|
12998
|
-
},
|
|
12999
|
-
{
|
|
13000
|
-
"kind": "field",
|
|
13001
|
-
"name": "dismissed",
|
|
13002
|
-
"type": {
|
|
13003
|
-
"text": "boolean"
|
|
13004
|
-
},
|
|
13005
|
-
"privacy": "private",
|
|
13006
|
-
"default": "false"
|
|
13007
|
-
},
|
|
13008
|
-
{
|
|
13009
|
-
"kind": "field",
|
|
13010
|
-
"name": "variant",
|
|
13011
|
-
"type": {
|
|
13012
|
-
"text": "\"default\" | \"danger\""
|
|
13013
|
-
},
|
|
13014
|
-
"default": "\"default\"",
|
|
13015
|
-
"description": "The style variant of the toast.",
|
|
13016
|
-
"attribute": "variant",
|
|
13017
|
-
"reflects": true
|
|
13018
|
-
},
|
|
13019
|
-
{
|
|
13020
|
-
"kind": "field",
|
|
13021
|
-
"name": "autoDismiss",
|
|
13022
|
-
"type": {
|
|
13023
|
-
"text": "number"
|
|
13024
|
-
},
|
|
13025
|
-
"default": "10000",
|
|
13026
|
-
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
13027
|
-
"attribute": "auto-dismiss"
|
|
13028
|
-
},
|
|
13029
|
-
{
|
|
13030
|
-
"kind": "method",
|
|
13031
|
-
"name": "dismiss",
|
|
13032
|
-
"description": "Programmatically dismiss the toast.\nThe returned promise resolves when toast's exit animation is complete."
|
|
12836
|
+
"name": "event",
|
|
12837
|
+
"type": {
|
|
12838
|
+
"text": "KeyboardEvent"
|
|
12839
|
+
}
|
|
12840
|
+
}
|
|
12841
|
+
],
|
|
12842
|
+
"description": "Handle keyboard accessible controls."
|
|
13033
12843
|
},
|
|
13034
12844
|
{
|
|
13035
12845
|
"kind": "method",
|
|
13036
|
-
"name": "
|
|
13037
|
-
"privacy": "
|
|
12846
|
+
"name": "updateSelectedTab",
|
|
12847
|
+
"privacy": "private",
|
|
12848
|
+
"parameters": [
|
|
12849
|
+
{
|
|
12850
|
+
"name": "selectedTab",
|
|
12851
|
+
"type": {
|
|
12852
|
+
"text": "Tab"
|
|
12853
|
+
}
|
|
12854
|
+
}
|
|
12855
|
+
],
|
|
12856
|
+
"description": "Update the selected tab button with attributes and values.\nUpdate the tab group state."
|
|
13038
12857
|
}
|
|
13039
12858
|
],
|
|
13040
|
-
"
|
|
12859
|
+
"attributes": [
|
|
13041
12860
|
{
|
|
13042
|
-
"name": "
|
|
12861
|
+
"name": "label",
|
|
13043
12862
|
"type": {
|
|
13044
|
-
"text": "
|
|
12863
|
+
"text": "string"
|
|
13045
12864
|
},
|
|
13046
|
-
"
|
|
13047
|
-
|
|
13048
|
-
|
|
13049
|
-
|
|
12865
|
+
"default": "\"\"",
|
|
12866
|
+
"description": "Adds an accessible label to the tab list container.",
|
|
12867
|
+
"fieldName": "label"
|
|
12868
|
+
},
|
|
13050
12869
|
{
|
|
13051
|
-
"name": "
|
|
12870
|
+
"name": "padding",
|
|
13052
12871
|
"type": {
|
|
13053
|
-
"text": "\"
|
|
12872
|
+
"text": "\"m\" | \"l\" | \"none\" | undefined"
|
|
13054
12873
|
},
|
|
13055
|
-
"default": "\"
|
|
13056
|
-
"description": "
|
|
13057
|
-
"fieldName": "
|
|
12874
|
+
"default": "\"m\"",
|
|
12875
|
+
"description": "Controls the padding of the tab group component.",
|
|
12876
|
+
"fieldName": "padding"
|
|
13058
12877
|
},
|
|
13059
12878
|
{
|
|
13060
|
-
"name": "
|
|
12879
|
+
"name": "sticky",
|
|
13061
12880
|
"type": {
|
|
13062
|
-
"text": "
|
|
12881
|
+
"text": "boolean"
|
|
13063
12882
|
},
|
|
13064
|
-
"default": "
|
|
13065
|
-
"description": "
|
|
13066
|
-
"fieldName": "
|
|
12883
|
+
"default": "false",
|
|
12884
|
+
"description": "Whether the tab list sticks to the top of the tab group as you scroll.",
|
|
12885
|
+
"fieldName": "sticky"
|
|
13067
12886
|
}
|
|
13068
12887
|
],
|
|
13069
12888
|
"superclass": {
|
|
@@ -13072,10 +12891,10 @@
|
|
|
13072
12891
|
},
|
|
13073
12892
|
"localization": [],
|
|
13074
12893
|
"status": "ready",
|
|
13075
|
-
"category": "
|
|
13076
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use
|
|
12894
|
+
"category": "navigation",
|
|
12895
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to allow multiple panels to be contained within a single window.\n- Use the tab panel and tab components within the tab group component.\n- Use the tab and tab panel components in order to create a tab group content structure.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use other components to the tab and tab panel within the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n- Don't add a tab or tab panel component without providing an accompanying panel or tab.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the tab component related to the panel to select the tab but prevent the order of the tabs being affected.\n",
|
|
13077
12896
|
"examples": [],
|
|
13078
|
-
"tagName": "nord-
|
|
12897
|
+
"tagName": "nord-tab-group",
|
|
13079
12898
|
"customElement": true
|
|
13080
12899
|
}
|
|
13081
12900
|
],
|
|
@@ -13084,16 +12903,63 @@
|
|
|
13084
12903
|
"kind": "js",
|
|
13085
12904
|
"name": "default",
|
|
13086
12905
|
"declaration": {
|
|
13087
|
-
"name": "
|
|
13088
|
-
"module": "src/
|
|
12906
|
+
"name": "TabGroup",
|
|
12907
|
+
"module": "src/tab-group/TabGroup.ts"
|
|
13089
12908
|
}
|
|
13090
12909
|
},
|
|
13091
12910
|
{
|
|
13092
12911
|
"kind": "custom-element-definition",
|
|
13093
|
-
"name": "nord-
|
|
12912
|
+
"name": "nord-tab-group",
|
|
13094
12913
|
"declaration": {
|
|
13095
|
-
"name": "
|
|
13096
|
-
"module": "src/
|
|
12914
|
+
"name": "TabGroup",
|
|
12915
|
+
"module": "src/tab-group/TabGroup.ts"
|
|
12916
|
+
}
|
|
12917
|
+
}
|
|
12918
|
+
]
|
|
12919
|
+
},
|
|
12920
|
+
{
|
|
12921
|
+
"kind": "javascript-module",
|
|
12922
|
+
"path": "src/tab-panel/TabPanel.ts",
|
|
12923
|
+
"declarations": [
|
|
12924
|
+
{
|
|
12925
|
+
"kind": "class",
|
|
12926
|
+
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
12927
|
+
"name": "TabPanel",
|
|
12928
|
+
"slots": [
|
|
12929
|
+
{
|
|
12930
|
+
"description": "The tab panel content.",
|
|
12931
|
+
"name": ""
|
|
12932
|
+
}
|
|
12933
|
+
],
|
|
12934
|
+
"members": [],
|
|
12935
|
+
"superclass": {
|
|
12936
|
+
"name": "LitElement",
|
|
12937
|
+
"package": "lit"
|
|
12938
|
+
},
|
|
12939
|
+
"localization": [],
|
|
12940
|
+
"status": "ready",
|
|
12941
|
+
"category": "navigation",
|
|
12942
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab panel component within the tab group component.\n- Use both non-interactive and interactive elements within the contents of the tab panel.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use the tab panel component outside of the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the related tab component to select the tab but prevent the order of the tabs being affected.\n",
|
|
12943
|
+
"examples": [],
|
|
12944
|
+
"tagName": "nord-tab-panel",
|
|
12945
|
+
"customElement": true
|
|
12946
|
+
}
|
|
12947
|
+
],
|
|
12948
|
+
"exports": [
|
|
12949
|
+
{
|
|
12950
|
+
"kind": "js",
|
|
12951
|
+
"name": "default",
|
|
12952
|
+
"declaration": {
|
|
12953
|
+
"name": "TabPanel",
|
|
12954
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
12955
|
+
}
|
|
12956
|
+
},
|
|
12957
|
+
{
|
|
12958
|
+
"kind": "custom-element-definition",
|
|
12959
|
+
"name": "nord-tab-panel",
|
|
12960
|
+
"declaration": {
|
|
12961
|
+
"name": "TabPanel",
|
|
12962
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
13097
12963
|
}
|
|
13098
12964
|
}
|
|
13099
12965
|
]
|
|
@@ -14109,6 +13975,145 @@
|
|
|
14109
13975
|
}
|
|
14110
13976
|
]
|
|
14111
13977
|
},
|
|
13978
|
+
{
|
|
13979
|
+
"kind": "javascript-module",
|
|
13980
|
+
"path": "src/toast/Toast.ts",
|
|
13981
|
+
"declarations": [
|
|
13982
|
+
{
|
|
13983
|
+
"kind": "class",
|
|
13984
|
+
"description": "Toasts are non-disruptive messages that appear in the interface\nto provide quick, at-a-glance feedback on the outcome of an action.",
|
|
13985
|
+
"name": "Toast",
|
|
13986
|
+
"slots": [
|
|
13987
|
+
{
|
|
13988
|
+
"description": "Default slot used for the toast text/message.",
|
|
13989
|
+
"name": ""
|
|
13990
|
+
}
|
|
13991
|
+
],
|
|
13992
|
+
"members": [
|
|
13993
|
+
{
|
|
13994
|
+
"kind": "field",
|
|
13995
|
+
"name": "timeoutId",
|
|
13996
|
+
"type": {
|
|
13997
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
13998
|
+
},
|
|
13999
|
+
"privacy": "private"
|
|
14000
|
+
},
|
|
14001
|
+
{
|
|
14002
|
+
"kind": "field",
|
|
14003
|
+
"name": "events",
|
|
14004
|
+
"privacy": "private",
|
|
14005
|
+
"default": "new EventController(this)"
|
|
14006
|
+
},
|
|
14007
|
+
{
|
|
14008
|
+
"kind": "field",
|
|
14009
|
+
"name": "toast",
|
|
14010
|
+
"type": {
|
|
14011
|
+
"text": "HTMLElement"
|
|
14012
|
+
},
|
|
14013
|
+
"privacy": "private"
|
|
14014
|
+
},
|
|
14015
|
+
{
|
|
14016
|
+
"kind": "field",
|
|
14017
|
+
"name": "dismissed",
|
|
14018
|
+
"type": {
|
|
14019
|
+
"text": "boolean"
|
|
14020
|
+
},
|
|
14021
|
+
"privacy": "private",
|
|
14022
|
+
"default": "false"
|
|
14023
|
+
},
|
|
14024
|
+
{
|
|
14025
|
+
"kind": "field",
|
|
14026
|
+
"name": "variant",
|
|
14027
|
+
"type": {
|
|
14028
|
+
"text": "\"default\" | \"danger\""
|
|
14029
|
+
},
|
|
14030
|
+
"default": "\"default\"",
|
|
14031
|
+
"description": "The style variant of the toast.",
|
|
14032
|
+
"attribute": "variant",
|
|
14033
|
+
"reflects": true
|
|
14034
|
+
},
|
|
14035
|
+
{
|
|
14036
|
+
"kind": "field",
|
|
14037
|
+
"name": "autoDismiss",
|
|
14038
|
+
"type": {
|
|
14039
|
+
"text": "number"
|
|
14040
|
+
},
|
|
14041
|
+
"default": "10000",
|
|
14042
|
+
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
14043
|
+
"attribute": "auto-dismiss"
|
|
14044
|
+
},
|
|
14045
|
+
{
|
|
14046
|
+
"kind": "method",
|
|
14047
|
+
"name": "dismiss",
|
|
14048
|
+
"description": "Programmatically dismiss the toast.\nThe returned promise resolves when toast's exit animation is complete."
|
|
14049
|
+
},
|
|
14050
|
+
{
|
|
14051
|
+
"kind": "method",
|
|
14052
|
+
"name": "handleAutoDismissChange",
|
|
14053
|
+
"privacy": "protected"
|
|
14054
|
+
}
|
|
14055
|
+
],
|
|
14056
|
+
"events": [
|
|
14057
|
+
{
|
|
14058
|
+
"name": "dismiss",
|
|
14059
|
+
"type": {
|
|
14060
|
+
"text": "NordEvent"
|
|
14061
|
+
},
|
|
14062
|
+
"description": "Fired when the toast is dismissed (via user action or auto-dismiss), and its exit animation has completed. This event should be used to remove the dismissed toast from the DOM."
|
|
14063
|
+
}
|
|
14064
|
+
],
|
|
14065
|
+
"attributes": [
|
|
14066
|
+
{
|
|
14067
|
+
"name": "variant",
|
|
14068
|
+
"type": {
|
|
14069
|
+
"text": "\"default\" | \"danger\""
|
|
14070
|
+
},
|
|
14071
|
+
"default": "\"default\"",
|
|
14072
|
+
"description": "The style variant of the toast.",
|
|
14073
|
+
"fieldName": "variant"
|
|
14074
|
+
},
|
|
14075
|
+
{
|
|
14076
|
+
"name": "auto-dismiss",
|
|
14077
|
+
"type": {
|
|
14078
|
+
"text": "number"
|
|
14079
|
+
},
|
|
14080
|
+
"default": "10000",
|
|
14081
|
+
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
14082
|
+
"fieldName": "autoDismiss"
|
|
14083
|
+
}
|
|
14084
|
+
],
|
|
14085
|
+
"superclass": {
|
|
14086
|
+
"name": "LitElement",
|
|
14087
|
+
"package": "lit"
|
|
14088
|
+
},
|
|
14089
|
+
"localization": [],
|
|
14090
|
+
"status": "ready",
|
|
14091
|
+
"category": "feedback",
|
|
14092
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for short messages that confirm an action taken by a user.\n- Use for ephemeral status updates.\n- Use in combination with [Toast group](../toast-group/) so that toasts get styled and announced to screen readers correctly.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use toasts for critical information that user needs to act on.\n- Don’t rely on users seeing toasts. Toasts are transient and should not be used for critical messages.\n- Don’t place interactive content in toasts. Assistive technology like screen readers will not convey any semantics when announcing toast messages.\n- Don’t use for error messages unless absolutely necessary. Try to favor a [Banner](/components/banner/) for error messaging instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n",
|
|
14093
|
+
"examples": [],
|
|
14094
|
+
"tagName": "nord-toast",
|
|
14095
|
+
"customElement": true
|
|
14096
|
+
}
|
|
14097
|
+
],
|
|
14098
|
+
"exports": [
|
|
14099
|
+
{
|
|
14100
|
+
"kind": "js",
|
|
14101
|
+
"name": "default",
|
|
14102
|
+
"declaration": {
|
|
14103
|
+
"name": "Toast",
|
|
14104
|
+
"module": "src/toast/Toast.ts"
|
|
14105
|
+
}
|
|
14106
|
+
},
|
|
14107
|
+
{
|
|
14108
|
+
"kind": "custom-element-definition",
|
|
14109
|
+
"name": "nord-toast",
|
|
14110
|
+
"declaration": {
|
|
14111
|
+
"name": "Toast",
|
|
14112
|
+
"module": "src/toast/Toast.ts"
|
|
14113
|
+
}
|
|
14114
|
+
}
|
|
14115
|
+
]
|
|
14116
|
+
},
|
|
14112
14117
|
{
|
|
14113
14118
|
"kind": "javascript-module",
|
|
14114
14119
|
"path": "src/toast-group/ToastGroup.ts",
|