@nordhealth/components 4.0.0 → 4.0.1
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 +1860 -1860
- package/lib/IconManager.js +1 -1
- package/lib/bundle.js +1 -1
- package/lib/react.d.ts +138 -28
- package/package.json +3 -3
package/custom-elements.json
CHANGED
|
@@ -790,6 +790,246 @@
|
|
|
790
790
|
}
|
|
791
791
|
]
|
|
792
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
|
+
{
|
|
879
|
+
"kind": "javascript-module",
|
|
880
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
881
|
+
"declarations": [
|
|
882
|
+
{
|
|
883
|
+
"kind": "class",
|
|
884
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
885
|
+
"name": "ButtonGroup",
|
|
886
|
+
"cssProperties": [
|
|
887
|
+
{
|
|
888
|
+
"description": "Controls the rounded corners of the button group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
889
|
+
"name": "--n-button-group-border-radius",
|
|
890
|
+
"default": "var(--n-border-radius-s)"
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
894
|
+
"name": "--n-button-group-box-shadow",
|
|
895
|
+
"default": "var(--n-box-shadow)"
|
|
896
|
+
}
|
|
897
|
+
],
|
|
898
|
+
"slots": [
|
|
899
|
+
{
|
|
900
|
+
"description": "The button group content",
|
|
901
|
+
"name": ""
|
|
902
|
+
}
|
|
903
|
+
],
|
|
904
|
+
"members": [
|
|
905
|
+
{
|
|
906
|
+
"kind": "field",
|
|
907
|
+
"name": "defaultSlot",
|
|
908
|
+
"privacy": "private",
|
|
909
|
+
"default": "new SlotController(this)"
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"kind": "field",
|
|
913
|
+
"name": "dirController",
|
|
914
|
+
"privacy": "private",
|
|
915
|
+
"default": "new DirectionController(this)"
|
|
916
|
+
},
|
|
917
|
+
{
|
|
918
|
+
"kind": "field",
|
|
919
|
+
"name": "variant",
|
|
920
|
+
"type": {
|
|
921
|
+
"text": "\"default\" | \"spaced\""
|
|
922
|
+
},
|
|
923
|
+
"default": "\"default\"",
|
|
924
|
+
"description": "The style variant of the button group.",
|
|
925
|
+
"attribute": "variant",
|
|
926
|
+
"reflects": true
|
|
927
|
+
},
|
|
928
|
+
{
|
|
929
|
+
"kind": "field",
|
|
930
|
+
"name": "direction",
|
|
931
|
+
"type": {
|
|
932
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
933
|
+
},
|
|
934
|
+
"default": "\"horizontal\"",
|
|
935
|
+
"description": "The direction of the button group.",
|
|
936
|
+
"attribute": "direction",
|
|
937
|
+
"reflects": true
|
|
938
|
+
},
|
|
939
|
+
{
|
|
940
|
+
"kind": "field",
|
|
941
|
+
"name": "wrap",
|
|
942
|
+
"type": {
|
|
943
|
+
"text": "boolean"
|
|
944
|
+
},
|
|
945
|
+
"default": "false",
|
|
946
|
+
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
947
|
+
"attribute": "wrap",
|
|
948
|
+
"reflects": true
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"kind": "field",
|
|
952
|
+
"name": "role",
|
|
953
|
+
"type": {
|
|
954
|
+
"text": "string"
|
|
955
|
+
},
|
|
956
|
+
"default": "\"group\"",
|
|
957
|
+
"description": "The appropriate role for the containing element.",
|
|
958
|
+
"attribute": "role",
|
|
959
|
+
"reflects": true
|
|
960
|
+
}
|
|
961
|
+
],
|
|
962
|
+
"attributes": [
|
|
963
|
+
{
|
|
964
|
+
"name": "variant",
|
|
965
|
+
"type": {
|
|
966
|
+
"text": "\"default\" | \"spaced\""
|
|
967
|
+
},
|
|
968
|
+
"default": "\"default\"",
|
|
969
|
+
"description": "The style variant of the button group.",
|
|
970
|
+
"fieldName": "variant"
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "direction",
|
|
974
|
+
"type": {
|
|
975
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
976
|
+
},
|
|
977
|
+
"default": "\"horizontal\"",
|
|
978
|
+
"description": "The direction of the button group.",
|
|
979
|
+
"fieldName": "direction"
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
"name": "wrap",
|
|
983
|
+
"type": {
|
|
984
|
+
"text": "boolean"
|
|
985
|
+
},
|
|
986
|
+
"default": "false",
|
|
987
|
+
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
988
|
+
"fieldName": "wrap"
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
"name": "role",
|
|
992
|
+
"type": {
|
|
993
|
+
"text": "string"
|
|
994
|
+
},
|
|
995
|
+
"default": "\"group\"",
|
|
996
|
+
"description": "The appropriate role for the containing element.",
|
|
997
|
+
"fieldName": "role"
|
|
998
|
+
}
|
|
999
|
+
],
|
|
1000
|
+
"superclass": {
|
|
1001
|
+
"name": "LitElement",
|
|
1002
|
+
"package": "lit"
|
|
1003
|
+
},
|
|
1004
|
+
"localization": [],
|
|
1005
|
+
"status": "ready",
|
|
1006
|
+
"category": "structure",
|
|
1007
|
+
"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 buttons, or dropdowns, of a similar nature or purpose.\n- Use the appropriate `role` attribute on the button group to provide additional semantics.\n- Use an `aria-labelledby` attribute referencing another element to best explain the contents of the button group.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t add components other than buttons, dropdowns and in some instances visually hidden components to the button 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\nButton labels 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\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing 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 unnecessary words and articles in button 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\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 segmented buttons to emphasize that they’re thematically-related. |\n| `spaced` | The spaced variant renders a gap between the buttons to space them out evenly. |\n",
|
|
1008
|
+
"examples": [],
|
|
1009
|
+
"dependencies": [],
|
|
1010
|
+
"tagName": "nord-button-group",
|
|
1011
|
+
"customElement": true
|
|
1012
|
+
}
|
|
1013
|
+
],
|
|
1014
|
+
"exports": [
|
|
1015
|
+
{
|
|
1016
|
+
"kind": "js",
|
|
1017
|
+
"name": "default",
|
|
1018
|
+
"declaration": {
|
|
1019
|
+
"name": "ButtonGroup",
|
|
1020
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1021
|
+
}
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"kind": "custom-element-definition",
|
|
1025
|
+
"name": "nord-button-group",
|
|
1026
|
+
"declaration": {
|
|
1027
|
+
"name": "ButtonGroup",
|
|
1028
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1029
|
+
}
|
|
1030
|
+
}
|
|
1031
|
+
]
|
|
1032
|
+
},
|
|
793
1033
|
{
|
|
794
1034
|
"kind": "javascript-module",
|
|
795
1035
|
"path": "src/button/Button.ts",
|
|
@@ -1403,693 +1643,330 @@
|
|
|
1403
1643
|
},
|
|
1404
1644
|
{
|
|
1405
1645
|
"kind": "javascript-module",
|
|
1406
|
-
"path": "src/
|
|
1646
|
+
"path": "src/calendar/Calendar.ts",
|
|
1407
1647
|
"declarations": [
|
|
1408
1648
|
{
|
|
1409
1649
|
"kind": "class",
|
|
1410
|
-
"description": "
|
|
1411
|
-
"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",
|
|
1412
1652
|
"cssProperties": [
|
|
1413
1653
|
{
|
|
1414
1654
|
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1415
|
-
"name": "--n-
|
|
1655
|
+
"name": "--n-calendar-border-radius",
|
|
1416
1656
|
"default": "var(--n-border-radius)"
|
|
1417
1657
|
},
|
|
1418
1658
|
{
|
|
1419
1659
|
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1420
|
-
"name": "--n-
|
|
1421
|
-
"default": "var(--n-box-shadow-
|
|
1660
|
+
"name": "--n-calendar-box-shadow",
|
|
1661
|
+
"default": "var(--n-box-shadow-popout)"
|
|
1422
1662
|
}
|
|
1423
1663
|
],
|
|
1424
|
-
"
|
|
1425
|
-
{
|
|
1426
|
-
"description": "default slot",
|
|
1427
|
-
"name": ""
|
|
1428
|
-
}
|
|
1429
|
-
],
|
|
1430
|
-
"members": [
|
|
1664
|
+
"members": [
|
|
1431
1665
|
{
|
|
1432
1666
|
"kind": "field",
|
|
1433
|
-
"name": "
|
|
1667
|
+
"name": "monthSelectNode",
|
|
1434
1668
|
"type": {
|
|
1435
|
-
"text": "
|
|
1669
|
+
"text": "HTMLElement"
|
|
1436
1670
|
},
|
|
1437
|
-
"
|
|
1438
|
-
|
|
1439
|
-
"attribute": "variant",
|
|
1440
|
-
"reflects": true
|
|
1441
|
-
}
|
|
1442
|
-
],
|
|
1443
|
-
"attributes": [
|
|
1671
|
+
"privacy": "private"
|
|
1672
|
+
},
|
|
1444
1673
|
{
|
|
1445
|
-
"
|
|
1674
|
+
"kind": "field",
|
|
1675
|
+
"name": "focusedDayNode",
|
|
1446
1676
|
"type": {
|
|
1447
|
-
"text": "
|
|
1677
|
+
"text": "HTMLButtonElement"
|
|
1448
1678
|
},
|
|
1449
|
-
"
|
|
1450
|
-
|
|
1451
|
-
"fieldName": "variant"
|
|
1452
|
-
}
|
|
1453
|
-
],
|
|
1454
|
-
"superclass": {
|
|
1455
|
-
"name": "LitElement",
|
|
1456
|
-
"package": "lit"
|
|
1457
|
-
},
|
|
1458
|
-
"localization": [],
|
|
1459
|
-
"status": "ready",
|
|
1460
|
-
"category": "feedback",
|
|
1461
|
-
"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",
|
|
1462
|
-
"examples": [],
|
|
1463
|
-
"dependencies": [
|
|
1464
|
-
"icon"
|
|
1465
|
-
],
|
|
1466
|
-
"tagName": "nord-banner",
|
|
1467
|
-
"customElement": true
|
|
1468
|
-
}
|
|
1469
|
-
],
|
|
1470
|
-
"exports": [
|
|
1471
|
-
{
|
|
1472
|
-
"kind": "js",
|
|
1473
|
-
"name": "default",
|
|
1474
|
-
"declaration": {
|
|
1475
|
-
"name": "Banner",
|
|
1476
|
-
"module": "src/banner/Banner.ts"
|
|
1477
|
-
}
|
|
1478
|
-
},
|
|
1479
|
-
{
|
|
1480
|
-
"kind": "custom-element-definition",
|
|
1481
|
-
"name": "nord-banner",
|
|
1482
|
-
"declaration": {
|
|
1483
|
-
"name": "Banner",
|
|
1484
|
-
"module": "src/banner/Banner.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": [
|
|
1679
|
+
"privacy": "private"
|
|
1680
|
+
},
|
|
1498
1681
|
{
|
|
1499
|
-
"
|
|
1500
|
-
"name": "
|
|
1501
|
-
"
|
|
1682
|
+
"kind": "field",
|
|
1683
|
+
"name": "direction",
|
|
1684
|
+
"privacy": "private",
|
|
1685
|
+
"default": "new DirectionController(this)"
|
|
1502
1686
|
},
|
|
1503
1687
|
{
|
|
1504
|
-
"
|
|
1505
|
-
"name": "
|
|
1506
|
-
"
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
"slots": [
|
|
1688
|
+
"kind": "field",
|
|
1689
|
+
"name": "swipe",
|
|
1690
|
+
"privacy": "private",
|
|
1691
|
+
"default": "new SwipeController(this, { matchesGesture: isHorizontalSwipe, onSwipeEnd: ({ distX }) => this.addMonths(distX < 0 ? 1 : -1), })"
|
|
1692
|
+
},
|
|
1510
1693
|
{
|
|
1511
|
-
"
|
|
1512
|
-
"name": ""
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
"members": [
|
|
1694
|
+
"kind": "field",
|
|
1695
|
+
"name": "shortcuts",
|
|
1696
|
+
"privacy": "private"
|
|
1697
|
+
},
|
|
1516
1698
|
{
|
|
1517
1699
|
"kind": "field",
|
|
1518
|
-
"name": "
|
|
1700
|
+
"name": "localize",
|
|
1519
1701
|
"privacy": "private",
|
|
1520
|
-
"default": "new
|
|
1702
|
+
"default": "new LocalizeController<\"nord-calendar\">(this, { onLangChange: () => this.handleLangChange(), })"
|
|
1521
1703
|
},
|
|
1522
1704
|
{
|
|
1523
1705
|
"kind": "field",
|
|
1524
|
-
"name": "
|
|
1706
|
+
"name": "dateFormatShort",
|
|
1707
|
+
"type": {
|
|
1708
|
+
"text": "Intl.DateTimeFormat"
|
|
1709
|
+
},
|
|
1525
1710
|
"privacy": "private",
|
|
1526
|
-
"
|
|
1711
|
+
"description": "Whilst dateAdapter is used for handling the formatting/parsing dates in the input,\nthese are used to format dates exclusively for the benefit of screen readers.\n\nWe prefer DateTimeFormat over date.toLocaleDateString, as the former has\nbetter performance when formatting large number of dates. See:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleDateString#Performance"
|
|
1527
1712
|
},
|
|
1528
1713
|
{
|
|
1529
1714
|
"kind": "field",
|
|
1530
|
-
"name": "
|
|
1715
|
+
"name": "monthNames",
|
|
1531
1716
|
"type": {
|
|
1532
|
-
"text": "
|
|
1717
|
+
"text": "string[]"
|
|
1533
1718
|
},
|
|
1534
|
-
"
|
|
1535
|
-
"description": "The style variant of the button group.",
|
|
1536
|
-
"attribute": "variant",
|
|
1537
|
-
"reflects": true
|
|
1719
|
+
"privacy": "private"
|
|
1538
1720
|
},
|
|
1539
1721
|
{
|
|
1540
1722
|
"kind": "field",
|
|
1541
|
-
"name": "
|
|
1723
|
+
"name": "monthNamesShort",
|
|
1542
1724
|
"type": {
|
|
1543
|
-
"text": "
|
|
1725
|
+
"text": "string[]"
|
|
1544
1726
|
},
|
|
1545
|
-
"
|
|
1546
|
-
"description": "The direction of the button group.",
|
|
1547
|
-
"attribute": "direction",
|
|
1548
|
-
"reflects": true
|
|
1727
|
+
"privacy": "private"
|
|
1549
1728
|
},
|
|
1550
1729
|
{
|
|
1551
1730
|
"kind": "field",
|
|
1552
|
-
"name": "
|
|
1731
|
+
"name": "dayNames",
|
|
1553
1732
|
"type": {
|
|
1554
|
-
"text": "
|
|
1733
|
+
"text": "string[]"
|
|
1555
1734
|
},
|
|
1556
|
-
"
|
|
1557
|
-
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
1558
|
-
"attribute": "wrap",
|
|
1559
|
-
"reflects": true
|
|
1735
|
+
"privacy": "private"
|
|
1560
1736
|
},
|
|
1561
1737
|
{
|
|
1562
1738
|
"kind": "field",
|
|
1563
|
-
"name": "
|
|
1739
|
+
"name": "dayNamesShort",
|
|
1740
|
+
"type": {
|
|
1741
|
+
"text": "string[]"
|
|
1742
|
+
},
|
|
1743
|
+
"privacy": "private"
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"kind": "field",
|
|
1747
|
+
"name": "value",
|
|
1564
1748
|
"type": {
|
|
1565
1749
|
"text": "string"
|
|
1566
1750
|
},
|
|
1567
|
-
"default": "\"
|
|
1568
|
-
"description": "The
|
|
1569
|
-
"attribute": "
|
|
1751
|
+
"default": "\"\"",
|
|
1752
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1753
|
+
"attribute": "value"
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"kind": "field",
|
|
1757
|
+
"name": "firstDayOfWeek",
|
|
1758
|
+
"type": {
|
|
1759
|
+
"text": "DaysOfWeek"
|
|
1760
|
+
},
|
|
1761
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1762
|
+
"attribute": "first-day-of-week",
|
|
1570
1763
|
"reflects": true
|
|
1571
|
-
}
|
|
1572
|
-
],
|
|
1573
|
-
"attributes": [
|
|
1764
|
+
},
|
|
1574
1765
|
{
|
|
1575
|
-
"
|
|
1766
|
+
"kind": "field",
|
|
1767
|
+
"name": "min",
|
|
1576
1768
|
"type": {
|
|
1577
|
-
"text": "
|
|
1769
|
+
"text": "string | undefined"
|
|
1578
1770
|
},
|
|
1579
|
-
"
|
|
1580
|
-
"
|
|
1581
|
-
"
|
|
1771
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property.",
|
|
1772
|
+
"attribute": "min",
|
|
1773
|
+
"reflects": true
|
|
1582
1774
|
},
|
|
1583
1775
|
{
|
|
1584
|
-
"
|
|
1776
|
+
"kind": "field",
|
|
1777
|
+
"name": "max",
|
|
1585
1778
|
"type": {
|
|
1586
|
-
"text": "
|
|
1779
|
+
"text": "string | undefined"
|
|
1587
1780
|
},
|
|
1588
|
-
"
|
|
1589
|
-
"
|
|
1590
|
-
"
|
|
1781
|
+
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
1782
|
+
"attribute": "max",
|
|
1783
|
+
"reflects": true
|
|
1591
1784
|
},
|
|
1592
1785
|
{
|
|
1593
|
-
"
|
|
1786
|
+
"kind": "field",
|
|
1787
|
+
"name": "expand",
|
|
1594
1788
|
"type": {
|
|
1595
1789
|
"text": "boolean"
|
|
1596
1790
|
},
|
|
1597
1791
|
"default": "false",
|
|
1598
|
-
"description": "
|
|
1599
|
-
"
|
|
1792
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1793
|
+
"attribute": "expand",
|
|
1794
|
+
"reflects": true
|
|
1600
1795
|
},
|
|
1601
1796
|
{
|
|
1602
|
-
"
|
|
1797
|
+
"kind": "field",
|
|
1798
|
+
"name": "isDateDisabled",
|
|
1603
1799
|
"type": {
|
|
1604
|
-
"text": "
|
|
1800
|
+
"text": "DatePredicate"
|
|
1605
1801
|
},
|
|
1606
|
-
"default": "
|
|
1607
|
-
"description": "
|
|
1608
|
-
"fieldName": "role"
|
|
1609
|
-
}
|
|
1610
|
-
],
|
|
1611
|
-
"superclass": {
|
|
1612
|
-
"name": "LitElement",
|
|
1613
|
-
"package": "lit"
|
|
1614
|
-
},
|
|
1615
|
-
"localization": [],
|
|
1616
|
-
"status": "ready",
|
|
1617
|
-
"category": "structure",
|
|
1618
|
-
"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 buttons, or dropdowns, of a similar nature or purpose.\n- Use the appropriate `role` attribute on the button group to provide additional semantics.\n- Use an `aria-labelledby` attribute referencing another element to best explain the contents of the button group.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t add components other than buttons, dropdowns and in some instances visually hidden components to the button 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\nButton labels 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\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing 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 unnecessary words and articles in button 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\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 segmented buttons to emphasize that they’re thematically-related. |\n| `spaced` | The spaced variant renders a gap between the buttons to space them out evenly. |\n",
|
|
1619
|
-
"examples": [],
|
|
1620
|
-
"dependencies": [],
|
|
1621
|
-
"tagName": "nord-button-group",
|
|
1622
|
-
"customElement": true
|
|
1623
|
-
}
|
|
1624
|
-
],
|
|
1625
|
-
"exports": [
|
|
1626
|
-
{
|
|
1627
|
-
"kind": "js",
|
|
1628
|
-
"name": "default",
|
|
1629
|
-
"declaration": {
|
|
1630
|
-
"name": "ButtonGroup",
|
|
1631
|
-
"module": "src/button-group/ButtonGroup.ts"
|
|
1632
|
-
}
|
|
1633
|
-
},
|
|
1634
|
-
{
|
|
1635
|
-
"kind": "custom-element-definition",
|
|
1636
|
-
"name": "nord-button-group",
|
|
1637
|
-
"declaration": {
|
|
1638
|
-
"name": "ButtonGroup",
|
|
1639
|
-
"module": "src/button-group/ButtonGroup.ts"
|
|
1640
|
-
}
|
|
1641
|
-
}
|
|
1642
|
-
]
|
|
1643
|
-
},
|
|
1644
|
-
{
|
|
1645
|
-
"kind": "javascript-module",
|
|
1646
|
-
"path": "src/card/Card.ts",
|
|
1647
|
-
"declarations": [
|
|
1648
|
-
{
|
|
1649
|
-
"kind": "class",
|
|
1650
|
-
"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.",
|
|
1651
|
-
"name": "Card",
|
|
1652
|
-
"cssProperties": [
|
|
1653
|
-
{
|
|
1654
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1655
|
-
"name": "--n-card-border-radius",
|
|
1656
|
-
"default": "var(--n-border-radius)"
|
|
1802
|
+
"default": "isDateDisabled",
|
|
1803
|
+
"description": "Controls which days are disabled and therefore disallowed.\nFor example, this can be used to disallow selection of weekends."
|
|
1657
1804
|
},
|
|
1658
1805
|
{
|
|
1659
|
-
"
|
|
1660
|
-
"name": "
|
|
1661
|
-
"
|
|
1806
|
+
"kind": "field",
|
|
1807
|
+
"name": "isDateHighlighted",
|
|
1808
|
+
"type": {
|
|
1809
|
+
"text": "(date: Date) => string | boolean"
|
|
1810
|
+
},
|
|
1811
|
+
"default": "isDateHighlighted",
|
|
1812
|
+
"description": "Controls which days are highlighted with a small indicator.\nReturning a \"falsy\" value will not show an indicator.\nReturning \"truthy\" value will show the indicator, but without an accessible label.\nReturning a string will show the indicator, and use the string as accessible label.\nIt is recommended to return a string rather than a truthy value whenever possible."
|
|
1662
1813
|
},
|
|
1663
1814
|
{
|
|
1664
|
-
"
|
|
1665
|
-
"name": "
|
|
1666
|
-
"
|
|
1815
|
+
"kind": "field",
|
|
1816
|
+
"name": "activeFocus",
|
|
1817
|
+
"type": {
|
|
1818
|
+
"text": "boolean"
|
|
1819
|
+
},
|
|
1820
|
+
"privacy": "private",
|
|
1821
|
+
"default": "false"
|
|
1667
1822
|
},
|
|
1668
1823
|
{
|
|
1669
|
-
"
|
|
1670
|
-
"name": "
|
|
1671
|
-
"
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
"slots": [
|
|
1824
|
+
"kind": "field",
|
|
1825
|
+
"name": "focusedDay",
|
|
1826
|
+
"privacy": "private",
|
|
1827
|
+
"default": "new Date()"
|
|
1828
|
+
},
|
|
1675
1829
|
{
|
|
1676
|
-
"
|
|
1677
|
-
"name": ""
|
|
1830
|
+
"kind": "method",
|
|
1831
|
+
"name": "focus",
|
|
1832
|
+
"parameters": [
|
|
1833
|
+
{
|
|
1834
|
+
"name": "options",
|
|
1835
|
+
"optional": true,
|
|
1836
|
+
"type": {
|
|
1837
|
+
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
1838
|
+
},
|
|
1839
|
+
"description": "An object which controls aspects of the focusing process."
|
|
1840
|
+
}
|
|
1841
|
+
],
|
|
1842
|
+
"description": "Programmatically move focus to the calendar."
|
|
1678
1843
|
},
|
|
1679
1844
|
{
|
|
1680
|
-
"
|
|
1681
|
-
"name": "
|
|
1845
|
+
"kind": "method",
|
|
1846
|
+
"name": "handleValueChange",
|
|
1847
|
+
"privacy": "protected"
|
|
1682
1848
|
},
|
|
1683
1849
|
{
|
|
1684
|
-
"
|
|
1685
|
-
"name": "
|
|
1850
|
+
"kind": "method",
|
|
1851
|
+
"name": "handleFocusedDayChange",
|
|
1852
|
+
"privacy": "protected"
|
|
1686
1853
|
},
|
|
1687
1854
|
{
|
|
1688
|
-
"
|
|
1689
|
-
"name": "
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
"members": [
|
|
1855
|
+
"kind": "method",
|
|
1856
|
+
"name": "handleLangChange",
|
|
1857
|
+
"privacy": "private"
|
|
1858
|
+
},
|
|
1693
1859
|
{
|
|
1694
1860
|
"kind": "field",
|
|
1695
|
-
"name": "
|
|
1696
|
-
"privacy": "private"
|
|
1697
|
-
"default": "new SlotController(this, \"header\")"
|
|
1861
|
+
"name": "handleDaySelect",
|
|
1862
|
+
"privacy": "private"
|
|
1698
1863
|
},
|
|
1699
1864
|
{
|
|
1700
|
-
"kind": "
|
|
1701
|
-
"name": "
|
|
1865
|
+
"kind": "method",
|
|
1866
|
+
"name": "addDays",
|
|
1702
1867
|
"privacy": "private",
|
|
1703
|
-
"
|
|
1868
|
+
"parameters": [
|
|
1869
|
+
{
|
|
1870
|
+
"name": "days",
|
|
1871
|
+
"type": {
|
|
1872
|
+
"text": "number"
|
|
1873
|
+
}
|
|
1874
|
+
}
|
|
1875
|
+
]
|
|
1704
1876
|
},
|
|
1705
1877
|
{
|
|
1706
|
-
"kind": "
|
|
1707
|
-
"name": "
|
|
1878
|
+
"kind": "method",
|
|
1879
|
+
"name": "addMonths",
|
|
1708
1880
|
"privacy": "private",
|
|
1709
|
-
"
|
|
1881
|
+
"parameters": [
|
|
1882
|
+
{
|
|
1883
|
+
"name": "months",
|
|
1884
|
+
"type": {
|
|
1885
|
+
"text": "number"
|
|
1886
|
+
}
|
|
1887
|
+
}
|
|
1888
|
+
]
|
|
1710
1889
|
},
|
|
1711
1890
|
{
|
|
1712
|
-
"kind": "
|
|
1713
|
-
"name": "
|
|
1714
|
-
"
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
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)"
|
|
1891
|
+
"kind": "method",
|
|
1892
|
+
"name": "addYears",
|
|
1893
|
+
"privacy": "private",
|
|
1894
|
+
"parameters": [
|
|
1895
|
+
{
|
|
1896
|
+
"name": "years",
|
|
1897
|
+
"type": {
|
|
1898
|
+
"text": "number"
|
|
1899
|
+
}
|
|
1900
|
+
}
|
|
1901
|
+
]
|
|
1780
1902
|
},
|
|
1781
1903
|
{
|
|
1782
|
-
"
|
|
1783
|
-
"name": "
|
|
1784
|
-
"default": "var(--n-box-shadow-popout)"
|
|
1785
|
-
}
|
|
1786
|
-
],
|
|
1787
|
-
"members": [
|
|
1788
|
-
{
|
|
1789
|
-
"kind": "field",
|
|
1790
|
-
"name": "monthSelectNode",
|
|
1791
|
-
"type": {
|
|
1792
|
-
"text": "HTMLElement"
|
|
1793
|
-
},
|
|
1904
|
+
"kind": "method",
|
|
1905
|
+
"name": "startOfWeek",
|
|
1794
1906
|
"privacy": "private"
|
|
1795
1907
|
},
|
|
1796
1908
|
{
|
|
1797
|
-
"kind": "
|
|
1798
|
-
"name": "
|
|
1799
|
-
"type": {
|
|
1800
|
-
"text": "HTMLButtonElement"
|
|
1801
|
-
},
|
|
1909
|
+
"kind": "method",
|
|
1910
|
+
"name": "endOfWeek",
|
|
1802
1911
|
"privacy": "private"
|
|
1803
1912
|
},
|
|
1804
1913
|
{
|
|
1805
|
-
"kind": "
|
|
1806
|
-
"name": "
|
|
1914
|
+
"kind": "method",
|
|
1915
|
+
"name": "setMonth",
|
|
1807
1916
|
"privacy": "private",
|
|
1808
|
-
"
|
|
1917
|
+
"parameters": [
|
|
1918
|
+
{
|
|
1919
|
+
"name": "month",
|
|
1920
|
+
"type": {
|
|
1921
|
+
"text": "number"
|
|
1922
|
+
}
|
|
1923
|
+
}
|
|
1924
|
+
]
|
|
1809
1925
|
},
|
|
1810
1926
|
{
|
|
1811
|
-
"kind": "
|
|
1812
|
-
"name": "
|
|
1927
|
+
"kind": "method",
|
|
1928
|
+
"name": "setYear",
|
|
1813
1929
|
"privacy": "private",
|
|
1814
|
-
"
|
|
1930
|
+
"parameters": [
|
|
1931
|
+
{
|
|
1932
|
+
"name": "year",
|
|
1933
|
+
"type": {
|
|
1934
|
+
"text": "number"
|
|
1935
|
+
}
|
|
1936
|
+
}
|
|
1937
|
+
]
|
|
1938
|
+
},
|
|
1939
|
+
{
|
|
1940
|
+
"kind": "method",
|
|
1941
|
+
"name": "setFocusedDay",
|
|
1942
|
+
"privacy": "private",
|
|
1943
|
+
"parameters": [
|
|
1944
|
+
{
|
|
1945
|
+
"name": "day",
|
|
1946
|
+
"type": {
|
|
1947
|
+
"text": "Date"
|
|
1948
|
+
}
|
|
1949
|
+
}
|
|
1950
|
+
]
|
|
1815
1951
|
},
|
|
1816
1952
|
{
|
|
1817
1953
|
"kind": "field",
|
|
1818
|
-
"name": "
|
|
1954
|
+
"name": "handleMonthSelect",
|
|
1819
1955
|
"privacy": "private"
|
|
1820
1956
|
},
|
|
1821
1957
|
{
|
|
1822
1958
|
"kind": "field",
|
|
1823
|
-
"name": "
|
|
1824
|
-
"privacy": "private"
|
|
1825
|
-
"default": "new LocalizeController<\"nord-calendar\">(this, { onLangChange: () => this.handleLangChange(), })"
|
|
1959
|
+
"name": "handleYearSelect",
|
|
1960
|
+
"privacy": "private"
|
|
1826
1961
|
},
|
|
1827
1962
|
{
|
|
1828
1963
|
"kind": "field",
|
|
1829
|
-
"name": "
|
|
1830
|
-
"
|
|
1831
|
-
"text": "Intl.DateTimeFormat"
|
|
1832
|
-
},
|
|
1833
|
-
"privacy": "private",
|
|
1834
|
-
"description": "Whilst dateAdapter is used for handling the formatting/parsing dates in the input,\nthese are used to format dates exclusively for the benefit of screen readers.\n\nWe prefer DateTimeFormat over date.toLocaleDateString, as the former has\nbetter performance when formatting large number of dates. See:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleDateString#Performance"
|
|
1964
|
+
"name": "handleNextMonthClick",
|
|
1965
|
+
"privacy": "private"
|
|
1835
1966
|
},
|
|
1836
1967
|
{
|
|
1837
1968
|
"kind": "field",
|
|
1838
|
-
"name": "
|
|
1839
|
-
"type": {
|
|
1840
|
-
"text": "string[]"
|
|
1841
|
-
},
|
|
1842
|
-
"privacy": "private"
|
|
1843
|
-
},
|
|
1844
|
-
{
|
|
1845
|
-
"kind": "field",
|
|
1846
|
-
"name": "monthNamesShort",
|
|
1847
|
-
"type": {
|
|
1848
|
-
"text": "string[]"
|
|
1849
|
-
},
|
|
1850
|
-
"privacy": "private"
|
|
1851
|
-
},
|
|
1852
|
-
{
|
|
1853
|
-
"kind": "field",
|
|
1854
|
-
"name": "dayNames",
|
|
1855
|
-
"type": {
|
|
1856
|
-
"text": "string[]"
|
|
1857
|
-
},
|
|
1858
|
-
"privacy": "private"
|
|
1859
|
-
},
|
|
1860
|
-
{
|
|
1861
|
-
"kind": "field",
|
|
1862
|
-
"name": "dayNamesShort",
|
|
1863
|
-
"type": {
|
|
1864
|
-
"text": "string[]"
|
|
1865
|
-
},
|
|
1866
|
-
"privacy": "private"
|
|
1867
|
-
},
|
|
1868
|
-
{
|
|
1869
|
-
"kind": "field",
|
|
1870
|
-
"name": "value",
|
|
1871
|
-
"type": {
|
|
1872
|
-
"text": "string"
|
|
1873
|
-
},
|
|
1874
|
-
"default": "\"\"",
|
|
1875
|
-
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1876
|
-
"attribute": "value"
|
|
1877
|
-
},
|
|
1878
|
-
{
|
|
1879
|
-
"kind": "field",
|
|
1880
|
-
"name": "firstDayOfWeek",
|
|
1881
|
-
"type": {
|
|
1882
|
-
"text": "DaysOfWeek"
|
|
1883
|
-
},
|
|
1884
|
-
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1885
|
-
"attribute": "first-day-of-week",
|
|
1886
|
-
"reflects": true
|
|
1887
|
-
},
|
|
1888
|
-
{
|
|
1889
|
-
"kind": "field",
|
|
1890
|
-
"name": "min",
|
|
1891
|
-
"type": {
|
|
1892
|
-
"text": "string | undefined"
|
|
1893
|
-
},
|
|
1894
|
-
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property.",
|
|
1895
|
-
"attribute": "min",
|
|
1896
|
-
"reflects": true
|
|
1897
|
-
},
|
|
1898
|
-
{
|
|
1899
|
-
"kind": "field",
|
|
1900
|
-
"name": "max",
|
|
1901
|
-
"type": {
|
|
1902
|
-
"text": "string | undefined"
|
|
1903
|
-
},
|
|
1904
|
-
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
1905
|
-
"attribute": "max",
|
|
1906
|
-
"reflects": true
|
|
1907
|
-
},
|
|
1908
|
-
{
|
|
1909
|
-
"kind": "field",
|
|
1910
|
-
"name": "expand",
|
|
1911
|
-
"type": {
|
|
1912
|
-
"text": "boolean"
|
|
1913
|
-
},
|
|
1914
|
-
"default": "false",
|
|
1915
|
-
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1916
|
-
"attribute": "expand",
|
|
1917
|
-
"reflects": true
|
|
1918
|
-
},
|
|
1919
|
-
{
|
|
1920
|
-
"kind": "field",
|
|
1921
|
-
"name": "isDateDisabled",
|
|
1922
|
-
"type": {
|
|
1923
|
-
"text": "DatePredicate"
|
|
1924
|
-
},
|
|
1925
|
-
"default": "isDateDisabled",
|
|
1926
|
-
"description": "Controls which days are disabled and therefore disallowed.\nFor example, this can be used to disallow selection of weekends."
|
|
1927
|
-
},
|
|
1928
|
-
{
|
|
1929
|
-
"kind": "field",
|
|
1930
|
-
"name": "isDateHighlighted",
|
|
1931
|
-
"type": {
|
|
1932
|
-
"text": "(date: Date) => string | boolean"
|
|
1933
|
-
},
|
|
1934
|
-
"default": "isDateHighlighted",
|
|
1935
|
-
"description": "Controls which days are highlighted with a small indicator.\nReturning a \"falsy\" value will not show an indicator.\nReturning \"truthy\" value will show the indicator, but without an accessible label.\nReturning a string will show the indicator, and use the string as accessible label.\nIt is recommended to return a string rather than a truthy value whenever possible."
|
|
1936
|
-
},
|
|
1937
|
-
{
|
|
1938
|
-
"kind": "field",
|
|
1939
|
-
"name": "activeFocus",
|
|
1940
|
-
"type": {
|
|
1941
|
-
"text": "boolean"
|
|
1942
|
-
},
|
|
1943
|
-
"privacy": "private",
|
|
1944
|
-
"default": "false"
|
|
1945
|
-
},
|
|
1946
|
-
{
|
|
1947
|
-
"kind": "field",
|
|
1948
|
-
"name": "focusedDay",
|
|
1949
|
-
"privacy": "private",
|
|
1950
|
-
"default": "new Date()"
|
|
1951
|
-
},
|
|
1952
|
-
{
|
|
1953
|
-
"kind": "method",
|
|
1954
|
-
"name": "focus",
|
|
1955
|
-
"parameters": [
|
|
1956
|
-
{
|
|
1957
|
-
"name": "options",
|
|
1958
|
-
"optional": true,
|
|
1959
|
-
"type": {
|
|
1960
|
-
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
1961
|
-
},
|
|
1962
|
-
"description": "An object which controls aspects of the focusing process."
|
|
1963
|
-
}
|
|
1964
|
-
],
|
|
1965
|
-
"description": "Programmatically move focus to the calendar."
|
|
1966
|
-
},
|
|
1967
|
-
{
|
|
1968
|
-
"kind": "method",
|
|
1969
|
-
"name": "handleValueChange",
|
|
1970
|
-
"privacy": "protected"
|
|
1971
|
-
},
|
|
1972
|
-
{
|
|
1973
|
-
"kind": "method",
|
|
1974
|
-
"name": "handleFocusedDayChange",
|
|
1975
|
-
"privacy": "protected"
|
|
1976
|
-
},
|
|
1977
|
-
{
|
|
1978
|
-
"kind": "method",
|
|
1979
|
-
"name": "handleLangChange",
|
|
1980
|
-
"privacy": "private"
|
|
1981
|
-
},
|
|
1982
|
-
{
|
|
1983
|
-
"kind": "field",
|
|
1984
|
-
"name": "handleDaySelect",
|
|
1985
|
-
"privacy": "private"
|
|
1986
|
-
},
|
|
1987
|
-
{
|
|
1988
|
-
"kind": "method",
|
|
1989
|
-
"name": "addDays",
|
|
1990
|
-
"privacy": "private",
|
|
1991
|
-
"parameters": [
|
|
1992
|
-
{
|
|
1993
|
-
"name": "days",
|
|
1994
|
-
"type": {
|
|
1995
|
-
"text": "number"
|
|
1996
|
-
}
|
|
1997
|
-
}
|
|
1998
|
-
]
|
|
1999
|
-
},
|
|
2000
|
-
{
|
|
2001
|
-
"kind": "method",
|
|
2002
|
-
"name": "addMonths",
|
|
2003
|
-
"privacy": "private",
|
|
2004
|
-
"parameters": [
|
|
2005
|
-
{
|
|
2006
|
-
"name": "months",
|
|
2007
|
-
"type": {
|
|
2008
|
-
"text": "number"
|
|
2009
|
-
}
|
|
2010
|
-
}
|
|
2011
|
-
]
|
|
2012
|
-
},
|
|
2013
|
-
{
|
|
2014
|
-
"kind": "method",
|
|
2015
|
-
"name": "addYears",
|
|
2016
|
-
"privacy": "private",
|
|
2017
|
-
"parameters": [
|
|
2018
|
-
{
|
|
2019
|
-
"name": "years",
|
|
2020
|
-
"type": {
|
|
2021
|
-
"text": "number"
|
|
2022
|
-
}
|
|
2023
|
-
}
|
|
2024
|
-
]
|
|
2025
|
-
},
|
|
2026
|
-
{
|
|
2027
|
-
"kind": "method",
|
|
2028
|
-
"name": "startOfWeek",
|
|
2029
|
-
"privacy": "private"
|
|
2030
|
-
},
|
|
2031
|
-
{
|
|
2032
|
-
"kind": "method",
|
|
2033
|
-
"name": "endOfWeek",
|
|
2034
|
-
"privacy": "private"
|
|
2035
|
-
},
|
|
2036
|
-
{
|
|
2037
|
-
"kind": "method",
|
|
2038
|
-
"name": "setMonth",
|
|
2039
|
-
"privacy": "private",
|
|
2040
|
-
"parameters": [
|
|
2041
|
-
{
|
|
2042
|
-
"name": "month",
|
|
2043
|
-
"type": {
|
|
2044
|
-
"text": "number"
|
|
2045
|
-
}
|
|
2046
|
-
}
|
|
2047
|
-
]
|
|
2048
|
-
},
|
|
2049
|
-
{
|
|
2050
|
-
"kind": "method",
|
|
2051
|
-
"name": "setYear",
|
|
2052
|
-
"privacy": "private",
|
|
2053
|
-
"parameters": [
|
|
2054
|
-
{
|
|
2055
|
-
"name": "year",
|
|
2056
|
-
"type": {
|
|
2057
|
-
"text": "number"
|
|
2058
|
-
}
|
|
2059
|
-
}
|
|
2060
|
-
]
|
|
2061
|
-
},
|
|
2062
|
-
{
|
|
2063
|
-
"kind": "method",
|
|
2064
|
-
"name": "setFocusedDay",
|
|
2065
|
-
"privacy": "private",
|
|
2066
|
-
"parameters": [
|
|
2067
|
-
{
|
|
2068
|
-
"name": "day",
|
|
2069
|
-
"type": {
|
|
2070
|
-
"text": "Date"
|
|
2071
|
-
}
|
|
2072
|
-
}
|
|
2073
|
-
]
|
|
2074
|
-
},
|
|
2075
|
-
{
|
|
2076
|
-
"kind": "field",
|
|
2077
|
-
"name": "handleMonthSelect",
|
|
2078
|
-
"privacy": "private"
|
|
2079
|
-
},
|
|
2080
|
-
{
|
|
2081
|
-
"kind": "field",
|
|
2082
|
-
"name": "handleYearSelect",
|
|
2083
|
-
"privacy": "private"
|
|
2084
|
-
},
|
|
2085
|
-
{
|
|
2086
|
-
"kind": "field",
|
|
2087
|
-
"name": "handleNextMonthClick",
|
|
2088
|
-
"privacy": "private"
|
|
2089
|
-
},
|
|
2090
|
-
{
|
|
2091
|
-
"kind": "field",
|
|
2092
|
-
"name": "handlePreviousMonthClick",
|
|
1969
|
+
"name": "handlePreviousMonthClick",
|
|
2093
1970
|
"privacy": "private"
|
|
2094
1971
|
},
|
|
2095
1972
|
{
|
|
@@ -2268,15 +2145,138 @@
|
|
|
2268
2145
|
},
|
|
2269
2146
|
{
|
|
2270
2147
|
"kind": "javascript-module",
|
|
2271
|
-
"path": "src/
|
|
2148
|
+
"path": "src/card/Card.ts",
|
|
2272
2149
|
"declarations": [
|
|
2273
2150
|
{
|
|
2274
2151
|
"kind": "class",
|
|
2275
|
-
"description": "
|
|
2276
|
-
"name": "
|
|
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",
|
|
2277
2154
|
"cssProperties": [
|
|
2278
2155
|
{
|
|
2279
|
-
"description": "Controls
|
|
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
|
+
{
|
|
2270
|
+
"kind": "javascript-module",
|
|
2271
|
+
"path": "src/checkbox/Checkbox.ts",
|
|
2272
|
+
"declarations": [
|
|
2273
|
+
{
|
|
2274
|
+
"kind": "class",
|
|
2275
|
+
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
2276
|
+
"name": "Checkbox",
|
|
2277
|
+
"cssProperties": [
|
|
2278
|
+
{
|
|
2279
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
2280
2280
|
"name": "--n-label-color",
|
|
2281
2281
|
"default": "var(--n-color-text)"
|
|
2282
2282
|
}
|
|
@@ -7321,1369 +7321,1369 @@
|
|
|
7321
7321
|
},
|
|
7322
7322
|
{
|
|
7323
7323
|
"kind": "javascript-module",
|
|
7324
|
-
"path": "src/
|
|
7324
|
+
"path": "src/input/Input.ts",
|
|
7325
7325
|
"declarations": [
|
|
7326
7326
|
{
|
|
7327
7327
|
"kind": "class",
|
|
7328
|
-
"description": "
|
|
7329
|
-
"name": "
|
|
7328
|
+
"description": "Inputs are used to allow users to provide text input when the expected input is short.\nAs well as plain text, Input supports various types of text, including passwords and numbers.",
|
|
7329
|
+
"name": "Input",
|
|
7330
|
+
"cssProperties": [
|
|
7331
|
+
{
|
|
7332
|
+
"description": "Controls the inline size, or width, of the input.",
|
|
7333
|
+
"name": "--n-input-inline-size",
|
|
7334
|
+
"default": "240px"
|
|
7335
|
+
},
|
|
7336
|
+
{
|
|
7337
|
+
"description": "Controls the background of the input, using our [color tokens](/tokens/#color).",
|
|
7338
|
+
"name": "--n-input-background",
|
|
7339
|
+
"default": "var(--n-color-active)"
|
|
7340
|
+
},
|
|
7341
|
+
{
|
|
7342
|
+
"description": "Controls the text color of the input, using our [color tokens](/tokens/#color).",
|
|
7343
|
+
"name": "--n-input-color",
|
|
7344
|
+
"default": "var(--n-color-text)"
|
|
7345
|
+
},
|
|
7346
|
+
{
|
|
7347
|
+
"description": "Controls the border color of the input, using our [color tokens](/tokens/#color).",
|
|
7348
|
+
"name": "--n-input-border-color",
|
|
7349
|
+
"default": "var(--n-color-border-strong)"
|
|
7350
|
+
},
|
|
7351
|
+
{
|
|
7352
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
7353
|
+
"name": "--n-input-border-radius",
|
|
7354
|
+
"default": "var(--n-border-radius-s)"
|
|
7355
|
+
},
|
|
7356
|
+
{
|
|
7357
|
+
"description": "Controls the alignment of text within the input itself.",
|
|
7358
|
+
"name": "--n-input-text-align",
|
|
7359
|
+
"default": "start"
|
|
7360
|
+
},
|
|
7361
|
+
{
|
|
7362
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
7363
|
+
"name": "--n-label-color",
|
|
7364
|
+
"default": "var(--n-color-text)"
|
|
7365
|
+
}
|
|
7366
|
+
],
|
|
7330
7367
|
"slots": [
|
|
7331
7368
|
{
|
|
7332
|
-
"description": "
|
|
7333
|
-
"name": ""
|
|
7369
|
+
"description": "Use when a label requires more than plain text.",
|
|
7370
|
+
"name": "label"
|
|
7371
|
+
},
|
|
7372
|
+
{
|
|
7373
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
7374
|
+
"name": "hint"
|
|
7375
|
+
},
|
|
7376
|
+
{
|
|
7377
|
+
"description": "Optional slot that holds error text for the input.",
|
|
7378
|
+
"name": "error"
|
|
7379
|
+
},
|
|
7380
|
+
{
|
|
7381
|
+
"description": "Optional slot used to place an icon or prefix at the start of the input.",
|
|
7382
|
+
"name": "start"
|
|
7383
|
+
},
|
|
7384
|
+
{
|
|
7385
|
+
"description": "Optional slot used to place an icon or suffix at the end of the input.",
|
|
7386
|
+
"name": "end"
|
|
7334
7387
|
}
|
|
7335
7388
|
],
|
|
7336
7389
|
"members": [
|
|
7337
7390
|
{
|
|
7338
7391
|
"kind": "field",
|
|
7339
|
-
"name": "
|
|
7392
|
+
"name": "startSlot",
|
|
7393
|
+
"type": {
|
|
7394
|
+
"text": "HTMLSlotElement"
|
|
7395
|
+
},
|
|
7396
|
+
"privacy": "private"
|
|
7397
|
+
},
|
|
7398
|
+
{
|
|
7399
|
+
"kind": "field",
|
|
7400
|
+
"name": "endSlot",
|
|
7401
|
+
"type": {
|
|
7402
|
+
"text": "HTMLSlotElement"
|
|
7403
|
+
},
|
|
7404
|
+
"privacy": "private"
|
|
7405
|
+
},
|
|
7406
|
+
{
|
|
7407
|
+
"kind": "field",
|
|
7408
|
+
"name": "startObserver",
|
|
7340
7409
|
"privacy": "private",
|
|
7341
|
-
"
|
|
7342
|
-
"default": "new IconManager()"
|
|
7410
|
+
"default": "new ResizeController(this, () => this.startSlot)"
|
|
7343
7411
|
},
|
|
7344
7412
|
{
|
|
7345
|
-
"kind": "
|
|
7346
|
-
"name": "
|
|
7347
|
-
"
|
|
7348
|
-
"
|
|
7349
|
-
{
|
|
7350
|
-
"name": "resolver",
|
|
7351
|
-
"type": {
|
|
7352
|
-
"text": "IconResolver"
|
|
7353
|
-
},
|
|
7354
|
-
"description": "The resolver function to register."
|
|
7355
|
-
}
|
|
7356
|
-
],
|
|
7357
|
-
"description": "Register a custom icon resolver, which accepts the icon name as an parameter, and returns an SVG string.\nCan return a string synchronously, or a promise of a string.\nBy default, will load icons from the Nord CDN."
|
|
7413
|
+
"kind": "field",
|
|
7414
|
+
"name": "endObserver",
|
|
7415
|
+
"privacy": "private",
|
|
7416
|
+
"default": "new ResizeController(this, () => this.endSlot)"
|
|
7358
7417
|
},
|
|
7359
7418
|
{
|
|
7360
|
-
"kind": "
|
|
7361
|
-
"name": "
|
|
7362
|
-
"
|
|
7363
|
-
"
|
|
7364
|
-
|
|
7365
|
-
|
|
7366
|
-
|
|
7419
|
+
"kind": "field",
|
|
7420
|
+
"name": "direction",
|
|
7421
|
+
"privacy": "private",
|
|
7422
|
+
"default": "new DirectionController(this)"
|
|
7423
|
+
},
|
|
7424
|
+
{
|
|
7425
|
+
"kind": "field",
|
|
7426
|
+
"name": "type",
|
|
7427
|
+
"type": {
|
|
7428
|
+
"text": "| \"text\"\n | \"email\"\n | \"password\"\n | \"tel\"\n | \"url\"\n | \"search\"\n | \"number\"\n | \"unit\"\n | \"button\""
|
|
7367
7429
|
},
|
|
7368
|
-
"
|
|
7369
|
-
|
|
7370
|
-
|
|
7371
|
-
|
|
7372
|
-
"text": "{ title: string; default: string }"
|
|
7373
|
-
},
|
|
7374
|
-
"description": "An object representing the icon to be registered, where \"title\" is the icon's name, and \"default\" is the SVG string.\nThis is intended to be used in cases where you import an icon's entire ES module and register it directly."
|
|
7375
|
-
}
|
|
7376
|
-
],
|
|
7377
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
7430
|
+
"default": "\"text\"",
|
|
7431
|
+
"description": "The type of the input.",
|
|
7432
|
+
"attribute": "type",
|
|
7433
|
+
"reflects": true
|
|
7378
7434
|
},
|
|
7379
7435
|
{
|
|
7380
|
-
"kind": "
|
|
7381
|
-
"name": "
|
|
7382
|
-
"
|
|
7383
|
-
|
|
7384
|
-
|
|
7385
|
-
|
|
7386
|
-
|
|
7436
|
+
"kind": "field",
|
|
7437
|
+
"name": "expand",
|
|
7438
|
+
"type": {
|
|
7439
|
+
"text": "boolean"
|
|
7440
|
+
},
|
|
7441
|
+
"default": "false",
|
|
7442
|
+
"description": "Controls whether the input expands to fill the width of its container.",
|
|
7443
|
+
"attribute": "expand",
|
|
7444
|
+
"reflects": true
|
|
7445
|
+
},
|
|
7446
|
+
{
|
|
7447
|
+
"kind": "field",
|
|
7448
|
+
"name": "disallowPattern",
|
|
7449
|
+
"type": {
|
|
7450
|
+
"text": "string | undefined"
|
|
7387
7451
|
},
|
|
7452
|
+
"default": "undefined",
|
|
7453
|
+
"description": "Optionally disallow certain characters from being used inside the input, using a regex pattern.",
|
|
7454
|
+
"attribute": "disallow-pattern",
|
|
7455
|
+
"reflects": true
|
|
7456
|
+
},
|
|
7457
|
+
{
|
|
7458
|
+
"kind": "method",
|
|
7459
|
+
"name": "handleKeydown",
|
|
7460
|
+
"privacy": "private",
|
|
7388
7461
|
"parameters": [
|
|
7389
7462
|
{
|
|
7390
|
-
"name": "
|
|
7391
|
-
"type": {
|
|
7392
|
-
"text": "string"
|
|
7393
|
-
},
|
|
7394
|
-
"description": "The name of the icon to be registered."
|
|
7395
|
-
},
|
|
7396
|
-
{
|
|
7397
|
-
"name": "icon",
|
|
7463
|
+
"name": "e",
|
|
7398
7464
|
"type": {
|
|
7399
|
-
"text": "
|
|
7400
|
-
}
|
|
7401
|
-
"description": "The SVG string for the icon."
|
|
7465
|
+
"text": "KeyboardEvent"
|
|
7466
|
+
}
|
|
7402
7467
|
}
|
|
7403
|
-
]
|
|
7404
|
-
|
|
7468
|
+
]
|
|
7469
|
+
},
|
|
7470
|
+
{
|
|
7471
|
+
"kind": "field",
|
|
7472
|
+
"name": "handleInputChange",
|
|
7473
|
+
"privacy": "private"
|
|
7405
7474
|
},
|
|
7406
7475
|
{
|
|
7407
7476
|
"kind": "method",
|
|
7408
|
-
"name": "
|
|
7409
|
-
"
|
|
7477
|
+
"name": "handleSelect",
|
|
7478
|
+
"privacy": "protected",
|
|
7410
7479
|
"parameters": [
|
|
7411
7480
|
{
|
|
7412
|
-
"name": "
|
|
7413
|
-
"type": {
|
|
7414
|
-
"text": "string | { title: string; default: string }"
|
|
7415
|
-
},
|
|
7416
|
-
"description": "The name of the icon to be registered or an object representing the icon to be registered, where \"title\" is the icon's name, and \"default\" is the SVG string."
|
|
7417
|
-
},
|
|
7418
|
-
{
|
|
7419
|
-
"name": "icon",
|
|
7420
|
-
"optional": true,
|
|
7481
|
+
"name": "e",
|
|
7421
7482
|
"type": {
|
|
7422
|
-
"text": "
|
|
7423
|
-
}
|
|
7424
|
-
"description": "The SVG string for the icon."
|
|
7483
|
+
"text": "Event"
|
|
7484
|
+
}
|
|
7425
7485
|
}
|
|
7426
|
-
]
|
|
7427
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
7428
|
-
},
|
|
7429
|
-
{
|
|
7430
|
-
"kind": "field",
|
|
7431
|
-
"name": "name",
|
|
7432
|
-
"type": {
|
|
7433
|
-
"text": "string"
|
|
7434
|
-
},
|
|
7435
|
-
"default": "\"\"",
|
|
7436
|
-
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
7437
|
-
"attribute": "name",
|
|
7438
|
-
"reflects": true
|
|
7486
|
+
]
|
|
7439
7487
|
},
|
|
7440
7488
|
{
|
|
7441
7489
|
"kind": "field",
|
|
7442
7490
|
"name": "size",
|
|
7443
7491
|
"type": {
|
|
7444
|
-
"text": "\"
|
|
7492
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
7445
7493
|
},
|
|
7446
|
-
"description": "The size of the icon.",
|
|
7447
7494
|
"default": "\"m\"",
|
|
7495
|
+
"description": "The size of the component.",
|
|
7448
7496
|
"attribute": "size",
|
|
7449
|
-
"reflects": true
|
|
7497
|
+
"reflects": true,
|
|
7498
|
+
"inheritedFrom": {
|
|
7499
|
+
"name": "SizeMixin",
|
|
7500
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
7501
|
+
}
|
|
7450
7502
|
},
|
|
7451
7503
|
{
|
|
7452
7504
|
"kind": "field",
|
|
7453
|
-
"name": "
|
|
7505
|
+
"name": "labelSlot",
|
|
7506
|
+
"privacy": "protected",
|
|
7507
|
+
"default": "new SlotController(this, \"label\")",
|
|
7508
|
+
"inheritedFrom": {
|
|
7509
|
+
"name": "FormAssociatedMixin",
|
|
7510
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7511
|
+
}
|
|
7512
|
+
},
|
|
7513
|
+
{
|
|
7514
|
+
"kind": "field",
|
|
7515
|
+
"name": "errorSlot",
|
|
7516
|
+
"privacy": "protected",
|
|
7517
|
+
"default": "new SlotController(this, \"error\")",
|
|
7518
|
+
"inheritedFrom": {
|
|
7519
|
+
"name": "FormAssociatedMixin",
|
|
7520
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7521
|
+
}
|
|
7522
|
+
},
|
|
7523
|
+
{
|
|
7524
|
+
"kind": "field",
|
|
7525
|
+
"name": "hintSlot",
|
|
7526
|
+
"privacy": "protected",
|
|
7527
|
+
"default": "new SlotController(this, \"hint\")",
|
|
7528
|
+
"inheritedFrom": {
|
|
7529
|
+
"name": "FormAssociatedMixin",
|
|
7530
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7531
|
+
}
|
|
7532
|
+
},
|
|
7533
|
+
{
|
|
7534
|
+
"kind": "field",
|
|
7535
|
+
"name": "formData",
|
|
7536
|
+
"privacy": "protected",
|
|
7537
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
7538
|
+
"inheritedFrom": {
|
|
7539
|
+
"name": "FormAssociatedMixin",
|
|
7540
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7541
|
+
}
|
|
7542
|
+
},
|
|
7543
|
+
{
|
|
7544
|
+
"kind": "field",
|
|
7545
|
+
"name": "formValue",
|
|
7546
|
+
"privacy": "protected",
|
|
7547
|
+
"readonly": true,
|
|
7548
|
+
"inheritedFrom": {
|
|
7549
|
+
"name": "FormAssociatedMixin",
|
|
7550
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7551
|
+
}
|
|
7552
|
+
},
|
|
7553
|
+
{
|
|
7554
|
+
"kind": "field",
|
|
7555
|
+
"name": "inputId",
|
|
7454
7556
|
"type": {
|
|
7455
|
-
"text": "string
|
|
7557
|
+
"text": "string"
|
|
7456
7558
|
},
|
|
7457
|
-
"
|
|
7458
|
-
"
|
|
7459
|
-
"
|
|
7559
|
+
"privacy": "protected",
|
|
7560
|
+
"default": "\"input\"",
|
|
7561
|
+
"inheritedFrom": {
|
|
7562
|
+
"name": "FormAssociatedMixin",
|
|
7563
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7564
|
+
}
|
|
7460
7565
|
},
|
|
7461
7566
|
{
|
|
7462
7567
|
"kind": "field",
|
|
7463
|
-
"name": "
|
|
7568
|
+
"name": "errorId",
|
|
7464
7569
|
"type": {
|
|
7465
|
-
"text": "string
|
|
7570
|
+
"text": "string"
|
|
7466
7571
|
},
|
|
7467
|
-
"
|
|
7468
|
-
"
|
|
7469
|
-
"
|
|
7572
|
+
"privacy": "protected",
|
|
7573
|
+
"default": "\"error\"",
|
|
7574
|
+
"inheritedFrom": {
|
|
7575
|
+
"name": "FormAssociatedMixin",
|
|
7576
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7577
|
+
}
|
|
7470
7578
|
},
|
|
7471
7579
|
{
|
|
7472
7580
|
"kind": "field",
|
|
7473
|
-
"name": "
|
|
7581
|
+
"name": "hintId",
|
|
7474
7582
|
"type": {
|
|
7475
7583
|
"text": "string"
|
|
7476
7584
|
},
|
|
7477
|
-
"privacy": "
|
|
7478
|
-
"default": "\"\""
|
|
7585
|
+
"privacy": "protected",
|
|
7586
|
+
"default": "\"hint\"",
|
|
7587
|
+
"inheritedFrom": {
|
|
7588
|
+
"name": "FormAssociatedMixin",
|
|
7589
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7590
|
+
}
|
|
7479
7591
|
},
|
|
7480
7592
|
{
|
|
7481
|
-
"kind": "
|
|
7482
|
-
"name": "
|
|
7483
|
-
"privacy": "protected"
|
|
7484
|
-
}
|
|
7485
|
-
],
|
|
7486
|
-
"attributes": [
|
|
7487
|
-
{
|
|
7488
|
-
"name": "name",
|
|
7593
|
+
"kind": "field",
|
|
7594
|
+
"name": "label",
|
|
7489
7595
|
"type": {
|
|
7490
7596
|
"text": "string"
|
|
7491
7597
|
},
|
|
7492
7598
|
"default": "\"\"",
|
|
7493
|
-
"description": "
|
|
7494
|
-
"
|
|
7599
|
+
"description": "Label for the input.",
|
|
7600
|
+
"attribute": "label",
|
|
7601
|
+
"reflects": true,
|
|
7602
|
+
"inheritedFrom": {
|
|
7603
|
+
"name": "FormAssociatedMixin",
|
|
7604
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7605
|
+
}
|
|
7495
7606
|
},
|
|
7496
7607
|
{
|
|
7497
|
-
"
|
|
7608
|
+
"kind": "field",
|
|
7609
|
+
"name": "hint",
|
|
7498
7610
|
"type": {
|
|
7499
|
-
"text": "
|
|
7611
|
+
"text": "string | undefined"
|
|
7500
7612
|
},
|
|
7501
|
-
"description": "
|
|
7502
|
-
"
|
|
7503
|
-
"
|
|
7613
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
7614
|
+
"attribute": "hint",
|
|
7615
|
+
"reflects": true,
|
|
7616
|
+
"inheritedFrom": {
|
|
7617
|
+
"name": "FormAssociatedMixin",
|
|
7618
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7619
|
+
}
|
|
7504
7620
|
},
|
|
7505
7621
|
{
|
|
7506
|
-
"
|
|
7622
|
+
"kind": "field",
|
|
7623
|
+
"name": "hideLabel",
|
|
7624
|
+
"type": {
|
|
7625
|
+
"text": "boolean"
|
|
7626
|
+
},
|
|
7627
|
+
"default": "false",
|
|
7628
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
7629
|
+
"attribute": "hide-label",
|
|
7630
|
+
"reflects": true,
|
|
7631
|
+
"inheritedFrom": {
|
|
7632
|
+
"name": "FormAssociatedMixin",
|
|
7633
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7634
|
+
}
|
|
7635
|
+
},
|
|
7636
|
+
{
|
|
7637
|
+
"kind": "field",
|
|
7638
|
+
"name": "placeholder",
|
|
7507
7639
|
"type": {
|
|
7508
7640
|
"text": "string | undefined"
|
|
7509
7641
|
},
|
|
7510
|
-
"description": "
|
|
7511
|
-
"
|
|
7642
|
+
"description": "Placeholder text to display within the input.",
|
|
7643
|
+
"attribute": "placeholder",
|
|
7644
|
+
"reflects": true,
|
|
7645
|
+
"inheritedFrom": {
|
|
7646
|
+
"name": "FormAssociatedMixin",
|
|
7647
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7648
|
+
}
|
|
7512
7649
|
},
|
|
7513
7650
|
{
|
|
7514
|
-
"
|
|
7651
|
+
"kind": "field",
|
|
7652
|
+
"name": "error",
|
|
7515
7653
|
"type": {
|
|
7516
7654
|
"text": "string | undefined"
|
|
7517
7655
|
},
|
|
7518
|
-
"description": "
|
|
7519
|
-
"
|
|
7520
|
-
|
|
7521
|
-
|
|
7522
|
-
|
|
7523
|
-
|
|
7524
|
-
|
|
7525
|
-
|
|
7526
|
-
"localization": [],
|
|
7527
|
-
"status": "ready",
|
|
7528
|
-
"category": "image",
|
|
7529
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<nord-button href=\"/nordicons/\" variant=\"primary\">View Nordicons</nord-button>\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to provide additional meaning in addition to a text label.\n- Use to help users who have difficulties with reading and attention.\n- Use in places where text label doesn’t fit (remember to add an accessible label for the icon).\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for decorative purposes alone.\n- Don’t use when a button’s action is already clear based on the text label.\n- Don’t use the same icon for differing purposes, as users will come to associate icons with specific types of actions.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Icon components are hidden from assistive technologies by default.\n- Use `label` property to give an accessible label for the icon and to make it visible to assistive technologies.\n",
|
|
7530
|
-
"examples": [],
|
|
7531
|
-
"dependencies": [],
|
|
7532
|
-
"tagName": "nord-icon",
|
|
7533
|
-
"customElement": true
|
|
7534
|
-
}
|
|
7535
|
-
],
|
|
7536
|
-
"exports": [
|
|
7537
|
-
{
|
|
7538
|
-
"kind": "js",
|
|
7539
|
-
"name": "default",
|
|
7540
|
-
"declaration": {
|
|
7541
|
-
"name": "Icon",
|
|
7542
|
-
"module": "src/icon/Icon.ts"
|
|
7543
|
-
}
|
|
7544
|
-
},
|
|
7545
|
-
{
|
|
7546
|
-
"kind": "custom-element-definition",
|
|
7547
|
-
"name": "nord-icon",
|
|
7548
|
-
"declaration": {
|
|
7549
|
-
"name": "Icon",
|
|
7550
|
-
"module": "src/icon/Icon.ts"
|
|
7551
|
-
}
|
|
7552
|
-
}
|
|
7553
|
-
]
|
|
7554
|
-
},
|
|
7555
|
-
{
|
|
7556
|
-
"kind": "javascript-module",
|
|
7557
|
-
"path": "src/icon/IconManager.ts",
|
|
7558
|
-
"declarations": [
|
|
7559
|
-
{
|
|
7560
|
-
"kind": "class",
|
|
7561
|
-
"description": "",
|
|
7562
|
-
"name": "IconManager",
|
|
7563
|
-
"members": [
|
|
7656
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
7657
|
+
"attribute": "error",
|
|
7658
|
+
"reflects": true,
|
|
7659
|
+
"inheritedFrom": {
|
|
7660
|
+
"name": "FormAssociatedMixin",
|
|
7661
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7662
|
+
}
|
|
7663
|
+
},
|
|
7564
7664
|
{
|
|
7565
7665
|
"kind": "field",
|
|
7566
|
-
"name": "
|
|
7567
|
-
"
|
|
7568
|
-
|
|
7666
|
+
"name": "required",
|
|
7667
|
+
"type": {
|
|
7668
|
+
"text": "boolean"
|
|
7669
|
+
},
|
|
7670
|
+
"default": "false",
|
|
7671
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
7672
|
+
"attribute": "required",
|
|
7673
|
+
"reflects": true,
|
|
7674
|
+
"inheritedFrom": {
|
|
7675
|
+
"name": "FormAssociatedMixin",
|
|
7676
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7677
|
+
}
|
|
7569
7678
|
},
|
|
7570
7679
|
{
|
|
7571
7680
|
"kind": "field",
|
|
7572
|
-
"name": "
|
|
7681
|
+
"name": "hideRequired",
|
|
7573
7682
|
"type": {
|
|
7574
|
-
"text": "
|
|
7683
|
+
"text": "boolean"
|
|
7684
|
+
},
|
|
7685
|
+
"default": "false",
|
|
7686
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
7687
|
+
"attribute": "hide-required",
|
|
7688
|
+
"reflects": true,
|
|
7689
|
+
"inheritedFrom": {
|
|
7690
|
+
"name": "FormAssociatedMixin",
|
|
7691
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7575
7692
|
}
|
|
7576
7693
|
},
|
|
7577
7694
|
{
|
|
7578
7695
|
"kind": "method",
|
|
7579
|
-
"name": "
|
|
7696
|
+
"name": "handleInput",
|
|
7697
|
+
"privacy": "protected",
|
|
7580
7698
|
"parameters": [
|
|
7581
7699
|
{
|
|
7582
|
-
"name": "
|
|
7583
|
-
"type": {
|
|
7584
|
-
"text": "string"
|
|
7585
|
-
}
|
|
7586
|
-
},
|
|
7587
|
-
{
|
|
7588
|
-
"name": "onResolved",
|
|
7700
|
+
"name": "e",
|
|
7589
7701
|
"type": {
|
|
7590
|
-
"text": "
|
|
7702
|
+
"text": "Event"
|
|
7591
7703
|
}
|
|
7592
7704
|
}
|
|
7593
|
-
]
|
|
7705
|
+
],
|
|
7706
|
+
"inheritedFrom": {
|
|
7707
|
+
"name": "FormAssociatedMixin",
|
|
7708
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7709
|
+
}
|
|
7594
7710
|
},
|
|
7595
7711
|
{
|
|
7596
7712
|
"kind": "method",
|
|
7597
|
-
"name": "
|
|
7713
|
+
"name": "handleChange",
|
|
7714
|
+
"privacy": "protected",
|
|
7598
7715
|
"parameters": [
|
|
7599
7716
|
{
|
|
7600
|
-
"name": "
|
|
7717
|
+
"name": "e",
|
|
7601
7718
|
"type": {
|
|
7602
|
-
"text": "
|
|
7719
|
+
"text": "Event"
|
|
7603
7720
|
}
|
|
7604
|
-
}
|
|
7721
|
+
}
|
|
7722
|
+
],
|
|
7723
|
+
"inheritedFrom": {
|
|
7724
|
+
"name": "FormAssociatedMixin",
|
|
7725
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7726
|
+
}
|
|
7727
|
+
},
|
|
7728
|
+
{
|
|
7729
|
+
"kind": "method",
|
|
7730
|
+
"name": "renderLabel",
|
|
7731
|
+
"privacy": "protected",
|
|
7732
|
+
"parameters": [
|
|
7605
7733
|
{
|
|
7606
|
-
"name": "
|
|
7734
|
+
"name": "additionalContent",
|
|
7607
7735
|
"optional": true,
|
|
7608
7736
|
"type": {
|
|
7609
|
-
"text": "
|
|
7737
|
+
"text": "TemplateResult"
|
|
7610
7738
|
}
|
|
7611
7739
|
}
|
|
7612
|
-
]
|
|
7740
|
+
],
|
|
7741
|
+
"inheritedFrom": {
|
|
7742
|
+
"name": "FormAssociatedMixin",
|
|
7743
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7744
|
+
}
|
|
7613
7745
|
},
|
|
7614
7746
|
{
|
|
7615
7747
|
"kind": "method",
|
|
7616
|
-
"name": "
|
|
7617
|
-
|
|
7618
|
-
|
|
7619
|
-
|
|
7620
|
-
|
|
7621
|
-
|
|
7622
|
-
{
|
|
7623
|
-
"kind": "js",
|
|
7624
|
-
"name": "IconManager",
|
|
7625
|
-
"declaration": {
|
|
7626
|
-
"name": "IconManager",
|
|
7627
|
-
"module": "src/icon/IconManager.ts"
|
|
7628
|
-
}
|
|
7629
|
-
}
|
|
7630
|
-
]
|
|
7631
|
-
},
|
|
7632
|
-
{
|
|
7633
|
-
"kind": "javascript-module",
|
|
7634
|
-
"path": "src/input/Input.ts",
|
|
7635
|
-
"declarations": [
|
|
7636
|
-
{
|
|
7637
|
-
"kind": "class",
|
|
7638
|
-
"description": "Inputs are used to allow users to provide text input when the expected input is short.\nAs well as plain text, Input supports various types of text, including passwords and numbers.",
|
|
7639
|
-
"name": "Input",
|
|
7640
|
-
"cssProperties": [
|
|
7641
|
-
{
|
|
7642
|
-
"description": "Controls the inline size, or width, of the input.",
|
|
7643
|
-
"name": "--n-input-inline-size",
|
|
7644
|
-
"default": "240px"
|
|
7645
|
-
},
|
|
7646
|
-
{
|
|
7647
|
-
"description": "Controls the background of the input, using our [color tokens](/tokens/#color).",
|
|
7648
|
-
"name": "--n-input-background",
|
|
7649
|
-
"default": "var(--n-color-active)"
|
|
7650
|
-
},
|
|
7651
|
-
{
|
|
7652
|
-
"description": "Controls the text color of the input, using our [color tokens](/tokens/#color).",
|
|
7653
|
-
"name": "--n-input-color",
|
|
7654
|
-
"default": "var(--n-color-text)"
|
|
7655
|
-
},
|
|
7656
|
-
{
|
|
7657
|
-
"description": "Controls the border color of the input, using our [color tokens](/tokens/#color).",
|
|
7658
|
-
"name": "--n-input-border-color",
|
|
7659
|
-
"default": "var(--n-color-border-strong)"
|
|
7660
|
-
},
|
|
7661
|
-
{
|
|
7662
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
7663
|
-
"name": "--n-input-border-radius",
|
|
7664
|
-
"default": "var(--n-border-radius-s)"
|
|
7665
|
-
},
|
|
7666
|
-
{
|
|
7667
|
-
"description": "Controls the alignment of text within the input itself.",
|
|
7668
|
-
"name": "--n-input-text-align",
|
|
7669
|
-
"default": "start"
|
|
7748
|
+
"name": "renderError",
|
|
7749
|
+
"privacy": "protected",
|
|
7750
|
+
"inheritedFrom": {
|
|
7751
|
+
"name": "FormAssociatedMixin",
|
|
7752
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7753
|
+
}
|
|
7670
7754
|
},
|
|
7671
7755
|
{
|
|
7672
|
-
"
|
|
7673
|
-
"name": "
|
|
7674
|
-
"
|
|
7675
|
-
|
|
7676
|
-
|
|
7677
|
-
|
|
7678
|
-
|
|
7679
|
-
"description": "Use when a label requires more than plain text.",
|
|
7680
|
-
"name": "label"
|
|
7756
|
+
"kind": "method",
|
|
7757
|
+
"name": "getDescribedBy",
|
|
7758
|
+
"privacy": "protected",
|
|
7759
|
+
"inheritedFrom": {
|
|
7760
|
+
"name": "FormAssociatedMixin",
|
|
7761
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7762
|
+
}
|
|
7681
7763
|
},
|
|
7682
7764
|
{
|
|
7683
|
-
"
|
|
7684
|
-
"name": "
|
|
7765
|
+
"kind": "method",
|
|
7766
|
+
"name": "getInvalid",
|
|
7767
|
+
"privacy": "protected",
|
|
7768
|
+
"inheritedFrom": {
|
|
7769
|
+
"name": "FormAssociatedMixin",
|
|
7770
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7771
|
+
}
|
|
7685
7772
|
},
|
|
7686
7773
|
{
|
|
7687
|
-
"
|
|
7688
|
-
"name": "
|
|
7774
|
+
"kind": "field",
|
|
7775
|
+
"name": "hasHint",
|
|
7776
|
+
"privacy": "protected",
|
|
7777
|
+
"readonly": true,
|
|
7778
|
+
"inheritedFrom": {
|
|
7779
|
+
"name": "FormAssociatedMixin",
|
|
7780
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7781
|
+
}
|
|
7689
7782
|
},
|
|
7690
7783
|
{
|
|
7691
|
-
"
|
|
7692
|
-
"name": "
|
|
7784
|
+
"kind": "field",
|
|
7785
|
+
"name": "hasError",
|
|
7786
|
+
"privacy": "protected",
|
|
7787
|
+
"readonly": true,
|
|
7788
|
+
"inheritedFrom": {
|
|
7789
|
+
"name": "FormAssociatedMixin",
|
|
7790
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7791
|
+
}
|
|
7693
7792
|
},
|
|
7694
|
-
{
|
|
7695
|
-
"description": "Optional slot used to place an icon or suffix at the end of the input.",
|
|
7696
|
-
"name": "end"
|
|
7697
|
-
}
|
|
7698
|
-
],
|
|
7699
|
-
"members": [
|
|
7700
7793
|
{
|
|
7701
7794
|
"kind": "field",
|
|
7702
|
-
"name": "
|
|
7795
|
+
"name": "autocomplete",
|
|
7703
7796
|
"type": {
|
|
7704
|
-
"text": "
|
|
7797
|
+
"text": "AutocompleteAttribute"
|
|
7705
7798
|
},
|
|
7706
|
-
"
|
|
7799
|
+
"default": "\"off\"",
|
|
7800
|
+
"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.",
|
|
7801
|
+
"attribute": "autocomplete",
|
|
7802
|
+
"inheritedFrom": {
|
|
7803
|
+
"name": "AutocompleteMixin",
|
|
7804
|
+
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
7805
|
+
}
|
|
7707
7806
|
},
|
|
7708
7807
|
{
|
|
7709
7808
|
"kind": "field",
|
|
7710
|
-
"name": "
|
|
7809
|
+
"name": "readonly",
|
|
7711
7810
|
"type": {
|
|
7712
|
-
"text": "
|
|
7811
|
+
"text": "boolean"
|
|
7713
7812
|
},
|
|
7714
|
-
"
|
|
7813
|
+
"default": "false",
|
|
7814
|
+
"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.",
|
|
7815
|
+
"attribute": "readonly",
|
|
7816
|
+
"reflects": true,
|
|
7817
|
+
"inheritedFrom": {
|
|
7818
|
+
"name": "ReadonlyMixin",
|
|
7819
|
+
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
7820
|
+
}
|
|
7715
7821
|
},
|
|
7716
7822
|
{
|
|
7717
7823
|
"kind": "field",
|
|
7718
|
-
"name": "
|
|
7719
|
-
"privacy": "
|
|
7720
|
-
"
|
|
7721
|
-
|
|
7722
|
-
|
|
7723
|
-
|
|
7724
|
-
"name": "endObserver",
|
|
7725
|
-
"privacy": "private",
|
|
7726
|
-
"default": "new ResizeController(this, () => this.endSlot)"
|
|
7824
|
+
"name": "textSelectableRef",
|
|
7825
|
+
"privacy": "protected",
|
|
7826
|
+
"inheritedFrom": {
|
|
7827
|
+
"name": "TextSelectableMixin",
|
|
7828
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7829
|
+
}
|
|
7727
7830
|
},
|
|
7728
7831
|
{
|
|
7729
7832
|
"kind": "field",
|
|
7730
|
-
"name": "
|
|
7731
|
-
"
|
|
7732
|
-
"
|
|
7833
|
+
"name": "selectionStart",
|
|
7834
|
+
"description": "Gets or sets the starting position or offset of a text selection.\n\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/selectionStart)",
|
|
7835
|
+
"inheritedFrom": {
|
|
7836
|
+
"name": "TextSelectableMixin",
|
|
7837
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7838
|
+
}
|
|
7733
7839
|
},
|
|
7734
7840
|
{
|
|
7735
7841
|
"kind": "field",
|
|
7736
|
-
"name": "
|
|
7737
|
-
"
|
|
7738
|
-
|
|
7739
|
-
|
|
7740
|
-
|
|
7741
|
-
|
|
7742
|
-
"attribute": "type",
|
|
7743
|
-
"reflects": true
|
|
7842
|
+
"name": "selectionEnd",
|
|
7843
|
+
"description": "Gets or sets the end position or offset of a text selection.\n\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/selectionEnd)",
|
|
7844
|
+
"inheritedFrom": {
|
|
7845
|
+
"name": "TextSelectableMixin",
|
|
7846
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7847
|
+
}
|
|
7744
7848
|
},
|
|
7745
7849
|
{
|
|
7746
7850
|
"kind": "field",
|
|
7747
|
-
"name": "
|
|
7748
|
-
"
|
|
7749
|
-
|
|
7750
|
-
|
|
7751
|
-
|
|
7752
|
-
|
|
7753
|
-
"attribute": "expand",
|
|
7754
|
-
"reflects": true
|
|
7851
|
+
"name": "selectionDirection",
|
|
7852
|
+
"description": "Gets or sets the direction in which selection occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/selectionDirection)",
|
|
7853
|
+
"inheritedFrom": {
|
|
7854
|
+
"name": "TextSelectableMixin",
|
|
7855
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7856
|
+
}
|
|
7755
7857
|
},
|
|
7756
7858
|
{
|
|
7757
|
-
"kind": "
|
|
7758
|
-
"name": "
|
|
7759
|
-
"
|
|
7760
|
-
|
|
7761
|
-
|
|
7762
|
-
|
|
7763
|
-
|
|
7764
|
-
"attribute": "disallow-pattern",
|
|
7765
|
-
"reflects": true
|
|
7859
|
+
"kind": "method",
|
|
7860
|
+
"name": "select",
|
|
7861
|
+
"description": "Selects all the text in the text field.\n\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/select)",
|
|
7862
|
+
"inheritedFrom": {
|
|
7863
|
+
"name": "TextSelectableMixin",
|
|
7864
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7865
|
+
}
|
|
7766
7866
|
},
|
|
7767
7867
|
{
|
|
7768
7868
|
"kind": "method",
|
|
7769
|
-
"name": "
|
|
7770
|
-
"privacy": "private",
|
|
7869
|
+
"name": "setSelectionRange",
|
|
7771
7870
|
"parameters": [
|
|
7772
7871
|
{
|
|
7773
|
-
"name": "
|
|
7872
|
+
"name": "start",
|
|
7774
7873
|
"type": {
|
|
7775
|
-
"text": "
|
|
7776
|
-
}
|
|
7874
|
+
"text": "number | null"
|
|
7875
|
+
},
|
|
7876
|
+
"description": "The offset into the text field for the start of the selection."
|
|
7877
|
+
},
|
|
7878
|
+
{
|
|
7879
|
+
"name": "end",
|
|
7880
|
+
"type": {
|
|
7881
|
+
"text": "number | null"
|
|
7882
|
+
},
|
|
7883
|
+
"description": "The offset into the text field for the end of the selection."
|
|
7884
|
+
},
|
|
7885
|
+
{
|
|
7886
|
+
"name": "direction",
|
|
7887
|
+
"optional": true,
|
|
7888
|
+
"type": {
|
|
7889
|
+
"text": "\"forward\" | \"backward\" | \"none\""
|
|
7890
|
+
},
|
|
7891
|
+
"description": "The direction in which the selection is performed."
|
|
7777
7892
|
}
|
|
7778
|
-
]
|
|
7779
|
-
|
|
7780
|
-
|
|
7781
|
-
|
|
7782
|
-
|
|
7783
|
-
|
|
7893
|
+
],
|
|
7894
|
+
"description": "Sets the start and end positions of a selection in the text field.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/setSelectionRange)",
|
|
7895
|
+
"inheritedFrom": {
|
|
7896
|
+
"name": "TextSelectableMixin",
|
|
7897
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7898
|
+
}
|
|
7784
7899
|
},
|
|
7785
7900
|
{
|
|
7786
7901
|
"kind": "method",
|
|
7787
|
-
"name": "
|
|
7788
|
-
"privacy": "protected",
|
|
7902
|
+
"name": "setRangeText",
|
|
7789
7903
|
"parameters": [
|
|
7790
7904
|
{
|
|
7791
|
-
"name": "
|
|
7905
|
+
"name": "replacement",
|
|
7792
7906
|
"type": {
|
|
7793
|
-
"text": "
|
|
7794
|
-
}
|
|
7907
|
+
"text": "string"
|
|
7908
|
+
},
|
|
7909
|
+
"description": "The string to insert."
|
|
7910
|
+
},
|
|
7911
|
+
{
|
|
7912
|
+
"name": "start",
|
|
7913
|
+
"optional": true,
|
|
7914
|
+
"type": {
|
|
7915
|
+
"text": "number"
|
|
7916
|
+
},
|
|
7917
|
+
"description": "The 0-based index of the first character to replace. Defaults to the current `selectionStart` value (the start of the user's current selection)."
|
|
7918
|
+
},
|
|
7919
|
+
{
|
|
7920
|
+
"name": "end",
|
|
7921
|
+
"optional": true,
|
|
7922
|
+
"type": {
|
|
7923
|
+
"text": "number"
|
|
7924
|
+
},
|
|
7925
|
+
"description": "The 0-based index of the character after the last character to replace. Defaults to the current `selectionEnd` value (the end of the user's current selection)."
|
|
7926
|
+
},
|
|
7927
|
+
{
|
|
7928
|
+
"name": "selectMode",
|
|
7929
|
+
"default": "\"preserve\"",
|
|
7930
|
+
"type": {
|
|
7931
|
+
"text": "\"select\" | \"start\" | \"end\" | \"preserve\""
|
|
7932
|
+
},
|
|
7933
|
+
"description": "A string defining how the selection should be set after the text has been replaced."
|
|
7795
7934
|
}
|
|
7796
|
-
]
|
|
7797
|
-
|
|
7798
|
-
{
|
|
7799
|
-
"kind": "field",
|
|
7800
|
-
"name": "size",
|
|
7801
|
-
"type": {
|
|
7802
|
-
"text": "\"s\" | \"m\" | \"l\""
|
|
7803
|
-
},
|
|
7804
|
-
"default": "\"m\"",
|
|
7805
|
-
"description": "The size of the component.",
|
|
7806
|
-
"attribute": "size",
|
|
7807
|
-
"reflects": true,
|
|
7935
|
+
],
|
|
7936
|
+
"description": "Replaces a range of text with a new string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/setRangeText)",
|
|
7808
7937
|
"inheritedFrom": {
|
|
7809
|
-
"name": "
|
|
7810
|
-
"module": "src/common/mixins/
|
|
7938
|
+
"name": "TextSelectableMixin",
|
|
7939
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7811
7940
|
}
|
|
7812
7941
|
},
|
|
7813
7942
|
{
|
|
7814
|
-
"kind": "
|
|
7815
|
-
"name": "
|
|
7816
|
-
"
|
|
7817
|
-
"default": "new SlotController(this, \"label\")",
|
|
7943
|
+
"kind": "method",
|
|
7944
|
+
"name": "getNativeElement",
|
|
7945
|
+
"description": "Returns the native `<input>` or `<textarea>` element used under the hood.",
|
|
7818
7946
|
"inheritedFrom": {
|
|
7819
|
-
"name": "
|
|
7820
|
-
"module": "src/common/mixins/
|
|
7947
|
+
"name": "TextSelectableMixin",
|
|
7948
|
+
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
7821
7949
|
}
|
|
7822
7950
|
},
|
|
7823
7951
|
{
|
|
7824
7952
|
"kind": "field",
|
|
7825
|
-
"name": "
|
|
7826
|
-
"
|
|
7827
|
-
|
|
7953
|
+
"name": "disabled",
|
|
7954
|
+
"type": {
|
|
7955
|
+
"text": "boolean"
|
|
7956
|
+
},
|
|
7957
|
+
"default": "false",
|
|
7958
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
7959
|
+
"attribute": "disabled",
|
|
7960
|
+
"reflects": true,
|
|
7828
7961
|
"inheritedFrom": {
|
|
7829
|
-
"name": "
|
|
7830
|
-
"module": "src/common/mixins/
|
|
7962
|
+
"name": "InputMixin",
|
|
7963
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7831
7964
|
}
|
|
7832
7965
|
},
|
|
7833
7966
|
{
|
|
7834
7967
|
"kind": "field",
|
|
7835
|
-
"name": "
|
|
7836
|
-
"
|
|
7837
|
-
|
|
7968
|
+
"name": "name",
|
|
7969
|
+
"type": {
|
|
7970
|
+
"text": "string | undefined"
|
|
7971
|
+
},
|
|
7972
|
+
"description": "The name of the form component.",
|
|
7973
|
+
"attribute": "name",
|
|
7974
|
+
"reflects": true,
|
|
7838
7975
|
"inheritedFrom": {
|
|
7839
|
-
"name": "
|
|
7840
|
-
"module": "src/common/mixins/
|
|
7976
|
+
"name": "InputMixin",
|
|
7977
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7841
7978
|
}
|
|
7842
7979
|
},
|
|
7843
7980
|
{
|
|
7844
7981
|
"kind": "field",
|
|
7845
|
-
"name": "
|
|
7846
|
-
"
|
|
7847
|
-
|
|
7982
|
+
"name": "value",
|
|
7983
|
+
"type": {
|
|
7984
|
+
"text": "string"
|
|
7985
|
+
},
|
|
7986
|
+
"default": "\"\"",
|
|
7987
|
+
"description": "The value of the form component.",
|
|
7988
|
+
"attribute": "value",
|
|
7848
7989
|
"inheritedFrom": {
|
|
7849
|
-
"name": "
|
|
7850
|
-
"module": "src/common/mixins/
|
|
7990
|
+
"name": "InputMixin",
|
|
7991
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7851
7992
|
}
|
|
7852
7993
|
},
|
|
7853
7994
|
{
|
|
7854
7995
|
"kind": "field",
|
|
7855
|
-
"name": "
|
|
7856
|
-
"
|
|
7857
|
-
|
|
7996
|
+
"name": "formAncestor",
|
|
7997
|
+
"type": {
|
|
7998
|
+
"text": "HTMLFormElement | null"
|
|
7999
|
+
},
|
|
8000
|
+
"privacy": "private",
|
|
8001
|
+
"default": "null",
|
|
7858
8002
|
"inheritedFrom": {
|
|
7859
|
-
"name": "
|
|
7860
|
-
"module": "src/common/mixins/
|
|
8003
|
+
"name": "InputMixin",
|
|
8004
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7861
8005
|
}
|
|
7862
8006
|
},
|
|
7863
8007
|
{
|
|
7864
8008
|
"kind": "field",
|
|
7865
|
-
"name": "
|
|
8009
|
+
"name": "_formId",
|
|
7866
8010
|
"type": {
|
|
7867
|
-
"text": "string"
|
|
8011
|
+
"text": "string | undefined"
|
|
7868
8012
|
},
|
|
7869
8013
|
"privacy": "protected",
|
|
7870
|
-
"default": "\"input\"",
|
|
7871
8014
|
"inheritedFrom": {
|
|
7872
|
-
"name": "
|
|
7873
|
-
"module": "src/common/mixins/
|
|
8015
|
+
"name": "InputMixin",
|
|
8016
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7874
8017
|
}
|
|
7875
8018
|
},
|
|
7876
8019
|
{
|
|
7877
8020
|
"kind": "field",
|
|
7878
|
-
"name": "
|
|
8021
|
+
"name": "form",
|
|
7879
8022
|
"type": {
|
|
7880
|
-
"text": "
|
|
8023
|
+
"text": "HTMLFormElement | null"
|
|
7881
8024
|
},
|
|
7882
|
-
"
|
|
7883
|
-
"
|
|
8025
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
8026
|
+
"attribute": "form",
|
|
7884
8027
|
"inheritedFrom": {
|
|
7885
|
-
"name": "
|
|
7886
|
-
"module": "src/common/mixins/
|
|
8028
|
+
"name": "InputMixin",
|
|
8029
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7887
8030
|
}
|
|
7888
8031
|
},
|
|
7889
8032
|
{
|
|
7890
8033
|
"kind": "field",
|
|
7891
|
-
"name": "
|
|
7892
|
-
"type": {
|
|
7893
|
-
"text": "string"
|
|
7894
|
-
},
|
|
8034
|
+
"name": "focusableRef",
|
|
7895
8035
|
"privacy": "protected",
|
|
7896
|
-
"default": "\"hint\"",
|
|
7897
8036
|
"inheritedFrom": {
|
|
7898
|
-
"name": "
|
|
7899
|
-
"module": "src/common/mixins/
|
|
8037
|
+
"name": "FocusableMixin",
|
|
8038
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7900
8039
|
}
|
|
7901
8040
|
},
|
|
7902
8041
|
{
|
|
7903
|
-
"kind": "
|
|
7904
|
-
"name": "
|
|
7905
|
-
"
|
|
7906
|
-
|
|
7907
|
-
|
|
7908
|
-
|
|
7909
|
-
|
|
7910
|
-
|
|
7911
|
-
|
|
8042
|
+
"kind": "method",
|
|
8043
|
+
"name": "focus",
|
|
8044
|
+
"parameters": [
|
|
8045
|
+
{
|
|
8046
|
+
"name": "options",
|
|
8047
|
+
"optional": true,
|
|
8048
|
+
"type": {
|
|
8049
|
+
"text": "FocusOptions"
|
|
8050
|
+
},
|
|
8051
|
+
"description": "An object which controls aspects of the focusing process."
|
|
8052
|
+
}
|
|
8053
|
+
],
|
|
8054
|
+
"description": "Programmatically move focus to the component.",
|
|
7912
8055
|
"inheritedFrom": {
|
|
7913
|
-
"name": "
|
|
7914
|
-
"module": "src/common/mixins/
|
|
8056
|
+
"name": "FocusableMixin",
|
|
8057
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7915
8058
|
}
|
|
7916
8059
|
},
|
|
7917
8060
|
{
|
|
7918
|
-
"kind": "
|
|
7919
|
-
"name": "
|
|
7920
|
-
"
|
|
7921
|
-
"text": "string | undefined"
|
|
7922
|
-
},
|
|
7923
|
-
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
7924
|
-
"attribute": "hint",
|
|
7925
|
-
"reflects": true,
|
|
8061
|
+
"kind": "method",
|
|
8062
|
+
"name": "blur",
|
|
8063
|
+
"description": "Programmatically remove focus from the component.",
|
|
7926
8064
|
"inheritedFrom": {
|
|
7927
|
-
"name": "
|
|
7928
|
-
"module": "src/common/mixins/
|
|
8065
|
+
"name": "FocusableMixin",
|
|
8066
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7929
8067
|
}
|
|
7930
8068
|
},
|
|
7931
8069
|
{
|
|
7932
|
-
"kind": "
|
|
7933
|
-
"name": "
|
|
7934
|
-
"
|
|
7935
|
-
"text": "boolean"
|
|
7936
|
-
},
|
|
7937
|
-
"default": "false",
|
|
7938
|
-
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
7939
|
-
"attribute": "hide-label",
|
|
7940
|
-
"reflects": true,
|
|
8070
|
+
"kind": "method",
|
|
8071
|
+
"name": "click",
|
|
8072
|
+
"description": "Programmatically simulates a click on the component.",
|
|
7941
8073
|
"inheritedFrom": {
|
|
7942
|
-
"name": "
|
|
7943
|
-
"module": "src/common/mixins/
|
|
8074
|
+
"name": "FocusableMixin",
|
|
8075
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7944
8076
|
}
|
|
8077
|
+
}
|
|
8078
|
+
],
|
|
8079
|
+
"events": [
|
|
8080
|
+
{
|
|
8081
|
+
"name": "select",
|
|
8082
|
+
"type": {
|
|
8083
|
+
"text": "NordEvent"
|
|
8084
|
+
},
|
|
8085
|
+
"description": "Fired when some text has been selected."
|
|
7945
8086
|
},
|
|
7946
8087
|
{
|
|
7947
|
-
"
|
|
7948
|
-
"name": "placeholder",
|
|
8088
|
+
"name": "input",
|
|
7949
8089
|
"type": {
|
|
7950
|
-
"text": "
|
|
8090
|
+
"text": "NordEvent"
|
|
7951
8091
|
},
|
|
7952
|
-
"description": "
|
|
7953
|
-
"attribute": "placeholder",
|
|
7954
|
-
"reflects": true,
|
|
8092
|
+
"description": "Fired as the user types into the input.",
|
|
7955
8093
|
"inheritedFrom": {
|
|
7956
8094
|
"name": "FormAssociatedMixin",
|
|
7957
8095
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7958
8096
|
}
|
|
7959
8097
|
},
|
|
7960
8098
|
{
|
|
7961
|
-
"
|
|
7962
|
-
"name": "error",
|
|
8099
|
+
"name": "change",
|
|
7963
8100
|
"type": {
|
|
7964
|
-
"text": "
|
|
8101
|
+
"text": "NordEvent"
|
|
7965
8102
|
},
|
|
7966
|
-
"description": "
|
|
7967
|
-
"attribute": "error",
|
|
7968
|
-
"reflects": true,
|
|
8103
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
7969
8104
|
"inheritedFrom": {
|
|
7970
8105
|
"name": "FormAssociatedMixin",
|
|
7971
8106
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7972
8107
|
}
|
|
8108
|
+
}
|
|
8109
|
+
],
|
|
8110
|
+
"attributes": [
|
|
8111
|
+
{
|
|
8112
|
+
"name": "type",
|
|
8113
|
+
"type": {
|
|
8114
|
+
"text": "| \"text\"\n | \"email\"\n | \"password\"\n | \"tel\"\n | \"url\"\n | \"search\"\n | \"number\"\n | \"unit\"\n | \"button\""
|
|
8115
|
+
},
|
|
8116
|
+
"default": "\"text\"",
|
|
8117
|
+
"description": "The type of the input.",
|
|
8118
|
+
"fieldName": "type"
|
|
7973
8119
|
},
|
|
7974
8120
|
{
|
|
7975
|
-
"
|
|
7976
|
-
"name": "required",
|
|
8121
|
+
"name": "expand",
|
|
7977
8122
|
"type": {
|
|
7978
8123
|
"text": "boolean"
|
|
7979
8124
|
},
|
|
7980
8125
|
"default": "false",
|
|
7981
|
-
"description": "
|
|
7982
|
-
"
|
|
7983
|
-
"reflects": true,
|
|
7984
|
-
"inheritedFrom": {
|
|
7985
|
-
"name": "FormAssociatedMixin",
|
|
7986
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7987
|
-
}
|
|
8126
|
+
"description": "Controls whether the input expands to fill the width of its container.",
|
|
8127
|
+
"fieldName": "expand"
|
|
7988
8128
|
},
|
|
7989
8129
|
{
|
|
7990
|
-
"
|
|
7991
|
-
"name": "hideRequired",
|
|
8130
|
+
"name": "disallow-pattern",
|
|
7992
8131
|
"type": {
|
|
7993
|
-
"text": "
|
|
8132
|
+
"text": "string | undefined"
|
|
7994
8133
|
},
|
|
7995
|
-
"default": "
|
|
7996
|
-
"description": "
|
|
7997
|
-
"
|
|
7998
|
-
"reflects": true,
|
|
7999
|
-
"inheritedFrom": {
|
|
8000
|
-
"name": "FormAssociatedMixin",
|
|
8001
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8002
|
-
}
|
|
8134
|
+
"default": "undefined",
|
|
8135
|
+
"description": "Optionally disallow certain characters from being used inside the input, using a regex pattern.",
|
|
8136
|
+
"fieldName": "disallowPattern"
|
|
8003
8137
|
},
|
|
8004
8138
|
{
|
|
8005
|
-
"
|
|
8006
|
-
"
|
|
8007
|
-
|
|
8008
|
-
|
|
8009
|
-
|
|
8010
|
-
|
|
8011
|
-
|
|
8012
|
-
"text": "Event"
|
|
8013
|
-
}
|
|
8014
|
-
}
|
|
8015
|
-
],
|
|
8139
|
+
"name": "size",
|
|
8140
|
+
"type": {
|
|
8141
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
8142
|
+
},
|
|
8143
|
+
"default": "\"m\"",
|
|
8144
|
+
"description": "The size of the component.",
|
|
8145
|
+
"fieldName": "size",
|
|
8016
8146
|
"inheritedFrom": {
|
|
8017
|
-
"name": "
|
|
8018
|
-
"module": "src/common/mixins/
|
|
8147
|
+
"name": "SizeMixin",
|
|
8148
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
8019
8149
|
}
|
|
8020
8150
|
},
|
|
8021
8151
|
{
|
|
8022
|
-
"
|
|
8023
|
-
"
|
|
8024
|
-
|
|
8025
|
-
|
|
8026
|
-
|
|
8027
|
-
|
|
8028
|
-
|
|
8029
|
-
"text": "Event"
|
|
8030
|
-
}
|
|
8031
|
-
}
|
|
8032
|
-
],
|
|
8152
|
+
"name": "label",
|
|
8153
|
+
"type": {
|
|
8154
|
+
"text": "string"
|
|
8155
|
+
},
|
|
8156
|
+
"default": "\"\"",
|
|
8157
|
+
"description": "Label for the input.",
|
|
8158
|
+
"fieldName": "label",
|
|
8033
8159
|
"inheritedFrom": {
|
|
8034
8160
|
"name": "FormAssociatedMixin",
|
|
8035
8161
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8036
8162
|
}
|
|
8037
8163
|
},
|
|
8038
8164
|
{
|
|
8039
|
-
"
|
|
8040
|
-
"
|
|
8041
|
-
|
|
8042
|
-
|
|
8043
|
-
|
|
8044
|
-
|
|
8045
|
-
"optional": true,
|
|
8046
|
-
"type": {
|
|
8047
|
-
"text": "TemplateResult"
|
|
8048
|
-
}
|
|
8049
|
-
}
|
|
8050
|
-
],
|
|
8165
|
+
"name": "hint",
|
|
8166
|
+
"type": {
|
|
8167
|
+
"text": "string | undefined"
|
|
8168
|
+
},
|
|
8169
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
8170
|
+
"fieldName": "hint",
|
|
8051
8171
|
"inheritedFrom": {
|
|
8052
8172
|
"name": "FormAssociatedMixin",
|
|
8053
8173
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8054
8174
|
}
|
|
8055
8175
|
},
|
|
8056
8176
|
{
|
|
8057
|
-
"
|
|
8058
|
-
"
|
|
8059
|
-
|
|
8177
|
+
"name": "hide-label",
|
|
8178
|
+
"type": {
|
|
8179
|
+
"text": "boolean"
|
|
8180
|
+
},
|
|
8181
|
+
"default": "false",
|
|
8182
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
8183
|
+
"fieldName": "hideLabel",
|
|
8060
8184
|
"inheritedFrom": {
|
|
8061
8185
|
"name": "FormAssociatedMixin",
|
|
8062
8186
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8063
8187
|
}
|
|
8064
8188
|
},
|
|
8065
8189
|
{
|
|
8066
|
-
"
|
|
8067
|
-
"
|
|
8068
|
-
|
|
8190
|
+
"name": "placeholder",
|
|
8191
|
+
"type": {
|
|
8192
|
+
"text": "string | undefined"
|
|
8193
|
+
},
|
|
8194
|
+
"description": "Placeholder text to display within the input.",
|
|
8195
|
+
"fieldName": "placeholder",
|
|
8069
8196
|
"inheritedFrom": {
|
|
8070
8197
|
"name": "FormAssociatedMixin",
|
|
8071
8198
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8072
8199
|
}
|
|
8073
8200
|
},
|
|
8074
8201
|
{
|
|
8075
|
-
"
|
|
8076
|
-
"
|
|
8077
|
-
|
|
8202
|
+
"name": "error",
|
|
8203
|
+
"type": {
|
|
8204
|
+
"text": "string | undefined"
|
|
8205
|
+
},
|
|
8206
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
8207
|
+
"fieldName": "error",
|
|
8078
8208
|
"inheritedFrom": {
|
|
8079
8209
|
"name": "FormAssociatedMixin",
|
|
8080
8210
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8081
8211
|
}
|
|
8082
8212
|
},
|
|
8083
8213
|
{
|
|
8084
|
-
"
|
|
8085
|
-
"
|
|
8086
|
-
|
|
8087
|
-
|
|
8214
|
+
"name": "required",
|
|
8215
|
+
"type": {
|
|
8216
|
+
"text": "boolean"
|
|
8217
|
+
},
|
|
8218
|
+
"default": "false",
|
|
8219
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
8220
|
+
"fieldName": "required",
|
|
8088
8221
|
"inheritedFrom": {
|
|
8089
8222
|
"name": "FormAssociatedMixin",
|
|
8090
8223
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8091
8224
|
}
|
|
8092
8225
|
},
|
|
8093
8226
|
{
|
|
8094
|
-
"
|
|
8095
|
-
"
|
|
8096
|
-
|
|
8097
|
-
|
|
8227
|
+
"name": "hide-required",
|
|
8228
|
+
"type": {
|
|
8229
|
+
"text": "boolean"
|
|
8230
|
+
},
|
|
8231
|
+
"default": "false",
|
|
8232
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
8233
|
+
"fieldName": "hideRequired",
|
|
8098
8234
|
"inheritedFrom": {
|
|
8099
8235
|
"name": "FormAssociatedMixin",
|
|
8100
8236
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8101
8237
|
}
|
|
8102
8238
|
},
|
|
8103
8239
|
{
|
|
8104
|
-
"kind": "field",
|
|
8105
8240
|
"name": "autocomplete",
|
|
8106
8241
|
"type": {
|
|
8107
8242
|
"text": "AutocompleteAttribute"
|
|
8108
8243
|
},
|
|
8109
8244
|
"default": "\"off\"",
|
|
8110
8245
|
"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.",
|
|
8111
|
-
"
|
|
8246
|
+
"fieldName": "autocomplete",
|
|
8112
8247
|
"inheritedFrom": {
|
|
8113
8248
|
"name": "AutocompleteMixin",
|
|
8114
8249
|
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
8115
8250
|
}
|
|
8116
8251
|
},
|
|
8117
8252
|
{
|
|
8118
|
-
"kind": "field",
|
|
8119
8253
|
"name": "readonly",
|
|
8120
8254
|
"type": {
|
|
8121
8255
|
"text": "boolean"
|
|
8122
8256
|
},
|
|
8123
8257
|
"default": "false",
|
|
8124
8258
|
"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.",
|
|
8125
|
-
"
|
|
8126
|
-
"reflects": true,
|
|
8259
|
+
"fieldName": "readonly",
|
|
8127
8260
|
"inheritedFrom": {
|
|
8128
8261
|
"name": "ReadonlyMixin",
|
|
8129
8262
|
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
8130
8263
|
}
|
|
8131
8264
|
},
|
|
8132
8265
|
{
|
|
8133
|
-
"
|
|
8134
|
-
"
|
|
8135
|
-
|
|
8266
|
+
"name": "disabled",
|
|
8267
|
+
"type": {
|
|
8268
|
+
"text": "boolean"
|
|
8269
|
+
},
|
|
8270
|
+
"default": "false",
|
|
8271
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
8272
|
+
"fieldName": "disabled",
|
|
8136
8273
|
"inheritedFrom": {
|
|
8137
|
-
"name": "
|
|
8138
|
-
"module": "src/common/mixins/
|
|
8274
|
+
"name": "InputMixin",
|
|
8275
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
8139
8276
|
}
|
|
8140
8277
|
},
|
|
8141
8278
|
{
|
|
8142
|
-
"
|
|
8143
|
-
"
|
|
8144
|
-
|
|
8145
|
-
|
|
8146
|
-
|
|
8147
|
-
|
|
8279
|
+
"name": "name",
|
|
8280
|
+
"type": {
|
|
8281
|
+
"text": "string | undefined"
|
|
8282
|
+
},
|
|
8283
|
+
"description": "The name of the form component.",
|
|
8284
|
+
"fieldName": "name",
|
|
8285
|
+
"inheritedFrom": {
|
|
8286
|
+
"name": "InputMixin",
|
|
8287
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
8148
8288
|
}
|
|
8149
8289
|
},
|
|
8150
8290
|
{
|
|
8151
|
-
"
|
|
8152
|
-
"
|
|
8153
|
-
|
|
8291
|
+
"name": "value",
|
|
8292
|
+
"type": {
|
|
8293
|
+
"text": "string"
|
|
8294
|
+
},
|
|
8295
|
+
"default": "\"\"",
|
|
8296
|
+
"description": "The value of the form component.",
|
|
8297
|
+
"fieldName": "value",
|
|
8154
8298
|
"inheritedFrom": {
|
|
8155
|
-
"name": "
|
|
8156
|
-
"module": "src/common/mixins/
|
|
8299
|
+
"name": "InputMixin",
|
|
8300
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
8157
8301
|
}
|
|
8158
8302
|
},
|
|
8159
8303
|
{
|
|
8160
|
-
"
|
|
8161
|
-
"
|
|
8162
|
-
|
|
8304
|
+
"name": "form",
|
|
8305
|
+
"type": {
|
|
8306
|
+
"text": "HTMLFormElement | null"
|
|
8307
|
+
},
|
|
8308
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
8309
|
+
"fieldName": "form",
|
|
8163
8310
|
"inheritedFrom": {
|
|
8164
|
-
"name": "
|
|
8165
|
-
"module": "src/common/mixins/
|
|
8311
|
+
"name": "InputMixin",
|
|
8312
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
8166
8313
|
}
|
|
8314
|
+
}
|
|
8315
|
+
],
|
|
8316
|
+
"mixins": [
|
|
8317
|
+
{
|
|
8318
|
+
"name": "SizeMixin",
|
|
8319
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
8167
8320
|
},
|
|
8168
8321
|
{
|
|
8169
|
-
"
|
|
8170
|
-
"
|
|
8171
|
-
|
|
8172
|
-
|
|
8173
|
-
|
|
8174
|
-
|
|
8175
|
-
|
|
8322
|
+
"name": "FormAssociatedMixin",
|
|
8323
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
8324
|
+
},
|
|
8325
|
+
{
|
|
8326
|
+
"name": "AutocompleteMixin",
|
|
8327
|
+
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
8328
|
+
},
|
|
8329
|
+
{
|
|
8330
|
+
"name": "ReadonlyMixin",
|
|
8331
|
+
"module": "/src/common/mixins/ReadonlyMixin.js"
|
|
8332
|
+
},
|
|
8333
|
+
{
|
|
8334
|
+
"name": "TextSelectableMixin",
|
|
8335
|
+
"module": "/src/common/mixins/TextSelectableMixin.js"
|
|
8336
|
+
},
|
|
8337
|
+
{
|
|
8338
|
+
"name": "InputMixin",
|
|
8339
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
8340
|
+
},
|
|
8341
|
+
{
|
|
8342
|
+
"name": "FocusableMixin",
|
|
8343
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
8344
|
+
}
|
|
8345
|
+
],
|
|
8346
|
+
"superclass": {
|
|
8347
|
+
"name": "LitElement",
|
|
8348
|
+
"package": "lit"
|
|
8349
|
+
},
|
|
8350
|
+
"localization": [],
|
|
8351
|
+
"status": "ready",
|
|
8352
|
+
"category": "form",
|
|
8353
|
+
"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 provide a text input where the expected input is short.\n- Use to only ask for information that’s really needed. Hide optional fields by default if possible or have them shown with a lower priority.\n- Use help text and placeholder to provide additional, non-critical instructions.\n- Validate input as soon as users have finished interacting with them (but not before).\n- Where necessary, label the input as “Optional” when you need to request input that’s not required.\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 long. Use textarea component instead.\n- Don’t use the placeholder to provide information that’s required to use the input. Hint text should be used for this purpose instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nInput 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 input 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\">Company name</div>\n<div class=\"n-usage n-usage-dont\">Company Name</div>\n\nWhen an input isn’t part of a form and is placed individually on a page, you could provide the input 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 input label:\n\n<div class=\"n-usage n-usage-do\">First name</div>\n<div class=\"n-usage n-usage-dont\">First name:</div>\n\n---\n\n## Types\n\nThis section describes the different input types, their purpose, and when to use each type.\n\n| Name | Purpose |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `text` | The default and most common variant. Displayed as a single-line text field. Line-breaks are automatically removed from the input value. |\n| `email` | A field for editing an email address. Looks similar to a text input, but has validation parameters and relevant keyboard for devices with dynamic keyboards. |\n| `password` | A single-line text field where the value is obscured. This type will alert user if a site is not secure. |\n| `tel` | A field for entering a telephone number. Displays a number keypad on mobile devices. |\n| `url` | A field variant that is used to let the user enter and edit an URL. |\n| `search` | A single-line text field for entering search strings. |\n| `number` | Used to let the user enter a number. |\n\n---\n\n## Icon usage in input\n\nEach [input size](/components/input/?example=size) has a recommended icon size. The medium input uses the `s` icon size, the small input uses the `xs` icon size, and the large input uses the `m` icon size. The icon will adjust size automatically based on the button size, so you will get the correct behavior by default. However, this can be overridden by explicitly setting a size on the icon.\n\n---\n\n## Input masking\n\nWe recommend using [Maskito](https://maskito.dev/) for creating an [input mask](/components/input/?example=input+mask) which ensures that users type values according to a predefined format.\n",
|
|
8354
|
+
"examples": [],
|
|
8355
|
+
"dependencies": [
|
|
8356
|
+
"icon"
|
|
8357
|
+
],
|
|
8358
|
+
"tagName": "nord-input",
|
|
8359
|
+
"customElement": true
|
|
8360
|
+
}
|
|
8361
|
+
],
|
|
8362
|
+
"exports": [
|
|
8363
|
+
{
|
|
8364
|
+
"kind": "js",
|
|
8365
|
+
"name": "default",
|
|
8366
|
+
"declaration": {
|
|
8367
|
+
"name": "Input",
|
|
8368
|
+
"module": "src/input/Input.ts"
|
|
8369
|
+
}
|
|
8370
|
+
},
|
|
8371
|
+
{
|
|
8372
|
+
"kind": "custom-element-definition",
|
|
8373
|
+
"name": "nord-input",
|
|
8374
|
+
"declaration": {
|
|
8375
|
+
"name": "Input",
|
|
8376
|
+
"module": "src/input/Input.ts"
|
|
8377
|
+
}
|
|
8378
|
+
}
|
|
8379
|
+
]
|
|
8380
|
+
},
|
|
8381
|
+
{
|
|
8382
|
+
"kind": "javascript-module",
|
|
8383
|
+
"path": "src/icon/Icon.ts",
|
|
8384
|
+
"declarations": [
|
|
8385
|
+
{
|
|
8386
|
+
"kind": "class",
|
|
8387
|
+
"description": "Icons are used to provide additional meaning or in places where text label doesn’t fit.\nIcon component allows you to display an icon from the Nordicons library.",
|
|
8388
|
+
"name": "Icon",
|
|
8389
|
+
"slots": [
|
|
8390
|
+
{
|
|
8391
|
+
"description": "The default slot used for placing a custom SVG icon.",
|
|
8392
|
+
"name": ""
|
|
8393
|
+
}
|
|
8394
|
+
],
|
|
8395
|
+
"members": [
|
|
8396
|
+
{
|
|
8397
|
+
"kind": "field",
|
|
8398
|
+
"name": "manager",
|
|
8399
|
+
"privacy": "private",
|
|
8400
|
+
"static": true,
|
|
8401
|
+
"default": "new IconManager()"
|
|
8176
8402
|
},
|
|
8177
8403
|
{
|
|
8178
8404
|
"kind": "method",
|
|
8179
|
-
"name": "
|
|
8405
|
+
"name": "registerResolver",
|
|
8406
|
+
"static": true,
|
|
8180
8407
|
"parameters": [
|
|
8181
8408
|
{
|
|
8182
|
-
"name": "
|
|
8183
|
-
"type": {
|
|
8184
|
-
"text": "number | null"
|
|
8185
|
-
},
|
|
8186
|
-
"description": "The offset into the text field for the start of the selection."
|
|
8187
|
-
},
|
|
8188
|
-
{
|
|
8189
|
-
"name": "end",
|
|
8409
|
+
"name": "resolver",
|
|
8190
8410
|
"type": {
|
|
8191
|
-
"text": "
|
|
8411
|
+
"text": "IconResolver"
|
|
8192
8412
|
},
|
|
8193
|
-
"description": "The
|
|
8194
|
-
}
|
|
8413
|
+
"description": "The resolver function to register."
|
|
8414
|
+
}
|
|
8415
|
+
],
|
|
8416
|
+
"description": "Register a custom icon resolver, which accepts the icon name as an parameter, and returns an SVG string.\nCan return a string synchronously, or a promise of a string.\nBy default, will load icons from the Nord CDN."
|
|
8417
|
+
},
|
|
8418
|
+
{
|
|
8419
|
+
"kind": "method",
|
|
8420
|
+
"name": "registerIcon",
|
|
8421
|
+
"static": true,
|
|
8422
|
+
"return": {
|
|
8423
|
+
"type": {
|
|
8424
|
+
"text": "void"
|
|
8425
|
+
}
|
|
8426
|
+
},
|
|
8427
|
+
"parameters": [
|
|
8195
8428
|
{
|
|
8196
|
-
"name": "
|
|
8197
|
-
"optional": true,
|
|
8429
|
+
"name": "icon",
|
|
8198
8430
|
"type": {
|
|
8199
|
-
"text": "
|
|
8431
|
+
"text": "{ title: string; default: string }"
|
|
8200
8432
|
},
|
|
8201
|
-
"description": "
|
|
8433
|
+
"description": "An object representing the icon to be registered, where \"title\" is the icon's name, and \"default\" is the SVG string.\nThis is intended to be used in cases where you import an icon's entire ES module and register it directly."
|
|
8202
8434
|
}
|
|
8203
8435
|
],
|
|
8204
|
-
"description": "
|
|
8205
|
-
"inheritedFrom": {
|
|
8206
|
-
"name": "TextSelectableMixin",
|
|
8207
|
-
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
8208
|
-
}
|
|
8436
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
8209
8437
|
},
|
|
8210
8438
|
{
|
|
8211
8439
|
"kind": "method",
|
|
8212
|
-
"name": "
|
|
8440
|
+
"name": "registerIcon",
|
|
8441
|
+
"static": true,
|
|
8442
|
+
"return": {
|
|
8443
|
+
"type": {
|
|
8444
|
+
"text": "void"
|
|
8445
|
+
}
|
|
8446
|
+
},
|
|
8213
8447
|
"parameters": [
|
|
8214
8448
|
{
|
|
8215
|
-
"name": "
|
|
8449
|
+
"name": "name",
|
|
8216
8450
|
"type": {
|
|
8217
8451
|
"text": "string"
|
|
8218
8452
|
},
|
|
8219
|
-
"description": "The
|
|
8453
|
+
"description": "The name of the icon to be registered."
|
|
8220
8454
|
},
|
|
8221
8455
|
{
|
|
8222
|
-
"name": "
|
|
8223
|
-
"optional": true,
|
|
8456
|
+
"name": "icon",
|
|
8224
8457
|
"type": {
|
|
8225
|
-
"text": "
|
|
8458
|
+
"text": "string"
|
|
8226
8459
|
},
|
|
8227
|
-
"description": "The
|
|
8228
|
-
}
|
|
8460
|
+
"description": "The SVG string for the icon."
|
|
8461
|
+
}
|
|
8462
|
+
],
|
|
8463
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
8464
|
+
},
|
|
8465
|
+
{
|
|
8466
|
+
"kind": "method",
|
|
8467
|
+
"name": "registerIcon",
|
|
8468
|
+
"static": true,
|
|
8469
|
+
"parameters": [
|
|
8229
8470
|
{
|
|
8230
|
-
"name": "
|
|
8231
|
-
"optional": true,
|
|
8471
|
+
"name": "iconOrName",
|
|
8232
8472
|
"type": {
|
|
8233
|
-
"text": "
|
|
8473
|
+
"text": "string | { title: string; default: string }"
|
|
8234
8474
|
},
|
|
8235
|
-
"description": "The
|
|
8475
|
+
"description": "The name of the icon to be registered or an object representing the icon to be registered, where \"title\" is the icon's name, and \"default\" is the SVG string."
|
|
8236
8476
|
},
|
|
8237
8477
|
{
|
|
8238
|
-
"name": "
|
|
8239
|
-
"
|
|
8478
|
+
"name": "icon",
|
|
8479
|
+
"optional": true,
|
|
8240
8480
|
"type": {
|
|
8241
|
-
"text": "
|
|
8481
|
+
"text": "string"
|
|
8242
8482
|
},
|
|
8243
|
-
"description": "
|
|
8483
|
+
"description": "The SVG string for the icon."
|
|
8244
8484
|
}
|
|
8245
8485
|
],
|
|
8246
|
-
"description": "
|
|
8247
|
-
"inheritedFrom": {
|
|
8248
|
-
"name": "TextSelectableMixin",
|
|
8249
|
-
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
8250
|
-
}
|
|
8251
|
-
},
|
|
8252
|
-
{
|
|
8253
|
-
"kind": "method",
|
|
8254
|
-
"name": "getNativeElement",
|
|
8255
|
-
"description": "Returns the native `<input>` or `<textarea>` element used under the hood.",
|
|
8256
|
-
"inheritedFrom": {
|
|
8257
|
-
"name": "TextSelectableMixin",
|
|
8258
|
-
"module": "src/common/mixins/TextSelectableMixin.ts"
|
|
8259
|
-
}
|
|
8486
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
8260
8487
|
},
|
|
8261
8488
|
{
|
|
8262
8489
|
"kind": "field",
|
|
8263
|
-
"name": "
|
|
8490
|
+
"name": "name",
|
|
8264
8491
|
"type": {
|
|
8265
|
-
"text": "
|
|
8492
|
+
"text": "string"
|
|
8266
8493
|
},
|
|
8267
|
-
"default": "
|
|
8268
|
-
"description": "
|
|
8269
|
-
"attribute": "
|
|
8270
|
-
"reflects": true
|
|
8271
|
-
"inheritedFrom": {
|
|
8272
|
-
"name": "InputMixin",
|
|
8273
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8274
|
-
}
|
|
8494
|
+
"default": "\"\"",
|
|
8495
|
+
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
8496
|
+
"attribute": "name",
|
|
8497
|
+
"reflects": true
|
|
8275
8498
|
},
|
|
8276
8499
|
{
|
|
8277
8500
|
"kind": "field",
|
|
8278
|
-
"name": "
|
|
8501
|
+
"name": "size",
|
|
8279
8502
|
"type": {
|
|
8280
|
-
"text": "
|
|
8503
|
+
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
8281
8504
|
},
|
|
8282
|
-
"description": "The
|
|
8283
|
-
"
|
|
8284
|
-
"
|
|
8285
|
-
"
|
|
8286
|
-
"name": "InputMixin",
|
|
8287
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8288
|
-
}
|
|
8289
|
-
},
|
|
8290
|
-
{
|
|
8291
|
-
"kind": "field",
|
|
8292
|
-
"name": "value",
|
|
8293
|
-
"type": {
|
|
8294
|
-
"text": "string"
|
|
8295
|
-
},
|
|
8296
|
-
"default": "\"\"",
|
|
8297
|
-
"description": "The value of the form component.",
|
|
8298
|
-
"attribute": "value",
|
|
8299
|
-
"inheritedFrom": {
|
|
8300
|
-
"name": "InputMixin",
|
|
8301
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8302
|
-
}
|
|
8505
|
+
"description": "The size of the icon.",
|
|
8506
|
+
"default": "\"m\"",
|
|
8507
|
+
"attribute": "size",
|
|
8508
|
+
"reflects": true
|
|
8303
8509
|
},
|
|
8304
8510
|
{
|
|
8305
8511
|
"kind": "field",
|
|
8306
|
-
"name": "
|
|
8512
|
+
"name": "color",
|
|
8307
8513
|
"type": {
|
|
8308
|
-
"text": "
|
|
8514
|
+
"text": "string | undefined"
|
|
8309
8515
|
},
|
|
8310
|
-
"
|
|
8311
|
-
"
|
|
8312
|
-
"
|
|
8313
|
-
"name": "InputMixin",
|
|
8314
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8315
|
-
}
|
|
8516
|
+
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
8517
|
+
"attribute": "color",
|
|
8518
|
+
"reflects": true
|
|
8316
8519
|
},
|
|
8317
8520
|
{
|
|
8318
8521
|
"kind": "field",
|
|
8319
|
-
"name": "
|
|
8522
|
+
"name": "label",
|
|
8320
8523
|
"type": {
|
|
8321
8524
|
"text": "string | undefined"
|
|
8322
8525
|
},
|
|
8323
|
-
"
|
|
8324
|
-
"
|
|
8325
|
-
|
|
8326
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8327
|
-
}
|
|
8526
|
+
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
8527
|
+
"attribute": "label",
|
|
8528
|
+
"reflects": true
|
|
8328
8529
|
},
|
|
8329
8530
|
{
|
|
8330
8531
|
"kind": "field",
|
|
8331
|
-
"name": "
|
|
8532
|
+
"name": "svg",
|
|
8332
8533
|
"type": {
|
|
8333
|
-
"text": "
|
|
8534
|
+
"text": "string"
|
|
8334
8535
|
},
|
|
8335
|
-
"
|
|
8336
|
-
"
|
|
8337
|
-
"inheritedFrom": {
|
|
8338
|
-
"name": "InputMixin",
|
|
8339
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8340
|
-
}
|
|
8341
|
-
},
|
|
8342
|
-
{
|
|
8343
|
-
"kind": "field",
|
|
8344
|
-
"name": "focusableRef",
|
|
8345
|
-
"privacy": "protected",
|
|
8346
|
-
"inheritedFrom": {
|
|
8347
|
-
"name": "FocusableMixin",
|
|
8348
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8349
|
-
}
|
|
8350
|
-
},
|
|
8351
|
-
{
|
|
8352
|
-
"kind": "method",
|
|
8353
|
-
"name": "focus",
|
|
8354
|
-
"parameters": [
|
|
8355
|
-
{
|
|
8356
|
-
"name": "options",
|
|
8357
|
-
"optional": true,
|
|
8358
|
-
"type": {
|
|
8359
|
-
"text": "FocusOptions"
|
|
8360
|
-
},
|
|
8361
|
-
"description": "An object which controls aspects of the focusing process."
|
|
8362
|
-
}
|
|
8363
|
-
],
|
|
8364
|
-
"description": "Programmatically move focus to the component.",
|
|
8365
|
-
"inheritedFrom": {
|
|
8366
|
-
"name": "FocusableMixin",
|
|
8367
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8368
|
-
}
|
|
8369
|
-
},
|
|
8370
|
-
{
|
|
8371
|
-
"kind": "method",
|
|
8372
|
-
"name": "blur",
|
|
8373
|
-
"description": "Programmatically remove focus from the component.",
|
|
8374
|
-
"inheritedFrom": {
|
|
8375
|
-
"name": "FocusableMixin",
|
|
8376
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8377
|
-
}
|
|
8536
|
+
"privacy": "private",
|
|
8537
|
+
"default": "\"\""
|
|
8378
8538
|
},
|
|
8379
8539
|
{
|
|
8380
8540
|
"kind": "method",
|
|
8381
|
-
"name": "
|
|
8382
|
-
"
|
|
8383
|
-
"inheritedFrom": {
|
|
8384
|
-
"name": "FocusableMixin",
|
|
8385
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8386
|
-
}
|
|
8387
|
-
}
|
|
8388
|
-
],
|
|
8389
|
-
"events": [
|
|
8390
|
-
{
|
|
8391
|
-
"name": "select",
|
|
8392
|
-
"type": {
|
|
8393
|
-
"text": "NordEvent"
|
|
8394
|
-
},
|
|
8395
|
-
"description": "Fired when some text has been selected."
|
|
8396
|
-
},
|
|
8397
|
-
{
|
|
8398
|
-
"name": "input",
|
|
8399
|
-
"type": {
|
|
8400
|
-
"text": "NordEvent"
|
|
8401
|
-
},
|
|
8402
|
-
"description": "Fired as the user types into the input.",
|
|
8403
|
-
"inheritedFrom": {
|
|
8404
|
-
"name": "FormAssociatedMixin",
|
|
8405
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8406
|
-
}
|
|
8407
|
-
},
|
|
8408
|
-
{
|
|
8409
|
-
"name": "change",
|
|
8410
|
-
"type": {
|
|
8411
|
-
"text": "NordEvent"
|
|
8412
|
-
},
|
|
8413
|
-
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
8414
|
-
"inheritedFrom": {
|
|
8415
|
-
"name": "FormAssociatedMixin",
|
|
8416
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8417
|
-
}
|
|
8541
|
+
"name": "handleNameChange",
|
|
8542
|
+
"privacy": "protected"
|
|
8418
8543
|
}
|
|
8419
8544
|
],
|
|
8420
8545
|
"attributes": [
|
|
8421
8546
|
{
|
|
8422
|
-
"name": "
|
|
8423
|
-
"type": {
|
|
8424
|
-
"text": "| \"text\"\n | \"email\"\n | \"password\"\n | \"tel\"\n | \"url\"\n | \"search\"\n | \"number\"\n | \"unit\"\n | \"button\""
|
|
8425
|
-
},
|
|
8426
|
-
"default": "\"text\"",
|
|
8427
|
-
"description": "The type of the input.",
|
|
8428
|
-
"fieldName": "type"
|
|
8429
|
-
},
|
|
8430
|
-
{
|
|
8431
|
-
"name": "expand",
|
|
8432
|
-
"type": {
|
|
8433
|
-
"text": "boolean"
|
|
8434
|
-
},
|
|
8435
|
-
"default": "false",
|
|
8436
|
-
"description": "Controls whether the input expands to fill the width of its container.",
|
|
8437
|
-
"fieldName": "expand"
|
|
8438
|
-
},
|
|
8439
|
-
{
|
|
8440
|
-
"name": "disallow-pattern",
|
|
8441
|
-
"type": {
|
|
8442
|
-
"text": "string | undefined"
|
|
8443
|
-
},
|
|
8444
|
-
"default": "undefined",
|
|
8445
|
-
"description": "Optionally disallow certain characters from being used inside the input, using a regex pattern.",
|
|
8446
|
-
"fieldName": "disallowPattern"
|
|
8447
|
-
},
|
|
8448
|
-
{
|
|
8449
|
-
"name": "size",
|
|
8450
|
-
"type": {
|
|
8451
|
-
"text": "\"s\" | \"m\" | \"l\""
|
|
8452
|
-
},
|
|
8453
|
-
"default": "\"m\"",
|
|
8454
|
-
"description": "The size of the component.",
|
|
8455
|
-
"fieldName": "size",
|
|
8456
|
-
"inheritedFrom": {
|
|
8457
|
-
"name": "SizeMixin",
|
|
8458
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
8459
|
-
}
|
|
8460
|
-
},
|
|
8461
|
-
{
|
|
8462
|
-
"name": "label",
|
|
8547
|
+
"name": "name",
|
|
8463
8548
|
"type": {
|
|
8464
8549
|
"text": "string"
|
|
8465
8550
|
},
|
|
8466
8551
|
"default": "\"\"",
|
|
8467
|
-
"description": "
|
|
8468
|
-
"fieldName": "
|
|
8469
|
-
"inheritedFrom": {
|
|
8470
|
-
"name": "FormAssociatedMixin",
|
|
8471
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8472
|
-
}
|
|
8473
|
-
},
|
|
8474
|
-
{
|
|
8475
|
-
"name": "hint",
|
|
8476
|
-
"type": {
|
|
8477
|
-
"text": "string | undefined"
|
|
8478
|
-
},
|
|
8479
|
-
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
8480
|
-
"fieldName": "hint",
|
|
8481
|
-
"inheritedFrom": {
|
|
8482
|
-
"name": "FormAssociatedMixin",
|
|
8483
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8484
|
-
}
|
|
8485
|
-
},
|
|
8486
|
-
{
|
|
8487
|
-
"name": "hide-label",
|
|
8488
|
-
"type": {
|
|
8489
|
-
"text": "boolean"
|
|
8490
|
-
},
|
|
8491
|
-
"default": "false",
|
|
8492
|
-
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
8493
|
-
"fieldName": "hideLabel",
|
|
8494
|
-
"inheritedFrom": {
|
|
8495
|
-
"name": "FormAssociatedMixin",
|
|
8496
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8497
|
-
}
|
|
8552
|
+
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
8553
|
+
"fieldName": "name"
|
|
8498
8554
|
},
|
|
8499
8555
|
{
|
|
8500
|
-
"name": "
|
|
8556
|
+
"name": "size",
|
|
8501
8557
|
"type": {
|
|
8502
|
-
"text": "
|
|
8558
|
+
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
8503
8559
|
},
|
|
8504
|
-
"description": "
|
|
8505
|
-
"
|
|
8506
|
-
"
|
|
8507
|
-
"name": "FormAssociatedMixin",
|
|
8508
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8509
|
-
}
|
|
8560
|
+
"description": "The size of the icon.",
|
|
8561
|
+
"default": "\"m\"",
|
|
8562
|
+
"fieldName": "size"
|
|
8510
8563
|
},
|
|
8511
8564
|
{
|
|
8512
|
-
"name": "
|
|
8565
|
+
"name": "color",
|
|
8513
8566
|
"type": {
|
|
8514
8567
|
"text": "string | undefined"
|
|
8515
8568
|
},
|
|
8516
|
-
"description": "
|
|
8517
|
-
"fieldName": "
|
|
8518
|
-
"inheritedFrom": {
|
|
8519
|
-
"name": "FormAssociatedMixin",
|
|
8520
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8521
|
-
}
|
|
8522
|
-
},
|
|
8523
|
-
{
|
|
8524
|
-
"name": "required",
|
|
8525
|
-
"type": {
|
|
8526
|
-
"text": "boolean"
|
|
8527
|
-
},
|
|
8528
|
-
"default": "false",
|
|
8529
|
-
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
8530
|
-
"fieldName": "required",
|
|
8531
|
-
"inheritedFrom": {
|
|
8532
|
-
"name": "FormAssociatedMixin",
|
|
8533
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8534
|
-
}
|
|
8535
|
-
},
|
|
8536
|
-
{
|
|
8537
|
-
"name": "hide-required",
|
|
8538
|
-
"type": {
|
|
8539
|
-
"text": "boolean"
|
|
8540
|
-
},
|
|
8541
|
-
"default": "false",
|
|
8542
|
-
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
8543
|
-
"fieldName": "hideRequired",
|
|
8544
|
-
"inheritedFrom": {
|
|
8545
|
-
"name": "FormAssociatedMixin",
|
|
8546
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8547
|
-
}
|
|
8548
|
-
},
|
|
8549
|
-
{
|
|
8550
|
-
"name": "autocomplete",
|
|
8551
|
-
"type": {
|
|
8552
|
-
"text": "AutocompleteAttribute"
|
|
8553
|
-
},
|
|
8554
|
-
"default": "\"off\"",
|
|
8555
|
-
"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.",
|
|
8556
|
-
"fieldName": "autocomplete",
|
|
8557
|
-
"inheritedFrom": {
|
|
8558
|
-
"name": "AutocompleteMixin",
|
|
8559
|
-
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
8560
|
-
}
|
|
8561
|
-
},
|
|
8562
|
-
{
|
|
8563
|
-
"name": "readonly",
|
|
8564
|
-
"type": {
|
|
8565
|
-
"text": "boolean"
|
|
8566
|
-
},
|
|
8567
|
-
"default": "false",
|
|
8568
|
-
"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.",
|
|
8569
|
-
"fieldName": "readonly",
|
|
8570
|
-
"inheritedFrom": {
|
|
8571
|
-
"name": "ReadonlyMixin",
|
|
8572
|
-
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
8573
|
-
}
|
|
8574
|
-
},
|
|
8575
|
-
{
|
|
8576
|
-
"name": "disabled",
|
|
8577
|
-
"type": {
|
|
8578
|
-
"text": "boolean"
|
|
8579
|
-
},
|
|
8580
|
-
"default": "false",
|
|
8581
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
8582
|
-
"fieldName": "disabled",
|
|
8583
|
-
"inheritedFrom": {
|
|
8584
|
-
"name": "InputMixin",
|
|
8585
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8586
|
-
}
|
|
8569
|
+
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
8570
|
+
"fieldName": "color"
|
|
8587
8571
|
},
|
|
8588
8572
|
{
|
|
8589
|
-
"name": "
|
|
8573
|
+
"name": "label",
|
|
8590
8574
|
"type": {
|
|
8591
8575
|
"text": "string | undefined"
|
|
8592
8576
|
},
|
|
8593
|
-
"description": "
|
|
8594
|
-
"fieldName": "
|
|
8595
|
-
"inheritedFrom": {
|
|
8596
|
-
"name": "InputMixin",
|
|
8597
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8598
|
-
}
|
|
8599
|
-
},
|
|
8600
|
-
{
|
|
8601
|
-
"name": "value",
|
|
8602
|
-
"type": {
|
|
8603
|
-
"text": "string"
|
|
8604
|
-
},
|
|
8605
|
-
"default": "\"\"",
|
|
8606
|
-
"description": "The value of the form component.",
|
|
8607
|
-
"fieldName": "value",
|
|
8608
|
-
"inheritedFrom": {
|
|
8609
|
-
"name": "InputMixin",
|
|
8610
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8611
|
-
}
|
|
8612
|
-
},
|
|
8613
|
-
{
|
|
8614
|
-
"name": "form",
|
|
8615
|
-
"type": {
|
|
8616
|
-
"text": "HTMLFormElement | null"
|
|
8617
|
-
},
|
|
8618
|
-
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
8619
|
-
"fieldName": "form",
|
|
8620
|
-
"inheritedFrom": {
|
|
8621
|
-
"name": "InputMixin",
|
|
8622
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8623
|
-
}
|
|
8577
|
+
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
8578
|
+
"fieldName": "label"
|
|
8624
8579
|
}
|
|
8625
8580
|
],
|
|
8626
|
-
"
|
|
8627
|
-
|
|
8628
|
-
|
|
8629
|
-
|
|
8630
|
-
|
|
8631
|
-
|
|
8632
|
-
|
|
8633
|
-
|
|
8634
|
-
|
|
8581
|
+
"superclass": {
|
|
8582
|
+
"name": "LitElement",
|
|
8583
|
+
"package": "lit"
|
|
8584
|
+
},
|
|
8585
|
+
"localization": [],
|
|
8586
|
+
"status": "ready",
|
|
8587
|
+
"category": "image",
|
|
8588
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<nord-button href=\"/nordicons/\" variant=\"primary\">View Nordicons</nord-button>\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to provide additional meaning in addition to a text label.\n- Use to help users who have difficulties with reading and attention.\n- Use in places where text label doesn’t fit (remember to add an accessible label for the icon).\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for decorative purposes alone.\n- Don’t use when a button’s action is already clear based on the text label.\n- Don’t use the same icon for differing purposes, as users will come to associate icons with specific types of actions.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Icon components are hidden from assistive technologies by default.\n- Use `label` property to give an accessible label for the icon and to make it visible to assistive technologies.\n",
|
|
8589
|
+
"examples": [],
|
|
8590
|
+
"dependencies": [],
|
|
8591
|
+
"tagName": "nord-icon",
|
|
8592
|
+
"customElement": true
|
|
8593
|
+
}
|
|
8594
|
+
],
|
|
8595
|
+
"exports": [
|
|
8596
|
+
{
|
|
8597
|
+
"kind": "js",
|
|
8598
|
+
"name": "default",
|
|
8599
|
+
"declaration": {
|
|
8600
|
+
"name": "Icon",
|
|
8601
|
+
"module": "src/icon/Icon.ts"
|
|
8602
|
+
}
|
|
8603
|
+
},
|
|
8604
|
+
{
|
|
8605
|
+
"kind": "custom-element-definition",
|
|
8606
|
+
"name": "nord-icon",
|
|
8607
|
+
"declaration": {
|
|
8608
|
+
"name": "Icon",
|
|
8609
|
+
"module": "src/icon/Icon.ts"
|
|
8610
|
+
}
|
|
8611
|
+
}
|
|
8612
|
+
]
|
|
8613
|
+
},
|
|
8614
|
+
{
|
|
8615
|
+
"kind": "javascript-module",
|
|
8616
|
+
"path": "src/icon/IconManager.ts",
|
|
8617
|
+
"declarations": [
|
|
8618
|
+
{
|
|
8619
|
+
"kind": "class",
|
|
8620
|
+
"description": "",
|
|
8621
|
+
"name": "IconManager",
|
|
8622
|
+
"members": [
|
|
8635
8623
|
{
|
|
8636
|
-
"
|
|
8637
|
-
"
|
|
8624
|
+
"kind": "field",
|
|
8625
|
+
"name": "cache",
|
|
8626
|
+
"privacy": "private",
|
|
8627
|
+
"default": "new Map<string, string | Promise<string>>()"
|
|
8638
8628
|
},
|
|
8639
8629
|
{
|
|
8640
|
-
"
|
|
8641
|
-
"
|
|
8630
|
+
"kind": "field",
|
|
8631
|
+
"name": "resolver",
|
|
8632
|
+
"type": {
|
|
8633
|
+
"text": "IconResolver"
|
|
8634
|
+
}
|
|
8642
8635
|
},
|
|
8643
8636
|
{
|
|
8644
|
-
"
|
|
8645
|
-
"
|
|
8637
|
+
"kind": "method",
|
|
8638
|
+
"name": "resolve",
|
|
8639
|
+
"parameters": [
|
|
8640
|
+
{
|
|
8641
|
+
"name": "name",
|
|
8642
|
+
"type": {
|
|
8643
|
+
"text": "string"
|
|
8644
|
+
}
|
|
8645
|
+
},
|
|
8646
|
+
{
|
|
8647
|
+
"name": "onResolved",
|
|
8648
|
+
"type": {
|
|
8649
|
+
"text": "(svg: string) => void"
|
|
8650
|
+
}
|
|
8651
|
+
}
|
|
8652
|
+
]
|
|
8646
8653
|
},
|
|
8647
8654
|
{
|
|
8648
|
-
"
|
|
8649
|
-
"
|
|
8655
|
+
"kind": "method",
|
|
8656
|
+
"name": "registerIcon",
|
|
8657
|
+
"parameters": [
|
|
8658
|
+
{
|
|
8659
|
+
"name": "iconOrName",
|
|
8660
|
+
"type": {
|
|
8661
|
+
"text": "string | { title: string; default: string }"
|
|
8662
|
+
}
|
|
8663
|
+
},
|
|
8664
|
+
{
|
|
8665
|
+
"name": "icon",
|
|
8666
|
+
"optional": true,
|
|
8667
|
+
"type": {
|
|
8668
|
+
"text": "string"
|
|
8669
|
+
}
|
|
8670
|
+
}
|
|
8671
|
+
]
|
|
8650
8672
|
},
|
|
8651
8673
|
{
|
|
8652
|
-
"
|
|
8653
|
-
"
|
|
8674
|
+
"kind": "method",
|
|
8675
|
+
"name": "clear"
|
|
8654
8676
|
}
|
|
8655
|
-
]
|
|
8656
|
-
"superclass": {
|
|
8657
|
-
"name": "LitElement",
|
|
8658
|
-
"package": "lit"
|
|
8659
|
-
},
|
|
8660
|
-
"localization": [],
|
|
8661
|
-
"status": "ready",
|
|
8662
|
-
"category": "form",
|
|
8663
|
-
"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 provide a text input where the expected input is short.\n- Use to only ask for information that’s really needed. Hide optional fields by default if possible or have them shown with a lower priority.\n- Use help text and placeholder to provide additional, non-critical instructions.\n- Validate input as soon as users have finished interacting with them (but not before).\n- Where necessary, label the input as “Optional” when you need to request input that’s not required.\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 long. Use textarea component instead.\n- Don’t use the placeholder to provide information that’s required to use the input. Hint text should be used for this purpose instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nInput 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 input 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\">Company name</div>\n<div class=\"n-usage n-usage-dont\">Company Name</div>\n\nWhen an input isn’t part of a form and is placed individually on a page, you could provide the input 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 input label:\n\n<div class=\"n-usage n-usage-do\">First name</div>\n<div class=\"n-usage n-usage-dont\">First name:</div>\n\n---\n\n## Types\n\nThis section describes the different input types, their purpose, and when to use each type.\n\n| Name | Purpose |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `text` | The default and most common variant. Displayed as a single-line text field. Line-breaks are automatically removed from the input value. |\n| `email` | A field for editing an email address. Looks similar to a text input, but has validation parameters and relevant keyboard for devices with dynamic keyboards. |\n| `password` | A single-line text field where the value is obscured. This type will alert user if a site is not secure. |\n| `tel` | A field for entering a telephone number. Displays a number keypad on mobile devices. |\n| `url` | A field variant that is used to let the user enter and edit an URL. |\n| `search` | A single-line text field for entering search strings. |\n| `number` | Used to let the user enter a number. |\n\n---\n\n## Icon usage in input\n\nEach [input size](/components/input/?example=size) has a recommended icon size. The medium input uses the `s` icon size, the small input uses the `xs` icon size, and the large input uses the `m` icon size. The icon will adjust size automatically based on the button size, so you will get the correct behavior by default. However, this can be overridden by explicitly setting a size on the icon.\n\n---\n\n## Input masking\n\nWe recommend using [Maskito](https://maskito.dev/) for creating an [input mask](/components/input/?example=input+mask) which ensures that users type values according to a predefined format.\n",
|
|
8664
|
-
"examples": [],
|
|
8665
|
-
"dependencies": [
|
|
8666
|
-
"icon"
|
|
8667
|
-
],
|
|
8668
|
-
"tagName": "nord-input",
|
|
8669
|
-
"customElement": true
|
|
8677
|
+
]
|
|
8670
8678
|
}
|
|
8671
8679
|
],
|
|
8672
8680
|
"exports": [
|
|
8673
8681
|
{
|
|
8674
8682
|
"kind": "js",
|
|
8675
|
-
"name": "
|
|
8676
|
-
"declaration": {
|
|
8677
|
-
"name": "Input",
|
|
8678
|
-
"module": "src/input/Input.ts"
|
|
8679
|
-
}
|
|
8680
|
-
},
|
|
8681
|
-
{
|
|
8682
|
-
"kind": "custom-element-definition",
|
|
8683
|
-
"name": "nord-input",
|
|
8683
|
+
"name": "IconManager",
|
|
8684
8684
|
"declaration": {
|
|
8685
|
-
"name": "
|
|
8686
|
-
"module": "src/
|
|
8685
|
+
"name": "IconManager",
|
|
8686
|
+
"module": "src/icon/IconManager.ts"
|
|
8687
8687
|
}
|
|
8688
8688
|
}
|
|
8689
8689
|
]
|
|
@@ -10732,6 +10732,63 @@
|
|
|
10732
10732
|
}
|
|
10733
10733
|
]
|
|
10734
10734
|
},
|
|
10735
|
+
{
|
|
10736
|
+
"kind": "javascript-module",
|
|
10737
|
+
"path": "src/notification-group/NotificationGroup.ts",
|
|
10738
|
+
"declarations": [
|
|
10739
|
+
{
|
|
10740
|
+
"kind": "class",
|
|
10741
|
+
"description": "Notification group is used to position and style a group of notifications.",
|
|
10742
|
+
"name": "NotificationGroup",
|
|
10743
|
+
"slots": [
|
|
10744
|
+
{
|
|
10745
|
+
"description": "Default slot in which to place notifications.",
|
|
10746
|
+
"name": ""
|
|
10747
|
+
}
|
|
10748
|
+
],
|
|
10749
|
+
"members": [],
|
|
10750
|
+
"events": [
|
|
10751
|
+
{
|
|
10752
|
+
"type": {
|
|
10753
|
+
"text": "NordEvent"
|
|
10754
|
+
},
|
|
10755
|
+
"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.",
|
|
10756
|
+
"name": "dismiss"
|
|
10757
|
+
}
|
|
10758
|
+
],
|
|
10759
|
+
"superclass": {
|
|
10760
|
+
"name": "LitElement",
|
|
10761
|
+
"package": "lit"
|
|
10762
|
+
},
|
|
10763
|
+
"localization": [],
|
|
10764
|
+
"status": "ready",
|
|
10765
|
+
"category": "feedback",
|
|
10766
|
+
"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",
|
|
10767
|
+
"examples": [],
|
|
10768
|
+
"dependencies": [],
|
|
10769
|
+
"tagName": "nord-notification-group",
|
|
10770
|
+
"customElement": true
|
|
10771
|
+
}
|
|
10772
|
+
],
|
|
10773
|
+
"exports": [
|
|
10774
|
+
{
|
|
10775
|
+
"kind": "js",
|
|
10776
|
+
"name": "default",
|
|
10777
|
+
"declaration": {
|
|
10778
|
+
"name": "NotificationGroup",
|
|
10779
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10780
|
+
}
|
|
10781
|
+
},
|
|
10782
|
+
{
|
|
10783
|
+
"kind": "custom-element-definition",
|
|
10784
|
+
"name": "nord-notification-group",
|
|
10785
|
+
"declaration": {
|
|
10786
|
+
"name": "NotificationGroup",
|
|
10787
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10788
|
+
}
|
|
10789
|
+
}
|
|
10790
|
+
]
|
|
10791
|
+
},
|
|
10735
10792
|
{
|
|
10736
10793
|
"kind": "javascript-module",
|
|
10737
10794
|
"path": "src/notification/Notification.ts",
|
|
@@ -10873,63 +10930,6 @@
|
|
|
10873
10930
|
}
|
|
10874
10931
|
]
|
|
10875
10932
|
},
|
|
10876
|
-
{
|
|
10877
|
-
"kind": "javascript-module",
|
|
10878
|
-
"path": "src/notification-group/NotificationGroup.ts",
|
|
10879
|
-
"declarations": [
|
|
10880
|
-
{
|
|
10881
|
-
"kind": "class",
|
|
10882
|
-
"description": "Notification group is used to position and style a group of notifications.",
|
|
10883
|
-
"name": "NotificationGroup",
|
|
10884
|
-
"slots": [
|
|
10885
|
-
{
|
|
10886
|
-
"description": "Default slot in which to place notifications.",
|
|
10887
|
-
"name": ""
|
|
10888
|
-
}
|
|
10889
|
-
],
|
|
10890
|
-
"members": [],
|
|
10891
|
-
"events": [
|
|
10892
|
-
{
|
|
10893
|
-
"type": {
|
|
10894
|
-
"text": "NordEvent"
|
|
10895
|
-
},
|
|
10896
|
-
"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.",
|
|
10897
|
-
"name": "dismiss"
|
|
10898
|
-
}
|
|
10899
|
-
],
|
|
10900
|
-
"superclass": {
|
|
10901
|
-
"name": "LitElement",
|
|
10902
|
-
"package": "lit"
|
|
10903
|
-
},
|
|
10904
|
-
"localization": [],
|
|
10905
|
-
"status": "ready",
|
|
10906
|
-
"category": "feedback",
|
|
10907
|
-
"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",
|
|
10908
|
-
"examples": [],
|
|
10909
|
-
"dependencies": [],
|
|
10910
|
-
"tagName": "nord-notification-group",
|
|
10911
|
-
"customElement": true
|
|
10912
|
-
}
|
|
10913
|
-
],
|
|
10914
|
-
"exports": [
|
|
10915
|
-
{
|
|
10916
|
-
"kind": "js",
|
|
10917
|
-
"name": "default",
|
|
10918
|
-
"declaration": {
|
|
10919
|
-
"name": "NotificationGroup",
|
|
10920
|
-
"module": "src/notification-group/NotificationGroup.ts"
|
|
10921
|
-
}
|
|
10922
|
-
},
|
|
10923
|
-
{
|
|
10924
|
-
"kind": "custom-element-definition",
|
|
10925
|
-
"name": "nord-notification-group",
|
|
10926
|
-
"declaration": {
|
|
10927
|
-
"name": "NotificationGroup",
|
|
10928
|
-
"module": "src/notification-group/NotificationGroup.ts"
|
|
10929
|
-
}
|
|
10930
|
-
}
|
|
10931
|
-
]
|
|
10932
|
-
},
|
|
10933
10933
|
{
|
|
10934
10934
|
"kind": "javascript-module",
|
|
10935
10935
|
"path": "src/popout/Popout.ts",
|
|
@@ -15172,80 +15172,30 @@
|
|
|
15172
15172
|
"name": "label",
|
|
15173
15173
|
"type": {
|
|
15174
15174
|
"text": "string"
|
|
15175
|
-
},
|
|
15176
|
-
"default": "\"\"",
|
|
15177
|
-
"description": "Adds an accessible label to the tab list container.",
|
|
15178
|
-
"fieldName": "label"
|
|
15179
|
-
},
|
|
15180
|
-
{
|
|
15181
|
-
"name": "padding",
|
|
15182
|
-
"type": {
|
|
15183
|
-
"text": "\"m\" | \"l\" | \"none\" | undefined"
|
|
15184
|
-
},
|
|
15185
|
-
"default": "\"m\"",
|
|
15186
|
-
"description": "Controls the padding of the tab group component.",
|
|
15187
|
-
"fieldName": "padding"
|
|
15188
|
-
},
|
|
15189
|
-
{
|
|
15190
|
-
"name": "sticky",
|
|
15191
|
-
"type": {
|
|
15192
|
-
"text": "boolean"
|
|
15193
|
-
},
|
|
15194
|
-
"default": "false",
|
|
15195
|
-
"description": "Whether the tab list sticks to the top of the tab group as you scroll.",
|
|
15196
|
-
"fieldName": "sticky"
|
|
15197
|
-
}
|
|
15198
|
-
],
|
|
15199
|
-
"superclass": {
|
|
15200
|
-
"name": "LitElement",
|
|
15201
|
-
"package": "lit"
|
|
15202
|
-
},
|
|
15203
|
-
"localization": [],
|
|
15204
|
-
"status": "ready",
|
|
15205
|
-
"category": "navigation",
|
|
15206
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to allow multiple panels to be contained within a single window.\n- Use the tab panel and tab components within the tab group component.\n- Use the tab and tab panel components in order to create a tab group content structure.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use other components to the tab and tab panel within the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n- Don't add a tab or tab panel component without providing an accompanying panel or tab.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the tab component related to the panel to select the tab but prevent the order of the tabs being affected.\n",
|
|
15207
|
-
"examples": [],
|
|
15208
|
-
"dependencies": [
|
|
15209
|
-
"tab"
|
|
15210
|
-
],
|
|
15211
|
-
"tagName": "nord-tab-group",
|
|
15212
|
-
"customElement": true
|
|
15213
|
-
}
|
|
15214
|
-
],
|
|
15215
|
-
"exports": [
|
|
15216
|
-
{
|
|
15217
|
-
"kind": "js",
|
|
15218
|
-
"name": "default",
|
|
15219
|
-
"declaration": {
|
|
15220
|
-
"name": "TabGroup",
|
|
15221
|
-
"module": "src/tab-group/TabGroup.ts"
|
|
15222
|
-
}
|
|
15223
|
-
},
|
|
15224
|
-
{
|
|
15225
|
-
"kind": "custom-element-definition",
|
|
15226
|
-
"name": "nord-tab-group",
|
|
15227
|
-
"declaration": {
|
|
15228
|
-
"name": "TabGroup",
|
|
15229
|
-
"module": "src/tab-group/TabGroup.ts"
|
|
15230
|
-
}
|
|
15231
|
-
}
|
|
15232
|
-
]
|
|
15233
|
-
},
|
|
15234
|
-
{
|
|
15235
|
-
"kind": "javascript-module",
|
|
15236
|
-
"path": "src/tab-panel/TabPanel.ts",
|
|
15237
|
-
"declarations": [
|
|
15238
|
-
{
|
|
15239
|
-
"kind": "class",
|
|
15240
|
-
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15241
|
-
"name": "TabPanel",
|
|
15242
|
-
"slots": [
|
|
15175
|
+
},
|
|
15176
|
+
"default": "\"\"",
|
|
15177
|
+
"description": "Adds an accessible label to the tab list container.",
|
|
15178
|
+
"fieldName": "label"
|
|
15179
|
+
},
|
|
15243
15180
|
{
|
|
15244
|
-
"
|
|
15245
|
-
"
|
|
15181
|
+
"name": "padding",
|
|
15182
|
+
"type": {
|
|
15183
|
+
"text": "\"m\" | \"l\" | \"none\" | undefined"
|
|
15184
|
+
},
|
|
15185
|
+
"default": "\"m\"",
|
|
15186
|
+
"description": "Controls the padding of the tab group component.",
|
|
15187
|
+
"fieldName": "padding"
|
|
15188
|
+
},
|
|
15189
|
+
{
|
|
15190
|
+
"name": "sticky",
|
|
15191
|
+
"type": {
|
|
15192
|
+
"text": "boolean"
|
|
15193
|
+
},
|
|
15194
|
+
"default": "false",
|
|
15195
|
+
"description": "Whether the tab list sticks to the top of the tab group as you scroll.",
|
|
15196
|
+
"fieldName": "sticky"
|
|
15246
15197
|
}
|
|
15247
15198
|
],
|
|
15248
|
-
"members": [],
|
|
15249
15199
|
"superclass": {
|
|
15250
15200
|
"name": "LitElement",
|
|
15251
15201
|
"package": "lit"
|
|
@@ -15253,10 +15203,12 @@
|
|
|
15253
15203
|
"localization": [],
|
|
15254
15204
|
"status": "ready",
|
|
15255
15205
|
"category": "navigation",
|
|
15256
|
-
"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
|
|
15206
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to allow multiple panels to be contained within a single window.\n- Use the tab panel and tab components within the tab group component.\n- Use the tab and tab panel components in order to create a tab group content structure.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use other components to the tab and tab panel within the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n- Don't add a tab or tab panel component without providing an accompanying panel or tab.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the tab component related to the panel to select the tab but prevent the order of the tabs being affected.\n",
|
|
15257
15207
|
"examples": [],
|
|
15258
|
-
"dependencies": [
|
|
15259
|
-
|
|
15208
|
+
"dependencies": [
|
|
15209
|
+
"tab"
|
|
15210
|
+
],
|
|
15211
|
+
"tagName": "nord-tab-group",
|
|
15260
15212
|
"customElement": true
|
|
15261
15213
|
}
|
|
15262
15214
|
],
|
|
@@ -15265,16 +15217,16 @@
|
|
|
15265
15217
|
"kind": "js",
|
|
15266
15218
|
"name": "default",
|
|
15267
15219
|
"declaration": {
|
|
15268
|
-
"name": "
|
|
15269
|
-
"module": "src/tab-
|
|
15220
|
+
"name": "TabGroup",
|
|
15221
|
+
"module": "src/tab-group/TabGroup.ts"
|
|
15270
15222
|
}
|
|
15271
15223
|
},
|
|
15272
15224
|
{
|
|
15273
15225
|
"kind": "custom-element-definition",
|
|
15274
|
-
"name": "nord-tab-
|
|
15226
|
+
"name": "nord-tab-group",
|
|
15275
15227
|
"declaration": {
|
|
15276
|
-
"name": "
|
|
15277
|
-
"module": "src/tab-
|
|
15228
|
+
"name": "TabGroup",
|
|
15229
|
+
"module": "src/tab-group/TabGroup.ts"
|
|
15278
15230
|
}
|
|
15279
15231
|
}
|
|
15280
15232
|
]
|
|
@@ -15425,6 +15377,54 @@
|
|
|
15425
15377
|
}
|
|
15426
15378
|
]
|
|
15427
15379
|
},
|
|
15380
|
+
{
|
|
15381
|
+
"kind": "javascript-module",
|
|
15382
|
+
"path": "src/tab-panel/TabPanel.ts",
|
|
15383
|
+
"declarations": [
|
|
15384
|
+
{
|
|
15385
|
+
"kind": "class",
|
|
15386
|
+
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15387
|
+
"name": "TabPanel",
|
|
15388
|
+
"slots": [
|
|
15389
|
+
{
|
|
15390
|
+
"description": "The tab panel content.",
|
|
15391
|
+
"name": ""
|
|
15392
|
+
}
|
|
15393
|
+
],
|
|
15394
|
+
"members": [],
|
|
15395
|
+
"superclass": {
|
|
15396
|
+
"name": "LitElement",
|
|
15397
|
+
"package": "lit"
|
|
15398
|
+
},
|
|
15399
|
+
"localization": [],
|
|
15400
|
+
"status": "ready",
|
|
15401
|
+
"category": "navigation",
|
|
15402
|
+
"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",
|
|
15403
|
+
"examples": [],
|
|
15404
|
+
"dependencies": [],
|
|
15405
|
+
"tagName": "nord-tab-panel",
|
|
15406
|
+
"customElement": true
|
|
15407
|
+
}
|
|
15408
|
+
],
|
|
15409
|
+
"exports": [
|
|
15410
|
+
{
|
|
15411
|
+
"kind": "js",
|
|
15412
|
+
"name": "default",
|
|
15413
|
+
"declaration": {
|
|
15414
|
+
"name": "TabPanel",
|
|
15415
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15416
|
+
}
|
|
15417
|
+
},
|
|
15418
|
+
{
|
|
15419
|
+
"kind": "custom-element-definition",
|
|
15420
|
+
"name": "nord-tab-panel",
|
|
15421
|
+
"declaration": {
|
|
15422
|
+
"name": "TabPanel",
|
|
15423
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15424
|
+
}
|
|
15425
|
+
}
|
|
15426
|
+
]
|
|
15427
|
+
},
|
|
15428
15428
|
{
|
|
15429
15429
|
"kind": "javascript-module",
|
|
15430
15430
|
"path": "src/tag/Tag.ts",
|
|
@@ -15834,172 +15834,9 @@
|
|
|
15834
15834
|
"kind": "variable",
|
|
15835
15835
|
"name": "localization",
|
|
15836
15836
|
"type": {
|
|
15837
|
-
"text": "object"
|
|
15838
|
-
},
|
|
15839
|
-
"default": "{ removeLabel: \"Remove\", }"
|
|
15840
|
-
}
|
|
15841
|
-
],
|
|
15842
|
-
"exports": [
|
|
15843
|
-
{
|
|
15844
|
-
"kind": "js",
|
|
15845
|
-
"name": "default",
|
|
15846
|
-
"declaration": {
|
|
15847
|
-
"name": "localization",
|
|
15848
|
-
"module": "src/tag/localization.ts"
|
|
15849
|
-
}
|
|
15850
|
-
}
|
|
15851
|
-
]
|
|
15852
|
-
},
|
|
15853
|
-
{
|
|
15854
|
-
"kind": "javascript-module",
|
|
15855
|
-
"path": "src/tag-group/TagGroup.ts",
|
|
15856
|
-
"declarations": [
|
|
15857
|
-
{
|
|
15858
|
-
"kind": "class",
|
|
15859
|
-
"description": "Tag groups are designed to bring together selectable tags that are of a similar nature. For example categories you can filter by.",
|
|
15860
|
-
"name": "TagGroup",
|
|
15861
|
-
"cssProperties": [
|
|
15862
|
-
{
|
|
15863
|
-
"description": "Controls the rounded corners of the tag group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
15864
|
-
"name": "--n-tag-group-border-radius",
|
|
15865
|
-
"default": "var(--n-border-radius-s)"
|
|
15866
|
-
},
|
|
15867
|
-
{
|
|
15868
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
15869
|
-
"name": "--n-tag-group-box-shadow",
|
|
15870
|
-
"default": "var(--n-box-shadow)"
|
|
15871
|
-
}
|
|
15872
|
-
],
|
|
15873
|
-
"slots": [
|
|
15874
|
-
{
|
|
15875
|
-
"description": "The tag group content",
|
|
15876
|
-
"name": ""
|
|
15877
|
-
}
|
|
15878
|
-
],
|
|
15879
|
-
"members": [
|
|
15880
|
-
{
|
|
15881
|
-
"kind": "field",
|
|
15882
|
-
"name": "defaultSlot",
|
|
15883
|
-
"privacy": "private",
|
|
15884
|
-
"default": "new SlotController(this)"
|
|
15885
|
-
},
|
|
15886
|
-
{
|
|
15887
|
-
"kind": "field",
|
|
15888
|
-
"name": "dirController",
|
|
15889
|
-
"privacy": "private",
|
|
15890
|
-
"default": "new DirectionController(this)"
|
|
15891
|
-
},
|
|
15892
|
-
{
|
|
15893
|
-
"kind": "field",
|
|
15894
|
-
"name": "variant",
|
|
15895
|
-
"type": {
|
|
15896
|
-
"text": "\"default\" | \"spaced\""
|
|
15897
|
-
},
|
|
15898
|
-
"default": "\"default\"",
|
|
15899
|
-
"description": "The style variant of the tag group.",
|
|
15900
|
-
"attribute": "variant",
|
|
15901
|
-
"reflects": true
|
|
15902
|
-
},
|
|
15903
|
-
{
|
|
15904
|
-
"kind": "field",
|
|
15905
|
-
"name": "direction",
|
|
15906
|
-
"type": {
|
|
15907
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
15908
|
-
},
|
|
15909
|
-
"default": "\"horizontal\"",
|
|
15910
|
-
"description": "The direction of the tag group.",
|
|
15911
|
-
"attribute": "direction",
|
|
15912
|
-
"reflects": true
|
|
15913
|
-
},
|
|
15914
|
-
{
|
|
15915
|
-
"kind": "field",
|
|
15916
|
-
"name": "wrap",
|
|
15917
|
-
"type": {
|
|
15918
|
-
"text": "boolean"
|
|
15919
|
-
},
|
|
15920
|
-
"default": "false",
|
|
15921
|
-
"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`).",
|
|
15922
|
-
"attribute": "wrap",
|
|
15923
|
-
"reflects": true
|
|
15924
|
-
},
|
|
15925
|
-
{
|
|
15926
|
-
"kind": "field",
|
|
15927
|
-
"name": "role",
|
|
15928
|
-
"type": {
|
|
15929
|
-
"text": "string"
|
|
15930
|
-
},
|
|
15931
|
-
"default": "\"group\"",
|
|
15932
|
-
"description": "The appropriate role for the containing element.",
|
|
15933
|
-
"attribute": "role",
|
|
15934
|
-
"reflects": true
|
|
15935
|
-
}
|
|
15936
|
-
],
|
|
15937
|
-
"events": [
|
|
15938
|
-
{
|
|
15939
|
-
"type": {
|
|
15940
|
-
"text": "NordEvent"
|
|
15941
|
-
},
|
|
15942
|
-
"description": "Fired whenever a tag has been checked or unchecked via user interaction.",
|
|
15943
|
-
"name": "change"
|
|
15944
|
-
},
|
|
15945
|
-
{
|
|
15946
|
-
"type": {
|
|
15947
|
-
"text": "NordEvent"
|
|
15948
|
-
},
|
|
15949
|
-
"description": "Fired when the remove button is activated on a tag. This event should be used to remove the tag from the DOM.",
|
|
15950
|
-
"name": "remove"
|
|
15951
|
-
}
|
|
15952
|
-
],
|
|
15953
|
-
"attributes": [
|
|
15954
|
-
{
|
|
15955
|
-
"name": "variant",
|
|
15956
|
-
"type": {
|
|
15957
|
-
"text": "\"default\" | \"spaced\""
|
|
15958
|
-
},
|
|
15959
|
-
"default": "\"default\"",
|
|
15960
|
-
"description": "The style variant of the tag group.",
|
|
15961
|
-
"fieldName": "variant"
|
|
15962
|
-
},
|
|
15963
|
-
{
|
|
15964
|
-
"name": "direction",
|
|
15965
|
-
"type": {
|
|
15966
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
15967
|
-
},
|
|
15968
|
-
"default": "\"horizontal\"",
|
|
15969
|
-
"description": "The direction of the tag group.",
|
|
15970
|
-
"fieldName": "direction"
|
|
15971
|
-
},
|
|
15972
|
-
{
|
|
15973
|
-
"name": "wrap",
|
|
15974
|
-
"type": {
|
|
15975
|
-
"text": "boolean"
|
|
15976
|
-
},
|
|
15977
|
-
"default": "false",
|
|
15978
|
-
"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`).",
|
|
15979
|
-
"fieldName": "wrap"
|
|
15980
|
-
},
|
|
15981
|
-
{
|
|
15982
|
-
"name": "role",
|
|
15983
|
-
"type": {
|
|
15984
|
-
"text": "string"
|
|
15985
|
-
},
|
|
15986
|
-
"default": "\"group\"",
|
|
15987
|
-
"description": "The appropriate role for the containing element.",
|
|
15988
|
-
"fieldName": "role"
|
|
15989
|
-
}
|
|
15990
|
-
],
|
|
15991
|
-
"superclass": {
|
|
15992
|
-
"name": "LitElement",
|
|
15993
|
-
"package": "lit"
|
|
15994
|
-
},
|
|
15995
|
-
"localization": [],
|
|
15996
|
-
"status": "new",
|
|
15997
|
-
"category": "structure",
|
|
15998
|
-
"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",
|
|
15999
|
-
"examples": [],
|
|
16000
|
-
"dependencies": [],
|
|
16001
|
-
"tagName": "nord-tag-group",
|
|
16002
|
-
"customElement": true
|
|
15837
|
+
"text": "object"
|
|
15838
|
+
},
|
|
15839
|
+
"default": "{ removeLabel: \"Remove\", }"
|
|
16003
15840
|
}
|
|
16004
15841
|
],
|
|
16005
15842
|
"exports": [
|
|
@@ -16007,16 +15844,8 @@
|
|
|
16007
15844
|
"kind": "js",
|
|
16008
15845
|
"name": "default",
|
|
16009
15846
|
"declaration": {
|
|
16010
|
-
"name": "
|
|
16011
|
-
"module": "src/tag
|
|
16012
|
-
}
|
|
16013
|
-
},
|
|
16014
|
-
{
|
|
16015
|
-
"kind": "custom-element-definition",
|
|
16016
|
-
"name": "nord-tag-group",
|
|
16017
|
-
"declaration": {
|
|
16018
|
-
"name": "TagGroup",
|
|
16019
|
-
"module": "src/tag-group/TagGroup.ts"
|
|
15847
|
+
"name": "localization",
|
|
15848
|
+
"module": "src/tag/localization.ts"
|
|
16020
15849
|
}
|
|
16021
15850
|
}
|
|
16022
15851
|
]
|
|
@@ -17094,6 +16923,177 @@
|
|
|
17094
16923
|
}
|
|
17095
16924
|
]
|
|
17096
16925
|
},
|
|
16926
|
+
{
|
|
16927
|
+
"kind": "javascript-module",
|
|
16928
|
+
"path": "src/tag-group/TagGroup.ts",
|
|
16929
|
+
"declarations": [
|
|
16930
|
+
{
|
|
16931
|
+
"kind": "class",
|
|
16932
|
+
"description": "Tag groups are designed to bring together selectable tags that are of a similar nature. For example categories you can filter by.",
|
|
16933
|
+
"name": "TagGroup",
|
|
16934
|
+
"cssProperties": [
|
|
16935
|
+
{
|
|
16936
|
+
"description": "Controls the rounded corners of the tag group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
16937
|
+
"name": "--n-tag-group-border-radius",
|
|
16938
|
+
"default": "var(--n-border-radius-s)"
|
|
16939
|
+
},
|
|
16940
|
+
{
|
|
16941
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
16942
|
+
"name": "--n-tag-group-box-shadow",
|
|
16943
|
+
"default": "var(--n-box-shadow)"
|
|
16944
|
+
}
|
|
16945
|
+
],
|
|
16946
|
+
"slots": [
|
|
16947
|
+
{
|
|
16948
|
+
"description": "The tag group content",
|
|
16949
|
+
"name": ""
|
|
16950
|
+
}
|
|
16951
|
+
],
|
|
16952
|
+
"members": [
|
|
16953
|
+
{
|
|
16954
|
+
"kind": "field",
|
|
16955
|
+
"name": "defaultSlot",
|
|
16956
|
+
"privacy": "private",
|
|
16957
|
+
"default": "new SlotController(this)"
|
|
16958
|
+
},
|
|
16959
|
+
{
|
|
16960
|
+
"kind": "field",
|
|
16961
|
+
"name": "dirController",
|
|
16962
|
+
"privacy": "private",
|
|
16963
|
+
"default": "new DirectionController(this)"
|
|
16964
|
+
},
|
|
16965
|
+
{
|
|
16966
|
+
"kind": "field",
|
|
16967
|
+
"name": "variant",
|
|
16968
|
+
"type": {
|
|
16969
|
+
"text": "\"default\" | \"spaced\""
|
|
16970
|
+
},
|
|
16971
|
+
"default": "\"default\"",
|
|
16972
|
+
"description": "The style variant of the tag group.",
|
|
16973
|
+
"attribute": "variant",
|
|
16974
|
+
"reflects": true
|
|
16975
|
+
},
|
|
16976
|
+
{
|
|
16977
|
+
"kind": "field",
|
|
16978
|
+
"name": "direction",
|
|
16979
|
+
"type": {
|
|
16980
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
16981
|
+
},
|
|
16982
|
+
"default": "\"horizontal\"",
|
|
16983
|
+
"description": "The direction of the tag group.",
|
|
16984
|
+
"attribute": "direction",
|
|
16985
|
+
"reflects": true
|
|
16986
|
+
},
|
|
16987
|
+
{
|
|
16988
|
+
"kind": "field",
|
|
16989
|
+
"name": "wrap",
|
|
16990
|
+
"type": {
|
|
16991
|
+
"text": "boolean"
|
|
16992
|
+
},
|
|
16993
|
+
"default": "false",
|
|
16994
|
+
"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`).",
|
|
16995
|
+
"attribute": "wrap",
|
|
16996
|
+
"reflects": true
|
|
16997
|
+
},
|
|
16998
|
+
{
|
|
16999
|
+
"kind": "field",
|
|
17000
|
+
"name": "role",
|
|
17001
|
+
"type": {
|
|
17002
|
+
"text": "string"
|
|
17003
|
+
},
|
|
17004
|
+
"default": "\"group\"",
|
|
17005
|
+
"description": "The appropriate role for the containing element.",
|
|
17006
|
+
"attribute": "role",
|
|
17007
|
+
"reflects": true
|
|
17008
|
+
}
|
|
17009
|
+
],
|
|
17010
|
+
"events": [
|
|
17011
|
+
{
|
|
17012
|
+
"type": {
|
|
17013
|
+
"text": "NordEvent"
|
|
17014
|
+
},
|
|
17015
|
+
"description": "Fired whenever a tag has been checked or unchecked via user interaction.",
|
|
17016
|
+
"name": "change"
|
|
17017
|
+
},
|
|
17018
|
+
{
|
|
17019
|
+
"type": {
|
|
17020
|
+
"text": "NordEvent"
|
|
17021
|
+
},
|
|
17022
|
+
"description": "Fired when the remove button is activated on a tag. This event should be used to remove the tag from the DOM.",
|
|
17023
|
+
"name": "remove"
|
|
17024
|
+
}
|
|
17025
|
+
],
|
|
17026
|
+
"attributes": [
|
|
17027
|
+
{
|
|
17028
|
+
"name": "variant",
|
|
17029
|
+
"type": {
|
|
17030
|
+
"text": "\"default\" | \"spaced\""
|
|
17031
|
+
},
|
|
17032
|
+
"default": "\"default\"",
|
|
17033
|
+
"description": "The style variant of the tag group.",
|
|
17034
|
+
"fieldName": "variant"
|
|
17035
|
+
},
|
|
17036
|
+
{
|
|
17037
|
+
"name": "direction",
|
|
17038
|
+
"type": {
|
|
17039
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
17040
|
+
},
|
|
17041
|
+
"default": "\"horizontal\"",
|
|
17042
|
+
"description": "The direction of the tag group.",
|
|
17043
|
+
"fieldName": "direction"
|
|
17044
|
+
},
|
|
17045
|
+
{
|
|
17046
|
+
"name": "wrap",
|
|
17047
|
+
"type": {
|
|
17048
|
+
"text": "boolean"
|
|
17049
|
+
},
|
|
17050
|
+
"default": "false",
|
|
17051
|
+
"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`).",
|
|
17052
|
+
"fieldName": "wrap"
|
|
17053
|
+
},
|
|
17054
|
+
{
|
|
17055
|
+
"name": "role",
|
|
17056
|
+
"type": {
|
|
17057
|
+
"text": "string"
|
|
17058
|
+
},
|
|
17059
|
+
"default": "\"group\"",
|
|
17060
|
+
"description": "The appropriate role for the containing element.",
|
|
17061
|
+
"fieldName": "role"
|
|
17062
|
+
}
|
|
17063
|
+
],
|
|
17064
|
+
"superclass": {
|
|
17065
|
+
"name": "LitElement",
|
|
17066
|
+
"package": "lit"
|
|
17067
|
+
},
|
|
17068
|
+
"localization": [],
|
|
17069
|
+
"status": "new",
|
|
17070
|
+
"category": "structure",
|
|
17071
|
+
"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",
|
|
17072
|
+
"examples": [],
|
|
17073
|
+
"dependencies": [],
|
|
17074
|
+
"tagName": "nord-tag-group",
|
|
17075
|
+
"customElement": true
|
|
17076
|
+
}
|
|
17077
|
+
],
|
|
17078
|
+
"exports": [
|
|
17079
|
+
{
|
|
17080
|
+
"kind": "js",
|
|
17081
|
+
"name": "default",
|
|
17082
|
+
"declaration": {
|
|
17083
|
+
"name": "TagGroup",
|
|
17084
|
+
"module": "src/tag-group/TagGroup.ts"
|
|
17085
|
+
}
|
|
17086
|
+
},
|
|
17087
|
+
{
|
|
17088
|
+
"kind": "custom-element-definition",
|
|
17089
|
+
"name": "nord-tag-group",
|
|
17090
|
+
"declaration": {
|
|
17091
|
+
"name": "TagGroup",
|
|
17092
|
+
"module": "src/tag-group/TagGroup.ts"
|
|
17093
|
+
}
|
|
17094
|
+
}
|
|
17095
|
+
]
|
|
17096
|
+
},
|
|
17097
17097
|
{
|
|
17098
17098
|
"kind": "javascript-module",
|
|
17099
17099
|
"path": "src/toast/Toast.ts",
|
|
@@ -18427,6 +18427,41 @@
|
|
|
18427
18427
|
}
|
|
18428
18428
|
]
|
|
18429
18429
|
},
|
|
18430
|
+
{
|
|
18431
|
+
"kind": "javascript-module",
|
|
18432
|
+
"path": "src/common/decorators/observe.ts",
|
|
18433
|
+
"declarations": [
|
|
18434
|
+
{
|
|
18435
|
+
"kind": "function",
|
|
18436
|
+
"name": "observe",
|
|
18437
|
+
"parameters": [
|
|
18438
|
+
{
|
|
18439
|
+
"name": "propertyName",
|
|
18440
|
+
"type": {
|
|
18441
|
+
"text": "string"
|
|
18442
|
+
}
|
|
18443
|
+
},
|
|
18444
|
+
{
|
|
18445
|
+
"name": "lifecycle",
|
|
18446
|
+
"default": "\"update\"",
|
|
18447
|
+
"type": {
|
|
18448
|
+
"text": "ObserveLifecycle"
|
|
18449
|
+
}
|
|
18450
|
+
}
|
|
18451
|
+
]
|
|
18452
|
+
}
|
|
18453
|
+
],
|
|
18454
|
+
"exports": [
|
|
18455
|
+
{
|
|
18456
|
+
"kind": "js",
|
|
18457
|
+
"name": "observe",
|
|
18458
|
+
"declaration": {
|
|
18459
|
+
"name": "observe",
|
|
18460
|
+
"module": "src/common/decorators/observe.ts"
|
|
18461
|
+
}
|
|
18462
|
+
}
|
|
18463
|
+
]
|
|
18464
|
+
},
|
|
18430
18465
|
{
|
|
18431
18466
|
"kind": "javascript-module",
|
|
18432
18467
|
"path": "src/common/controllers/BroadcastChannelController.ts",
|
|
@@ -19688,41 +19723,6 @@
|
|
|
19688
19723
|
}
|
|
19689
19724
|
]
|
|
19690
19725
|
},
|
|
19691
|
-
{
|
|
19692
|
-
"kind": "javascript-module",
|
|
19693
|
-
"path": "src/common/decorators/observe.ts",
|
|
19694
|
-
"declarations": [
|
|
19695
|
-
{
|
|
19696
|
-
"kind": "function",
|
|
19697
|
-
"name": "observe",
|
|
19698
|
-
"parameters": [
|
|
19699
|
-
{
|
|
19700
|
-
"name": "propertyName",
|
|
19701
|
-
"type": {
|
|
19702
|
-
"text": "string"
|
|
19703
|
-
}
|
|
19704
|
-
},
|
|
19705
|
-
{
|
|
19706
|
-
"name": "lifecycle",
|
|
19707
|
-
"default": "\"update\"",
|
|
19708
|
-
"type": {
|
|
19709
|
-
"text": "ObserveLifecycle"
|
|
19710
|
-
}
|
|
19711
|
-
}
|
|
19712
|
-
]
|
|
19713
|
-
}
|
|
19714
|
-
],
|
|
19715
|
-
"exports": [
|
|
19716
|
-
{
|
|
19717
|
-
"kind": "js",
|
|
19718
|
-
"name": "observe",
|
|
19719
|
-
"declaration": {
|
|
19720
|
-
"name": "observe",
|
|
19721
|
-
"module": "src/common/decorators/observe.ts"
|
|
19722
|
-
}
|
|
19723
|
-
}
|
|
19724
|
-
]
|
|
19725
|
-
},
|
|
19726
19726
|
{
|
|
19727
19727
|
"kind": "javascript-module",
|
|
19728
19728
|
"path": "src/common/directives/cond.ts",
|