@nordhealth/components 3.18.2 → 3.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +1694 -1642
- package/lib/Avatar.js +1 -1
- package/lib/Avatar.js.map +1 -1
- package/lib/{DropdownItem-DpwKwVOT.js → DropdownItem-CPeMIqN8.js} +2 -2
- package/lib/DropdownItem-CPeMIqN8.js.map +1 -0
- package/lib/DropdownItem.js +1 -1
- package/lib/DropdownItem.js.map +1 -1
- package/lib/IconManager.js +1 -1
- package/lib/Message.js +1 -1
- package/lib/Select.js +1 -1
- package/lib/Select.js.map +1 -1
- package/lib/Stack.js +1 -1
- package/lib/Stack.js.map +1 -1
- package/lib/bundle.js +9 -9
- package/lib/bundle.js.map +1 -1
- package/lib/index.js +1 -1
- package/lib/src/dropdown-item/DropdownItem.d.ts +15 -0
- package/lib/src/select/Select.d.ts +1 -0
- package/lib/src/stack/Stack.d.ts +2 -2
- package/package.json +4 -4
- package/lib/DropdownItem-DpwKwVOT.js.map +0 -1
package/custom-elements.json
CHANGED
|
@@ -673,208 +673,6 @@
|
|
|
673
673
|
}
|
|
674
674
|
]
|
|
675
675
|
},
|
|
676
|
-
{
|
|
677
|
-
"kind": "javascript-module",
|
|
678
|
-
"path": "src/badge/Badge.ts",
|
|
679
|
-
"declarations": [
|
|
680
|
-
{
|
|
681
|
-
"kind": "class",
|
|
682
|
-
"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.",
|
|
683
|
-
"name": "Badge",
|
|
684
|
-
"slots": [
|
|
685
|
-
{
|
|
686
|
-
"description": "The badge content.",
|
|
687
|
-
"name": ""
|
|
688
|
-
},
|
|
689
|
-
{
|
|
690
|
-
"description": "Used to place an icon at the start of badge.",
|
|
691
|
-
"name": "icon"
|
|
692
|
-
}
|
|
693
|
-
],
|
|
694
|
-
"members": [
|
|
695
|
-
{
|
|
696
|
-
"kind": "field",
|
|
697
|
-
"name": "type",
|
|
698
|
-
"type": {
|
|
699
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
700
|
-
},
|
|
701
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
702
|
-
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
703
|
-
"default": "\"neutral\"",
|
|
704
|
-
"attribute": "type",
|
|
705
|
-
"reflects": true
|
|
706
|
-
},
|
|
707
|
-
{
|
|
708
|
-
"kind": "field",
|
|
709
|
-
"name": "variant",
|
|
710
|
-
"type": {
|
|
711
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
712
|
-
},
|
|
713
|
-
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
714
|
-
"default": "\"neutral\"",
|
|
715
|
-
"attribute": "variant",
|
|
716
|
-
"reflects": true
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
"kind": "field",
|
|
720
|
-
"name": "strong",
|
|
721
|
-
"type": {
|
|
722
|
-
"text": "boolean"
|
|
723
|
-
},
|
|
724
|
-
"default": "false",
|
|
725
|
-
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
726
|
-
"attribute": "strong",
|
|
727
|
-
"reflects": true
|
|
728
|
-
}
|
|
729
|
-
],
|
|
730
|
-
"attributes": [
|
|
731
|
-
{
|
|
732
|
-
"name": "type",
|
|
733
|
-
"type": {
|
|
734
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
735
|
-
},
|
|
736
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
737
|
-
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
738
|
-
"default": "\"neutral\"",
|
|
739
|
-
"fieldName": "type"
|
|
740
|
-
},
|
|
741
|
-
{
|
|
742
|
-
"name": "variant",
|
|
743
|
-
"type": {
|
|
744
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
745
|
-
},
|
|
746
|
-
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
747
|
-
"default": "\"neutral\"",
|
|
748
|
-
"fieldName": "variant"
|
|
749
|
-
},
|
|
750
|
-
{
|
|
751
|
-
"name": "strong",
|
|
752
|
-
"type": {
|
|
753
|
-
"text": "boolean"
|
|
754
|
-
},
|
|
755
|
-
"default": "false",
|
|
756
|
-
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
757
|
-
"fieldName": "strong"
|
|
758
|
-
}
|
|
759
|
-
],
|
|
760
|
-
"superclass": {
|
|
761
|
-
"name": "LitElement",
|
|
762
|
-
"package": "lit"
|
|
763
|
-
},
|
|
764
|
-
"localization": [],
|
|
765
|
-
"status": "ready",
|
|
766
|
-
"category": "text",
|
|
767
|
-
"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 easy 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- Don't use badges for labeling, categorizing, or organizing objects. Use the [tag component](/components/tag/) instead.\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",
|
|
768
|
-
"examples": [],
|
|
769
|
-
"dependencies": [],
|
|
770
|
-
"tagName": "nord-badge",
|
|
771
|
-
"customElement": true
|
|
772
|
-
}
|
|
773
|
-
],
|
|
774
|
-
"exports": [
|
|
775
|
-
{
|
|
776
|
-
"kind": "js",
|
|
777
|
-
"name": "default",
|
|
778
|
-
"declaration": {
|
|
779
|
-
"name": "Badge",
|
|
780
|
-
"module": "src/badge/Badge.ts"
|
|
781
|
-
}
|
|
782
|
-
},
|
|
783
|
-
{
|
|
784
|
-
"kind": "custom-element-definition",
|
|
785
|
-
"name": "nord-badge",
|
|
786
|
-
"declaration": {
|
|
787
|
-
"name": "Badge",
|
|
788
|
-
"module": "src/badge/Badge.ts"
|
|
789
|
-
}
|
|
790
|
-
}
|
|
791
|
-
]
|
|
792
|
-
},
|
|
793
|
-
{
|
|
794
|
-
"kind": "javascript-module",
|
|
795
|
-
"path": "src/banner/Banner.ts",
|
|
796
|
-
"declarations": [
|
|
797
|
-
{
|
|
798
|
-
"kind": "class",
|
|
799
|
-
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
800
|
-
"name": "Banner",
|
|
801
|
-
"cssProperties": [
|
|
802
|
-
{
|
|
803
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
804
|
-
"name": "--n-banner-border-radius",
|
|
805
|
-
"default": "var(--n-border-radius)"
|
|
806
|
-
},
|
|
807
|
-
{
|
|
808
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
809
|
-
"name": "--n-banner-box-shadow",
|
|
810
|
-
"default": "var(--n-box-shadow-card)"
|
|
811
|
-
}
|
|
812
|
-
],
|
|
813
|
-
"slots": [
|
|
814
|
-
{
|
|
815
|
-
"description": "default slot",
|
|
816
|
-
"name": ""
|
|
817
|
-
}
|
|
818
|
-
],
|
|
819
|
-
"members": [
|
|
820
|
-
{
|
|
821
|
-
"kind": "field",
|
|
822
|
-
"name": "variant",
|
|
823
|
-
"type": {
|
|
824
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
825
|
-
},
|
|
826
|
-
"default": "\"info\"",
|
|
827
|
-
"description": "The style variant of the banner.",
|
|
828
|
-
"attribute": "variant",
|
|
829
|
-
"reflects": true
|
|
830
|
-
}
|
|
831
|
-
],
|
|
832
|
-
"attributes": [
|
|
833
|
-
{
|
|
834
|
-
"name": "variant",
|
|
835
|
-
"type": {
|
|
836
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
837
|
-
},
|
|
838
|
-
"default": "\"info\"",
|
|
839
|
-
"description": "The style variant of the banner.",
|
|
840
|
-
"fieldName": "variant"
|
|
841
|
-
}
|
|
842
|
-
],
|
|
843
|
-
"superclass": {
|
|
844
|
-
"name": "LitElement",
|
|
845
|
-
"package": "lit"
|
|
846
|
-
},
|
|
847
|
-
"localization": [],
|
|
848
|
-
"status": "ready",
|
|
849
|
-
"category": "feedback",
|
|
850
|
-
"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 this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner 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\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
851
|
-
"examples": [],
|
|
852
|
-
"dependencies": [
|
|
853
|
-
"icon"
|
|
854
|
-
],
|
|
855
|
-
"tagName": "nord-banner",
|
|
856
|
-
"customElement": true
|
|
857
|
-
}
|
|
858
|
-
],
|
|
859
|
-
"exports": [
|
|
860
|
-
{
|
|
861
|
-
"kind": "js",
|
|
862
|
-
"name": "default",
|
|
863
|
-
"declaration": {
|
|
864
|
-
"name": "Banner",
|
|
865
|
-
"module": "src/banner/Banner.ts"
|
|
866
|
-
}
|
|
867
|
-
},
|
|
868
|
-
{
|
|
869
|
-
"kind": "custom-element-definition",
|
|
870
|
-
"name": "nord-banner",
|
|
871
|
-
"declaration": {
|
|
872
|
-
"name": "Banner",
|
|
873
|
-
"module": "src/banner/Banner.ts"
|
|
874
|
-
}
|
|
875
|
-
}
|
|
876
|
-
]
|
|
877
|
-
},
|
|
878
676
|
{
|
|
879
677
|
"kind": "javascript-module",
|
|
880
678
|
"path": "src/button/Button.ts",
|
|
@@ -1488,67 +1286,269 @@
|
|
|
1488
1286
|
},
|
|
1489
1287
|
{
|
|
1490
1288
|
"kind": "javascript-module",
|
|
1491
|
-
"path": "src/
|
|
1289
|
+
"path": "src/banner/Banner.ts",
|
|
1492
1290
|
"declarations": [
|
|
1493
1291
|
{
|
|
1494
1292
|
"kind": "class",
|
|
1495
|
-
"description": "
|
|
1496
|
-
"name": "
|
|
1293
|
+
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
1294
|
+
"name": "Banner",
|
|
1497
1295
|
"cssProperties": [
|
|
1498
1296
|
{
|
|
1499
|
-
"description": "Controls
|
|
1500
|
-
"name": "--n-
|
|
1501
|
-
"default": "var(--n-border-radius
|
|
1297
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1298
|
+
"name": "--n-banner-border-radius",
|
|
1299
|
+
"default": "var(--n-border-radius)"
|
|
1502
1300
|
},
|
|
1503
1301
|
{
|
|
1504
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).
|
|
1505
|
-
"name": "--n-
|
|
1506
|
-
"default": "var(--n-box-shadow)"
|
|
1302
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1303
|
+
"name": "--n-banner-box-shadow",
|
|
1304
|
+
"default": "var(--n-box-shadow-card)"
|
|
1507
1305
|
}
|
|
1508
1306
|
],
|
|
1509
1307
|
"slots": [
|
|
1510
1308
|
{
|
|
1511
|
-
"description": "
|
|
1309
|
+
"description": "default slot",
|
|
1512
1310
|
"name": ""
|
|
1513
1311
|
}
|
|
1514
1312
|
],
|
|
1515
1313
|
"members": [
|
|
1516
|
-
{
|
|
1517
|
-
"kind": "field",
|
|
1518
|
-
"name": "defaultSlot",
|
|
1519
|
-
"privacy": "private",
|
|
1520
|
-
"default": "new SlotController(this)"
|
|
1521
|
-
},
|
|
1522
|
-
{
|
|
1523
|
-
"kind": "field",
|
|
1524
|
-
"name": "dirController",
|
|
1525
|
-
"privacy": "private",
|
|
1526
|
-
"default": "new DirectionController(this)"
|
|
1527
|
-
},
|
|
1528
1314
|
{
|
|
1529
1315
|
"kind": "field",
|
|
1530
1316
|
"name": "variant",
|
|
1531
1317
|
"type": {
|
|
1532
|
-
"text": "\"
|
|
1318
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1533
1319
|
},
|
|
1534
|
-
"default": "\"
|
|
1535
|
-
"description": "The style variant of the
|
|
1320
|
+
"default": "\"info\"",
|
|
1321
|
+
"description": "The style variant of the banner.",
|
|
1536
1322
|
"attribute": "variant",
|
|
1537
1323
|
"reflects": true
|
|
1538
|
-
}
|
|
1324
|
+
}
|
|
1325
|
+
],
|
|
1326
|
+
"attributes": [
|
|
1539
1327
|
{
|
|
1540
|
-
"
|
|
1541
|
-
"name": "direction",
|
|
1328
|
+
"name": "variant",
|
|
1542
1329
|
"type": {
|
|
1543
|
-
"text": "\"
|
|
1330
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1544
1331
|
},
|
|
1545
|
-
"default": "\"
|
|
1546
|
-
"description": "The
|
|
1547
|
-
"
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1332
|
+
"default": "\"info\"",
|
|
1333
|
+
"description": "The style variant of the banner.",
|
|
1334
|
+
"fieldName": "variant"
|
|
1335
|
+
}
|
|
1336
|
+
],
|
|
1337
|
+
"superclass": {
|
|
1338
|
+
"name": "LitElement",
|
|
1339
|
+
"package": "lit"
|
|
1340
|
+
},
|
|
1341
|
+
"localization": [],
|
|
1342
|
+
"status": "ready",
|
|
1343
|
+
"category": "feedback",
|
|
1344
|
+
"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 this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner 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\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
1345
|
+
"examples": [],
|
|
1346
|
+
"dependencies": [
|
|
1347
|
+
"icon"
|
|
1348
|
+
],
|
|
1349
|
+
"tagName": "nord-banner",
|
|
1350
|
+
"customElement": true
|
|
1351
|
+
}
|
|
1352
|
+
],
|
|
1353
|
+
"exports": [
|
|
1354
|
+
{
|
|
1355
|
+
"kind": "js",
|
|
1356
|
+
"name": "default",
|
|
1357
|
+
"declaration": {
|
|
1358
|
+
"name": "Banner",
|
|
1359
|
+
"module": "src/banner/Banner.ts"
|
|
1360
|
+
}
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
"kind": "custom-element-definition",
|
|
1364
|
+
"name": "nord-banner",
|
|
1365
|
+
"declaration": {
|
|
1366
|
+
"name": "Banner",
|
|
1367
|
+
"module": "src/banner/Banner.ts"
|
|
1368
|
+
}
|
|
1369
|
+
}
|
|
1370
|
+
]
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"kind": "javascript-module",
|
|
1374
|
+
"path": "src/badge/Badge.ts",
|
|
1375
|
+
"declarations": [
|
|
1376
|
+
{
|
|
1377
|
+
"kind": "class",
|
|
1378
|
+
"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.",
|
|
1379
|
+
"name": "Badge",
|
|
1380
|
+
"slots": [
|
|
1381
|
+
{
|
|
1382
|
+
"description": "The badge content.",
|
|
1383
|
+
"name": ""
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
"description": "Used to place an icon at the start of badge.",
|
|
1387
|
+
"name": "icon"
|
|
1388
|
+
}
|
|
1389
|
+
],
|
|
1390
|
+
"members": [
|
|
1391
|
+
{
|
|
1392
|
+
"kind": "field",
|
|
1393
|
+
"name": "type",
|
|
1394
|
+
"type": {
|
|
1395
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
1396
|
+
},
|
|
1397
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1398
|
+
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
1399
|
+
"default": "\"neutral\"",
|
|
1400
|
+
"attribute": "type",
|
|
1401
|
+
"reflects": true
|
|
1402
|
+
},
|
|
1403
|
+
{
|
|
1404
|
+
"kind": "field",
|
|
1405
|
+
"name": "variant",
|
|
1406
|
+
"type": {
|
|
1407
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
1408
|
+
},
|
|
1409
|
+
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
1410
|
+
"default": "\"neutral\"",
|
|
1411
|
+
"attribute": "variant",
|
|
1412
|
+
"reflects": true
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
"kind": "field",
|
|
1416
|
+
"name": "strong",
|
|
1417
|
+
"type": {
|
|
1418
|
+
"text": "boolean"
|
|
1419
|
+
},
|
|
1420
|
+
"default": "false",
|
|
1421
|
+
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
1422
|
+
"attribute": "strong",
|
|
1423
|
+
"reflects": true
|
|
1424
|
+
}
|
|
1425
|
+
],
|
|
1426
|
+
"attributes": [
|
|
1427
|
+
{
|
|
1428
|
+
"name": "type",
|
|
1429
|
+
"type": {
|
|
1430
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
1431
|
+
},
|
|
1432
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1433
|
+
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
1434
|
+
"default": "\"neutral\"",
|
|
1435
|
+
"fieldName": "type"
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"name": "variant",
|
|
1439
|
+
"type": {
|
|
1440
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
1441
|
+
},
|
|
1442
|
+
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
1443
|
+
"default": "\"neutral\"",
|
|
1444
|
+
"fieldName": "variant"
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"name": "strong",
|
|
1448
|
+
"type": {
|
|
1449
|
+
"text": "boolean"
|
|
1450
|
+
},
|
|
1451
|
+
"default": "false",
|
|
1452
|
+
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
1453
|
+
"fieldName": "strong"
|
|
1454
|
+
}
|
|
1455
|
+
],
|
|
1456
|
+
"superclass": {
|
|
1457
|
+
"name": "LitElement",
|
|
1458
|
+
"package": "lit"
|
|
1459
|
+
},
|
|
1460
|
+
"localization": [],
|
|
1461
|
+
"status": "ready",
|
|
1462
|
+
"category": "text",
|
|
1463
|
+
"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 easy 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- Don't use badges for labeling, categorizing, or organizing objects. Use the [tag component](/components/tag/) instead.\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",
|
|
1464
|
+
"examples": [],
|
|
1465
|
+
"dependencies": [],
|
|
1466
|
+
"tagName": "nord-badge",
|
|
1467
|
+
"customElement": true
|
|
1468
|
+
}
|
|
1469
|
+
],
|
|
1470
|
+
"exports": [
|
|
1471
|
+
{
|
|
1472
|
+
"kind": "js",
|
|
1473
|
+
"name": "default",
|
|
1474
|
+
"declaration": {
|
|
1475
|
+
"name": "Badge",
|
|
1476
|
+
"module": "src/badge/Badge.ts"
|
|
1477
|
+
}
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"kind": "custom-element-definition",
|
|
1481
|
+
"name": "nord-badge",
|
|
1482
|
+
"declaration": {
|
|
1483
|
+
"name": "Badge",
|
|
1484
|
+
"module": "src/badge/Badge.ts"
|
|
1485
|
+
}
|
|
1486
|
+
}
|
|
1487
|
+
]
|
|
1488
|
+
},
|
|
1489
|
+
{
|
|
1490
|
+
"kind": "javascript-module",
|
|
1491
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
1492
|
+
"declarations": [
|
|
1493
|
+
{
|
|
1494
|
+
"kind": "class",
|
|
1495
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
1496
|
+
"name": "ButtonGroup",
|
|
1497
|
+
"cssProperties": [
|
|
1498
|
+
{
|
|
1499
|
+
"description": "Controls the rounded corners of the button group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
1500
|
+
"name": "--n-button-group-border-radius",
|
|
1501
|
+
"default": "var(--n-border-radius-s)"
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
1505
|
+
"name": "--n-button-group-box-shadow",
|
|
1506
|
+
"default": "var(--n-box-shadow)"
|
|
1507
|
+
}
|
|
1508
|
+
],
|
|
1509
|
+
"slots": [
|
|
1510
|
+
{
|
|
1511
|
+
"description": "The button group content",
|
|
1512
|
+
"name": ""
|
|
1513
|
+
}
|
|
1514
|
+
],
|
|
1515
|
+
"members": [
|
|
1516
|
+
{
|
|
1517
|
+
"kind": "field",
|
|
1518
|
+
"name": "defaultSlot",
|
|
1519
|
+
"privacy": "private",
|
|
1520
|
+
"default": "new SlotController(this)"
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"kind": "field",
|
|
1524
|
+
"name": "dirController",
|
|
1525
|
+
"privacy": "private",
|
|
1526
|
+
"default": "new DirectionController(this)"
|
|
1527
|
+
},
|
|
1528
|
+
{
|
|
1529
|
+
"kind": "field",
|
|
1530
|
+
"name": "variant",
|
|
1531
|
+
"type": {
|
|
1532
|
+
"text": "\"default\" | \"spaced\""
|
|
1533
|
+
},
|
|
1534
|
+
"default": "\"default\"",
|
|
1535
|
+
"description": "The style variant of the button group.",
|
|
1536
|
+
"attribute": "variant",
|
|
1537
|
+
"reflects": true
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"kind": "field",
|
|
1541
|
+
"name": "direction",
|
|
1542
|
+
"type": {
|
|
1543
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1544
|
+
},
|
|
1545
|
+
"default": "\"horizontal\"",
|
|
1546
|
+
"description": "The direction of the button group.",
|
|
1547
|
+
"attribute": "direction",
|
|
1548
|
+
"reflects": true
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"kind": "field",
|
|
1552
1552
|
"name": "wrap",
|
|
1553
1553
|
"type": {
|
|
1554
1554
|
"text": "boolean"
|
|
@@ -1643,155 +1643,32 @@
|
|
|
1643
1643
|
},
|
|
1644
1644
|
{
|
|
1645
1645
|
"kind": "javascript-module",
|
|
1646
|
-
"path": "src/
|
|
1646
|
+
"path": "src/calendar/Calendar.ts",
|
|
1647
1647
|
"declarations": [
|
|
1648
1648
|
{
|
|
1649
1649
|
"kind": "class",
|
|
1650
|
-
"description": "
|
|
1651
|
-
"name": "
|
|
1650
|
+
"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.",
|
|
1651
|
+
"name": "Calendar",
|
|
1652
1652
|
"cssProperties": [
|
|
1653
1653
|
{
|
|
1654
1654
|
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1655
|
-
"name": "--n-
|
|
1655
|
+
"name": "--n-calendar-border-radius",
|
|
1656
1656
|
"default": "var(--n-border-radius)"
|
|
1657
1657
|
},
|
|
1658
1658
|
{
|
|
1659
1659
|
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1660
|
-
"name": "--n-
|
|
1660
|
+
"name": "--n-calendar-box-shadow",
|
|
1661
1661
|
"default": "var(--n-box-shadow-popout)"
|
|
1662
|
-
},
|
|
1663
|
-
{
|
|
1664
|
-
"description": "Controls the padding on all sides of the card.",
|
|
1665
|
-
"name": "--n-card-padding",
|
|
1666
|
-
"default": "var(--n-space-m)"
|
|
1667
|
-
},
|
|
1668
|
-
{
|
|
1669
|
-
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
1670
|
-
"name": "--n-card-slot-padding",
|
|
1671
|
-
"default": "var(--n-space-m)"
|
|
1672
1662
|
}
|
|
1673
1663
|
],
|
|
1674
|
-
"
|
|
1675
|
-
{
|
|
1676
|
-
"description": "The card content.",
|
|
1677
|
-
"name": ""
|
|
1678
|
-
},
|
|
1664
|
+
"members": [
|
|
1679
1665
|
{
|
|
1680
|
-
"
|
|
1681
|
-
"name": "
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
"
|
|
1686
|
-
},
|
|
1687
|
-
{
|
|
1688
|
-
"description": "Optional slot that holds footer content for the card.",
|
|
1689
|
-
"name": "footer"
|
|
1690
|
-
}
|
|
1691
|
-
],
|
|
1692
|
-
"members": [
|
|
1693
|
-
{
|
|
1694
|
-
"kind": "field",
|
|
1695
|
-
"name": "headerSlot",
|
|
1696
|
-
"privacy": "private",
|
|
1697
|
-
"default": "new SlotController(this, \"header\")"
|
|
1698
|
-
},
|
|
1699
|
-
{
|
|
1700
|
-
"kind": "field",
|
|
1701
|
-
"name": "headerEndSlot",
|
|
1702
|
-
"privacy": "private",
|
|
1703
|
-
"default": "new SlotController(this, \"header-end\")"
|
|
1704
|
-
},
|
|
1705
|
-
{
|
|
1706
|
-
"kind": "field",
|
|
1707
|
-
"name": "footerSlot",
|
|
1708
|
-
"privacy": "private",
|
|
1709
|
-
"default": "new SlotController(this, \"footer\")"
|
|
1710
|
-
},
|
|
1711
|
-
{
|
|
1712
|
-
"kind": "field",
|
|
1713
|
-
"name": "padding",
|
|
1714
|
-
"type": {
|
|
1715
|
-
"text": "\"m\" | \"l\" | \"none\""
|
|
1716
|
-
},
|
|
1717
|
-
"default": "\"m\"",
|
|
1718
|
-
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1719
|
-
"attribute": "padding",
|
|
1720
|
-
"reflects": true
|
|
1721
|
-
}
|
|
1722
|
-
],
|
|
1723
|
-
"attributes": [
|
|
1724
|
-
{
|
|
1725
|
-
"name": "padding",
|
|
1726
|
-
"type": {
|
|
1727
|
-
"text": "\"m\" | \"l\" | \"none\""
|
|
1728
|
-
},
|
|
1729
|
-
"default": "\"m\"",
|
|
1730
|
-
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1731
|
-
"fieldName": "padding"
|
|
1732
|
-
}
|
|
1733
|
-
],
|
|
1734
|
-
"superclass": {
|
|
1735
|
-
"name": "LitElement",
|
|
1736
|
-
"package": "lit"
|
|
1737
|
-
},
|
|
1738
|
-
"localization": [],
|
|
1739
|
-
"status": "ready",
|
|
1740
|
-
"category": "structure",
|
|
1741
|
-
"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 display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n- Include a header when placing a [Table](/components/table) component inside the card.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place cards within cards. Consider using the [divider](/components/divider/) component to break up sections instead.\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n",
|
|
1742
|
-
"examples": [],
|
|
1743
|
-
"dependencies": [],
|
|
1744
|
-
"tagName": "nord-card",
|
|
1745
|
-
"customElement": true
|
|
1746
|
-
}
|
|
1747
|
-
],
|
|
1748
|
-
"exports": [
|
|
1749
|
-
{
|
|
1750
|
-
"kind": "js",
|
|
1751
|
-
"name": "default",
|
|
1752
|
-
"declaration": {
|
|
1753
|
-
"name": "Card",
|
|
1754
|
-
"module": "src/card/Card.ts"
|
|
1755
|
-
}
|
|
1756
|
-
},
|
|
1757
|
-
{
|
|
1758
|
-
"kind": "custom-element-definition",
|
|
1759
|
-
"name": "nord-card",
|
|
1760
|
-
"declaration": {
|
|
1761
|
-
"name": "Card",
|
|
1762
|
-
"module": "src/card/Card.ts"
|
|
1763
|
-
}
|
|
1764
|
-
}
|
|
1765
|
-
]
|
|
1766
|
-
},
|
|
1767
|
-
{
|
|
1768
|
-
"kind": "javascript-module",
|
|
1769
|
-
"path": "src/calendar/Calendar.ts",
|
|
1770
|
-
"declarations": [
|
|
1771
|
-
{
|
|
1772
|
-
"kind": "class",
|
|
1773
|
-
"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.",
|
|
1774
|
-
"name": "Calendar",
|
|
1775
|
-
"cssProperties": [
|
|
1776
|
-
{
|
|
1777
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1778
|
-
"name": "--n-calendar-border-radius",
|
|
1779
|
-
"default": "var(--n-border-radius)"
|
|
1780
|
-
},
|
|
1781
|
-
{
|
|
1782
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1783
|
-
"name": "--n-calendar-box-shadow",
|
|
1784
|
-
"default": "var(--n-box-shadow-popout)"
|
|
1785
|
-
}
|
|
1786
|
-
],
|
|
1787
|
-
"members": [
|
|
1788
|
-
{
|
|
1789
|
-
"kind": "field",
|
|
1790
|
-
"name": "monthSelectNode",
|
|
1791
|
-
"type": {
|
|
1792
|
-
"text": "HTMLElement"
|
|
1793
|
-
},
|
|
1794
|
-
"privacy": "private"
|
|
1666
|
+
"kind": "field",
|
|
1667
|
+
"name": "monthSelectNode",
|
|
1668
|
+
"type": {
|
|
1669
|
+
"text": "HTMLElement"
|
|
1670
|
+
},
|
|
1671
|
+
"privacy": "private"
|
|
1795
1672
|
},
|
|
1796
1673
|
{
|
|
1797
1674
|
"kind": "field",
|
|
@@ -2266,6 +2143,129 @@
|
|
|
2266
2143
|
}
|
|
2267
2144
|
]
|
|
2268
2145
|
},
|
|
2146
|
+
{
|
|
2147
|
+
"kind": "javascript-module",
|
|
2148
|
+
"path": "src/card/Card.ts",
|
|
2149
|
+
"declarations": [
|
|
2150
|
+
{
|
|
2151
|
+
"kind": "class",
|
|
2152
|
+
"description": "Cards are shadowed surfaces that display content and actions on a\nsingle topic. They should be easy to scan for relevant and\nactionable information.",
|
|
2153
|
+
"name": "Card",
|
|
2154
|
+
"cssProperties": [
|
|
2155
|
+
{
|
|
2156
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
2157
|
+
"name": "--n-card-border-radius",
|
|
2158
|
+
"default": "var(--n-border-radius)"
|
|
2159
|
+
},
|
|
2160
|
+
{
|
|
2161
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
2162
|
+
"name": "--n-card-box-shadow",
|
|
2163
|
+
"default": "var(--n-box-shadow-popout)"
|
|
2164
|
+
},
|
|
2165
|
+
{
|
|
2166
|
+
"description": "Controls the padding on all sides of the card.",
|
|
2167
|
+
"name": "--n-card-padding",
|
|
2168
|
+
"default": "var(--n-space-m)"
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
2172
|
+
"name": "--n-card-slot-padding",
|
|
2173
|
+
"default": "var(--n-space-m)"
|
|
2174
|
+
}
|
|
2175
|
+
],
|
|
2176
|
+
"slots": [
|
|
2177
|
+
{
|
|
2178
|
+
"description": "The card content.",
|
|
2179
|
+
"name": ""
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"description": "Optional slot that holds a header for the card.",
|
|
2183
|
+
"name": "header"
|
|
2184
|
+
},
|
|
2185
|
+
{
|
|
2186
|
+
"description": "Optional slot that positions content at the end of the header. Useful for actions or additional info.",
|
|
2187
|
+
"name": "header-end"
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"description": "Optional slot that holds footer content for the card.",
|
|
2191
|
+
"name": "footer"
|
|
2192
|
+
}
|
|
2193
|
+
],
|
|
2194
|
+
"members": [
|
|
2195
|
+
{
|
|
2196
|
+
"kind": "field",
|
|
2197
|
+
"name": "headerSlot",
|
|
2198
|
+
"privacy": "private",
|
|
2199
|
+
"default": "new SlotController(this, \"header\")"
|
|
2200
|
+
},
|
|
2201
|
+
{
|
|
2202
|
+
"kind": "field",
|
|
2203
|
+
"name": "headerEndSlot",
|
|
2204
|
+
"privacy": "private",
|
|
2205
|
+
"default": "new SlotController(this, \"header-end\")"
|
|
2206
|
+
},
|
|
2207
|
+
{
|
|
2208
|
+
"kind": "field",
|
|
2209
|
+
"name": "footerSlot",
|
|
2210
|
+
"privacy": "private",
|
|
2211
|
+
"default": "new SlotController(this, \"footer\")"
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"kind": "field",
|
|
2215
|
+
"name": "padding",
|
|
2216
|
+
"type": {
|
|
2217
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
2218
|
+
},
|
|
2219
|
+
"default": "\"m\"",
|
|
2220
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
2221
|
+
"attribute": "padding",
|
|
2222
|
+
"reflects": true
|
|
2223
|
+
}
|
|
2224
|
+
],
|
|
2225
|
+
"attributes": [
|
|
2226
|
+
{
|
|
2227
|
+
"name": "padding",
|
|
2228
|
+
"type": {
|
|
2229
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
2230
|
+
},
|
|
2231
|
+
"default": "\"m\"",
|
|
2232
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
2233
|
+
"fieldName": "padding"
|
|
2234
|
+
}
|
|
2235
|
+
],
|
|
2236
|
+
"superclass": {
|
|
2237
|
+
"name": "LitElement",
|
|
2238
|
+
"package": "lit"
|
|
2239
|
+
},
|
|
2240
|
+
"localization": [],
|
|
2241
|
+
"status": "ready",
|
|
2242
|
+
"category": "structure",
|
|
2243
|
+
"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 display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n- Include a header when placing a [Table](/components/table) component inside the card.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place cards within cards. Consider using the [divider](/components/divider/) component to break up sections instead.\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n",
|
|
2244
|
+
"examples": [],
|
|
2245
|
+
"dependencies": [],
|
|
2246
|
+
"tagName": "nord-card",
|
|
2247
|
+
"customElement": true
|
|
2248
|
+
}
|
|
2249
|
+
],
|
|
2250
|
+
"exports": [
|
|
2251
|
+
{
|
|
2252
|
+
"kind": "js",
|
|
2253
|
+
"name": "default",
|
|
2254
|
+
"declaration": {
|
|
2255
|
+
"name": "Card",
|
|
2256
|
+
"module": "src/card/Card.ts"
|
|
2257
|
+
}
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"kind": "custom-element-definition",
|
|
2261
|
+
"name": "nord-card",
|
|
2262
|
+
"declaration": {
|
|
2263
|
+
"name": "Card",
|
|
2264
|
+
"module": "src/card/Card.ts"
|
|
2265
|
+
}
|
|
2266
|
+
}
|
|
2267
|
+
]
|
|
2268
|
+
},
|
|
2269
2269
|
{
|
|
2270
2270
|
"kind": "javascript-module",
|
|
2271
2271
|
"path": "src/checkbox/Checkbox.ts",
|
|
@@ -6726,23 +6726,61 @@
|
|
|
6726
6726
|
},
|
|
6727
6727
|
{
|
|
6728
6728
|
"kind": "field",
|
|
6729
|
-
"name": "
|
|
6730
|
-
"
|
|
6731
|
-
|
|
6732
|
-
|
|
6733
|
-
|
|
6734
|
-
|
|
6729
|
+
"name": "disabled",
|
|
6730
|
+
"type": {
|
|
6731
|
+
"text": "boolean"
|
|
6732
|
+
},
|
|
6733
|
+
"default": "false",
|
|
6734
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
6735
|
+
"attribute": "disabled",
|
|
6736
|
+
"reflects": true
|
|
6735
6737
|
},
|
|
6736
6738
|
{
|
|
6737
6739
|
"kind": "method",
|
|
6738
|
-
"name": "
|
|
6740
|
+
"name": "renderLink",
|
|
6741
|
+
"privacy": "private",
|
|
6739
6742
|
"parameters": [
|
|
6740
6743
|
{
|
|
6741
|
-
"name": "
|
|
6742
|
-
"optional": true,
|
|
6744
|
+
"name": "innards",
|
|
6743
6745
|
"type": {
|
|
6744
|
-
"text": "
|
|
6745
|
-
}
|
|
6746
|
+
"text": "TemplateResult"
|
|
6747
|
+
}
|
|
6748
|
+
}
|
|
6749
|
+
],
|
|
6750
|
+
"description": "We jump through some hoops here to ensure the link is treated correctly when \"disabled\".\nLinks cannot be disabled natively, so we need to rely on some aria magic to get the correct semantics.\nAlong with the advice in the article below, we also set tabindex to \"-1\", so it is taken out of tab order."
|
|
6751
|
+
},
|
|
6752
|
+
{
|
|
6753
|
+
"kind": "method",
|
|
6754
|
+
"name": "renderButton",
|
|
6755
|
+
"privacy": "private",
|
|
6756
|
+
"parameters": [
|
|
6757
|
+
{
|
|
6758
|
+
"name": "innards",
|
|
6759
|
+
"type": {
|
|
6760
|
+
"text": "TemplateResult"
|
|
6761
|
+
}
|
|
6762
|
+
}
|
|
6763
|
+
]
|
|
6764
|
+
},
|
|
6765
|
+
{
|
|
6766
|
+
"kind": "field",
|
|
6767
|
+
"name": "focusableRef",
|
|
6768
|
+
"privacy": "protected",
|
|
6769
|
+
"inheritedFrom": {
|
|
6770
|
+
"name": "FocusableMixin",
|
|
6771
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
6772
|
+
}
|
|
6773
|
+
},
|
|
6774
|
+
{
|
|
6775
|
+
"kind": "method",
|
|
6776
|
+
"name": "focus",
|
|
6777
|
+
"parameters": [
|
|
6778
|
+
{
|
|
6779
|
+
"name": "options",
|
|
6780
|
+
"optional": true,
|
|
6781
|
+
"type": {
|
|
6782
|
+
"text": "FocusOptions"
|
|
6783
|
+
},
|
|
6746
6784
|
"description": "An object which controls aspects of the focusing process."
|
|
6747
6785
|
}
|
|
6748
6786
|
],
|
|
@@ -6788,6 +6826,15 @@
|
|
|
6788
6826
|
"default": "\"_self\"",
|
|
6789
6827
|
"description": "When provided together with a href property, determines where\nto open the linked URL. The keywords have special meanings for\nwhere to load the URL: “_self” means the current browsing context,\n“_blank” usually a new tab but users can configure browsers this to\nopen a new window instead, “_parent” means the parent browsing\ncontext of the current one, but if no parent exists, behaves as\n_self, and finally “top” means the topmost browsing context.",
|
|
6790
6828
|
"fieldName": "target"
|
|
6829
|
+
},
|
|
6830
|
+
{
|
|
6831
|
+
"name": "disabled",
|
|
6832
|
+
"type": {
|
|
6833
|
+
"text": "boolean"
|
|
6834
|
+
},
|
|
6835
|
+
"default": "false",
|
|
6836
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
6837
|
+
"fieldName": "disabled"
|
|
6791
6838
|
}
|
|
6792
6839
|
],
|
|
6793
6840
|
"mixins": [
|
|
@@ -10545,6 +10592,136 @@
|
|
|
10545
10592
|
}
|
|
10546
10593
|
]
|
|
10547
10594
|
},
|
|
10595
|
+
{
|
|
10596
|
+
"kind": "javascript-module",
|
|
10597
|
+
"path": "src/navigation/Navigation.ts",
|
|
10598
|
+
"declarations": [
|
|
10599
|
+
{
|
|
10600
|
+
"kind": "class",
|
|
10601
|
+
"description": "Navigation is used to display the primary navigation in the sidebar\nof an application. Navigation includes a list of links that users\nuse to move between sections of the application.",
|
|
10602
|
+
"name": "Navigation",
|
|
10603
|
+
"cssProperties": [
|
|
10604
|
+
{
|
|
10605
|
+
"description": "Controls the background color of the navigation element.",
|
|
10606
|
+
"name": "--n-navigation-background-color",
|
|
10607
|
+
"default": "var(--n-color-nav-surface)"
|
|
10608
|
+
}
|
|
10609
|
+
],
|
|
10610
|
+
"slots": [
|
|
10611
|
+
{
|
|
10612
|
+
"description": "The main section of the sidebar, for holding nav components.",
|
|
10613
|
+
"name": ""
|
|
10614
|
+
},
|
|
10615
|
+
{
|
|
10616
|
+
"description": "The top section of the sidebar.",
|
|
10617
|
+
"name": "header"
|
|
10618
|
+
},
|
|
10619
|
+
{
|
|
10620
|
+
"description": "The bottom section of the sidebar.",
|
|
10621
|
+
"name": "footer"
|
|
10622
|
+
}
|
|
10623
|
+
],
|
|
10624
|
+
"members": [
|
|
10625
|
+
{
|
|
10626
|
+
"kind": "field",
|
|
10627
|
+
"name": "headerSlot",
|
|
10628
|
+
"privacy": "private",
|
|
10629
|
+
"default": "new SlotController(this, \"header\")"
|
|
10630
|
+
},
|
|
10631
|
+
{
|
|
10632
|
+
"kind": "field",
|
|
10633
|
+
"name": "events",
|
|
10634
|
+
"privacy": "private",
|
|
10635
|
+
"default": "new EventController(this)"
|
|
10636
|
+
},
|
|
10637
|
+
{
|
|
10638
|
+
"kind": "field",
|
|
10639
|
+
"name": "allowItemsToRemainOpen",
|
|
10640
|
+
"type": {
|
|
10641
|
+
"text": "boolean"
|
|
10642
|
+
},
|
|
10643
|
+
"privacy": "private",
|
|
10644
|
+
"default": "false"
|
|
10645
|
+
},
|
|
10646
|
+
{
|
|
10647
|
+
"kind": "field",
|
|
10648
|
+
"name": "stickyFooter",
|
|
10649
|
+
"type": {
|
|
10650
|
+
"text": "boolean"
|
|
10651
|
+
},
|
|
10652
|
+
"default": "false",
|
|
10653
|
+
"description": "Controls whether the navigations's footer has sticky positioning.",
|
|
10654
|
+
"attribute": "sticky-footer",
|
|
10655
|
+
"reflects": true
|
|
10656
|
+
},
|
|
10657
|
+
{
|
|
10658
|
+
"kind": "field",
|
|
10659
|
+
"name": "handleActivate",
|
|
10660
|
+
"privacy": "private"
|
|
10661
|
+
}
|
|
10662
|
+
],
|
|
10663
|
+
"events": [
|
|
10664
|
+
{
|
|
10665
|
+
"type": {
|
|
10666
|
+
"text": "NordEvent"
|
|
10667
|
+
},
|
|
10668
|
+
"description": "Dispatched whenever a nav item's state changes between open and closed.",
|
|
10669
|
+
"name": "toggle"
|
|
10670
|
+
},
|
|
10671
|
+
{
|
|
10672
|
+
"type": {
|
|
10673
|
+
"text": "NordEvent"
|
|
10674
|
+
},
|
|
10675
|
+
"description": "Dispatched whenever a nav item has been marked as active",
|
|
10676
|
+
"name": "activate"
|
|
10677
|
+
}
|
|
10678
|
+
],
|
|
10679
|
+
"attributes": [
|
|
10680
|
+
{
|
|
10681
|
+
"name": "sticky-footer",
|
|
10682
|
+
"type": {
|
|
10683
|
+
"text": "boolean"
|
|
10684
|
+
},
|
|
10685
|
+
"default": "false",
|
|
10686
|
+
"description": "Controls whether the navigations's footer has sticky positioning.",
|
|
10687
|
+
"fieldName": "stickyFooter"
|
|
10688
|
+
}
|
|
10689
|
+
],
|
|
10690
|
+
"superclass": {
|
|
10691
|
+
"name": "LitElement",
|
|
10692
|
+
"package": "lit"
|
|
10693
|
+
},
|
|
10694
|
+
"localization": [],
|
|
10695
|
+
"status": "ready",
|
|
10696
|
+
"category": "navigation",
|
|
10697
|
+
"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 primary navigation items that perform an action when clicked. Each action should navigate to a URL or trigger another action like a modal overlay.\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 place a `<nav>` element inside the navigation component, as it already contains one internally.\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",
|
|
10698
|
+
"examples": [],
|
|
10699
|
+
"dependencies": [
|
|
10700
|
+
"nav-item"
|
|
10701
|
+
],
|
|
10702
|
+
"tagName": "nord-navigation",
|
|
10703
|
+
"customElement": true
|
|
10704
|
+
}
|
|
10705
|
+
],
|
|
10706
|
+
"exports": [
|
|
10707
|
+
{
|
|
10708
|
+
"kind": "js",
|
|
10709
|
+
"name": "default",
|
|
10710
|
+
"declaration": {
|
|
10711
|
+
"name": "Navigation",
|
|
10712
|
+
"module": "src/navigation/Navigation.ts"
|
|
10713
|
+
}
|
|
10714
|
+
},
|
|
10715
|
+
{
|
|
10716
|
+
"kind": "custom-element-definition",
|
|
10717
|
+
"name": "nord-navigation",
|
|
10718
|
+
"declaration": {
|
|
10719
|
+
"name": "Navigation",
|
|
10720
|
+
"module": "src/navigation/Navigation.ts"
|
|
10721
|
+
}
|
|
10722
|
+
}
|
|
10723
|
+
]
|
|
10724
|
+
},
|
|
10548
10725
|
{
|
|
10549
10726
|
"kind": "javascript-module",
|
|
10550
10727
|
"path": "src/notification/Notification.ts",
|
|
@@ -10688,97 +10865,26 @@
|
|
|
10688
10865
|
},
|
|
10689
10866
|
{
|
|
10690
10867
|
"kind": "javascript-module",
|
|
10691
|
-
"path": "src/
|
|
10868
|
+
"path": "src/notification-group/NotificationGroup.ts",
|
|
10692
10869
|
"declarations": [
|
|
10693
10870
|
{
|
|
10694
10871
|
"kind": "class",
|
|
10695
|
-
"description": "
|
|
10696
|
-
"name": "
|
|
10697
|
-
"cssProperties": [
|
|
10698
|
-
{
|
|
10699
|
-
"description": "Controls the background color of the navigation element.",
|
|
10700
|
-
"name": "--n-navigation-background-color",
|
|
10701
|
-
"default": "var(--n-color-nav-surface)"
|
|
10702
|
-
}
|
|
10703
|
-
],
|
|
10872
|
+
"description": "Notification group is used to position and style a group of notifications.",
|
|
10873
|
+
"name": "NotificationGroup",
|
|
10704
10874
|
"slots": [
|
|
10705
10875
|
{
|
|
10706
|
-
"description": "
|
|
10876
|
+
"description": "Default slot in which to place notifications.",
|
|
10707
10877
|
"name": ""
|
|
10708
|
-
},
|
|
10709
|
-
{
|
|
10710
|
-
"description": "The top section of the sidebar.",
|
|
10711
|
-
"name": "header"
|
|
10712
|
-
},
|
|
10713
|
-
{
|
|
10714
|
-
"description": "The bottom section of the sidebar.",
|
|
10715
|
-
"name": "footer"
|
|
10716
|
-
}
|
|
10717
|
-
],
|
|
10718
|
-
"members": [
|
|
10719
|
-
{
|
|
10720
|
-
"kind": "field",
|
|
10721
|
-
"name": "headerSlot",
|
|
10722
|
-
"privacy": "private",
|
|
10723
|
-
"default": "new SlotController(this, \"header\")"
|
|
10724
|
-
},
|
|
10725
|
-
{
|
|
10726
|
-
"kind": "field",
|
|
10727
|
-
"name": "events",
|
|
10728
|
-
"privacy": "private",
|
|
10729
|
-
"default": "new EventController(this)"
|
|
10730
|
-
},
|
|
10731
|
-
{
|
|
10732
|
-
"kind": "field",
|
|
10733
|
-
"name": "allowItemsToRemainOpen",
|
|
10734
|
-
"type": {
|
|
10735
|
-
"text": "boolean"
|
|
10736
|
-
},
|
|
10737
|
-
"privacy": "private",
|
|
10738
|
-
"default": "false"
|
|
10739
|
-
},
|
|
10740
|
-
{
|
|
10741
|
-
"kind": "field",
|
|
10742
|
-
"name": "stickyFooter",
|
|
10743
|
-
"type": {
|
|
10744
|
-
"text": "boolean"
|
|
10745
|
-
},
|
|
10746
|
-
"default": "false",
|
|
10747
|
-
"description": "Controls whether the navigations's footer has sticky positioning.",
|
|
10748
|
-
"attribute": "sticky-footer",
|
|
10749
|
-
"reflects": true
|
|
10750
|
-
},
|
|
10751
|
-
{
|
|
10752
|
-
"kind": "field",
|
|
10753
|
-
"name": "handleActivate",
|
|
10754
|
-
"privacy": "private"
|
|
10755
10878
|
}
|
|
10756
10879
|
],
|
|
10880
|
+
"members": [],
|
|
10757
10881
|
"events": [
|
|
10758
10882
|
{
|
|
10759
10883
|
"type": {
|
|
10760
10884
|
"text": "NordEvent"
|
|
10761
10885
|
},
|
|
10762
|
-
"description": "
|
|
10763
|
-
"name": "
|
|
10764
|
-
},
|
|
10765
|
-
{
|
|
10766
|
-
"type": {
|
|
10767
|
-
"text": "NordEvent"
|
|
10768
|
-
},
|
|
10769
|
-
"description": "Dispatched whenever a nav item has been marked as active",
|
|
10770
|
-
"name": "activate"
|
|
10771
|
-
}
|
|
10772
|
-
],
|
|
10773
|
-
"attributes": [
|
|
10774
|
-
{
|
|
10775
|
-
"name": "sticky-footer",
|
|
10776
|
-
"type": {
|
|
10777
|
-
"text": "boolean"
|
|
10778
|
-
},
|
|
10779
|
-
"default": "false",
|
|
10780
|
-
"description": "Controls whether the navigations's footer has sticky positioning.",
|
|
10781
|
-
"fieldName": "stickyFooter"
|
|
10886
|
+
"description": "Fired when a notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
10887
|
+
"name": "dismiss"
|
|
10782
10888
|
}
|
|
10783
10889
|
],
|
|
10784
10890
|
"superclass": {
|
|
@@ -10787,13 +10893,11 @@
|
|
|
10787
10893
|
},
|
|
10788
10894
|
"localization": [],
|
|
10789
10895
|
"status": "ready",
|
|
10790
|
-
"category": "
|
|
10791
|
-
"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
|
|
10896
|
+
"category": "feedback",
|
|
10897
|
+
"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 in combination with [Notification](/components/notification/) so that notifications get styled and positioned correctly.\n- Add as close to the start of your main content area as possible.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than notification components\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification 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\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link 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\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
10792
10898
|
"examples": [],
|
|
10793
|
-
"dependencies": [
|
|
10794
|
-
|
|
10795
|
-
],
|
|
10796
|
-
"tagName": "nord-navigation",
|
|
10899
|
+
"dependencies": [],
|
|
10900
|
+
"tagName": "nord-notification-group",
|
|
10797
10901
|
"customElement": true
|
|
10798
10902
|
}
|
|
10799
10903
|
],
|
|
@@ -10802,16 +10906,16 @@
|
|
|
10802
10906
|
"kind": "js",
|
|
10803
10907
|
"name": "default",
|
|
10804
10908
|
"declaration": {
|
|
10805
|
-
"name": "
|
|
10806
|
-
"module": "src/
|
|
10909
|
+
"name": "NotificationGroup",
|
|
10910
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10807
10911
|
}
|
|
10808
10912
|
},
|
|
10809
10913
|
{
|
|
10810
10914
|
"kind": "custom-element-definition",
|
|
10811
|
-
"name": "nord-
|
|
10915
|
+
"name": "nord-notification-group",
|
|
10812
10916
|
"declaration": {
|
|
10813
|
-
"name": "
|
|
10814
|
-
"module": "src/
|
|
10917
|
+
"name": "NotificationGroup",
|
|
10918
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10815
10919
|
}
|
|
10816
10920
|
}
|
|
10817
10921
|
]
|
|
@@ -11159,63 +11263,6 @@
|
|
|
11159
11263
|
}
|
|
11160
11264
|
]
|
|
11161
11265
|
},
|
|
11162
|
-
{
|
|
11163
|
-
"kind": "javascript-module",
|
|
11164
|
-
"path": "src/notification-group/NotificationGroup.ts",
|
|
11165
|
-
"declarations": [
|
|
11166
|
-
{
|
|
11167
|
-
"kind": "class",
|
|
11168
|
-
"description": "Notification group is used to position and style a group of notifications.",
|
|
11169
|
-
"name": "NotificationGroup",
|
|
11170
|
-
"slots": [
|
|
11171
|
-
{
|
|
11172
|
-
"description": "Default slot in which to place notifications.",
|
|
11173
|
-
"name": ""
|
|
11174
|
-
}
|
|
11175
|
-
],
|
|
11176
|
-
"members": [],
|
|
11177
|
-
"events": [
|
|
11178
|
-
{
|
|
11179
|
-
"type": {
|
|
11180
|
-
"text": "NordEvent"
|
|
11181
|
-
},
|
|
11182
|
-
"description": "Fired when a notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
11183
|
-
"name": "dismiss"
|
|
11184
|
-
}
|
|
11185
|
-
],
|
|
11186
|
-
"superclass": {
|
|
11187
|
-
"name": "LitElement",
|
|
11188
|
-
"package": "lit"
|
|
11189
|
-
},
|
|
11190
|
-
"localization": [],
|
|
11191
|
-
"status": "ready",
|
|
11192
|
-
"category": "feedback",
|
|
11193
|
-
"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 in combination with [Notification](/components/notification/) so that notifications get styled and positioned correctly.\n- Add as close to the start of your main content area as possible.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than notification components\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification 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\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link 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\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
11194
|
-
"examples": [],
|
|
11195
|
-
"dependencies": [],
|
|
11196
|
-
"tagName": "nord-notification-group",
|
|
11197
|
-
"customElement": true
|
|
11198
|
-
}
|
|
11199
|
-
],
|
|
11200
|
-
"exports": [
|
|
11201
|
-
{
|
|
11202
|
-
"kind": "js",
|
|
11203
|
-
"name": "default",
|
|
11204
|
-
"declaration": {
|
|
11205
|
-
"name": "NotificationGroup",
|
|
11206
|
-
"module": "src/notification-group/NotificationGroup.ts"
|
|
11207
|
-
}
|
|
11208
|
-
},
|
|
11209
|
-
{
|
|
11210
|
-
"kind": "custom-element-definition",
|
|
11211
|
-
"name": "nord-notification-group",
|
|
11212
|
-
"declaration": {
|
|
11213
|
-
"name": "NotificationGroup",
|
|
11214
|
-
"module": "src/notification-group/NotificationGroup.ts"
|
|
11215
|
-
}
|
|
11216
|
-
}
|
|
11217
|
-
]
|
|
11218
|
-
},
|
|
11219
11266
|
{
|
|
11220
11267
|
"kind": "javascript-module",
|
|
11221
11268
|
"path": "src/progress-bar/ProgressBar.ts",
|
|
@@ -11577,32 +11624,17 @@
|
|
|
11577
11624
|
},
|
|
11578
11625
|
{
|
|
11579
11626
|
"kind": "javascript-module",
|
|
11580
|
-
"path": "src/
|
|
11627
|
+
"path": "src/radio/Radio.ts",
|
|
11581
11628
|
"declarations": [
|
|
11582
11629
|
{
|
|
11583
11630
|
"kind": "class",
|
|
11584
|
-
"description": "
|
|
11585
|
-
"name": "
|
|
11631
|
+
"description": "Radio buttons are graphical user interface elements that allow user to choose only one option from\na predefined set of mutually exclusive options.",
|
|
11632
|
+
"name": "Radio",
|
|
11586
11633
|
"cssProperties": [
|
|
11587
11634
|
{
|
|
11588
|
-
"description": "Controls the
|
|
11589
|
-
"name": "--n-
|
|
11590
|
-
"default": "
|
|
11591
|
-
},
|
|
11592
|
-
{
|
|
11593
|
-
"description": "Controls the color of the portion of the track that represents the current value.",
|
|
11594
|
-
"name": "--n-range-track-color-active",
|
|
11595
|
-
"default": "var(--n-color-accent)"
|
|
11596
|
-
},
|
|
11597
|
-
{
|
|
11598
|
-
"description": "Controls the color of the portion of the track that represents the remaining value.",
|
|
11599
|
-
"name": "--n-range-track-color-inactive",
|
|
11600
|
-
"default": "var(--n-color-border-strong)"
|
|
11601
|
-
},
|
|
11602
|
-
{
|
|
11603
|
-
"description": "Controls the height of the track.",
|
|
11604
|
-
"name": "--n-range-track-size",
|
|
11605
|
-
"default": "3px"
|
|
11635
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
11636
|
+
"name": "--n-label-color",
|
|
11637
|
+
"default": "var(--n-color-text)"
|
|
11606
11638
|
}
|
|
11607
11639
|
],
|
|
11608
11640
|
"slots": [
|
|
@@ -11622,66 +11654,38 @@
|
|
|
11622
11654
|
"members": [
|
|
11623
11655
|
{
|
|
11624
11656
|
"kind": "field",
|
|
11625
|
-
"name": "
|
|
11626
|
-
"privacy": "private",
|
|
11627
|
-
"default": "new DirectionController(this)"
|
|
11628
|
-
},
|
|
11629
|
-
{
|
|
11630
|
-
"kind": "field",
|
|
11631
|
-
"name": "min",
|
|
11632
|
-
"type": {
|
|
11633
|
-
"text": "number"
|
|
11634
|
-
},
|
|
11635
|
-
"default": "0",
|
|
11636
|
-
"description": "Minimum value for the range slider.",
|
|
11637
|
-
"attribute": "min",
|
|
11638
|
-
"reflects": true
|
|
11639
|
-
},
|
|
11640
|
-
{
|
|
11641
|
-
"kind": "field",
|
|
11642
|
-
"name": "max",
|
|
11657
|
+
"name": "inputId",
|
|
11643
11658
|
"type": {
|
|
11644
|
-
"text": "
|
|
11659
|
+
"text": "string"
|
|
11645
11660
|
},
|
|
11646
|
-
"
|
|
11647
|
-
"
|
|
11648
|
-
"
|
|
11649
|
-
|
|
11661
|
+
"privacy": "protected",
|
|
11662
|
+
"default": "\"input\"",
|
|
11663
|
+
"inheritedFrom": {
|
|
11664
|
+
"name": "FormAssociatedMixin",
|
|
11665
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
11666
|
+
}
|
|
11650
11667
|
},
|
|
11651
11668
|
{
|
|
11652
11669
|
"kind": "field",
|
|
11653
|
-
"name": "
|
|
11670
|
+
"name": "hintId",
|
|
11654
11671
|
"type": {
|
|
11655
|
-
"text": "
|
|
11672
|
+
"text": "string"
|
|
11656
11673
|
},
|
|
11657
|
-
"
|
|
11658
|
-
"
|
|
11659
|
-
"
|
|
11660
|
-
|
|
11674
|
+
"privacy": "protected",
|
|
11675
|
+
"default": "\"hint\"",
|
|
11676
|
+
"inheritedFrom": {
|
|
11677
|
+
"name": "FormAssociatedMixin",
|
|
11678
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
11679
|
+
}
|
|
11661
11680
|
},
|
|
11662
11681
|
{
|
|
11663
11682
|
"kind": "field",
|
|
11664
|
-
"name": "
|
|
11683
|
+
"name": "errorId",
|
|
11665
11684
|
"type": {
|
|
11666
|
-
"text": "
|
|
11685
|
+
"text": "string"
|
|
11667
11686
|
},
|
|
11668
|
-
"default": "false",
|
|
11669
|
-
"description": "Controls whether the input expands to fill the width of its container.",
|
|
11670
|
-
"attribute": "expand",
|
|
11671
|
-
"reflects": true
|
|
11672
|
-
},
|
|
11673
|
-
{
|
|
11674
|
-
"kind": "method",
|
|
11675
|
-
"name": "handleInput",
|
|
11676
11687
|
"privacy": "protected",
|
|
11677
|
-
"
|
|
11678
|
-
{
|
|
11679
|
-
"name": "e",
|
|
11680
|
-
"type": {
|
|
11681
|
-
"text": "Event"
|
|
11682
|
-
}
|
|
11683
|
-
}
|
|
11684
|
-
],
|
|
11688
|
+
"default": "\"error\"",
|
|
11685
11689
|
"inheritedFrom": {
|
|
11686
11690
|
"name": "FormAssociatedMixin",
|
|
11687
11691
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11689,9 +11693,10 @@
|
|
|
11689
11693
|
},
|
|
11690
11694
|
{
|
|
11691
11695
|
"kind": "field",
|
|
11692
|
-
"name": "
|
|
11696
|
+
"name": "hintSlot",
|
|
11693
11697
|
"privacy": "protected",
|
|
11694
|
-
"default": "new
|
|
11698
|
+
"default": "new LightSlotController(this, { slotName: \"hint\", render: () => (this.hint ? html`<div slot=\"hint-internal\" id=${this.hintId}>${this.hint}</div>` : nothing), syncLightDom: element => { element.id = this.hintId }, })",
|
|
11699
|
+
"description": "For accessibility reasons, we render some parts of the component to the light DOM.",
|
|
11695
11700
|
"inheritedFrom": {
|
|
11696
11701
|
"name": "FormAssociatedMixin",
|
|
11697
11702
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11699,9 +11704,9 @@
|
|
|
11699
11704
|
},
|
|
11700
11705
|
{
|
|
11701
11706
|
"kind": "field",
|
|
11702
|
-
"name": "
|
|
11707
|
+
"name": "labelSlot",
|
|
11703
11708
|
"privacy": "protected",
|
|
11704
|
-
"default": "new
|
|
11709
|
+
"default": "new LightSlotController(this, { slotName: \"label\", render: () => (this.label ? html`<label slot=\"label-internal\" for=${this.inputId}>${this.label}</label>` : nothing), syncLightDom: element => { if (!isLabel(element)) { // eslint-disable-next-line no-console console.warn(`NORD: Only <label> elements should be placed in radio's \"label\" slot`) } else { element.htmlFor = this.inputId } }, })",
|
|
11705
11710
|
"inheritedFrom": {
|
|
11706
11711
|
"name": "FormAssociatedMixin",
|
|
11707
11712
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11709,9 +11714,9 @@
|
|
|
11709
11714
|
},
|
|
11710
11715
|
{
|
|
11711
11716
|
"kind": "field",
|
|
11712
|
-
"name": "
|
|
11717
|
+
"name": "errorSlot",
|
|
11713
11718
|
"privacy": "protected",
|
|
11714
|
-
"default": "new
|
|
11719
|
+
"default": "new LightSlotController(this, { slotName: \"error\", render: () => (this.error ? html`<div slot=\"error-internal\" id=${this.errorId}>${this.error}</div>` : nothing), syncLightDom: element => { element.id = this.hintId }, })",
|
|
11715
11720
|
"inheritedFrom": {
|
|
11716
11721
|
"name": "FormAssociatedMixin",
|
|
11717
11722
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11719,13 +11724,9 @@
|
|
|
11719
11724
|
},
|
|
11720
11725
|
{
|
|
11721
11726
|
"kind": "field",
|
|
11722
|
-
"name": "
|
|
11727
|
+
"name": "inputSlot",
|
|
11723
11728
|
"privacy": "protected",
|
|
11724
|
-
"default": "new
|
|
11725
|
-
"inheritedFrom": {
|
|
11726
|
-
"name": "FormAssociatedMixin",
|
|
11727
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
11728
|
-
}
|
|
11729
|
+
"default": "new LightDomController(this, { render: () => html` <input slot=\"input\" @blur=${this.handleBlur} @focus=${this.handleFocus} ${ref(this.focusableRef)} class=\"n-input\" id=${this.inputId} type=\"radio\" name=${cond(this.name)} .value=${cond(this.value)} .checked=${this.checked} ?disabled=${this.disabled} ?required=${this.required} aria-describedby=${cond(this.getDescribedBy())} aria-invalid=${cond(this.getInvalid())} form=${cond(this._formId)} /> `, })"
|
|
11729
11730
|
},
|
|
11730
11731
|
{
|
|
11731
11732
|
"kind": "field",
|
|
@@ -11739,25 +11740,50 @@
|
|
|
11739
11740
|
},
|
|
11740
11741
|
{
|
|
11741
11742
|
"kind": "field",
|
|
11742
|
-
"name": "
|
|
11743
|
+
"name": "checked",
|
|
11743
11744
|
"type": {
|
|
11744
|
-
"text": "
|
|
11745
|
+
"text": "boolean"
|
|
11745
11746
|
},
|
|
11747
|
+
"default": "false",
|
|
11748
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
11749
|
+
"attribute": "checked",
|
|
11750
|
+
"reflects": true
|
|
11751
|
+
},
|
|
11752
|
+
{
|
|
11753
|
+
"kind": "method",
|
|
11754
|
+
"name": "handleCheckedChange",
|
|
11746
11755
|
"privacy": "protected",
|
|
11747
|
-
"
|
|
11748
|
-
|
|
11749
|
-
|
|
11750
|
-
|
|
11751
|
-
|
|
11756
|
+
"parameters": [
|
|
11757
|
+
{
|
|
11758
|
+
"name": "previousChecked",
|
|
11759
|
+
"type": {
|
|
11760
|
+
"text": "boolean"
|
|
11761
|
+
}
|
|
11762
|
+
}
|
|
11763
|
+
]
|
|
11752
11764
|
},
|
|
11753
11765
|
{
|
|
11754
|
-
"kind": "
|
|
11755
|
-
"name": "
|
|
11756
|
-
"
|
|
11757
|
-
|
|
11758
|
-
|
|
11766
|
+
"kind": "method",
|
|
11767
|
+
"name": "uncheckSiblings",
|
|
11768
|
+
"privacy": "private"
|
|
11769
|
+
},
|
|
11770
|
+
{
|
|
11771
|
+
"kind": "method",
|
|
11772
|
+
"name": "handleChange",
|
|
11759
11773
|
"privacy": "protected",
|
|
11760
|
-
"
|
|
11774
|
+
"parameters": [
|
|
11775
|
+
{
|
|
11776
|
+
"name": "e",
|
|
11777
|
+
"type": {
|
|
11778
|
+
"text": "Event"
|
|
11779
|
+
}
|
|
11780
|
+
}
|
|
11781
|
+
],
|
|
11782
|
+
"return": {
|
|
11783
|
+
"type": {
|
|
11784
|
+
"text": "void"
|
|
11785
|
+
}
|
|
11786
|
+
},
|
|
11761
11787
|
"inheritedFrom": {
|
|
11762
11788
|
"name": "FormAssociatedMixin",
|
|
11763
11789
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11765,14 +11791,36 @@
|
|
|
11765
11791
|
},
|
|
11766
11792
|
{
|
|
11767
11793
|
"kind": "field",
|
|
11768
|
-
"name": "
|
|
11769
|
-
"
|
|
11770
|
-
|
|
11771
|
-
|
|
11772
|
-
"
|
|
11773
|
-
"
|
|
11774
|
-
"
|
|
11775
|
-
|
|
11794
|
+
"name": "handleBlur",
|
|
11795
|
+
"privacy": "private"
|
|
11796
|
+
},
|
|
11797
|
+
{
|
|
11798
|
+
"kind": "field",
|
|
11799
|
+
"name": "handleFocus",
|
|
11800
|
+
"privacy": "private"
|
|
11801
|
+
},
|
|
11802
|
+
{
|
|
11803
|
+
"kind": "field",
|
|
11804
|
+
"name": "size",
|
|
11805
|
+
"type": {
|
|
11806
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
11807
|
+
},
|
|
11808
|
+
"default": "\"m\"",
|
|
11809
|
+
"description": "The size of the component.",
|
|
11810
|
+
"attribute": "size",
|
|
11811
|
+
"reflects": true,
|
|
11812
|
+
"inheritedFrom": {
|
|
11813
|
+
"name": "SizeMixin",
|
|
11814
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
11815
|
+
}
|
|
11816
|
+
},
|
|
11817
|
+
{
|
|
11818
|
+
"kind": "field",
|
|
11819
|
+
"name": "formData",
|
|
11820
|
+
"privacy": "protected",
|
|
11821
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
11822
|
+
"inheritedFrom": {
|
|
11823
|
+
"name": "FormAssociatedMixin",
|
|
11776
11824
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
11777
11825
|
}
|
|
11778
11826
|
},
|
|
@@ -11880,7 +11928,7 @@
|
|
|
11880
11928
|
},
|
|
11881
11929
|
{
|
|
11882
11930
|
"kind": "method",
|
|
11883
|
-
"name": "
|
|
11931
|
+
"name": "handleInput",
|
|
11884
11932
|
"privacy": "protected",
|
|
11885
11933
|
"parameters": [
|
|
11886
11934
|
{
|
|
@@ -11960,35 +12008,6 @@
|
|
|
11960
12008
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
11961
12009
|
}
|
|
11962
12010
|
},
|
|
11963
|
-
{
|
|
11964
|
-
"kind": "field",
|
|
11965
|
-
"name": "autocomplete",
|
|
11966
|
-
"type": {
|
|
11967
|
-
"text": "AutocompleteAttribute"
|
|
11968
|
-
},
|
|
11969
|
-
"default": "\"off\"",
|
|
11970
|
-
"description": "Specifies the data type of the field, so that the browser may attempt to fill out the field automatically on behalf of the user.",
|
|
11971
|
-
"attribute": "autocomplete",
|
|
11972
|
-
"inheritedFrom": {
|
|
11973
|
-
"name": "AutocompleteMixin",
|
|
11974
|
-
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
11975
|
-
}
|
|
11976
|
-
},
|
|
11977
|
-
{
|
|
11978
|
-
"kind": "field",
|
|
11979
|
-
"name": "readonly",
|
|
11980
|
-
"type": {
|
|
11981
|
-
"text": "boolean"
|
|
11982
|
-
},
|
|
11983
|
-
"default": "false",
|
|
11984
|
-
"description": "Makes the component readonly, so that it is not editable.\nReadonly differs from disabled in that readonly fields are still focusable and will be submitted with a form.",
|
|
11985
|
-
"attribute": "readonly",
|
|
11986
|
-
"reflects": true,
|
|
11987
|
-
"inheritedFrom": {
|
|
11988
|
-
"name": "ReadonlyMixin",
|
|
11989
|
-
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
11990
|
-
}
|
|
11991
|
-
},
|
|
11992
12011
|
{
|
|
11993
12012
|
"kind": "field",
|
|
11994
12013
|
"name": "disabled",
|
|
@@ -12117,66 +12136,28 @@
|
|
|
12117
12136
|
}
|
|
12118
12137
|
}
|
|
12119
12138
|
],
|
|
12120
|
-
"
|
|
12139
|
+
"attributes": [
|
|
12121
12140
|
{
|
|
12122
|
-
"name": "
|
|
12141
|
+
"name": "checked",
|
|
12123
12142
|
"type": {
|
|
12124
|
-
"text": "
|
|
12143
|
+
"text": "boolean"
|
|
12125
12144
|
},
|
|
12126
|
-
"
|
|
12127
|
-
"
|
|
12128
|
-
|
|
12129
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12130
|
-
}
|
|
12145
|
+
"default": "false",
|
|
12146
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
12147
|
+
"fieldName": "checked"
|
|
12131
12148
|
},
|
|
12132
12149
|
{
|
|
12133
|
-
"name": "
|
|
12150
|
+
"name": "size",
|
|
12134
12151
|
"type": {
|
|
12135
|
-
"text": "
|
|
12152
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
12136
12153
|
},
|
|
12137
|
-
"
|
|
12154
|
+
"default": "\"m\"",
|
|
12155
|
+
"description": "The size of the component.",
|
|
12156
|
+
"fieldName": "size",
|
|
12138
12157
|
"inheritedFrom": {
|
|
12139
|
-
"name": "
|
|
12140
|
-
"module": "src/common/mixins/
|
|
12158
|
+
"name": "SizeMixin",
|
|
12159
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
12141
12160
|
}
|
|
12142
|
-
}
|
|
12143
|
-
],
|
|
12144
|
-
"attributes": [
|
|
12145
|
-
{
|
|
12146
|
-
"name": "min",
|
|
12147
|
-
"type": {
|
|
12148
|
-
"text": "number"
|
|
12149
|
-
},
|
|
12150
|
-
"default": "0",
|
|
12151
|
-
"description": "Minimum value for the range slider.",
|
|
12152
|
-
"fieldName": "min"
|
|
12153
|
-
},
|
|
12154
|
-
{
|
|
12155
|
-
"name": "max",
|
|
12156
|
-
"type": {
|
|
12157
|
-
"text": "number"
|
|
12158
|
-
},
|
|
12159
|
-
"default": "10",
|
|
12160
|
-
"description": "Maximum value for the range slider.",
|
|
12161
|
-
"fieldName": "max"
|
|
12162
|
-
},
|
|
12163
|
-
{
|
|
12164
|
-
"name": "step",
|
|
12165
|
-
"type": {
|
|
12166
|
-
"text": "number"
|
|
12167
|
-
},
|
|
12168
|
-
"default": "1",
|
|
12169
|
-
"description": "Step amount for the range slider.",
|
|
12170
|
-
"fieldName": "step"
|
|
12171
|
-
},
|
|
12172
|
-
{
|
|
12173
|
-
"name": "expand",
|
|
12174
|
-
"type": {
|
|
12175
|
-
"text": "boolean"
|
|
12176
|
-
},
|
|
12177
|
-
"default": "false",
|
|
12178
|
-
"description": "Controls whether the input expands to fill the width of its container.",
|
|
12179
|
-
"fieldName": "expand"
|
|
12180
12161
|
},
|
|
12181
12162
|
{
|
|
12182
12163
|
"name": "label",
|
|
@@ -12266,32 +12247,6 @@
|
|
|
12266
12247
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12267
12248
|
}
|
|
12268
12249
|
},
|
|
12269
|
-
{
|
|
12270
|
-
"name": "autocomplete",
|
|
12271
|
-
"type": {
|
|
12272
|
-
"text": "AutocompleteAttribute"
|
|
12273
|
-
},
|
|
12274
|
-
"default": "\"off\"",
|
|
12275
|
-
"description": "Specifies the data type of the field, so that the browser may attempt to fill out the field automatically on behalf of the user.",
|
|
12276
|
-
"fieldName": "autocomplete",
|
|
12277
|
-
"inheritedFrom": {
|
|
12278
|
-
"name": "AutocompleteMixin",
|
|
12279
|
-
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
12280
|
-
}
|
|
12281
|
-
},
|
|
12282
|
-
{
|
|
12283
|
-
"name": "readonly",
|
|
12284
|
-
"type": {
|
|
12285
|
-
"text": "boolean"
|
|
12286
|
-
},
|
|
12287
|
-
"default": "false",
|
|
12288
|
-
"description": "Makes the component readonly, so that it is not editable.\nReadonly differs from disabled in that readonly fields are still focusable and will be submitted with a form.",
|
|
12289
|
-
"fieldName": "readonly",
|
|
12290
|
-
"inheritedFrom": {
|
|
12291
|
-
"name": "ReadonlyMixin",
|
|
12292
|
-
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
12293
|
-
}
|
|
12294
|
-
},
|
|
12295
12250
|
{
|
|
12296
12251
|
"name": "disabled",
|
|
12297
12252
|
"type": {
|
|
@@ -12345,16 +12300,12 @@
|
|
|
12345
12300
|
],
|
|
12346
12301
|
"mixins": [
|
|
12347
12302
|
{
|
|
12348
|
-
"name": "
|
|
12349
|
-
"module": "/src/common/mixins/
|
|
12350
|
-
},
|
|
12351
|
-
{
|
|
12352
|
-
"name": "AutocompleteMixin",
|
|
12353
|
-
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
12303
|
+
"name": "SizeMixin",
|
|
12304
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
12354
12305
|
},
|
|
12355
12306
|
{
|
|
12356
|
-
"name": "
|
|
12357
|
-
"module": "/src/common/mixins/
|
|
12307
|
+
"name": "FormAssociatedMixin",
|
|
12308
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
12358
12309
|
},
|
|
12359
12310
|
{
|
|
12360
12311
|
"name": "InputMixin",
|
|
@@ -12372,11 +12323,35 @@
|
|
|
12372
12323
|
"localization": [],
|
|
12373
12324
|
"status": "ready",
|
|
12374
12325
|
"category": "form",
|
|
12375
|
-
"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
|
|
12326
|
+
"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 a radio component when users can only select one option from a list.\n- Favor radios over a select component when there are a small number of options. This reduces the number of clicks a user has to make, increasing efficiency.\n- Radio buttons are grouped by their `name` attribute. Therefore, it is crucial that the same `name` is used for a group of radios.\n- Give each radio within a group a unique `value`.\n- Radios **must** be used in combination with a fieldset component.\n- In most cases, a stack component should be used to layout a group of radio buttons.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place interactive content (buttons, links etc) inside the label.\n- Don’t use when a user can select more than one option. In this case, use a checkbox instead.\n- Don’t use for “accepting terms of service” and similar functionality. Use a checkbox instead.\n- When you have more than 10 options to choose from. Consider using a select instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nRadio button labels should be clear, accurate and predictable. It should be possible for the user to understand what they are enabling or disabling:\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 radio button 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 ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Blue</div>\n<div class=\"n-usage n-usage-dont\">Blue.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patient</div>\n<div class=\"n-usage n-usage-dont\">Patient;</div>\n\n---\n\n## Additional considerations\n\n- Hint text can be used to offer further information or explanation for an option.\n- Once a radio has been selected, users cannot return to having no radios selected without refreshing their browser window. Therefore, you should include \"None of the above\" or \"I do not know\" if they are valid options.\n- In most cases, radio buttons should be stacked vertically. However, radio buttons can be stacked horizontally when there are only two options with short labels. An example might be a yes/no question.\n",
|
|
12376
12327
|
"examples": [],
|
|
12377
12328
|
"dependencies": [],
|
|
12378
|
-
"tagName": "nord-
|
|
12379
|
-
"customElement": true
|
|
12329
|
+
"tagName": "nord-radio",
|
|
12330
|
+
"customElement": true,
|
|
12331
|
+
"events": [
|
|
12332
|
+
{
|
|
12333
|
+
"name": "input",
|
|
12334
|
+
"type": {
|
|
12335
|
+
"text": "NordEvent"
|
|
12336
|
+
},
|
|
12337
|
+
"description": "Fired as the user types into the input.",
|
|
12338
|
+
"inheritedFrom": {
|
|
12339
|
+
"name": "FormAssociatedMixin",
|
|
12340
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12341
|
+
}
|
|
12342
|
+
},
|
|
12343
|
+
{
|
|
12344
|
+
"name": "change",
|
|
12345
|
+
"type": {
|
|
12346
|
+
"text": "NordEvent"
|
|
12347
|
+
},
|
|
12348
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
12349
|
+
"inheritedFrom": {
|
|
12350
|
+
"name": "FormAssociatedMixin",
|
|
12351
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12352
|
+
}
|
|
12353
|
+
}
|
|
12354
|
+
]
|
|
12380
12355
|
}
|
|
12381
12356
|
],
|
|
12382
12357
|
"exports": [
|
|
@@ -12384,33 +12359,48 @@
|
|
|
12384
12359
|
"kind": "js",
|
|
12385
12360
|
"name": "default",
|
|
12386
12361
|
"declaration": {
|
|
12387
|
-
"name": "
|
|
12388
|
-
"module": "src/
|
|
12362
|
+
"name": "Radio",
|
|
12363
|
+
"module": "src/radio/Radio.ts"
|
|
12389
12364
|
}
|
|
12390
12365
|
},
|
|
12391
12366
|
{
|
|
12392
12367
|
"kind": "custom-element-definition",
|
|
12393
|
-
"name": "nord-
|
|
12368
|
+
"name": "nord-radio",
|
|
12394
12369
|
"declaration": {
|
|
12395
|
-
"name": "
|
|
12396
|
-
"module": "src/
|
|
12370
|
+
"name": "Radio",
|
|
12371
|
+
"module": "src/radio/Radio.ts"
|
|
12397
12372
|
}
|
|
12398
12373
|
}
|
|
12399
12374
|
]
|
|
12400
12375
|
},
|
|
12401
12376
|
{
|
|
12402
12377
|
"kind": "javascript-module",
|
|
12403
|
-
"path": "src/
|
|
12378
|
+
"path": "src/range/Range.ts",
|
|
12404
12379
|
"declarations": [
|
|
12405
12380
|
{
|
|
12406
12381
|
"kind": "class",
|
|
12407
|
-
"description": "
|
|
12408
|
-
"name": "
|
|
12382
|
+
"description": "Range input lets user specify a numeric value using a slider which\nmust be no less than a given value, and no more than another given value.",
|
|
12383
|
+
"name": "Range",
|
|
12409
12384
|
"cssProperties": [
|
|
12410
12385
|
{
|
|
12411
|
-
"description": "Controls the
|
|
12412
|
-
"name": "--n-
|
|
12413
|
-
"default": "
|
|
12386
|
+
"description": "Controls the size of the thumb.",
|
|
12387
|
+
"name": "--n-range-thumb-size",
|
|
12388
|
+
"default": "20px"
|
|
12389
|
+
},
|
|
12390
|
+
{
|
|
12391
|
+
"description": "Controls the color of the portion of the track that represents the current value.",
|
|
12392
|
+
"name": "--n-range-track-color-active",
|
|
12393
|
+
"default": "var(--n-color-accent)"
|
|
12394
|
+
},
|
|
12395
|
+
{
|
|
12396
|
+
"description": "Controls the color of the portion of the track that represents the remaining value.",
|
|
12397
|
+
"name": "--n-range-track-color-inactive",
|
|
12398
|
+
"default": "var(--n-color-border-strong)"
|
|
12399
|
+
},
|
|
12400
|
+
{
|
|
12401
|
+
"description": "Controls the height of the track.",
|
|
12402
|
+
"name": "--n-range-track-size",
|
|
12403
|
+
"default": "3px"
|
|
12414
12404
|
}
|
|
12415
12405
|
],
|
|
12416
12406
|
"slots": [
|
|
@@ -12430,38 +12420,66 @@
|
|
|
12430
12420
|
"members": [
|
|
12431
12421
|
{
|
|
12432
12422
|
"kind": "field",
|
|
12433
|
-
"name": "
|
|
12423
|
+
"name": "direction",
|
|
12424
|
+
"privacy": "private",
|
|
12425
|
+
"default": "new DirectionController(this)"
|
|
12426
|
+
},
|
|
12427
|
+
{
|
|
12428
|
+
"kind": "field",
|
|
12429
|
+
"name": "min",
|
|
12434
12430
|
"type": {
|
|
12435
|
-
"text": "
|
|
12431
|
+
"text": "number"
|
|
12436
12432
|
},
|
|
12437
|
-
"
|
|
12438
|
-
"
|
|
12439
|
-
"
|
|
12440
|
-
|
|
12441
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12442
|
-
}
|
|
12433
|
+
"default": "0",
|
|
12434
|
+
"description": "Minimum value for the range slider.",
|
|
12435
|
+
"attribute": "min",
|
|
12436
|
+
"reflects": true
|
|
12443
12437
|
},
|
|
12444
12438
|
{
|
|
12445
12439
|
"kind": "field",
|
|
12446
|
-
"name": "
|
|
12440
|
+
"name": "max",
|
|
12447
12441
|
"type": {
|
|
12448
|
-
"text": "
|
|
12442
|
+
"text": "number"
|
|
12449
12443
|
},
|
|
12450
|
-
"
|
|
12451
|
-
"
|
|
12452
|
-
"
|
|
12453
|
-
|
|
12454
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12455
|
-
}
|
|
12444
|
+
"default": "10",
|
|
12445
|
+
"description": "Maximum value for the range slider.",
|
|
12446
|
+
"attribute": "max",
|
|
12447
|
+
"reflects": true
|
|
12456
12448
|
},
|
|
12457
12449
|
{
|
|
12458
12450
|
"kind": "field",
|
|
12459
|
-
"name": "
|
|
12451
|
+
"name": "step",
|
|
12460
12452
|
"type": {
|
|
12461
|
-
"text": "
|
|
12453
|
+
"text": "number"
|
|
12454
|
+
},
|
|
12455
|
+
"default": "1",
|
|
12456
|
+
"description": "Step amount for the range slider.",
|
|
12457
|
+
"attribute": "step",
|
|
12458
|
+
"reflects": true
|
|
12459
|
+
},
|
|
12460
|
+
{
|
|
12461
|
+
"kind": "field",
|
|
12462
|
+
"name": "expand",
|
|
12463
|
+
"type": {
|
|
12464
|
+
"text": "boolean"
|
|
12462
12465
|
},
|
|
12466
|
+
"default": "false",
|
|
12467
|
+
"description": "Controls whether the input expands to fill the width of its container.",
|
|
12468
|
+
"attribute": "expand",
|
|
12469
|
+
"reflects": true
|
|
12470
|
+
},
|
|
12471
|
+
{
|
|
12472
|
+
"kind": "method",
|
|
12473
|
+
"name": "handleInput",
|
|
12463
12474
|
"privacy": "protected",
|
|
12464
|
-
"
|
|
12475
|
+
"parameters": [
|
|
12476
|
+
{
|
|
12477
|
+
"name": "e",
|
|
12478
|
+
"type": {
|
|
12479
|
+
"text": "Event"
|
|
12480
|
+
}
|
|
12481
|
+
}
|
|
12482
|
+
],
|
|
12465
12483
|
"inheritedFrom": {
|
|
12466
12484
|
"name": "FormAssociatedMixin",
|
|
12467
12485
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12469,10 +12487,9 @@
|
|
|
12469
12487
|
},
|
|
12470
12488
|
{
|
|
12471
12489
|
"kind": "field",
|
|
12472
|
-
"name": "
|
|
12490
|
+
"name": "labelSlot",
|
|
12473
12491
|
"privacy": "protected",
|
|
12474
|
-
"default": "new
|
|
12475
|
-
"description": "For accessibility reasons, we render some parts of the component to the light DOM.",
|
|
12492
|
+
"default": "new SlotController(this, \"label\")",
|
|
12476
12493
|
"inheritedFrom": {
|
|
12477
12494
|
"name": "FormAssociatedMixin",
|
|
12478
12495
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12480,9 +12497,9 @@
|
|
|
12480
12497
|
},
|
|
12481
12498
|
{
|
|
12482
12499
|
"kind": "field",
|
|
12483
|
-
"name": "
|
|
12500
|
+
"name": "errorSlot",
|
|
12484
12501
|
"privacy": "protected",
|
|
12485
|
-
"default": "new
|
|
12502
|
+
"default": "new SlotController(this, \"error\")",
|
|
12486
12503
|
"inheritedFrom": {
|
|
12487
12504
|
"name": "FormAssociatedMixin",
|
|
12488
12505
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12490,9 +12507,9 @@
|
|
|
12490
12507
|
},
|
|
12491
12508
|
{
|
|
12492
12509
|
"kind": "field",
|
|
12493
|
-
"name": "
|
|
12510
|
+
"name": "hintSlot",
|
|
12494
12511
|
"privacy": "protected",
|
|
12495
|
-
"default": "new
|
|
12512
|
+
"default": "new SlotController(this, \"hint\")",
|
|
12496
12513
|
"inheritedFrom": {
|
|
12497
12514
|
"name": "FormAssociatedMixin",
|
|
12498
12515
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12500,9 +12517,13 @@
|
|
|
12500
12517
|
},
|
|
12501
12518
|
{
|
|
12502
12519
|
"kind": "field",
|
|
12503
|
-
"name": "
|
|
12520
|
+
"name": "formData",
|
|
12504
12521
|
"privacy": "protected",
|
|
12505
|
-
"default": "new
|
|
12522
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
12523
|
+
"inheritedFrom": {
|
|
12524
|
+
"name": "FormAssociatedMixin",
|
|
12525
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12526
|
+
}
|
|
12506
12527
|
},
|
|
12507
12528
|
{
|
|
12508
12529
|
"kind": "field",
|
|
@@ -12516,50 +12537,12 @@
|
|
|
12516
12537
|
},
|
|
12517
12538
|
{
|
|
12518
12539
|
"kind": "field",
|
|
12519
|
-
"name": "
|
|
12540
|
+
"name": "inputId",
|
|
12520
12541
|
"type": {
|
|
12521
|
-
"text": "
|
|
12542
|
+
"text": "string"
|
|
12522
12543
|
},
|
|
12523
|
-
"default": "false",
|
|
12524
|
-
"description": "Controls whether the checkbox is checked or not.",
|
|
12525
|
-
"attribute": "checked",
|
|
12526
|
-
"reflects": true
|
|
12527
|
-
},
|
|
12528
|
-
{
|
|
12529
|
-
"kind": "method",
|
|
12530
|
-
"name": "handleCheckedChange",
|
|
12531
|
-
"privacy": "protected",
|
|
12532
|
-
"parameters": [
|
|
12533
|
-
{
|
|
12534
|
-
"name": "previousChecked",
|
|
12535
|
-
"type": {
|
|
12536
|
-
"text": "boolean"
|
|
12537
|
-
}
|
|
12538
|
-
}
|
|
12539
|
-
]
|
|
12540
|
-
},
|
|
12541
|
-
{
|
|
12542
|
-
"kind": "method",
|
|
12543
|
-
"name": "uncheckSiblings",
|
|
12544
|
-
"privacy": "private"
|
|
12545
|
-
},
|
|
12546
|
-
{
|
|
12547
|
-
"kind": "method",
|
|
12548
|
-
"name": "handleChange",
|
|
12549
12544
|
"privacy": "protected",
|
|
12550
|
-
"
|
|
12551
|
-
{
|
|
12552
|
-
"name": "e",
|
|
12553
|
-
"type": {
|
|
12554
|
-
"text": "Event"
|
|
12555
|
-
}
|
|
12556
|
-
}
|
|
12557
|
-
],
|
|
12558
|
-
"return": {
|
|
12559
|
-
"type": {
|
|
12560
|
-
"text": "void"
|
|
12561
|
-
}
|
|
12562
|
-
},
|
|
12545
|
+
"default": "\"input\"",
|
|
12563
12546
|
"inheritedFrom": {
|
|
12564
12547
|
"name": "FormAssociatedMixin",
|
|
12565
12548
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12567,34 +12550,25 @@
|
|
|
12567
12550
|
},
|
|
12568
12551
|
{
|
|
12569
12552
|
"kind": "field",
|
|
12570
|
-
"name": "
|
|
12571
|
-
"privacy": "private"
|
|
12572
|
-
},
|
|
12573
|
-
{
|
|
12574
|
-
"kind": "field",
|
|
12575
|
-
"name": "handleFocus",
|
|
12576
|
-
"privacy": "private"
|
|
12577
|
-
},
|
|
12578
|
-
{
|
|
12579
|
-
"kind": "field",
|
|
12580
|
-
"name": "size",
|
|
12553
|
+
"name": "errorId",
|
|
12581
12554
|
"type": {
|
|
12582
|
-
"text": "
|
|
12555
|
+
"text": "string"
|
|
12583
12556
|
},
|
|
12584
|
-
"
|
|
12585
|
-
"
|
|
12586
|
-
"attribute": "size",
|
|
12587
|
-
"reflects": true,
|
|
12557
|
+
"privacy": "protected",
|
|
12558
|
+
"default": "\"error\"",
|
|
12588
12559
|
"inheritedFrom": {
|
|
12589
|
-
"name": "
|
|
12590
|
-
"module": "src/common/mixins/
|
|
12560
|
+
"name": "FormAssociatedMixin",
|
|
12561
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12591
12562
|
}
|
|
12592
12563
|
},
|
|
12593
12564
|
{
|
|
12594
12565
|
"kind": "field",
|
|
12595
|
-
"name": "
|
|
12566
|
+
"name": "hintId",
|
|
12567
|
+
"type": {
|
|
12568
|
+
"text": "string"
|
|
12569
|
+
},
|
|
12596
12570
|
"privacy": "protected",
|
|
12597
|
-
"default": "
|
|
12571
|
+
"default": "\"hint\"",
|
|
12598
12572
|
"inheritedFrom": {
|
|
12599
12573
|
"name": "FormAssociatedMixin",
|
|
12600
12574
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12704,7 +12678,7 @@
|
|
|
12704
12678
|
},
|
|
12705
12679
|
{
|
|
12706
12680
|
"kind": "method",
|
|
12707
|
-
"name": "
|
|
12681
|
+
"name": "handleChange",
|
|
12708
12682
|
"privacy": "protected",
|
|
12709
12683
|
"parameters": [
|
|
12710
12684
|
{
|
|
@@ -12784,6 +12758,35 @@
|
|
|
12784
12758
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12785
12759
|
}
|
|
12786
12760
|
},
|
|
12761
|
+
{
|
|
12762
|
+
"kind": "field",
|
|
12763
|
+
"name": "autocomplete",
|
|
12764
|
+
"type": {
|
|
12765
|
+
"text": "AutocompleteAttribute"
|
|
12766
|
+
},
|
|
12767
|
+
"default": "\"off\"",
|
|
12768
|
+
"description": "Specifies the data type of the field, so that the browser may attempt to fill out the field automatically on behalf of the user.",
|
|
12769
|
+
"attribute": "autocomplete",
|
|
12770
|
+
"inheritedFrom": {
|
|
12771
|
+
"name": "AutocompleteMixin",
|
|
12772
|
+
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
12773
|
+
}
|
|
12774
|
+
},
|
|
12775
|
+
{
|
|
12776
|
+
"kind": "field",
|
|
12777
|
+
"name": "readonly",
|
|
12778
|
+
"type": {
|
|
12779
|
+
"text": "boolean"
|
|
12780
|
+
},
|
|
12781
|
+
"default": "false",
|
|
12782
|
+
"description": "Makes the component readonly, so that it is not editable.\nReadonly differs from disabled in that readonly fields are still focusable and will be submitted with a form.",
|
|
12783
|
+
"attribute": "readonly",
|
|
12784
|
+
"reflects": true,
|
|
12785
|
+
"inheritedFrom": {
|
|
12786
|
+
"name": "ReadonlyMixin",
|
|
12787
|
+
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
12788
|
+
}
|
|
12789
|
+
},
|
|
12787
12790
|
{
|
|
12788
12791
|
"kind": "field",
|
|
12789
12792
|
"name": "disabled",
|
|
@@ -12912,28 +12915,66 @@
|
|
|
12912
12915
|
}
|
|
12913
12916
|
}
|
|
12914
12917
|
],
|
|
12915
|
-
"
|
|
12918
|
+
"events": [
|
|
12916
12919
|
{
|
|
12917
|
-
"name": "
|
|
12920
|
+
"name": "input",
|
|
12918
12921
|
"type": {
|
|
12919
|
-
"text": "
|
|
12922
|
+
"text": "NordEvent"
|
|
12920
12923
|
},
|
|
12921
|
-
"
|
|
12922
|
-
"
|
|
12923
|
-
|
|
12924
|
+
"description": "Fired as the user types into the input.",
|
|
12925
|
+
"inheritedFrom": {
|
|
12926
|
+
"name": "FormAssociatedMixin",
|
|
12927
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12928
|
+
}
|
|
12924
12929
|
},
|
|
12925
12930
|
{
|
|
12926
|
-
"name": "
|
|
12931
|
+
"name": "change",
|
|
12927
12932
|
"type": {
|
|
12928
|
-
"text": "
|
|
12933
|
+
"text": "NordEvent"
|
|
12929
12934
|
},
|
|
12930
|
-
"
|
|
12931
|
-
"description": "The size of the component.",
|
|
12932
|
-
"fieldName": "size",
|
|
12935
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
12933
12936
|
"inheritedFrom": {
|
|
12934
|
-
"name": "
|
|
12935
|
-
"module": "src/common/mixins/
|
|
12937
|
+
"name": "FormAssociatedMixin",
|
|
12938
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
12936
12939
|
}
|
|
12940
|
+
}
|
|
12941
|
+
],
|
|
12942
|
+
"attributes": [
|
|
12943
|
+
{
|
|
12944
|
+
"name": "min",
|
|
12945
|
+
"type": {
|
|
12946
|
+
"text": "number"
|
|
12947
|
+
},
|
|
12948
|
+
"default": "0",
|
|
12949
|
+
"description": "Minimum value for the range slider.",
|
|
12950
|
+
"fieldName": "min"
|
|
12951
|
+
},
|
|
12952
|
+
{
|
|
12953
|
+
"name": "max",
|
|
12954
|
+
"type": {
|
|
12955
|
+
"text": "number"
|
|
12956
|
+
},
|
|
12957
|
+
"default": "10",
|
|
12958
|
+
"description": "Maximum value for the range slider.",
|
|
12959
|
+
"fieldName": "max"
|
|
12960
|
+
},
|
|
12961
|
+
{
|
|
12962
|
+
"name": "step",
|
|
12963
|
+
"type": {
|
|
12964
|
+
"text": "number"
|
|
12965
|
+
},
|
|
12966
|
+
"default": "1",
|
|
12967
|
+
"description": "Step amount for the range slider.",
|
|
12968
|
+
"fieldName": "step"
|
|
12969
|
+
},
|
|
12970
|
+
{
|
|
12971
|
+
"name": "expand",
|
|
12972
|
+
"type": {
|
|
12973
|
+
"text": "boolean"
|
|
12974
|
+
},
|
|
12975
|
+
"default": "false",
|
|
12976
|
+
"description": "Controls whether the input expands to fill the width of its container.",
|
|
12977
|
+
"fieldName": "expand"
|
|
12937
12978
|
},
|
|
12938
12979
|
{
|
|
12939
12980
|
"name": "label",
|
|
@@ -13024,28 +13065,54 @@
|
|
|
13024
13065
|
}
|
|
13025
13066
|
},
|
|
13026
13067
|
{
|
|
13027
|
-
"name": "
|
|
13068
|
+
"name": "autocomplete",
|
|
13028
13069
|
"type": {
|
|
13029
|
-
"text": "
|
|
13070
|
+
"text": "AutocompleteAttribute"
|
|
13030
13071
|
},
|
|
13031
|
-
"default": "
|
|
13032
|
-
"description": "
|
|
13033
|
-
"fieldName": "
|
|
13072
|
+
"default": "\"off\"",
|
|
13073
|
+
"description": "Specifies the data type of the field, so that the browser may attempt to fill out the field automatically on behalf of the user.",
|
|
13074
|
+
"fieldName": "autocomplete",
|
|
13034
13075
|
"inheritedFrom": {
|
|
13035
|
-
"name": "
|
|
13036
|
-
"module": "src/common/mixins/
|
|
13076
|
+
"name": "AutocompleteMixin",
|
|
13077
|
+
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
13037
13078
|
}
|
|
13038
13079
|
},
|
|
13039
13080
|
{
|
|
13040
|
-
"name": "
|
|
13081
|
+
"name": "readonly",
|
|
13041
13082
|
"type": {
|
|
13042
|
-
"text": "
|
|
13083
|
+
"text": "boolean"
|
|
13043
13084
|
},
|
|
13044
|
-
"
|
|
13045
|
-
"
|
|
13085
|
+
"default": "false",
|
|
13086
|
+
"description": "Makes the component readonly, so that it is not editable.\nReadonly differs from disabled in that readonly fields are still focusable and will be submitted with a form.",
|
|
13087
|
+
"fieldName": "readonly",
|
|
13046
13088
|
"inheritedFrom": {
|
|
13047
|
-
"name": "
|
|
13048
|
-
"module": "src/common/mixins/
|
|
13089
|
+
"name": "ReadonlyMixin",
|
|
13090
|
+
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
13091
|
+
}
|
|
13092
|
+
},
|
|
13093
|
+
{
|
|
13094
|
+
"name": "disabled",
|
|
13095
|
+
"type": {
|
|
13096
|
+
"text": "boolean"
|
|
13097
|
+
},
|
|
13098
|
+
"default": "false",
|
|
13099
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
13100
|
+
"fieldName": "disabled",
|
|
13101
|
+
"inheritedFrom": {
|
|
13102
|
+
"name": "InputMixin",
|
|
13103
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
13104
|
+
}
|
|
13105
|
+
},
|
|
13106
|
+
{
|
|
13107
|
+
"name": "name",
|
|
13108
|
+
"type": {
|
|
13109
|
+
"text": "string | undefined"
|
|
13110
|
+
},
|
|
13111
|
+
"description": "The name of the form component.",
|
|
13112
|
+
"fieldName": "name",
|
|
13113
|
+
"inheritedFrom": {
|
|
13114
|
+
"name": "InputMixin",
|
|
13115
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
13049
13116
|
}
|
|
13050
13117
|
},
|
|
13051
13118
|
{
|
|
@@ -13075,14 +13142,18 @@
|
|
|
13075
13142
|
}
|
|
13076
13143
|
],
|
|
13077
13144
|
"mixins": [
|
|
13078
|
-
{
|
|
13079
|
-
"name": "SizeMixin",
|
|
13080
|
-
"module": "/src/common/mixins/SizeMixin.js"
|
|
13081
|
-
},
|
|
13082
13145
|
{
|
|
13083
13146
|
"name": "FormAssociatedMixin",
|
|
13084
13147
|
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
13085
13148
|
},
|
|
13149
|
+
{
|
|
13150
|
+
"name": "AutocompleteMixin",
|
|
13151
|
+
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
13152
|
+
},
|
|
13153
|
+
{
|
|
13154
|
+
"name": "ReadonlyMixin",
|
|
13155
|
+
"module": "/src/common/mixins/ReadonlyMixin.js"
|
|
13156
|
+
},
|
|
13086
13157
|
{
|
|
13087
13158
|
"name": "InputMixin",
|
|
13088
13159
|
"module": "/src/common/mixins/InputMixin.js"
|
|
@@ -13099,35 +13170,11 @@
|
|
|
13099
13170
|
"localization": [],
|
|
13100
13171
|
"status": "ready",
|
|
13101
13172
|
"category": "form",
|
|
13102
|
-
"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
|
|
13173
|
+
"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 let user specify a numeric value using a slider.\n- Use when the accuracy of the numeric value entered isn’t important.\n- Always use with a label, even if that label is hidden.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when the accuracy of the numeric value entered is important.\n- For entering arbitrary numeric values. Use [input component](/components/input/) instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nRange labels act as a title for the range input. Labels should typically be short and in noun form:\n\n<div class=\"n-usage n-usage-do\">Lightness percentage</div>\n<div class=\"n-usage n-usage-dont\">What is the lightness percentage?</div>\n\nWhen writing range 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\">Item price</div>\n<div class=\"n-usage n-usage-dont\">Item Price</div>\n\nDo not use colons in range label:\n\n<div class=\"n-usage n-usage-do\">Color depth</div>\n<div class=\"n-usage n-usage-dont\">Color depth:</div>\n",
|
|
13103
13174
|
"examples": [],
|
|
13104
13175
|
"dependencies": [],
|
|
13105
|
-
"tagName": "nord-
|
|
13106
|
-
"customElement": true
|
|
13107
|
-
"events": [
|
|
13108
|
-
{
|
|
13109
|
-
"name": "input",
|
|
13110
|
-
"type": {
|
|
13111
|
-
"text": "NordEvent"
|
|
13112
|
-
},
|
|
13113
|
-
"description": "Fired as the user types into the input.",
|
|
13114
|
-
"inheritedFrom": {
|
|
13115
|
-
"name": "FormAssociatedMixin",
|
|
13116
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
13117
|
-
}
|
|
13118
|
-
},
|
|
13119
|
-
{
|
|
13120
|
-
"name": "change",
|
|
13121
|
-
"type": {
|
|
13122
|
-
"text": "NordEvent"
|
|
13123
|
-
},
|
|
13124
|
-
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
13125
|
-
"inheritedFrom": {
|
|
13126
|
-
"name": "FormAssociatedMixin",
|
|
13127
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
13128
|
-
}
|
|
13129
|
-
}
|
|
13130
|
-
]
|
|
13176
|
+
"tagName": "nord-range",
|
|
13177
|
+
"customElement": true
|
|
13131
13178
|
}
|
|
13132
13179
|
],
|
|
13133
13180
|
"exports": [
|
|
@@ -13135,16 +13182,16 @@
|
|
|
13135
13182
|
"kind": "js",
|
|
13136
13183
|
"name": "default",
|
|
13137
13184
|
"declaration": {
|
|
13138
|
-
"name": "
|
|
13139
|
-
"module": "src/
|
|
13185
|
+
"name": "Range",
|
|
13186
|
+
"module": "src/range/Range.ts"
|
|
13140
13187
|
}
|
|
13141
13188
|
},
|
|
13142
13189
|
{
|
|
13143
13190
|
"kind": "custom-element-definition",
|
|
13144
|
-
"name": "nord-
|
|
13191
|
+
"name": "nord-range",
|
|
13145
13192
|
"declaration": {
|
|
13146
|
-
"name": "
|
|
13147
|
-
"module": "src/
|
|
13193
|
+
"name": "Range",
|
|
13194
|
+
"module": "src/range/Range.ts"
|
|
13148
13195
|
}
|
|
13149
13196
|
}
|
|
13150
13197
|
]
|
|
@@ -13697,6 +13744,11 @@
|
|
|
13697
13744
|
"name": "--n-select-block-size",
|
|
13698
13745
|
"default": "var(--n-space-xl)"
|
|
13699
13746
|
},
|
|
13747
|
+
{
|
|
13748
|
+
"description": "Controls the inline size, or width, of the select.",
|
|
13749
|
+
"name": "--n-select-inline-size",
|
|
13750
|
+
"default": "fit-content"
|
|
13751
|
+
},
|
|
13700
13752
|
{
|
|
13701
13753
|
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
13702
13754
|
"name": "--n-label-color",
|
|
@@ -14720,7 +14772,7 @@
|
|
|
14720
14772
|
"kind": "field",
|
|
14721
14773
|
"name": "alignItems",
|
|
14722
14774
|
"type": {
|
|
14723
|
-
"text": "\"center\"
|
|
14775
|
+
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"baseline\"\n | \"stretch\" | undefined"
|
|
14724
14776
|
},
|
|
14725
14777
|
"default": "\"stretch\"",
|
|
14726
14778
|
"description": "How to align the child items inside the stack.",
|
|
@@ -14742,7 +14794,7 @@
|
|
|
14742
14794
|
"kind": "field",
|
|
14743
14795
|
"name": "justifyContent",
|
|
14744
14796
|
"type": {
|
|
14745
|
-
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"
|
|
14797
|
+
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"space-between\"\n | \"space-around\"\n | \"space-evenly\" | undefined"
|
|
14746
14798
|
},
|
|
14747
14799
|
"description": "How to justify the child items inside the stack.",
|
|
14748
14800
|
"attribute": "justify-content",
|
|
@@ -14771,7 +14823,7 @@
|
|
|
14771
14823
|
{
|
|
14772
14824
|
"name": "align-items",
|
|
14773
14825
|
"type": {
|
|
14774
|
-
"text": "\"center\"
|
|
14826
|
+
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"baseline\"\n | \"stretch\" | undefined"
|
|
14775
14827
|
},
|
|
14776
14828
|
"default": "\"stretch\"",
|
|
14777
14829
|
"description": "How to align the child items inside the stack.",
|
|
@@ -14789,7 +14841,7 @@
|
|
|
14789
14841
|
{
|
|
14790
14842
|
"name": "justify-content",
|
|
14791
14843
|
"type": {
|
|
14792
|
-
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"
|
|
14844
|
+
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"space-between\"\n | \"space-around\"\n | \"space-evenly\" | undefined"
|
|
14793
14845
|
},
|
|
14794
14846
|
"description": "How to justify the child items inside the stack.",
|
|
14795
14847
|
"fieldName": "justifyContent"
|
|
@@ -14923,54 +14975,6 @@
|
|
|
14923
14975
|
}
|
|
14924
14976
|
]
|
|
14925
14977
|
},
|
|
14926
|
-
{
|
|
14927
|
-
"kind": "javascript-module",
|
|
14928
|
-
"path": "src/tab-panel/TabPanel.ts",
|
|
14929
|
-
"declarations": [
|
|
14930
|
-
{
|
|
14931
|
-
"kind": "class",
|
|
14932
|
-
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
14933
|
-
"name": "TabPanel",
|
|
14934
|
-
"slots": [
|
|
14935
|
-
{
|
|
14936
|
-
"description": "The tab panel content.",
|
|
14937
|
-
"name": ""
|
|
14938
|
-
}
|
|
14939
|
-
],
|
|
14940
|
-
"members": [],
|
|
14941
|
-
"superclass": {
|
|
14942
|
-
"name": "LitElement",
|
|
14943
|
-
"package": "lit"
|
|
14944
|
-
},
|
|
14945
|
-
"localization": [],
|
|
14946
|
-
"status": "ready",
|
|
14947
|
-
"category": "navigation",
|
|
14948
|
-
"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",
|
|
14949
|
-
"examples": [],
|
|
14950
|
-
"dependencies": [],
|
|
14951
|
-
"tagName": "nord-tab-panel",
|
|
14952
|
-
"customElement": true
|
|
14953
|
-
}
|
|
14954
|
-
],
|
|
14955
|
-
"exports": [
|
|
14956
|
-
{
|
|
14957
|
-
"kind": "js",
|
|
14958
|
-
"name": "default",
|
|
14959
|
-
"declaration": {
|
|
14960
|
-
"name": "TabPanel",
|
|
14961
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
14962
|
-
}
|
|
14963
|
-
},
|
|
14964
|
-
{
|
|
14965
|
-
"kind": "custom-element-definition",
|
|
14966
|
-
"name": "nord-tab-panel",
|
|
14967
|
-
"declaration": {
|
|
14968
|
-
"name": "TabPanel",
|
|
14969
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
14970
|
-
}
|
|
14971
|
-
}
|
|
14972
|
-
]
|
|
14973
|
-
},
|
|
14974
14978
|
{
|
|
14975
14979
|
"kind": "javascript-module",
|
|
14976
14980
|
"path": "src/tab-group/TabGroup.ts",
|
|
@@ -15219,99 +15223,293 @@
|
|
|
15219
15223
|
},
|
|
15220
15224
|
{
|
|
15221
15225
|
"kind": "javascript-module",
|
|
15222
|
-
"path": "src/
|
|
15226
|
+
"path": "src/tab-panel/TabPanel.ts",
|
|
15223
15227
|
"declarations": [
|
|
15224
15228
|
{
|
|
15225
15229
|
"kind": "class",
|
|
15226
|
-
"description": "
|
|
15227
|
-
"name": "
|
|
15230
|
+
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15231
|
+
"name": "TabPanel",
|
|
15228
15232
|
"slots": [
|
|
15229
15233
|
{
|
|
15230
|
-
"description": "The
|
|
15234
|
+
"description": "The tab panel content.",
|
|
15231
15235
|
"name": ""
|
|
15232
15236
|
}
|
|
15233
15237
|
],
|
|
15234
|
-
"members": [
|
|
15235
|
-
|
|
15236
|
-
|
|
15237
|
-
|
|
15238
|
-
|
|
15239
|
-
|
|
15240
|
-
|
|
15238
|
+
"members": [],
|
|
15239
|
+
"superclass": {
|
|
15240
|
+
"name": "LitElement",
|
|
15241
|
+
"package": "lit"
|
|
15242
|
+
},
|
|
15243
|
+
"localization": [],
|
|
15244
|
+
"status": "ready",
|
|
15245
|
+
"category": "navigation",
|
|
15246
|
+
"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",
|
|
15247
|
+
"examples": [],
|
|
15248
|
+
"dependencies": [],
|
|
15249
|
+
"tagName": "nord-tab-panel",
|
|
15250
|
+
"customElement": true
|
|
15251
|
+
}
|
|
15252
|
+
],
|
|
15253
|
+
"exports": [
|
|
15254
|
+
{
|
|
15255
|
+
"kind": "js",
|
|
15256
|
+
"name": "default",
|
|
15257
|
+
"declaration": {
|
|
15258
|
+
"name": "TabPanel",
|
|
15259
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15260
|
+
}
|
|
15261
|
+
},
|
|
15262
|
+
{
|
|
15263
|
+
"kind": "custom-element-definition",
|
|
15264
|
+
"name": "nord-tab-panel",
|
|
15265
|
+
"declaration": {
|
|
15266
|
+
"name": "TabPanel",
|
|
15267
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15268
|
+
}
|
|
15269
|
+
}
|
|
15270
|
+
]
|
|
15271
|
+
},
|
|
15272
|
+
{
|
|
15273
|
+
"kind": "javascript-module",
|
|
15274
|
+
"path": "src/table/Table.ts",
|
|
15275
|
+
"declarations": [
|
|
15276
|
+
{
|
|
15277
|
+
"kind": "class",
|
|
15278
|
+
"description": "Table is used to organize and display information from a data set.\nProvides table styles in addition to features like sticky\nheaders and support for narrow viewports.",
|
|
15279
|
+
"name": "Table",
|
|
15280
|
+
"cssProperties": [
|
|
15241
15281
|
{
|
|
15242
|
-
"
|
|
15243
|
-
"name": "
|
|
15244
|
-
"
|
|
15245
|
-
"default": "new FormDataController(this, { value: () => this.formValue })"
|
|
15282
|
+
"description": "Controls the padding around the table cells.",
|
|
15283
|
+
"name": "--n-table-td-padding",
|
|
15284
|
+
"default": "calc(var(--n-space-m) * 0.95)"
|
|
15246
15285
|
},
|
|
15247
15286
|
{
|
|
15248
|
-
"
|
|
15249
|
-
"name": "
|
|
15250
|
-
"
|
|
15251
|
-
|
|
15252
|
-
|
|
15287
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
15288
|
+
"name": "--n-table-border-radius",
|
|
15289
|
+
"default": "var(--n-border-radius-s)"
|
|
15290
|
+
}
|
|
15291
|
+
],
|
|
15292
|
+
"slots": [
|
|
15253
15293
|
{
|
|
15254
|
-
"
|
|
15255
|
-
"name": "
|
|
15256
|
-
|
|
15257
|
-
|
|
15258
|
-
|
|
15259
|
-
"privacy": "protected",
|
|
15260
|
-
"default": "\"input\""
|
|
15261
|
-
},
|
|
15294
|
+
"description": "Default slot which holds the HTML `<table>` element.",
|
|
15295
|
+
"name": ""
|
|
15296
|
+
}
|
|
15297
|
+
],
|
|
15298
|
+
"members": [
|
|
15262
15299
|
{
|
|
15263
15300
|
"kind": "field",
|
|
15264
|
-
"name": "
|
|
15301
|
+
"name": "density",
|
|
15265
15302
|
"type": {
|
|
15266
|
-
"text": "\"
|
|
15303
|
+
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
15267
15304
|
},
|
|
15268
15305
|
"default": "\"default\"",
|
|
15269
|
-
"description": "
|
|
15270
|
-
"attribute": "
|
|
15306
|
+
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
15307
|
+
"attribute": "density",
|
|
15271
15308
|
"reflects": true
|
|
15272
15309
|
},
|
|
15273
15310
|
{
|
|
15274
15311
|
"kind": "field",
|
|
15275
|
-
"name": "
|
|
15312
|
+
"name": "scrollSnap",
|
|
15276
15313
|
"type": {
|
|
15277
15314
|
"text": "boolean"
|
|
15278
15315
|
},
|
|
15279
15316
|
"default": "false",
|
|
15280
|
-
"description": "
|
|
15281
|
-
"attribute": "
|
|
15282
|
-
"reflects": true
|
|
15283
|
-
},
|
|
15284
|
-
{
|
|
15285
|
-
"kind": "field",
|
|
15286
|
-
"name": "size",
|
|
15287
|
-
"type": {
|
|
15288
|
-
"text": "\"s\" | \"m\""
|
|
15289
|
-
},
|
|
15290
|
-
"default": "\"m\"",
|
|
15291
|
-
"description": "The size of the tag. This affects the font-size.",
|
|
15292
|
-
"attribute": "size",
|
|
15317
|
+
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
15318
|
+
"attribute": "scroll-snap",
|
|
15293
15319
|
"reflects": true
|
|
15294
15320
|
},
|
|
15295
15321
|
{
|
|
15296
15322
|
"kind": "field",
|
|
15297
|
-
"name": "
|
|
15323
|
+
"name": "striped",
|
|
15298
15324
|
"type": {
|
|
15299
15325
|
"text": "boolean"
|
|
15300
15326
|
},
|
|
15301
15327
|
"default": "false",
|
|
15302
|
-
"description": "Controls whether
|
|
15303
|
-
"attribute": "
|
|
15328
|
+
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
15329
|
+
"attribute": "striped",
|
|
15304
15330
|
"reflects": true
|
|
15305
15331
|
},
|
|
15306
15332
|
{
|
|
15307
15333
|
"kind": "method",
|
|
15308
|
-
"name": "
|
|
15309
|
-
"privacy": "
|
|
15310
|
-
"
|
|
15311
|
-
|
|
15312
|
-
|
|
15313
|
-
|
|
15314
|
-
|
|
15334
|
+
"name": "renderStyles",
|
|
15335
|
+
"privacy": "private",
|
|
15336
|
+
"description": "renders table styles into nearest root.\nthis is necessary since we do not use shadow dom."
|
|
15337
|
+
}
|
|
15338
|
+
],
|
|
15339
|
+
"attributes": [
|
|
15340
|
+
{
|
|
15341
|
+
"name": "density",
|
|
15342
|
+
"type": {
|
|
15343
|
+
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
15344
|
+
},
|
|
15345
|
+
"default": "\"default\"",
|
|
15346
|
+
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
15347
|
+
"fieldName": "density"
|
|
15348
|
+
},
|
|
15349
|
+
{
|
|
15350
|
+
"name": "scroll-snap",
|
|
15351
|
+
"type": {
|
|
15352
|
+
"text": "boolean"
|
|
15353
|
+
},
|
|
15354
|
+
"default": "false",
|
|
15355
|
+
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
15356
|
+
"fieldName": "scrollSnap"
|
|
15357
|
+
},
|
|
15358
|
+
{
|
|
15359
|
+
"name": "striped",
|
|
15360
|
+
"type": {
|
|
15361
|
+
"text": "boolean"
|
|
15362
|
+
},
|
|
15363
|
+
"default": "false",
|
|
15364
|
+
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
15365
|
+
"fieldName": "striped"
|
|
15366
|
+
}
|
|
15367
|
+
],
|
|
15368
|
+
"superclass": {
|
|
15369
|
+
"name": "LitElement",
|
|
15370
|
+
"package": "lit"
|
|
15371
|
+
},
|
|
15372
|
+
"localization": [],
|
|
15373
|
+
"status": "ready",
|
|
15374
|
+
"category": "list",
|
|
15375
|
+
"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 you need to display tabular data in a view.\n- Use a `<table>` element directly within the component.\n- Use inside a [Card](/components/card/?example=with+table), and give the card a header.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to display list data.\n- Don’t use to display basic key and value pairs, consider a [description list](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl) instead.\n- Don’t use tables for layout.\n- Don't use a primary button in every row of a table.\n\n</div>\n\n---\n\n## Content guidelines\n\nHeaders in a table should be clear, accurate and predictable. When writing headers, 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 account</div>\n<div class=\"n-usage n-usage-dont\">User Account</div>\n\nInclude units of measurement symbols in the table header so they aren’t repeated throughout every single column:\n\n<div class=\"n-usage n-usage-do\">Temperature °C</div>\n<div class=\"n-usage n-usage-dont\">Temperature</div>\n\nAvoid unnecessary words and articles in table headers, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Description</div>\n<div class=\"n-usage n-usage-dont\">A description</div>\n\nKeep decimals consistent. For example, don’t use 3 decimals in one row and 2 in others:\n\n<div class=\"n-usage n-usage-do\">30.00<br/>25.00</div>\n<div class=\"n-usage n-usage-dont\">30.000<br/>25.0</div>\n\n---\n\n## Additional considerations\n\n- Nord’s table component acts as a lightweight and un-opinionated _wrapper_ component for enhancing tabular data. It is up to the user of this component to make sure that the table markup they use is accessible.\n- Despite the name the Nord table component does not supplement the HTML `<table>` element. Please ensure that a `<table>` element is a direct descendant of the table component.\n- It’s important to pay close attention to semantics when authoring tables. The markup in the examples can be used as a starting point. However, be aware that [HTML tables have a large feature set](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) which cannot be fully covered in this documentation.\n- When making adjustments to table columns such as width, color, alignment and other styles please consider using the HTML `<col>` and `<colgroup>` elements for applying them. Further information on the `<col>` and `<colgroup>` elements can be [found in the MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/col).\n\n---\n\n## Advanced use-cases\n\nThe table component itself does not provide any functionality, only styles. This works well for simple or static tables, but there are instances where functionality such as sorting, resizing, or column dragging are required. This kind of functionality is out of scope for the table component, as the spectrum of possible use-cases is too broad for a single component to cover effectively. Whilst the table component is limited out of the box, these same limitations make it easy to integrate with third-party libraries which offer advanced functionality.\n\nBroadly speaking, there are two categories of library for building advanced tables: _headless_ and _component-based_.\n\n### Which kind of table library should I use?\n\nEach approach has subtle tradeoffs. Understanding these subtleties will help you make the right decision for your application and team.\n\n#### Component-based Table Libraries\n\nComponent-based table libraries will typically supply you with a feature-rich drop-in solution, and ready-to-use components/markup complete with styles/theming.\n\n**Pros:**\n\n- Ship with ready-to-use markup/styles.\n- Little setup required.\n- Turn-key experience.\n\n**Cons:**\n\n- Less control over markup.\n- Custom styles are typically theme-based.\n- Larger bundle-sizes.\n\nIf you want a ready-to-use table and design/bundle-size are not hard requirements, then you should consider using a component-based table library.\n\n#### Headless Table Libraries\n\nHeadless table libraries will typically supply you with functions, state, utilities and event listeners to build your own table markup or attach to existing table markups.\n\n**Pros:**\n\n- Full control over markup and styles.\n- Supports all styling patterns (CSS, CSS-in-JS, UI libraries, etc).\n- Smaller bundle-sizes.\n\n**Cons:**\n\n- More setup and effort required.\n- No markup, styles or themes provided.\n\nIf you want a lighter-weight table or full control over the design, then you should consider using a headless table library.\n\n### Recommendation for headless libraries\n\nIn the headless category, we recommend [Tanstack Table](https://tanstack.com/table/). Tanstack table offers integrations for many UI frameworks, such as Vue and React. It is easy to work with, and because it does not bring any HTML or styles itself, you can use it to render a plain, semantic `<table>` wrapped in a `<nord-table>`, and you will get all the necessary styles.\n\nWe have created examples in both Vue and React, showing how to combine Tanstack table with Nord's table component, in order to build a table with both sorting and resizable columns. Check out the [React example](/components/table/?example=with+react+and+tanstack+table) and likewise the [Vue example](/components/table/?example=with+vue+and+tanstack+table).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / Tanstack table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / Tanstack table source\n </nord-button>\n</nord-stack>\n\n### Recommendation for component-based libraries\n\nIn the component-based category, we recommend [AG Grid](https://www.ag-grid.com/), specifically the community edition. AG Grid is feature-rich, has extensive documentation, and offers integrations for many UI frameworks, such as Vue and React. AG Grid takes control of all rendering and output, but offers extension points for taking control of some aspects. It does not output a `<table>` element, so it cannot be used with Nord's own table component.\n\nHowever it can be styled via themes, and we have created a Nord theme using our design tokens. The theme is published on npm as `@nordhealth/ag-theme-nord`. To use the theme, include the CSS in your project and add the class `ag-theme-nord` to the element wrapping AG Grid.\n\nWe have created examples in both Vue and React showing how to combine AG Grid with Nord's theme, in order to build a table with sorting, resizable columns, draggable and re-orderable columns, plus sticky/pinned columns. Check out the [React example](/components/table/?example=with+react+and+ag+grid) and likewise the [Vue example](/components/table/?example=with+vue+and+ag+grid).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l n-margin-be-s\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / AG Grid table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / AG Grid table source\n </nord-button>\n</nord-stack>\n",
|
|
15376
|
+
"examples": [
|
|
15377
|
+
{
|
|
15378
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
15379
|
+
"name": "with react and tanstack table"
|
|
15380
|
+
},
|
|
15381
|
+
{
|
|
15382
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
15383
|
+
"name": "with react and ag grid"
|
|
15384
|
+
},
|
|
15385
|
+
{
|
|
15386
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
15387
|
+
"name": "with vue and tanstack table"
|
|
15388
|
+
},
|
|
15389
|
+
{
|
|
15390
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
15391
|
+
"name": "with vue and ag grid"
|
|
15392
|
+
}
|
|
15393
|
+
],
|
|
15394
|
+
"dependencies": [],
|
|
15395
|
+
"tagName": "nord-table",
|
|
15396
|
+
"customElement": true
|
|
15397
|
+
}
|
|
15398
|
+
],
|
|
15399
|
+
"exports": [
|
|
15400
|
+
{
|
|
15401
|
+
"kind": "js",
|
|
15402
|
+
"name": "default",
|
|
15403
|
+
"declaration": {
|
|
15404
|
+
"name": "Table",
|
|
15405
|
+
"module": "src/table/Table.ts"
|
|
15406
|
+
}
|
|
15407
|
+
},
|
|
15408
|
+
{
|
|
15409
|
+
"kind": "custom-element-definition",
|
|
15410
|
+
"name": "nord-table",
|
|
15411
|
+
"declaration": {
|
|
15412
|
+
"name": "Table",
|
|
15413
|
+
"module": "src/table/Table.ts"
|
|
15414
|
+
}
|
|
15415
|
+
}
|
|
15416
|
+
]
|
|
15417
|
+
},
|
|
15418
|
+
{
|
|
15419
|
+
"kind": "javascript-module",
|
|
15420
|
+
"path": "src/tag/Tag.ts",
|
|
15421
|
+
"declarations": [
|
|
15422
|
+
{
|
|
15423
|
+
"kind": "class",
|
|
15424
|
+
"description": "Tags represent a set of keywords that help label, categorize,\nand organize objects. Commonly used to signify the attributes of an object.",
|
|
15425
|
+
"name": "Tag",
|
|
15426
|
+
"slots": [
|
|
15427
|
+
{
|
|
15428
|
+
"description": "The tag content.",
|
|
15429
|
+
"name": ""
|
|
15430
|
+
}
|
|
15431
|
+
],
|
|
15432
|
+
"members": [
|
|
15433
|
+
{
|
|
15434
|
+
"kind": "field",
|
|
15435
|
+
"name": "localize",
|
|
15436
|
+
"privacy": "private",
|
|
15437
|
+
"default": "new LocalizeController<\"nord-tag\">(this)"
|
|
15438
|
+
},
|
|
15439
|
+
{
|
|
15440
|
+
"kind": "field",
|
|
15441
|
+
"name": "formData",
|
|
15442
|
+
"privacy": "protected",
|
|
15443
|
+
"default": "new FormDataController(this, { value: () => this.formValue })"
|
|
15444
|
+
},
|
|
15445
|
+
{
|
|
15446
|
+
"kind": "field",
|
|
15447
|
+
"name": "formValue",
|
|
15448
|
+
"privacy": "protected",
|
|
15449
|
+
"readonly": true
|
|
15450
|
+
},
|
|
15451
|
+
{
|
|
15452
|
+
"kind": "field",
|
|
15453
|
+
"name": "inputId",
|
|
15454
|
+
"type": {
|
|
15455
|
+
"text": "string"
|
|
15456
|
+
},
|
|
15457
|
+
"privacy": "protected",
|
|
15458
|
+
"default": "\"input\""
|
|
15459
|
+
},
|
|
15460
|
+
{
|
|
15461
|
+
"kind": "field",
|
|
15462
|
+
"name": "variant",
|
|
15463
|
+
"type": {
|
|
15464
|
+
"text": "\"default\" | \"removable\" | \"selectable\""
|
|
15465
|
+
},
|
|
15466
|
+
"default": "\"default\"",
|
|
15467
|
+
"description": "The behavioral variant of the tag.",
|
|
15468
|
+
"attribute": "variant",
|
|
15469
|
+
"reflects": true
|
|
15470
|
+
},
|
|
15471
|
+
{
|
|
15472
|
+
"kind": "field",
|
|
15473
|
+
"name": "checked",
|
|
15474
|
+
"type": {
|
|
15475
|
+
"text": "boolean"
|
|
15476
|
+
},
|
|
15477
|
+
"default": "false",
|
|
15478
|
+
"description": "Controls whether the tag is checked or not (only relevant when variant is set to `selectable`).",
|
|
15479
|
+
"attribute": "checked",
|
|
15480
|
+
"reflects": true
|
|
15481
|
+
},
|
|
15482
|
+
{
|
|
15483
|
+
"kind": "field",
|
|
15484
|
+
"name": "size",
|
|
15485
|
+
"type": {
|
|
15486
|
+
"text": "\"s\" | \"m\""
|
|
15487
|
+
},
|
|
15488
|
+
"default": "\"m\"",
|
|
15489
|
+
"description": "The size of the tag. This affects the font-size.",
|
|
15490
|
+
"attribute": "size",
|
|
15491
|
+
"reflects": true
|
|
15492
|
+
},
|
|
15493
|
+
{
|
|
15494
|
+
"kind": "field",
|
|
15495
|
+
"name": "expand",
|
|
15496
|
+
"type": {
|
|
15497
|
+
"text": "boolean"
|
|
15498
|
+
},
|
|
15499
|
+
"default": "false",
|
|
15500
|
+
"description": "Controls whether the tag expands to fill the width of its container.",
|
|
15501
|
+
"attribute": "expand",
|
|
15502
|
+
"reflects": true
|
|
15503
|
+
},
|
|
15504
|
+
{
|
|
15505
|
+
"kind": "method",
|
|
15506
|
+
"name": "handleChange",
|
|
15507
|
+
"privacy": "protected",
|
|
15508
|
+
"parameters": [
|
|
15509
|
+
{
|
|
15510
|
+
"name": "e",
|
|
15511
|
+
"type": {
|
|
15512
|
+
"text": "Event"
|
|
15315
15513
|
}
|
|
15316
15514
|
}
|
|
15317
15515
|
]
|
|
@@ -15644,356 +15842,140 @@
|
|
|
15644
15842
|
},
|
|
15645
15843
|
{
|
|
15646
15844
|
"kind": "javascript-module",
|
|
15647
|
-
"path": "src/
|
|
15845
|
+
"path": "src/tag-group/TagGroup.ts",
|
|
15648
15846
|
"declarations": [
|
|
15649
15847
|
{
|
|
15650
15848
|
"kind": "class",
|
|
15651
|
-
"description": "
|
|
15652
|
-
"name": "
|
|
15849
|
+
"description": "Tag groups are designed to bring together selectable tags that are of a similar nature. For example categories you can filter by.",
|
|
15850
|
+
"name": "TagGroup",
|
|
15653
15851
|
"cssProperties": [
|
|
15654
15852
|
{
|
|
15655
|
-
"description": "Controls the
|
|
15656
|
-
"name": "--n-
|
|
15657
|
-
"default": "
|
|
15853
|
+
"description": "Controls the rounded corners of the tag group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
15854
|
+
"name": "--n-tag-group-border-radius",
|
|
15855
|
+
"default": "var(--n-border-radius-s)"
|
|
15658
15856
|
},
|
|
15659
15857
|
{
|
|
15660
|
-
"description": "Controls
|
|
15661
|
-
"name": "--n-
|
|
15662
|
-
"default": "var(--n-
|
|
15858
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
15859
|
+
"name": "--n-tag-group-box-shadow",
|
|
15860
|
+
"default": "var(--n-box-shadow)"
|
|
15663
15861
|
}
|
|
15664
15862
|
],
|
|
15665
15863
|
"slots": [
|
|
15666
15864
|
{
|
|
15667
|
-
"description": "
|
|
15865
|
+
"description": "The tag group content",
|
|
15668
15866
|
"name": ""
|
|
15669
15867
|
}
|
|
15670
15868
|
],
|
|
15671
15869
|
"members": [
|
|
15672
15870
|
{
|
|
15673
15871
|
"kind": "field",
|
|
15674
|
-
"name": "
|
|
15675
|
-
"type": {
|
|
15676
|
-
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
15677
|
-
},
|
|
15678
|
-
"default": "\"default\"",
|
|
15679
|
-
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
15680
|
-
"attribute": "density",
|
|
15681
|
-
"reflects": true
|
|
15682
|
-
},
|
|
15683
|
-
{
|
|
15684
|
-
"kind": "field",
|
|
15685
|
-
"name": "scrollSnap",
|
|
15686
|
-
"type": {
|
|
15687
|
-
"text": "boolean"
|
|
15688
|
-
},
|
|
15689
|
-
"default": "false",
|
|
15690
|
-
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
15691
|
-
"attribute": "scroll-snap",
|
|
15692
|
-
"reflects": true
|
|
15693
|
-
},
|
|
15694
|
-
{
|
|
15695
|
-
"kind": "field",
|
|
15696
|
-
"name": "striped",
|
|
15697
|
-
"type": {
|
|
15698
|
-
"text": "boolean"
|
|
15699
|
-
},
|
|
15700
|
-
"default": "false",
|
|
15701
|
-
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
15702
|
-
"attribute": "striped",
|
|
15703
|
-
"reflects": true
|
|
15704
|
-
},
|
|
15705
|
-
{
|
|
15706
|
-
"kind": "method",
|
|
15707
|
-
"name": "renderStyles",
|
|
15872
|
+
"name": "defaultSlot",
|
|
15708
15873
|
"privacy": "private",
|
|
15709
|
-
"
|
|
15710
|
-
}
|
|
15711
|
-
],
|
|
15712
|
-
"attributes": [
|
|
15713
|
-
{
|
|
15714
|
-
"name": "density",
|
|
15715
|
-
"type": {
|
|
15716
|
-
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
15717
|
-
},
|
|
15718
|
-
"default": "\"default\"",
|
|
15719
|
-
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
15720
|
-
"fieldName": "density"
|
|
15721
|
-
},
|
|
15722
|
-
{
|
|
15723
|
-
"name": "scroll-snap",
|
|
15724
|
-
"type": {
|
|
15725
|
-
"text": "boolean"
|
|
15726
|
-
},
|
|
15727
|
-
"default": "false",
|
|
15728
|
-
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
15729
|
-
"fieldName": "scrollSnap"
|
|
15730
|
-
},
|
|
15731
|
-
{
|
|
15732
|
-
"name": "striped",
|
|
15733
|
-
"type": {
|
|
15734
|
-
"text": "boolean"
|
|
15735
|
-
},
|
|
15736
|
-
"default": "false",
|
|
15737
|
-
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
15738
|
-
"fieldName": "striped"
|
|
15739
|
-
}
|
|
15740
|
-
],
|
|
15741
|
-
"superclass": {
|
|
15742
|
-
"name": "LitElement",
|
|
15743
|
-
"package": "lit"
|
|
15744
|
-
},
|
|
15745
|
-
"localization": [],
|
|
15746
|
-
"status": "ready",
|
|
15747
|
-
"category": "list",
|
|
15748
|
-
"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 you need to display tabular data in a view.\n- Use a `<table>` element directly within the component.\n- Use inside a [Card](/components/card/?example=with+table), and give the card a header.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to display list data.\n- Don’t use to display basic key and value pairs, consider a [description list](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl) instead.\n- Don’t use tables for layout.\n- Don't use a primary button in every row of a table.\n\n</div>\n\n---\n\n## Content guidelines\n\nHeaders in a table should be clear, accurate and predictable. When writing headers, 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 account</div>\n<div class=\"n-usage n-usage-dont\">User Account</div>\n\nInclude units of measurement symbols in the table header so they aren’t repeated throughout every single column:\n\n<div class=\"n-usage n-usage-do\">Temperature °C</div>\n<div class=\"n-usage n-usage-dont\">Temperature</div>\n\nAvoid unnecessary words and articles in table headers, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Description</div>\n<div class=\"n-usage n-usage-dont\">A description</div>\n\nKeep decimals consistent. For example, don’t use 3 decimals in one row and 2 in others:\n\n<div class=\"n-usage n-usage-do\">30.00<br/>25.00</div>\n<div class=\"n-usage n-usage-dont\">30.000<br/>25.0</div>\n\n---\n\n## Additional considerations\n\n- Nord’s table component acts as a lightweight and un-opinionated _wrapper_ component for enhancing tabular data. It is up to the user of this component to make sure that the table markup they use is accessible.\n- Despite the name the Nord table component does not supplement the HTML `<table>` element. Please ensure that a `<table>` element is a direct descendant of the table component.\n- It’s important to pay close attention to semantics when authoring tables. The markup in the examples can be used as a starting point. However, be aware that [HTML tables have a large feature set](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) which cannot be fully covered in this documentation.\n- When making adjustments to table columns such as width, color, alignment and other styles please consider using the HTML `<col>` and `<colgroup>` elements for applying them. Further information on the `<col>` and `<colgroup>` elements can be [found in the MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/col).\n\n---\n\n## Advanced use-cases\n\nThe table component itself does not provide any functionality, only styles. This works well for simple or static tables, but there are instances where functionality such as sorting, resizing, or column dragging are required. This kind of functionality is out of scope for the table component, as the spectrum of possible use-cases is too broad for a single component to cover effectively. Whilst the table component is limited out of the box, these same limitations make it easy to integrate with third-party libraries which offer advanced functionality.\n\nBroadly speaking, there are two categories of library for building advanced tables: _headless_ and _component-based_.\n\n### Which kind of table library should I use?\n\nEach approach has subtle tradeoffs. Understanding these subtleties will help you make the right decision for your application and team.\n\n#### Component-based Table Libraries\n\nComponent-based table libraries will typically supply you with a feature-rich drop-in solution, and ready-to-use components/markup complete with styles/theming.\n\n**Pros:**\n\n- Ship with ready-to-use markup/styles.\n- Little setup required.\n- Turn-key experience.\n\n**Cons:**\n\n- Less control over markup.\n- Custom styles are typically theme-based.\n- Larger bundle-sizes.\n\nIf you want a ready-to-use table and design/bundle-size are not hard requirements, then you should consider using a component-based table library.\n\n#### Headless Table Libraries\n\nHeadless table libraries will typically supply you with functions, state, utilities and event listeners to build your own table markup or attach to existing table markups.\n\n**Pros:**\n\n- Full control over markup and styles.\n- Supports all styling patterns (CSS, CSS-in-JS, UI libraries, etc).\n- Smaller bundle-sizes.\n\n**Cons:**\n\n- More setup and effort required.\n- No markup, styles or themes provided.\n\nIf you want a lighter-weight table or full control over the design, then you should consider using a headless table library.\n\n### Recommendation for headless libraries\n\nIn the headless category, we recommend [Tanstack Table](https://tanstack.com/table/). Tanstack table offers integrations for many UI frameworks, such as Vue and React. It is easy to work with, and because it does not bring any HTML or styles itself, you can use it to render a plain, semantic `<table>` wrapped in a `<nord-table>`, and you will get all the necessary styles.\n\nWe have created examples in both Vue and React, showing how to combine Tanstack table with Nord's table component, in order to build a table with both sorting and resizable columns. Check out the [React example](/components/table/?example=with+react+and+tanstack+table) and likewise the [Vue example](/components/table/?example=with+vue+and+tanstack+table).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / Tanstack table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / Tanstack table source\n </nord-button>\n</nord-stack>\n\n### Recommendation for component-based libraries\n\nIn the component-based category, we recommend [AG Grid](https://www.ag-grid.com/), specifically the community edition. AG Grid is feature-rich, has extensive documentation, and offers integrations for many UI frameworks, such as Vue and React. AG Grid takes control of all rendering and output, but offers extension points for taking control of some aspects. It does not output a `<table>` element, so it cannot be used with Nord's own table component.\n\nHowever it can be styled via themes, and we have created a Nord theme using our design tokens. The theme is published on npm as `@nordhealth/ag-theme-nord`. To use the theme, include the CSS in your project and add the class `ag-theme-nord` to the element wrapping AG Grid.\n\nWe have created examples in both Vue and React showing how to combine AG Grid with Nord's theme, in order to build a table with sorting, resizable columns, draggable and re-orderable columns, plus sticky/pinned columns. Check out the [React example](/components/table/?example=with+react+and+ag+grid) and likewise the [Vue example](/components/table/?example=with+vue+and+ag+grid).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l n-margin-be-s\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / AG Grid table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / AG Grid table source\n </nord-button>\n</nord-stack>\n",
|
|
15749
|
-
"examples": [
|
|
15750
|
-
{
|
|
15751
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
15752
|
-
"name": "with react and tanstack table"
|
|
15753
|
-
},
|
|
15754
|
-
{
|
|
15755
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
15756
|
-
"name": "with react and ag grid"
|
|
15757
|
-
},
|
|
15758
|
-
{
|
|
15759
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
15760
|
-
"name": "with vue and tanstack table"
|
|
15874
|
+
"default": "new SlotController(this)"
|
|
15761
15875
|
},
|
|
15762
|
-
{
|
|
15763
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
15764
|
-
"name": "with vue and ag grid"
|
|
15765
|
-
}
|
|
15766
|
-
],
|
|
15767
|
-
"dependencies": [],
|
|
15768
|
-
"tagName": "nord-table",
|
|
15769
|
-
"customElement": true
|
|
15770
|
-
}
|
|
15771
|
-
],
|
|
15772
|
-
"exports": [
|
|
15773
|
-
{
|
|
15774
|
-
"kind": "js",
|
|
15775
|
-
"name": "default",
|
|
15776
|
-
"declaration": {
|
|
15777
|
-
"name": "Table",
|
|
15778
|
-
"module": "src/table/Table.ts"
|
|
15779
|
-
}
|
|
15780
|
-
},
|
|
15781
|
-
{
|
|
15782
|
-
"kind": "custom-element-definition",
|
|
15783
|
-
"name": "nord-table",
|
|
15784
|
-
"declaration": {
|
|
15785
|
-
"name": "Table",
|
|
15786
|
-
"module": "src/table/Table.ts"
|
|
15787
|
-
}
|
|
15788
|
-
}
|
|
15789
|
-
]
|
|
15790
|
-
},
|
|
15791
|
-
{
|
|
15792
|
-
"kind": "javascript-module",
|
|
15793
|
-
"path": "src/toast/Toast.ts",
|
|
15794
|
-
"declarations": [
|
|
15795
|
-
{
|
|
15796
|
-
"kind": "class",
|
|
15797
|
-
"description": "Toasts are non-disruptive messages that appear in the interface\nto provide quick, at-a-glance feedback on the outcome of an action.",
|
|
15798
|
-
"name": "Toast",
|
|
15799
|
-
"slots": [
|
|
15800
|
-
{
|
|
15801
|
-
"description": "Default slot used for the toast text/message.",
|
|
15802
|
-
"name": ""
|
|
15803
|
-
}
|
|
15804
|
-
],
|
|
15805
|
-
"members": [
|
|
15806
15876
|
{
|
|
15807
15877
|
"kind": "field",
|
|
15808
|
-
"name": "
|
|
15809
|
-
"
|
|
15810
|
-
|
|
15811
|
-
},
|
|
15812
|
-
"privacy": "private"
|
|
15878
|
+
"name": "dirController",
|
|
15879
|
+
"privacy": "private",
|
|
15880
|
+
"default": "new DirectionController(this)"
|
|
15813
15881
|
},
|
|
15814
15882
|
{
|
|
15815
15883
|
"kind": "field",
|
|
15816
15884
|
"name": "variant",
|
|
15817
15885
|
"type": {
|
|
15818
|
-
"text": "\"default\" | \"
|
|
15886
|
+
"text": "\"default\" | \"spaced\""
|
|
15819
15887
|
},
|
|
15820
15888
|
"default": "\"default\"",
|
|
15821
|
-
"description": "The style variant of the
|
|
15889
|
+
"description": "The style variant of the tag group.",
|
|
15822
15890
|
"attribute": "variant",
|
|
15823
15891
|
"reflects": true
|
|
15824
15892
|
},
|
|
15825
15893
|
{
|
|
15826
15894
|
"kind": "field",
|
|
15827
|
-
"name": "
|
|
15895
|
+
"name": "direction",
|
|
15828
15896
|
"type": {
|
|
15829
|
-
"text": "
|
|
15897
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
15830
15898
|
},
|
|
15831
|
-
"default": "
|
|
15832
|
-
"description": "
|
|
15833
|
-
"attribute": "
|
|
15899
|
+
"default": "\"horizontal\"",
|
|
15900
|
+
"description": "The direction of the tag group.",
|
|
15901
|
+
"attribute": "direction",
|
|
15834
15902
|
"reflects": true
|
|
15835
15903
|
},
|
|
15836
|
-
{
|
|
15837
|
-
"kind": "method",
|
|
15838
|
-
"name": "dismiss",
|
|
15839
|
-
"description": "Programmatically dismiss the toast.\nThe returned promise resolves when toast's exit animation is complete.",
|
|
15840
|
-
"inheritedFrom": {
|
|
15841
|
-
"name": "NotificationMixin",
|
|
15842
|
-
"module": "src/common/mixins/NotificationMixin.ts"
|
|
15843
|
-
}
|
|
15844
|
-
},
|
|
15845
|
-
{
|
|
15846
|
-
"kind": "method",
|
|
15847
|
-
"name": "handleAutoDismissChange",
|
|
15848
|
-
"privacy": "protected"
|
|
15849
|
-
},
|
|
15850
15904
|
{
|
|
15851
15905
|
"kind": "field",
|
|
15852
|
-
"name": "
|
|
15853
|
-
"privacy": "protected",
|
|
15854
|
-
"inheritedFrom": {
|
|
15855
|
-
"name": "NotificationMixin",
|
|
15856
|
-
"module": "src/common/mixins/NotificationMixin.ts"
|
|
15857
|
-
}
|
|
15858
|
-
},
|
|
15859
|
-
{
|
|
15860
|
-
"kind": "field",
|
|
15861
|
-
"name": "dismissed",
|
|
15906
|
+
"name": "wrap",
|
|
15862
15907
|
"type": {
|
|
15863
15908
|
"text": "boolean"
|
|
15864
15909
|
},
|
|
15865
|
-
"privacy": "protected",
|
|
15866
15910
|
"default": "false",
|
|
15867
|
-
"
|
|
15868
|
-
|
|
15869
|
-
|
|
15870
|
-
|
|
15871
|
-
}
|
|
15872
|
-
],
|
|
15873
|
-
"events": [
|
|
15911
|
+
"description": "Defines whether the tags are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
15912
|
+
"attribute": "wrap",
|
|
15913
|
+
"reflects": true
|
|
15914
|
+
},
|
|
15874
15915
|
{
|
|
15875
|
-
"
|
|
15916
|
+
"kind": "field",
|
|
15917
|
+
"name": "role",
|
|
15876
15918
|
"type": {
|
|
15877
|
-
"text": "
|
|
15919
|
+
"text": "string"
|
|
15878
15920
|
},
|
|
15879
|
-
"
|
|
15880
|
-
"
|
|
15881
|
-
|
|
15882
|
-
|
|
15883
|
-
}
|
|
15921
|
+
"default": "\"group\"",
|
|
15922
|
+
"description": "The appropriate role for the containing element.",
|
|
15923
|
+
"attribute": "role",
|
|
15924
|
+
"reflects": true
|
|
15884
15925
|
}
|
|
15885
15926
|
],
|
|
15886
|
-
"
|
|
15927
|
+
"events": [
|
|
15887
15928
|
{
|
|
15888
|
-
"name": "variant",
|
|
15889
15929
|
"type": {
|
|
15890
|
-
"text": "
|
|
15930
|
+
"text": "NordEvent"
|
|
15891
15931
|
},
|
|
15892
|
-
"
|
|
15893
|
-
"
|
|
15894
|
-
"fieldName": "variant"
|
|
15932
|
+
"description": "Fired whenever a tag has been checked or unchecked via user interaction.",
|
|
15933
|
+
"name": "change"
|
|
15895
15934
|
},
|
|
15896
15935
|
{
|
|
15897
|
-
"name": "auto-dismiss",
|
|
15898
15936
|
"type": {
|
|
15899
|
-
"text": "
|
|
15937
|
+
"text": "NordEvent"
|
|
15900
15938
|
},
|
|
15901
|
-
"
|
|
15902
|
-
"
|
|
15903
|
-
"fieldName": "autoDismiss"
|
|
15904
|
-
}
|
|
15905
|
-
],
|
|
15906
|
-
"mixins": [
|
|
15907
|
-
{
|
|
15908
|
-
"name": "NotificationMixin",
|
|
15909
|
-
"module": "/src/common/mixins/NotificationMixin.js"
|
|
15910
|
-
}
|
|
15911
|
-
],
|
|
15912
|
-
"superclass": {
|
|
15913
|
-
"name": "LitElement",
|
|
15914
|
-
"package": "lit"
|
|
15915
|
-
},
|
|
15916
|
-
"localization": [],
|
|
15917
|
-
"status": "ready",
|
|
15918
|
-
"category": "feedback",
|
|
15919
|
-
"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. Consider using a [Notification](/components/notification) instead.\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",
|
|
15920
|
-
"examples": [],
|
|
15921
|
-
"dependencies": [
|
|
15922
|
-
"icon"
|
|
15923
|
-
],
|
|
15924
|
-
"tagName": "nord-toast",
|
|
15925
|
-
"customElement": true
|
|
15926
|
-
}
|
|
15927
|
-
],
|
|
15928
|
-
"exports": [
|
|
15929
|
-
{
|
|
15930
|
-
"kind": "js",
|
|
15931
|
-
"name": "default",
|
|
15932
|
-
"declaration": {
|
|
15933
|
-
"name": "Toast",
|
|
15934
|
-
"module": "src/toast/Toast.ts"
|
|
15935
|
-
}
|
|
15936
|
-
},
|
|
15937
|
-
{
|
|
15938
|
-
"kind": "custom-element-definition",
|
|
15939
|
-
"name": "nord-toast",
|
|
15940
|
-
"declaration": {
|
|
15941
|
-
"name": "Toast",
|
|
15942
|
-
"module": "src/toast/Toast.ts"
|
|
15943
|
-
}
|
|
15944
|
-
}
|
|
15945
|
-
]
|
|
15946
|
-
},
|
|
15947
|
-
{
|
|
15948
|
-
"kind": "javascript-module",
|
|
15949
|
-
"path": "src/toast-group/ToastGroup.ts",
|
|
15950
|
-
"declarations": [
|
|
15951
|
-
{
|
|
15952
|
-
"kind": "class",
|
|
15953
|
-
"description": "Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.",
|
|
15954
|
-
"name": "ToastGroup",
|
|
15955
|
-
"slots": [
|
|
15956
|
-
{
|
|
15957
|
-
"description": "Default slot in which to place toasts.",
|
|
15958
|
-
"name": ""
|
|
15939
|
+
"description": "Fired when the remove button is activated on a tag. This event should be used to remove the tag from the DOM.",
|
|
15940
|
+
"name": "remove"
|
|
15959
15941
|
}
|
|
15960
15942
|
],
|
|
15961
|
-
"
|
|
15943
|
+
"attributes": [
|
|
15962
15944
|
{
|
|
15963
|
-
"
|
|
15964
|
-
"
|
|
15965
|
-
|
|
15966
|
-
|
|
15967
|
-
|
|
15968
|
-
|
|
15969
|
-
|
|
15970
|
-
|
|
15971
|
-
"description": "The text/message of the toast."
|
|
15972
|
-
},
|
|
15973
|
-
{
|
|
15974
|
-
"name": "options",
|
|
15975
|
-
"default": "{}",
|
|
15976
|
-
"type": {
|
|
15977
|
-
"text": "ToastOptions"
|
|
15978
|
-
},
|
|
15979
|
-
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
15980
|
-
}
|
|
15981
|
-
],
|
|
15982
|
-
"description": "Convenience method for creating and adding a toast to the group.",
|
|
15983
|
-
"return": {
|
|
15984
|
-
"type": {
|
|
15985
|
-
"text": "Toast"
|
|
15986
|
-
}
|
|
15987
|
-
}
|
|
15988
|
-
}
|
|
15989
|
-
],
|
|
15990
|
-
"events": [
|
|
15945
|
+
"name": "variant",
|
|
15946
|
+
"type": {
|
|
15947
|
+
"text": "\"default\" | \"spaced\""
|
|
15948
|
+
},
|
|
15949
|
+
"default": "\"default\"",
|
|
15950
|
+
"description": "The style variant of the tag group.",
|
|
15951
|
+
"fieldName": "variant"
|
|
15952
|
+
},
|
|
15991
15953
|
{
|
|
15954
|
+
"name": "direction",
|
|
15992
15955
|
"type": {
|
|
15993
|
-
"text": "
|
|
15956
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
15994
15957
|
},
|
|
15995
|
-
"
|
|
15996
|
-
"
|
|
15958
|
+
"default": "\"horizontal\"",
|
|
15959
|
+
"description": "The direction of the tag group.",
|
|
15960
|
+
"fieldName": "direction"
|
|
15961
|
+
},
|
|
15962
|
+
{
|
|
15963
|
+
"name": "wrap",
|
|
15964
|
+
"type": {
|
|
15965
|
+
"text": "boolean"
|
|
15966
|
+
},
|
|
15967
|
+
"default": "false",
|
|
15968
|
+
"description": "Defines whether the tags are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
15969
|
+
"fieldName": "wrap"
|
|
15970
|
+
},
|
|
15971
|
+
{
|
|
15972
|
+
"name": "role",
|
|
15973
|
+
"type": {
|
|
15974
|
+
"text": "string"
|
|
15975
|
+
},
|
|
15976
|
+
"default": "\"group\"",
|
|
15977
|
+
"description": "The appropriate role for the containing element.",
|
|
15978
|
+
"fieldName": "role"
|
|
15997
15979
|
}
|
|
15998
15980
|
],
|
|
15999
15981
|
"superclass": {
|
|
@@ -16001,14 +15983,12 @@
|
|
|
16001
15983
|
"package": "lit"
|
|
16002
15984
|
},
|
|
16003
15985
|
"localization": [],
|
|
16004
|
-
"status": "
|
|
16005
|
-
"category": "
|
|
16006
|
-
"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
|
|
15986
|
+
"status": "new",
|
|
15987
|
+
"category": "structure",
|
|
15988
|
+
"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 group together selectable tags.\n- Use the appropriate `role` attribute on the tag group to provide additional semantics.\n- Use an `aria-labelledby` attribute referencing another element to best explain the contents of the tag group.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t add components other than selectable tags and in some instances visually hidden components to the tag group.\n- Don’t skip the addition of an appropriate label if the added `role` attribute value calls for it.\n- Don’t use for building grid based layouts.\n\n</div>\n\n---\n\n## Content guidelines\n\nTags should use short and clear labels for easy scanning. They should be concise and informative:\n\n<div class=\"n-usage n-usage-do\">Has seizures</div>\n<div class=\"n-usage n-usage-dont\">This dog has seizures often</div>\n\nWhen writing tag 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\">Service dog</div>\n<div class=\"n-usage n-usage-dont\">Service Dog</div>\n\nAvoid unnecessary words and articles in tag labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Service dog</div>\n<div class=\"n-usage n-usage-dont\">A service dog</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| `default` | The default variant renders a group of tags to emphasize that they’re thematically-related. |\n| `spaced` | The spaced variant renders a gap between the tags to space them out evenly. |\n",
|
|
16007
15989
|
"examples": [],
|
|
16008
|
-
"dependencies": [
|
|
16009
|
-
|
|
16010
|
-
],
|
|
16011
|
-
"tagName": "nord-toast-group",
|
|
15990
|
+
"dependencies": [],
|
|
15991
|
+
"tagName": "nord-tag-group",
|
|
16012
15992
|
"customElement": true
|
|
16013
15993
|
}
|
|
16014
15994
|
],
|
|
@@ -16017,16 +15997,16 @@
|
|
|
16017
15997
|
"kind": "js",
|
|
16018
15998
|
"name": "default",
|
|
16019
15999
|
"declaration": {
|
|
16020
|
-
"name": "
|
|
16021
|
-
"module": "src/
|
|
16000
|
+
"name": "TagGroup",
|
|
16001
|
+
"module": "src/tag-group/TagGroup.ts"
|
|
16022
16002
|
}
|
|
16023
16003
|
},
|
|
16024
16004
|
{
|
|
16025
16005
|
"kind": "custom-element-definition",
|
|
16026
|
-
"name": "nord-
|
|
16006
|
+
"name": "nord-tag-group",
|
|
16027
16007
|
"declaration": {
|
|
16028
|
-
"name": "
|
|
16029
|
-
"module": "src/
|
|
16008
|
+
"name": "TagGroup",
|
|
16009
|
+
"module": "src/tag-group/TagGroup.ts"
|
|
16030
16010
|
}
|
|
16031
16011
|
}
|
|
16032
16012
|
]
|
|
@@ -16957,107 +16937,287 @@
|
|
|
16957
16937
|
"description": "Makes the component readonly, so that it is not editable.\nReadonly differs from disabled in that readonly fields are still focusable and will be submitted with a form.",
|
|
16958
16938
|
"fieldName": "readonly",
|
|
16959
16939
|
"inheritedFrom": {
|
|
16960
|
-
"name": "ReadonlyMixin",
|
|
16961
|
-
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
16940
|
+
"name": "ReadonlyMixin",
|
|
16941
|
+
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
16942
|
+
}
|
|
16943
|
+
},
|
|
16944
|
+
{
|
|
16945
|
+
"name": "disabled",
|
|
16946
|
+
"type": {
|
|
16947
|
+
"text": "boolean"
|
|
16948
|
+
},
|
|
16949
|
+
"default": "false",
|
|
16950
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
16951
|
+
"fieldName": "disabled",
|
|
16952
|
+
"inheritedFrom": {
|
|
16953
|
+
"name": "InputMixin",
|
|
16954
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
16955
|
+
}
|
|
16956
|
+
},
|
|
16957
|
+
{
|
|
16958
|
+
"name": "name",
|
|
16959
|
+
"type": {
|
|
16960
|
+
"text": "string | undefined"
|
|
16961
|
+
},
|
|
16962
|
+
"description": "The name of the form component.",
|
|
16963
|
+
"fieldName": "name",
|
|
16964
|
+
"inheritedFrom": {
|
|
16965
|
+
"name": "InputMixin",
|
|
16966
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
16967
|
+
}
|
|
16968
|
+
},
|
|
16969
|
+
{
|
|
16970
|
+
"name": "value",
|
|
16971
|
+
"type": {
|
|
16972
|
+
"text": "string"
|
|
16973
|
+
},
|
|
16974
|
+
"default": "\"\"",
|
|
16975
|
+
"description": "The value of the form component.",
|
|
16976
|
+
"fieldName": "value",
|
|
16977
|
+
"inheritedFrom": {
|
|
16978
|
+
"name": "InputMixin",
|
|
16979
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
16980
|
+
}
|
|
16981
|
+
},
|
|
16982
|
+
{
|
|
16983
|
+
"name": "form",
|
|
16984
|
+
"type": {
|
|
16985
|
+
"text": "HTMLFormElement | null"
|
|
16986
|
+
},
|
|
16987
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
16988
|
+
"fieldName": "form",
|
|
16989
|
+
"inheritedFrom": {
|
|
16990
|
+
"name": "InputMixin",
|
|
16991
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
16992
|
+
}
|
|
16993
|
+
}
|
|
16994
|
+
],
|
|
16995
|
+
"mixins": [
|
|
16996
|
+
{
|
|
16997
|
+
"name": "SizeMixin",
|
|
16998
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
16999
|
+
},
|
|
17000
|
+
{
|
|
17001
|
+
"name": "FormAssociatedMixin",
|
|
17002
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
17003
|
+
},
|
|
17004
|
+
{
|
|
17005
|
+
"name": "AutocompleteMixin",
|
|
17006
|
+
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
17007
|
+
},
|
|
17008
|
+
{
|
|
17009
|
+
"name": "ReadonlyMixin",
|
|
17010
|
+
"module": "/src/common/mixins/ReadonlyMixin.js"
|
|
17011
|
+
},
|
|
17012
|
+
{
|
|
17013
|
+
"name": "TextSelectableMixin",
|
|
17014
|
+
"module": "/src/common/mixins/TextSelectableMixin.js"
|
|
17015
|
+
},
|
|
17016
|
+
{
|
|
17017
|
+
"name": "InputMixin",
|
|
17018
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
17019
|
+
},
|
|
17020
|
+
{
|
|
17021
|
+
"name": "FocusableMixin",
|
|
17022
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
17023
|
+
}
|
|
17024
|
+
],
|
|
17025
|
+
"superclass": {
|
|
17026
|
+
"name": "LitElement",
|
|
17027
|
+
"package": "lit"
|
|
17028
|
+
},
|
|
17029
|
+
"localization": [
|
|
17030
|
+
{
|
|
17031
|
+
"name": "remainingCharacters",
|
|
17032
|
+
"description": "A function which receives the number of remaining characters and returns a string to be used as the aria-live message."
|
|
17033
|
+
}
|
|
17034
|
+
],
|
|
17035
|
+
"status": "ready",
|
|
17036
|
+
"category": "form",
|
|
17037
|
+
"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 text input where the expected input is long.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when the expected text input is short. Use input component instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nTextarea labels act as a title for the text field. Labels should typically be short and in noun form:\n\n<div class=\"n-usage n-usage-do\">Company name</div>\n<div class=\"n-usage n-usage-dont\">What is your company name?</div>\n\nWhen writing textarea 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\">Provide description</div>\n<div class=\"n-usage n-usage-dont\">Provide Description</div>\n\nWhen a textarea isn’t part of a form and is placed individually on a page, you could provide the textarea label as a call to action:\n\n<div class=\"n-usage n-usage-do\">Leave a comment</div>\n<div class=\"n-usage n-usage-dont\">Comment</div>\n\nDo not use colons in textarea labels:\n\n<div class=\"n-usage n-usage-do\">Provide description</div>\n<div class=\"n-usage n-usage-dont\">Provide description:</div>\n",
|
|
17038
|
+
"examples": [],
|
|
17039
|
+
"dependencies": [],
|
|
17040
|
+
"tagName": "nord-textarea",
|
|
17041
|
+
"customElement": true
|
|
17042
|
+
}
|
|
17043
|
+
],
|
|
17044
|
+
"exports": [
|
|
17045
|
+
{
|
|
17046
|
+
"kind": "js",
|
|
17047
|
+
"name": "default",
|
|
17048
|
+
"declaration": {
|
|
17049
|
+
"name": "Textarea",
|
|
17050
|
+
"module": "src/textarea/Textarea.ts"
|
|
17051
|
+
}
|
|
17052
|
+
},
|
|
17053
|
+
{
|
|
17054
|
+
"kind": "custom-element-definition",
|
|
17055
|
+
"name": "nord-textarea",
|
|
17056
|
+
"declaration": {
|
|
17057
|
+
"name": "Textarea",
|
|
17058
|
+
"module": "src/textarea/Textarea.ts"
|
|
17059
|
+
}
|
|
17060
|
+
}
|
|
17061
|
+
]
|
|
17062
|
+
},
|
|
17063
|
+
{
|
|
17064
|
+
"kind": "javascript-module",
|
|
17065
|
+
"path": "src/textarea/localization.ts",
|
|
17066
|
+
"declarations": [
|
|
17067
|
+
{
|
|
17068
|
+
"kind": "variable",
|
|
17069
|
+
"name": "localization",
|
|
17070
|
+
"type": {
|
|
17071
|
+
"text": "object"
|
|
17072
|
+
},
|
|
17073
|
+
"default": "{ remainingCharacters: (remainder: number) => `Characters remaining: ${remainder}`, }"
|
|
17074
|
+
}
|
|
17075
|
+
],
|
|
17076
|
+
"exports": [
|
|
17077
|
+
{
|
|
17078
|
+
"kind": "js",
|
|
17079
|
+
"name": "default",
|
|
17080
|
+
"declaration": {
|
|
17081
|
+
"name": "localization",
|
|
17082
|
+
"module": "src/textarea/localization.ts"
|
|
17083
|
+
}
|
|
17084
|
+
}
|
|
17085
|
+
]
|
|
17086
|
+
},
|
|
17087
|
+
{
|
|
17088
|
+
"kind": "javascript-module",
|
|
17089
|
+
"path": "src/toast/Toast.ts",
|
|
17090
|
+
"declarations": [
|
|
17091
|
+
{
|
|
17092
|
+
"kind": "class",
|
|
17093
|
+
"description": "Toasts are non-disruptive messages that appear in the interface\nto provide quick, at-a-glance feedback on the outcome of an action.",
|
|
17094
|
+
"name": "Toast",
|
|
17095
|
+
"slots": [
|
|
17096
|
+
{
|
|
17097
|
+
"description": "Default slot used for the toast text/message.",
|
|
17098
|
+
"name": ""
|
|
17099
|
+
}
|
|
17100
|
+
],
|
|
17101
|
+
"members": [
|
|
17102
|
+
{
|
|
17103
|
+
"kind": "field",
|
|
17104
|
+
"name": "timeoutId",
|
|
17105
|
+
"type": {
|
|
17106
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
17107
|
+
},
|
|
17108
|
+
"privacy": "private"
|
|
17109
|
+
},
|
|
17110
|
+
{
|
|
17111
|
+
"kind": "field",
|
|
17112
|
+
"name": "variant",
|
|
17113
|
+
"type": {
|
|
17114
|
+
"text": "\"default\" | \"danger\""
|
|
17115
|
+
},
|
|
17116
|
+
"default": "\"default\"",
|
|
17117
|
+
"description": "The style variant of the toast.",
|
|
17118
|
+
"attribute": "variant",
|
|
17119
|
+
"reflects": true
|
|
17120
|
+
},
|
|
17121
|
+
{
|
|
17122
|
+
"kind": "field",
|
|
17123
|
+
"name": "autoDismiss",
|
|
17124
|
+
"type": {
|
|
17125
|
+
"text": "number"
|
|
17126
|
+
},
|
|
17127
|
+
"default": "10000",
|
|
17128
|
+
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
17129
|
+
"attribute": "auto-dismiss",
|
|
17130
|
+
"reflects": true
|
|
17131
|
+
},
|
|
17132
|
+
{
|
|
17133
|
+
"kind": "method",
|
|
17134
|
+
"name": "dismiss",
|
|
17135
|
+
"description": "Programmatically dismiss the toast.\nThe returned promise resolves when toast's exit animation is complete.",
|
|
17136
|
+
"inheritedFrom": {
|
|
17137
|
+
"name": "NotificationMixin",
|
|
17138
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
17139
|
+
}
|
|
17140
|
+
},
|
|
17141
|
+
{
|
|
17142
|
+
"kind": "method",
|
|
17143
|
+
"name": "handleAutoDismissChange",
|
|
17144
|
+
"privacy": "protected"
|
|
17145
|
+
},
|
|
17146
|
+
{
|
|
17147
|
+
"kind": "field",
|
|
17148
|
+
"name": "notificationRef",
|
|
17149
|
+
"privacy": "protected",
|
|
17150
|
+
"inheritedFrom": {
|
|
17151
|
+
"name": "NotificationMixin",
|
|
17152
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
16962
17153
|
}
|
|
16963
17154
|
},
|
|
16964
17155
|
{
|
|
16965
|
-
"
|
|
17156
|
+
"kind": "field",
|
|
17157
|
+
"name": "dismissed",
|
|
16966
17158
|
"type": {
|
|
16967
17159
|
"text": "boolean"
|
|
16968
17160
|
},
|
|
17161
|
+
"privacy": "protected",
|
|
16969
17162
|
"default": "false",
|
|
16970
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
16971
|
-
"fieldName": "disabled",
|
|
16972
17163
|
"inheritedFrom": {
|
|
16973
|
-
"name": "
|
|
16974
|
-
"module": "src/common/mixins/
|
|
17164
|
+
"name": "NotificationMixin",
|
|
17165
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
16975
17166
|
}
|
|
16976
|
-
}
|
|
17167
|
+
}
|
|
17168
|
+
],
|
|
17169
|
+
"events": [
|
|
16977
17170
|
{
|
|
16978
|
-
"name": "
|
|
17171
|
+
"name": "dismiss",
|
|
16979
17172
|
"type": {
|
|
16980
|
-
"text": "
|
|
17173
|
+
"text": "NordEvent"
|
|
16981
17174
|
},
|
|
16982
|
-
"description": "
|
|
16983
|
-
"fieldName": "name",
|
|
17175
|
+
"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.",
|
|
16984
17176
|
"inheritedFrom": {
|
|
16985
|
-
"name": "
|
|
16986
|
-
"module": "src/common/mixins/
|
|
17177
|
+
"name": "NotificationMixin",
|
|
17178
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
16987
17179
|
}
|
|
16988
|
-
}
|
|
17180
|
+
}
|
|
17181
|
+
],
|
|
17182
|
+
"attributes": [
|
|
16989
17183
|
{
|
|
16990
|
-
"name": "
|
|
17184
|
+
"name": "variant",
|
|
16991
17185
|
"type": {
|
|
16992
|
-
"text": "
|
|
17186
|
+
"text": "\"default\" | \"danger\""
|
|
16993
17187
|
},
|
|
16994
|
-
"default": "\"\"",
|
|
16995
|
-
"description": "The
|
|
16996
|
-
"fieldName": "
|
|
16997
|
-
"inheritedFrom": {
|
|
16998
|
-
"name": "InputMixin",
|
|
16999
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17000
|
-
}
|
|
17188
|
+
"default": "\"default\"",
|
|
17189
|
+
"description": "The style variant of the toast.",
|
|
17190
|
+
"fieldName": "variant"
|
|
17001
17191
|
},
|
|
17002
17192
|
{
|
|
17003
|
-
"name": "
|
|
17193
|
+
"name": "auto-dismiss",
|
|
17004
17194
|
"type": {
|
|
17005
|
-
"text": "
|
|
17195
|
+
"text": "number"
|
|
17006
17196
|
},
|
|
17007
|
-
"
|
|
17008
|
-
"
|
|
17009
|
-
"
|
|
17010
|
-
"name": "InputMixin",
|
|
17011
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17012
|
-
}
|
|
17197
|
+
"default": "10000",
|
|
17198
|
+
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
17199
|
+
"fieldName": "autoDismiss"
|
|
17013
17200
|
}
|
|
17014
17201
|
],
|
|
17015
17202
|
"mixins": [
|
|
17016
17203
|
{
|
|
17017
|
-
"name": "
|
|
17018
|
-
"module": "/src/common/mixins/
|
|
17019
|
-
},
|
|
17020
|
-
{
|
|
17021
|
-
"name": "FormAssociatedMixin",
|
|
17022
|
-
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
17023
|
-
},
|
|
17024
|
-
{
|
|
17025
|
-
"name": "AutocompleteMixin",
|
|
17026
|
-
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
17027
|
-
},
|
|
17028
|
-
{
|
|
17029
|
-
"name": "ReadonlyMixin",
|
|
17030
|
-
"module": "/src/common/mixins/ReadonlyMixin.js"
|
|
17031
|
-
},
|
|
17032
|
-
{
|
|
17033
|
-
"name": "TextSelectableMixin",
|
|
17034
|
-
"module": "/src/common/mixins/TextSelectableMixin.js"
|
|
17035
|
-
},
|
|
17036
|
-
{
|
|
17037
|
-
"name": "InputMixin",
|
|
17038
|
-
"module": "/src/common/mixins/InputMixin.js"
|
|
17039
|
-
},
|
|
17040
|
-
{
|
|
17041
|
-
"name": "FocusableMixin",
|
|
17042
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
17204
|
+
"name": "NotificationMixin",
|
|
17205
|
+
"module": "/src/common/mixins/NotificationMixin.js"
|
|
17043
17206
|
}
|
|
17044
17207
|
],
|
|
17045
17208
|
"superclass": {
|
|
17046
17209
|
"name": "LitElement",
|
|
17047
17210
|
"package": "lit"
|
|
17048
17211
|
},
|
|
17049
|
-
"localization": [
|
|
17050
|
-
{
|
|
17051
|
-
"name": "remainingCharacters",
|
|
17052
|
-
"description": "A function which receives the number of remaining characters and returns a string to be used as the aria-live message."
|
|
17053
|
-
}
|
|
17054
|
-
],
|
|
17212
|
+
"localization": [],
|
|
17055
17213
|
"status": "ready",
|
|
17056
|
-
"category": "
|
|
17057
|
-
"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
|
|
17214
|
+
"category": "feedback",
|
|
17215
|
+
"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. Consider using a [Notification](/components/notification) instead.\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",
|
|
17058
17216
|
"examples": [],
|
|
17059
|
-
"dependencies": [
|
|
17060
|
-
|
|
17217
|
+
"dependencies": [
|
|
17218
|
+
"icon"
|
|
17219
|
+
],
|
|
17220
|
+
"tagName": "nord-toast",
|
|
17061
17221
|
"customElement": true
|
|
17062
17222
|
}
|
|
17063
17223
|
],
|
|
@@ -17066,31 +17226,86 @@
|
|
|
17066
17226
|
"kind": "js",
|
|
17067
17227
|
"name": "default",
|
|
17068
17228
|
"declaration": {
|
|
17069
|
-
"name": "
|
|
17070
|
-
"module": "src/
|
|
17229
|
+
"name": "Toast",
|
|
17230
|
+
"module": "src/toast/Toast.ts"
|
|
17071
17231
|
}
|
|
17072
17232
|
},
|
|
17073
17233
|
{
|
|
17074
17234
|
"kind": "custom-element-definition",
|
|
17075
|
-
"name": "nord-
|
|
17235
|
+
"name": "nord-toast",
|
|
17076
17236
|
"declaration": {
|
|
17077
|
-
"name": "
|
|
17078
|
-
"module": "src/
|
|
17237
|
+
"name": "Toast",
|
|
17238
|
+
"module": "src/toast/Toast.ts"
|
|
17079
17239
|
}
|
|
17080
17240
|
}
|
|
17081
17241
|
]
|
|
17082
17242
|
},
|
|
17083
17243
|
{
|
|
17084
17244
|
"kind": "javascript-module",
|
|
17085
|
-
"path": "src/
|
|
17245
|
+
"path": "src/toast-group/ToastGroup.ts",
|
|
17086
17246
|
"declarations": [
|
|
17087
17247
|
{
|
|
17088
|
-
"kind": "
|
|
17089
|
-
"
|
|
17090
|
-
"
|
|
17091
|
-
|
|
17248
|
+
"kind": "class",
|
|
17249
|
+
"description": "Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.",
|
|
17250
|
+
"name": "ToastGroup",
|
|
17251
|
+
"slots": [
|
|
17252
|
+
{
|
|
17253
|
+
"description": "Default slot in which to place toasts.",
|
|
17254
|
+
"name": ""
|
|
17255
|
+
}
|
|
17256
|
+
],
|
|
17257
|
+
"members": [
|
|
17258
|
+
{
|
|
17259
|
+
"kind": "method",
|
|
17260
|
+
"name": "addToast",
|
|
17261
|
+
"parameters": [
|
|
17262
|
+
{
|
|
17263
|
+
"name": "text",
|
|
17264
|
+
"type": {
|
|
17265
|
+
"text": "string"
|
|
17266
|
+
},
|
|
17267
|
+
"description": "The text/message of the toast."
|
|
17268
|
+
},
|
|
17269
|
+
{
|
|
17270
|
+
"name": "options",
|
|
17271
|
+
"default": "{}",
|
|
17272
|
+
"type": {
|
|
17273
|
+
"text": "ToastOptions"
|
|
17274
|
+
},
|
|
17275
|
+
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
17276
|
+
}
|
|
17277
|
+
],
|
|
17278
|
+
"description": "Convenience method for creating and adding a toast to the group.",
|
|
17279
|
+
"return": {
|
|
17280
|
+
"type": {
|
|
17281
|
+
"text": "Toast"
|
|
17282
|
+
}
|
|
17283
|
+
}
|
|
17284
|
+
}
|
|
17285
|
+
],
|
|
17286
|
+
"events": [
|
|
17287
|
+
{
|
|
17288
|
+
"type": {
|
|
17289
|
+
"text": "NordEvent"
|
|
17290
|
+
},
|
|
17291
|
+
"description": "Fired when a 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.",
|
|
17292
|
+
"name": "dismiss"
|
|
17293
|
+
}
|
|
17294
|
+
],
|
|
17295
|
+
"superclass": {
|
|
17296
|
+
"name": "LitElement",
|
|
17297
|
+
"package": "lit"
|
|
17092
17298
|
},
|
|
17093
|
-
"
|
|
17299
|
+
"localization": [],
|
|
17300
|
+
"status": "ready",
|
|
17301
|
+
"category": "feedback",
|
|
17302
|
+
"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 in combination with [Toast](/components/toast/) so that toasts get styled and announced to screen readers correctly.\n- Add as close to the bottom of the document as possible, ideally near the body closing tag, to maintain correct stacking order.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than toast components\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and understandable by the user:\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",
|
|
17303
|
+
"examples": [],
|
|
17304
|
+
"dependencies": [
|
|
17305
|
+
"toast"
|
|
17306
|
+
],
|
|
17307
|
+
"tagName": "nord-toast-group",
|
|
17308
|
+
"customElement": true
|
|
17094
17309
|
}
|
|
17095
17310
|
],
|
|
17096
17311
|
"exports": [
|
|
@@ -17098,8 +17313,16 @@
|
|
|
17098
17313
|
"kind": "js",
|
|
17099
17314
|
"name": "default",
|
|
17100
17315
|
"declaration": {
|
|
17101
|
-
"name": "
|
|
17102
|
-
"module": "src/
|
|
17316
|
+
"name": "ToastGroup",
|
|
17317
|
+
"module": "src/toast-group/ToastGroup.ts"
|
|
17318
|
+
}
|
|
17319
|
+
},
|
|
17320
|
+
{
|
|
17321
|
+
"kind": "custom-element-definition",
|
|
17322
|
+
"name": "nord-toast-group",
|
|
17323
|
+
"declaration": {
|
|
17324
|
+
"name": "ToastGroup",
|
|
17325
|
+
"module": "src/toast-group/ToastGroup.ts"
|
|
17103
17326
|
}
|
|
17104
17327
|
}
|
|
17105
17328
|
]
|
|
@@ -17815,67 +18038,15 @@
|
|
|
17815
18038
|
"name": "default",
|
|
17816
18039
|
"declaration": {
|
|
17817
18040
|
"name": "Toggle",
|
|
17818
|
-
"module": "src/toggle/Toggle.ts"
|
|
17819
|
-
}
|
|
17820
|
-
},
|
|
17821
|
-
{
|
|
17822
|
-
"kind": "custom-element-definition",
|
|
17823
|
-
"name": "nord-toggle",
|
|
17824
|
-
"declaration": {
|
|
17825
|
-
"name": "Toggle",
|
|
17826
|
-
"module": "src/toggle/Toggle.ts"
|
|
17827
|
-
}
|
|
17828
|
-
}
|
|
17829
|
-
]
|
|
17830
|
-
},
|
|
17831
|
-
{
|
|
17832
|
-
"kind": "javascript-module",
|
|
17833
|
-
"path": "src/top-bar/TopBar.ts",
|
|
17834
|
-
"declarations": [
|
|
17835
|
-
{
|
|
17836
|
-
"kind": "class",
|
|
17837
|
-
"description": "Top bar is a header component that is always visible at the top of the interface. Top bar allows functionality such as search and contextual menus to be placed at the top of the interface.",
|
|
17838
|
-
"name": "TopBar",
|
|
17839
|
-
"slots": [
|
|
17840
|
-
{
|
|
17841
|
-
"description": "Used for the main content of the top bar. We recommend placing your application’s global search functionality into this slot.",
|
|
17842
|
-
"name": ""
|
|
17843
|
-
},
|
|
17844
|
-
{
|
|
17845
|
-
"description": "Optional slot for menus, buttons, toggles, etc.",
|
|
17846
|
-
"name": "end"
|
|
17847
|
-
}
|
|
17848
|
-
],
|
|
17849
|
-
"members": [],
|
|
17850
|
-
"superclass": {
|
|
17851
|
-
"name": "LitElement",
|
|
17852
|
-
"package": "lit"
|
|
17853
|
-
},
|
|
17854
|
-
"localization": [],
|
|
17855
|
-
"status": "ready",
|
|
17856
|
-
"category": "structure",
|
|
17857
|
-
"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- Applications that utilize the top bar can allow users to customize the color of the top bar to match their preference. [View an example](/components/top-bar/?example=color).\n- If your application allows it, include search to help users find resources and navigate.\n- Include a user menu in the end slot of the top bar.\n- Use the [layout component](/components/layout/?example=top-bar) to provide structure for the top bar component. We’ve also created [an example which shows full theming capabilities](/components/layout/?example=theming).\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for global navigation. Use the [navigation component](/components/navigation/) instead.\n- Don’t allow the user to set a top bar color that doesn’t provide enough contrast with the content.\n- Don’t allow the user to freely pick a hex code as the top bar color. Instead, offer a choice from a predefined palette of colors which provides sufficient contrast with the content. [View an example](/components/top-bar/?example=color).\n\n</div>\n\n---\n\n## Theming\n\nPlease see the [Top Bar theming](/themes/#top-bar-theming) section in our theming documentation for detailed guidelines.\n\n<nord-button variant=\"primary\" href=\"/themes/#top-bar-theming\">Theming Guidelines</nord-button>\n",
|
|
17858
|
-
"examples": [],
|
|
17859
|
-
"dependencies": [],
|
|
17860
|
-
"tagName": "nord-top-bar",
|
|
17861
|
-
"customElement": true
|
|
17862
|
-
}
|
|
17863
|
-
],
|
|
17864
|
-
"exports": [
|
|
17865
|
-
{
|
|
17866
|
-
"kind": "js",
|
|
17867
|
-
"name": "default",
|
|
17868
|
-
"declaration": {
|
|
17869
|
-
"name": "TopBar",
|
|
17870
|
-
"module": "src/top-bar/TopBar.ts"
|
|
18041
|
+
"module": "src/toggle/Toggle.ts"
|
|
17871
18042
|
}
|
|
17872
18043
|
},
|
|
17873
18044
|
{
|
|
17874
18045
|
"kind": "custom-element-definition",
|
|
17875
|
-
"name": "nord-
|
|
18046
|
+
"name": "nord-toggle",
|
|
17876
18047
|
"declaration": {
|
|
17877
|
-
"name": "
|
|
17878
|
-
"module": "src/
|
|
18048
|
+
"name": "Toggle",
|
|
18049
|
+
"module": "src/toggle/Toggle.ts"
|
|
17879
18050
|
}
|
|
17880
18051
|
}
|
|
17881
18052
|
]
|
|
@@ -18145,16 +18316,20 @@
|
|
|
18145
18316
|
},
|
|
18146
18317
|
{
|
|
18147
18318
|
"kind": "javascript-module",
|
|
18148
|
-
"path": "src/
|
|
18319
|
+
"path": "src/top-bar/TopBar.ts",
|
|
18149
18320
|
"declarations": [
|
|
18150
18321
|
{
|
|
18151
18322
|
"kind": "class",
|
|
18152
|
-
"description": "
|
|
18153
|
-
"name": "
|
|
18323
|
+
"description": "Top bar is a header component that is always visible at the top of the interface. Top bar allows functionality such as search and contextual menus to be placed at the top of the interface.",
|
|
18324
|
+
"name": "TopBar",
|
|
18154
18325
|
"slots": [
|
|
18155
18326
|
{
|
|
18156
|
-
"description": "
|
|
18327
|
+
"description": "Used for the main content of the top bar. We recommend placing your application’s global search functionality into this slot.",
|
|
18157
18328
|
"name": ""
|
|
18329
|
+
},
|
|
18330
|
+
{
|
|
18331
|
+
"description": "Optional slot for menus, buttons, toggles, etc.",
|
|
18332
|
+
"name": "end"
|
|
18158
18333
|
}
|
|
18159
18334
|
],
|
|
18160
18335
|
"members": [],
|
|
@@ -18164,11 +18339,11 @@
|
|
|
18164
18339
|
},
|
|
18165
18340
|
"localization": [],
|
|
18166
18341
|
"status": "ready",
|
|
18167
|
-
"category": "
|
|
18168
|
-
"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-
|
|
18342
|
+
"category": "structure",
|
|
18343
|
+
"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- Applications that utilize the top bar can allow users to customize the color of the top bar to match their preference. [View an example](/components/top-bar/?example=color).\n- If your application allows it, include search to help users find resources and navigate.\n- Include a user menu in the end slot of the top bar.\n- Use the [layout component](/components/layout/?example=top-bar) to provide structure for the top bar component. We’ve also created [an example which shows full theming capabilities](/components/layout/?example=theming).\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for global navigation. Use the [navigation component](/components/navigation/) instead.\n- Don’t allow the user to set a top bar color that doesn’t provide enough contrast with the content.\n- Don’t allow the user to freely pick a hex code as the top bar color. Instead, offer a choice from a predefined palette of colors which provides sufficient contrast with the content. [View an example](/components/top-bar/?example=color).\n\n</div>\n\n---\n\n## Theming\n\nPlease see the [Top Bar theming](/themes/#top-bar-theming) section in our theming documentation for detailed guidelines.\n\n<nord-button variant=\"primary\" href=\"/themes/#top-bar-theming\">Theming Guidelines</nord-button>\n",
|
|
18169
18344
|
"examples": [],
|
|
18170
18345
|
"dependencies": [],
|
|
18171
|
-
"tagName": "nord-
|
|
18346
|
+
"tagName": "nord-top-bar",
|
|
18172
18347
|
"customElement": true
|
|
18173
18348
|
}
|
|
18174
18349
|
],
|
|
@@ -18177,169 +18352,46 @@
|
|
|
18177
18352
|
"kind": "js",
|
|
18178
18353
|
"name": "default",
|
|
18179
18354
|
"declaration": {
|
|
18180
|
-
"name": "
|
|
18181
|
-
"module": "src/
|
|
18355
|
+
"name": "TopBar",
|
|
18356
|
+
"module": "src/top-bar/TopBar.ts"
|
|
18182
18357
|
}
|
|
18183
18358
|
},
|
|
18184
18359
|
{
|
|
18185
18360
|
"kind": "custom-element-definition",
|
|
18186
|
-
"name": "nord-
|
|
18361
|
+
"name": "nord-top-bar",
|
|
18187
18362
|
"declaration": {
|
|
18188
|
-
"name": "
|
|
18189
|
-
"module": "src/
|
|
18363
|
+
"name": "TopBar",
|
|
18364
|
+
"module": "src/top-bar/TopBar.ts"
|
|
18190
18365
|
}
|
|
18191
18366
|
}
|
|
18192
18367
|
]
|
|
18193
18368
|
},
|
|
18194
18369
|
{
|
|
18195
18370
|
"kind": "javascript-module",
|
|
18196
|
-
"path": "src/
|
|
18371
|
+
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
18197
18372
|
"declarations": [
|
|
18198
18373
|
{
|
|
18199
18374
|
"kind": "class",
|
|
18200
|
-
"description": "
|
|
18201
|
-
"name": "
|
|
18202
|
-
"cssProperties": [
|
|
18203
|
-
{
|
|
18204
|
-
"description": "Controls the rounded corners of the tag group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
18205
|
-
"name": "--n-tag-group-border-radius",
|
|
18206
|
-
"default": "var(--n-border-radius-s)"
|
|
18207
|
-
},
|
|
18208
|
-
{
|
|
18209
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
18210
|
-
"name": "--n-tag-group-box-shadow",
|
|
18211
|
-
"default": "var(--n-box-shadow)"
|
|
18212
|
-
}
|
|
18213
|
-
],
|
|
18375
|
+
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
18376
|
+
"name": "VisuallyHidden",
|
|
18214
18377
|
"slots": [
|
|
18215
18378
|
{
|
|
18216
|
-
"description": "The
|
|
18379
|
+
"description": "The visually hidden content.",
|
|
18217
18380
|
"name": ""
|
|
18218
18381
|
}
|
|
18219
18382
|
],
|
|
18220
|
-
"members": [
|
|
18221
|
-
{
|
|
18222
|
-
"kind": "field",
|
|
18223
|
-
"name": "defaultSlot",
|
|
18224
|
-
"privacy": "private",
|
|
18225
|
-
"default": "new SlotController(this)"
|
|
18226
|
-
},
|
|
18227
|
-
{
|
|
18228
|
-
"kind": "field",
|
|
18229
|
-
"name": "dirController",
|
|
18230
|
-
"privacy": "private",
|
|
18231
|
-
"default": "new DirectionController(this)"
|
|
18232
|
-
},
|
|
18233
|
-
{
|
|
18234
|
-
"kind": "field",
|
|
18235
|
-
"name": "variant",
|
|
18236
|
-
"type": {
|
|
18237
|
-
"text": "\"default\" | \"spaced\""
|
|
18238
|
-
},
|
|
18239
|
-
"default": "\"default\"",
|
|
18240
|
-
"description": "The style variant of the tag group.",
|
|
18241
|
-
"attribute": "variant",
|
|
18242
|
-
"reflects": true
|
|
18243
|
-
},
|
|
18244
|
-
{
|
|
18245
|
-
"kind": "field",
|
|
18246
|
-
"name": "direction",
|
|
18247
|
-
"type": {
|
|
18248
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
18249
|
-
},
|
|
18250
|
-
"default": "\"horizontal\"",
|
|
18251
|
-
"description": "The direction of the tag group.",
|
|
18252
|
-
"attribute": "direction",
|
|
18253
|
-
"reflects": true
|
|
18254
|
-
},
|
|
18255
|
-
{
|
|
18256
|
-
"kind": "field",
|
|
18257
|
-
"name": "wrap",
|
|
18258
|
-
"type": {
|
|
18259
|
-
"text": "boolean"
|
|
18260
|
-
},
|
|
18261
|
-
"default": "false",
|
|
18262
|
-
"description": "Defines whether the tags are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
18263
|
-
"attribute": "wrap",
|
|
18264
|
-
"reflects": true
|
|
18265
|
-
},
|
|
18266
|
-
{
|
|
18267
|
-
"kind": "field",
|
|
18268
|
-
"name": "role",
|
|
18269
|
-
"type": {
|
|
18270
|
-
"text": "string"
|
|
18271
|
-
},
|
|
18272
|
-
"default": "\"group\"",
|
|
18273
|
-
"description": "The appropriate role for the containing element.",
|
|
18274
|
-
"attribute": "role",
|
|
18275
|
-
"reflects": true
|
|
18276
|
-
}
|
|
18277
|
-
],
|
|
18278
|
-
"events": [
|
|
18279
|
-
{
|
|
18280
|
-
"type": {
|
|
18281
|
-
"text": "NordEvent"
|
|
18282
|
-
},
|
|
18283
|
-
"description": "Fired whenever a tag has been checked or unchecked via user interaction.",
|
|
18284
|
-
"name": "change"
|
|
18285
|
-
},
|
|
18286
|
-
{
|
|
18287
|
-
"type": {
|
|
18288
|
-
"text": "NordEvent"
|
|
18289
|
-
},
|
|
18290
|
-
"description": "Fired when the remove button is activated on a tag. This event should be used to remove the tag from the DOM.",
|
|
18291
|
-
"name": "remove"
|
|
18292
|
-
}
|
|
18293
|
-
],
|
|
18294
|
-
"attributes": [
|
|
18295
|
-
{
|
|
18296
|
-
"name": "variant",
|
|
18297
|
-
"type": {
|
|
18298
|
-
"text": "\"default\" | \"spaced\""
|
|
18299
|
-
},
|
|
18300
|
-
"default": "\"default\"",
|
|
18301
|
-
"description": "The style variant of the tag group.",
|
|
18302
|
-
"fieldName": "variant"
|
|
18303
|
-
},
|
|
18304
|
-
{
|
|
18305
|
-
"name": "direction",
|
|
18306
|
-
"type": {
|
|
18307
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
18308
|
-
},
|
|
18309
|
-
"default": "\"horizontal\"",
|
|
18310
|
-
"description": "The direction of the tag group.",
|
|
18311
|
-
"fieldName": "direction"
|
|
18312
|
-
},
|
|
18313
|
-
{
|
|
18314
|
-
"name": "wrap",
|
|
18315
|
-
"type": {
|
|
18316
|
-
"text": "boolean"
|
|
18317
|
-
},
|
|
18318
|
-
"default": "false",
|
|
18319
|
-
"description": "Defines whether the tags are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
18320
|
-
"fieldName": "wrap"
|
|
18321
|
-
},
|
|
18322
|
-
{
|
|
18323
|
-
"name": "role",
|
|
18324
|
-
"type": {
|
|
18325
|
-
"text": "string"
|
|
18326
|
-
},
|
|
18327
|
-
"default": "\"group\"",
|
|
18328
|
-
"description": "The appropriate role for the containing element.",
|
|
18329
|
-
"fieldName": "role"
|
|
18330
|
-
}
|
|
18331
|
-
],
|
|
18383
|
+
"members": [],
|
|
18332
18384
|
"superclass": {
|
|
18333
18385
|
"name": "LitElement",
|
|
18334
18386
|
"package": "lit"
|
|
18335
18387
|
},
|
|
18336
18388
|
"localization": [],
|
|
18337
|
-
"status": "
|
|
18338
|
-
"category": "
|
|
18339
|
-
"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
|
|
18389
|
+
"status": "ready",
|
|
18390
|
+
"category": "text",
|
|
18391
|
+
"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 hide text visually from the screen, but keep it available to assistive technologies, such as screen readers.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for hiding interactive content.\n\n</div>\n",
|
|
18340
18392
|
"examples": [],
|
|
18341
18393
|
"dependencies": [],
|
|
18342
|
-
"tagName": "nord-
|
|
18394
|
+
"tagName": "nord-visually-hidden",
|
|
18343
18395
|
"customElement": true
|
|
18344
18396
|
}
|
|
18345
18397
|
],
|
|
@@ -18348,16 +18400,16 @@
|
|
|
18348
18400
|
"kind": "js",
|
|
18349
18401
|
"name": "default",
|
|
18350
18402
|
"declaration": {
|
|
18351
|
-
"name": "
|
|
18352
|
-
"module": "src/
|
|
18403
|
+
"name": "VisuallyHidden",
|
|
18404
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
18353
18405
|
}
|
|
18354
18406
|
},
|
|
18355
18407
|
{
|
|
18356
18408
|
"kind": "custom-element-definition",
|
|
18357
|
-
"name": "nord-
|
|
18409
|
+
"name": "nord-visually-hidden",
|
|
18358
18410
|
"declaration": {
|
|
18359
|
-
"name": "
|
|
18360
|
-
"module": "src/
|
|
18411
|
+
"name": "VisuallyHidden",
|
|
18412
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
18361
18413
|
}
|
|
18362
18414
|
}
|
|
18363
18415
|
]
|
|
@@ -19624,6 +19676,41 @@
|
|
|
19624
19676
|
}
|
|
19625
19677
|
]
|
|
19626
19678
|
},
|
|
19679
|
+
{
|
|
19680
|
+
"kind": "javascript-module",
|
|
19681
|
+
"path": "src/common/decorators/observe.ts",
|
|
19682
|
+
"declarations": [
|
|
19683
|
+
{
|
|
19684
|
+
"kind": "function",
|
|
19685
|
+
"name": "observe",
|
|
19686
|
+
"parameters": [
|
|
19687
|
+
{
|
|
19688
|
+
"name": "propertyName",
|
|
19689
|
+
"type": {
|
|
19690
|
+
"text": "string"
|
|
19691
|
+
}
|
|
19692
|
+
},
|
|
19693
|
+
{
|
|
19694
|
+
"name": "lifecycle",
|
|
19695
|
+
"default": "\"update\"",
|
|
19696
|
+
"type": {
|
|
19697
|
+
"text": "ObserveLifecycle"
|
|
19698
|
+
}
|
|
19699
|
+
}
|
|
19700
|
+
]
|
|
19701
|
+
}
|
|
19702
|
+
],
|
|
19703
|
+
"exports": [
|
|
19704
|
+
{
|
|
19705
|
+
"kind": "js",
|
|
19706
|
+
"name": "observe",
|
|
19707
|
+
"declaration": {
|
|
19708
|
+
"name": "observe",
|
|
19709
|
+
"module": "src/common/decorators/observe.ts"
|
|
19710
|
+
}
|
|
19711
|
+
}
|
|
19712
|
+
]
|
|
19713
|
+
},
|
|
19627
19714
|
{
|
|
19628
19715
|
"kind": "javascript-module",
|
|
19629
19716
|
"path": "src/common/directives/cond.ts",
|
|
@@ -20058,41 +20145,6 @@
|
|
|
20058
20145
|
}
|
|
20059
20146
|
]
|
|
20060
20147
|
},
|
|
20061
|
-
{
|
|
20062
|
-
"kind": "javascript-module",
|
|
20063
|
-
"path": "src/common/decorators/observe.ts",
|
|
20064
|
-
"declarations": [
|
|
20065
|
-
{
|
|
20066
|
-
"kind": "function",
|
|
20067
|
-
"name": "observe",
|
|
20068
|
-
"parameters": [
|
|
20069
|
-
{
|
|
20070
|
-
"name": "propertyName",
|
|
20071
|
-
"type": {
|
|
20072
|
-
"text": "string"
|
|
20073
|
-
}
|
|
20074
|
-
},
|
|
20075
|
-
{
|
|
20076
|
-
"name": "lifecycle",
|
|
20077
|
-
"default": "\"update\"",
|
|
20078
|
-
"type": {
|
|
20079
|
-
"text": "ObserveLifecycle"
|
|
20080
|
-
}
|
|
20081
|
-
}
|
|
20082
|
-
]
|
|
20083
|
-
}
|
|
20084
|
-
],
|
|
20085
|
-
"exports": [
|
|
20086
|
-
{
|
|
20087
|
-
"kind": "js",
|
|
20088
|
-
"name": "observe",
|
|
20089
|
-
"declaration": {
|
|
20090
|
-
"name": "observe",
|
|
20091
|
-
"module": "src/common/decorators/observe.ts"
|
|
20092
|
-
}
|
|
20093
|
-
}
|
|
20094
|
-
]
|
|
20095
|
-
},
|
|
20096
20148
|
{
|
|
20097
20149
|
"kind": "javascript-module",
|
|
20098
20150
|
"path": "src/common/mixins/AutocompleteMixin.ts",
|