@nordhealth/components 2.16.1-alpha.5 → 2.16.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 +1561 -1569
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Input.js +1 -1
- package/lib/Input.js.map +1 -1
- package/lib/Layout.js +1 -1
- package/lib/Layout.js.map +1 -1
- package/lib/NavGroup.js +1 -1
- package/lib/NavGroup.js.map +1 -1
- package/lib/NavItem.js +1 -1
- package/lib/NavItem.js.map +1 -1
- package/lib/Navigation.js +1 -1
- package/lib/Navigation.js.map +1 -1
- package/lib/Skeleton.js +1 -1
- package/lib/Skeleton.js.map +1 -1
- package/lib/bundle.js +3 -3
- package/lib/bundle.js.map +1 -1
- package/lib/src/drawer/Drawer.test.d.ts +1 -0
- package/lib/src/navigation/Navigation.d.ts +0 -1
- package/lib/src/skeleton/Skeleton.d.ts +2 -1
- package/package.json +3 -2
package/custom-elements.json
CHANGED
|
@@ -587,6 +587,93 @@
|
|
|
587
587
|
}
|
|
588
588
|
]
|
|
589
589
|
},
|
|
590
|
+
{
|
|
591
|
+
"kind": "javascript-module",
|
|
592
|
+
"path": "src/badge/Badge.ts",
|
|
593
|
+
"declarations": [
|
|
594
|
+
{
|
|
595
|
+
"kind": "class",
|
|
596
|
+
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
597
|
+
"name": "Badge",
|
|
598
|
+
"slots": [
|
|
599
|
+
{
|
|
600
|
+
"description": "The badge content.",
|
|
601
|
+
"name": ""
|
|
602
|
+
}
|
|
603
|
+
],
|
|
604
|
+
"members": [
|
|
605
|
+
{
|
|
606
|
+
"kind": "field",
|
|
607
|
+
"name": "type",
|
|
608
|
+
"type": {
|
|
609
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
610
|
+
},
|
|
611
|
+
"default": "\"neutral\"",
|
|
612
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
613
|
+
"attribute": "type",
|
|
614
|
+
"reflects": true
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"kind": "field",
|
|
618
|
+
"name": "progress",
|
|
619
|
+
"type": {
|
|
620
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
621
|
+
},
|
|
622
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
623
|
+
"attribute": "progress"
|
|
624
|
+
}
|
|
625
|
+
],
|
|
626
|
+
"attributes": [
|
|
627
|
+
{
|
|
628
|
+
"name": "type",
|
|
629
|
+
"type": {
|
|
630
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
631
|
+
},
|
|
632
|
+
"default": "\"neutral\"",
|
|
633
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
634
|
+
"fieldName": "type"
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
"name": "progress",
|
|
638
|
+
"type": {
|
|
639
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
640
|
+
},
|
|
641
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
642
|
+
"fieldName": "progress"
|
|
643
|
+
}
|
|
644
|
+
],
|
|
645
|
+
"superclass": {
|
|
646
|
+
"name": "LitElement",
|
|
647
|
+
"package": "lit"
|
|
648
|
+
},
|
|
649
|
+
"localization": [],
|
|
650
|
+
"status": "ready",
|
|
651
|
+
"category": "text",
|
|
652
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s clear to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
653
|
+
"examples": [],
|
|
654
|
+
"tagName": "nord-badge",
|
|
655
|
+
"customElement": true
|
|
656
|
+
}
|
|
657
|
+
],
|
|
658
|
+
"exports": [
|
|
659
|
+
{
|
|
660
|
+
"kind": "js",
|
|
661
|
+
"name": "default",
|
|
662
|
+
"declaration": {
|
|
663
|
+
"name": "Badge",
|
|
664
|
+
"module": "src/badge/Badge.ts"
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
{
|
|
668
|
+
"kind": "custom-element-definition",
|
|
669
|
+
"name": "nord-badge",
|
|
670
|
+
"declaration": {
|
|
671
|
+
"name": "Badge",
|
|
672
|
+
"module": "src/badge/Badge.ts"
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
]
|
|
676
|
+
},
|
|
590
677
|
{
|
|
591
678
|
"kind": "javascript-module",
|
|
592
679
|
"path": "src/button/Button.ts",
|
|
@@ -1127,93 +1214,6 @@
|
|
|
1127
1214
|
}
|
|
1128
1215
|
]
|
|
1129
1216
|
},
|
|
1130
|
-
{
|
|
1131
|
-
"kind": "javascript-module",
|
|
1132
|
-
"path": "src/badge/Badge.ts",
|
|
1133
|
-
"declarations": [
|
|
1134
|
-
{
|
|
1135
|
-
"kind": "class",
|
|
1136
|
-
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
1137
|
-
"name": "Badge",
|
|
1138
|
-
"slots": [
|
|
1139
|
-
{
|
|
1140
|
-
"description": "The badge content.",
|
|
1141
|
-
"name": ""
|
|
1142
|
-
}
|
|
1143
|
-
],
|
|
1144
|
-
"members": [
|
|
1145
|
-
{
|
|
1146
|
-
"kind": "field",
|
|
1147
|
-
"name": "type",
|
|
1148
|
-
"type": {
|
|
1149
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
1150
|
-
},
|
|
1151
|
-
"default": "\"neutral\"",
|
|
1152
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1153
|
-
"attribute": "type",
|
|
1154
|
-
"reflects": true
|
|
1155
|
-
},
|
|
1156
|
-
{
|
|
1157
|
-
"kind": "field",
|
|
1158
|
-
"name": "progress",
|
|
1159
|
-
"type": {
|
|
1160
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
1161
|
-
},
|
|
1162
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
1163
|
-
"attribute": "progress"
|
|
1164
|
-
}
|
|
1165
|
-
],
|
|
1166
|
-
"attributes": [
|
|
1167
|
-
{
|
|
1168
|
-
"name": "type",
|
|
1169
|
-
"type": {
|
|
1170
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
1171
|
-
},
|
|
1172
|
-
"default": "\"neutral\"",
|
|
1173
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1174
|
-
"fieldName": "type"
|
|
1175
|
-
},
|
|
1176
|
-
{
|
|
1177
|
-
"name": "progress",
|
|
1178
|
-
"type": {
|
|
1179
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
1180
|
-
},
|
|
1181
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
1182
|
-
"fieldName": "progress"
|
|
1183
|
-
}
|
|
1184
|
-
],
|
|
1185
|
-
"superclass": {
|
|
1186
|
-
"name": "LitElement",
|
|
1187
|
-
"package": "lit"
|
|
1188
|
-
},
|
|
1189
|
-
"localization": [],
|
|
1190
|
-
"status": "ready",
|
|
1191
|
-
"category": "text",
|
|
1192
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s clear to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
1193
|
-
"examples": [],
|
|
1194
|
-
"tagName": "nord-badge",
|
|
1195
|
-
"customElement": true
|
|
1196
|
-
}
|
|
1197
|
-
],
|
|
1198
|
-
"exports": [
|
|
1199
|
-
{
|
|
1200
|
-
"kind": "js",
|
|
1201
|
-
"name": "default",
|
|
1202
|
-
"declaration": {
|
|
1203
|
-
"name": "Badge",
|
|
1204
|
-
"module": "src/badge/Badge.ts"
|
|
1205
|
-
}
|
|
1206
|
-
},
|
|
1207
|
-
{
|
|
1208
|
-
"kind": "custom-element-definition",
|
|
1209
|
-
"name": "nord-badge",
|
|
1210
|
-
"declaration": {
|
|
1211
|
-
"name": "Badge",
|
|
1212
|
-
"module": "src/badge/Badge.ts"
|
|
1213
|
-
}
|
|
1214
|
-
}
|
|
1215
|
-
]
|
|
1216
|
-
},
|
|
1217
1217
|
{
|
|
1218
1218
|
"kind": "javascript-module",
|
|
1219
1219
|
"path": "src/banner/Banner.ts",
|
|
@@ -1918,66 +1918,188 @@
|
|
|
1918
1918
|
},
|
|
1919
1919
|
{
|
|
1920
1920
|
"kind": "javascript-module",
|
|
1921
|
-
"path": "src/
|
|
1921
|
+
"path": "src/card/Card.ts",
|
|
1922
1922
|
"declarations": [
|
|
1923
1923
|
{
|
|
1924
1924
|
"kind": "class",
|
|
1925
|
-
"description": "
|
|
1926
|
-
"name": "
|
|
1925
|
+
"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.",
|
|
1926
|
+
"name": "Card",
|
|
1927
|
+
"cssProperties": [
|
|
1928
|
+
{
|
|
1929
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1930
|
+
"name": "--n-card-border-radius",
|
|
1931
|
+
"default": "var(--n-border-radius)"
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1935
|
+
"name": "--n-card-box-shadow",
|
|
1936
|
+
"default": "var(--n-box-shadow-popout)"
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
"description": "Controls the padding on all sides of the card.",
|
|
1940
|
+
"name": "--n-card-padding",
|
|
1941
|
+
"default": "var(--n-space-m)"
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
1945
|
+
"name": "--n-card-slot-padding",
|
|
1946
|
+
"default": "var(--n-space-m)"
|
|
1947
|
+
}
|
|
1948
|
+
],
|
|
1927
1949
|
"slots": [
|
|
1928
1950
|
{
|
|
1929
|
-
"description": "
|
|
1930
|
-
"name": "
|
|
1951
|
+
"description": "The card content.",
|
|
1952
|
+
"name": ""
|
|
1931
1953
|
},
|
|
1932
1954
|
{
|
|
1933
|
-
"description": "Optional slot that holds
|
|
1934
|
-
"name": "
|
|
1955
|
+
"description": "Optional slot that holds a header for the card.",
|
|
1956
|
+
"name": "header"
|
|
1935
1957
|
},
|
|
1936
1958
|
{
|
|
1937
|
-
"description": "Optional slot that
|
|
1938
|
-
"name": "
|
|
1959
|
+
"description": "Optional slot that positions content at the end of the header. Useful for actions or additional info.",
|
|
1960
|
+
"name": "header-end"
|
|
1961
|
+
},
|
|
1962
|
+
{
|
|
1963
|
+
"description": "Optional slot that holds footer content for the card.",
|
|
1964
|
+
"name": "footer"
|
|
1939
1965
|
}
|
|
1940
1966
|
],
|
|
1941
1967
|
"members": [
|
|
1942
1968
|
{
|
|
1943
1969
|
"kind": "field",
|
|
1944
|
-
"name": "
|
|
1945
|
-
"privacy": "
|
|
1946
|
-
"
|
|
1947
|
-
"name": "FormAssociatedMixin",
|
|
1948
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1949
|
-
}
|
|
1970
|
+
"name": "headerSlot",
|
|
1971
|
+
"privacy": "private",
|
|
1972
|
+
"default": "new SlotController(this, \"header\")"
|
|
1950
1973
|
},
|
|
1951
1974
|
{
|
|
1952
1975
|
"kind": "field",
|
|
1953
|
-
"name": "
|
|
1954
|
-
"
|
|
1955
|
-
|
|
1956
|
-
},
|
|
1957
|
-
"default": "false",
|
|
1958
|
-
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
1959
|
-
"attribute": "indeterminate"
|
|
1976
|
+
"name": "headerEndSlot",
|
|
1977
|
+
"privacy": "private",
|
|
1978
|
+
"default": "new SlotController(this, \"header-end\")"
|
|
1960
1979
|
},
|
|
1961
1980
|
{
|
|
1962
1981
|
"kind": "field",
|
|
1963
|
-
"name": "
|
|
1964
|
-
"
|
|
1965
|
-
|
|
1966
|
-
},
|
|
1967
|
-
"default": "false",
|
|
1968
|
-
"description": "Controls whether the checkbox is checked or not.",
|
|
1969
|
-
"attribute": "checked"
|
|
1982
|
+
"name": "footerSlot",
|
|
1983
|
+
"privacy": "private",
|
|
1984
|
+
"default": "new SlotController(this, \"footer\")"
|
|
1970
1985
|
},
|
|
1971
1986
|
{
|
|
1972
|
-
"kind": "
|
|
1973
|
-
"name": "
|
|
1974
|
-
"
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
|
|
1987
|
+
"kind": "field",
|
|
1988
|
+
"name": "padding",
|
|
1989
|
+
"type": {
|
|
1990
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
1991
|
+
},
|
|
1992
|
+
"default": "\"m\"",
|
|
1993
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1994
|
+
"attribute": "padding",
|
|
1995
|
+
"reflects": true
|
|
1996
|
+
}
|
|
1997
|
+
],
|
|
1998
|
+
"attributes": [
|
|
1999
|
+
{
|
|
2000
|
+
"name": "padding",
|
|
2001
|
+
"type": {
|
|
2002
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
2003
|
+
},
|
|
2004
|
+
"default": "\"m\"",
|
|
2005
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
2006
|
+
"fieldName": "padding"
|
|
2007
|
+
}
|
|
2008
|
+
],
|
|
2009
|
+
"superclass": {
|
|
2010
|
+
"name": "LitElement",
|
|
2011
|
+
"package": "lit"
|
|
2012
|
+
},
|
|
2013
|
+
"localization": [],
|
|
2014
|
+
"status": "ready",
|
|
2015
|
+
"category": "structure",
|
|
2016
|
+
"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",
|
|
2017
|
+
"examples": [],
|
|
2018
|
+
"tagName": "nord-card",
|
|
2019
|
+
"customElement": true
|
|
2020
|
+
}
|
|
2021
|
+
],
|
|
2022
|
+
"exports": [
|
|
2023
|
+
{
|
|
2024
|
+
"kind": "js",
|
|
2025
|
+
"name": "default",
|
|
2026
|
+
"declaration": {
|
|
2027
|
+
"name": "Card",
|
|
2028
|
+
"module": "src/card/Card.ts"
|
|
2029
|
+
}
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"kind": "custom-element-definition",
|
|
2033
|
+
"name": "nord-card",
|
|
2034
|
+
"declaration": {
|
|
2035
|
+
"name": "Card",
|
|
2036
|
+
"module": "src/card/Card.ts"
|
|
2037
|
+
}
|
|
2038
|
+
}
|
|
2039
|
+
]
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"kind": "javascript-module",
|
|
2043
|
+
"path": "src/checkbox/Checkbox.ts",
|
|
2044
|
+
"declarations": [
|
|
2045
|
+
{
|
|
2046
|
+
"kind": "class",
|
|
2047
|
+
"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.",
|
|
2048
|
+
"name": "Checkbox",
|
|
2049
|
+
"slots": [
|
|
2050
|
+
{
|
|
2051
|
+
"description": "Use when a label requires more than plain text.",
|
|
2052
|
+
"name": "label"
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
2056
|
+
"name": "hint"
|
|
2057
|
+
},
|
|
2058
|
+
{
|
|
2059
|
+
"description": "Optional slot that holds error text for the input.",
|
|
2060
|
+
"name": "error"
|
|
2061
|
+
}
|
|
2062
|
+
],
|
|
2063
|
+
"members": [
|
|
2064
|
+
{
|
|
2065
|
+
"kind": "field",
|
|
2066
|
+
"name": "formValue",
|
|
2067
|
+
"privacy": "protected",
|
|
2068
|
+
"inheritedFrom": {
|
|
2069
|
+
"name": "FormAssociatedMixin",
|
|
2070
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2071
|
+
}
|
|
2072
|
+
},
|
|
2073
|
+
{
|
|
2074
|
+
"kind": "field",
|
|
2075
|
+
"name": "indeterminate",
|
|
2076
|
+
"type": {
|
|
2077
|
+
"text": "boolean"
|
|
2078
|
+
},
|
|
2079
|
+
"default": "false",
|
|
2080
|
+
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2081
|
+
"attribute": "indeterminate"
|
|
2082
|
+
},
|
|
2083
|
+
{
|
|
2084
|
+
"kind": "field",
|
|
2085
|
+
"name": "checked",
|
|
2086
|
+
"type": {
|
|
2087
|
+
"text": "boolean"
|
|
2088
|
+
},
|
|
2089
|
+
"default": "false",
|
|
2090
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
2091
|
+
"attribute": "checked"
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
"kind": "method",
|
|
2095
|
+
"name": "handleChange",
|
|
2096
|
+
"privacy": "protected",
|
|
2097
|
+
"parameters": [
|
|
2098
|
+
{
|
|
2099
|
+
"name": "e",
|
|
2100
|
+
"type": {
|
|
2101
|
+
"text": "Event"
|
|
2102
|
+
}
|
|
1981
2103
|
}
|
|
1982
2104
|
],
|
|
1983
2105
|
"return": {
|
|
@@ -2590,128 +2712,6 @@
|
|
|
2590
2712
|
}
|
|
2591
2713
|
]
|
|
2592
2714
|
},
|
|
2593
|
-
{
|
|
2594
|
-
"kind": "javascript-module",
|
|
2595
|
-
"path": "src/card/Card.ts",
|
|
2596
|
-
"declarations": [
|
|
2597
|
-
{
|
|
2598
|
-
"kind": "class",
|
|
2599
|
-
"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.",
|
|
2600
|
-
"name": "Card",
|
|
2601
|
-
"cssProperties": [
|
|
2602
|
-
{
|
|
2603
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
2604
|
-
"name": "--n-card-border-radius",
|
|
2605
|
-
"default": "var(--n-border-radius)"
|
|
2606
|
-
},
|
|
2607
|
-
{
|
|
2608
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
2609
|
-
"name": "--n-card-box-shadow",
|
|
2610
|
-
"default": "var(--n-box-shadow-popout)"
|
|
2611
|
-
},
|
|
2612
|
-
{
|
|
2613
|
-
"description": "Controls the padding on all sides of the card.",
|
|
2614
|
-
"name": "--n-card-padding",
|
|
2615
|
-
"default": "var(--n-space-m)"
|
|
2616
|
-
},
|
|
2617
|
-
{
|
|
2618
|
-
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
2619
|
-
"name": "--n-card-slot-padding",
|
|
2620
|
-
"default": "var(--n-space-m)"
|
|
2621
|
-
}
|
|
2622
|
-
],
|
|
2623
|
-
"slots": [
|
|
2624
|
-
{
|
|
2625
|
-
"description": "The card content.",
|
|
2626
|
-
"name": ""
|
|
2627
|
-
},
|
|
2628
|
-
{
|
|
2629
|
-
"description": "Optional slot that holds a header for the card.",
|
|
2630
|
-
"name": "header"
|
|
2631
|
-
},
|
|
2632
|
-
{
|
|
2633
|
-
"description": "Optional slot that positions content at the end of the header. Useful for actions or additional info.",
|
|
2634
|
-
"name": "header-end"
|
|
2635
|
-
},
|
|
2636
|
-
{
|
|
2637
|
-
"description": "Optional slot that holds footer content for the card.",
|
|
2638
|
-
"name": "footer"
|
|
2639
|
-
}
|
|
2640
|
-
],
|
|
2641
|
-
"members": [
|
|
2642
|
-
{
|
|
2643
|
-
"kind": "field",
|
|
2644
|
-
"name": "headerSlot",
|
|
2645
|
-
"privacy": "private",
|
|
2646
|
-
"default": "new SlotController(this, \"header\")"
|
|
2647
|
-
},
|
|
2648
|
-
{
|
|
2649
|
-
"kind": "field",
|
|
2650
|
-
"name": "headerEndSlot",
|
|
2651
|
-
"privacy": "private",
|
|
2652
|
-
"default": "new SlotController(this, \"header-end\")"
|
|
2653
|
-
},
|
|
2654
|
-
{
|
|
2655
|
-
"kind": "field",
|
|
2656
|
-
"name": "footerSlot",
|
|
2657
|
-
"privacy": "private",
|
|
2658
|
-
"default": "new SlotController(this, \"footer\")"
|
|
2659
|
-
},
|
|
2660
|
-
{
|
|
2661
|
-
"kind": "field",
|
|
2662
|
-
"name": "padding",
|
|
2663
|
-
"type": {
|
|
2664
|
-
"text": "\"m\" | \"l\" | \"none\""
|
|
2665
|
-
},
|
|
2666
|
-
"default": "\"m\"",
|
|
2667
|
-
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
2668
|
-
"attribute": "padding",
|
|
2669
|
-
"reflects": true
|
|
2670
|
-
}
|
|
2671
|
-
],
|
|
2672
|
-
"attributes": [
|
|
2673
|
-
{
|
|
2674
|
-
"name": "padding",
|
|
2675
|
-
"type": {
|
|
2676
|
-
"text": "\"m\" | \"l\" | \"none\""
|
|
2677
|
-
},
|
|
2678
|
-
"default": "\"m\"",
|
|
2679
|
-
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
2680
|
-
"fieldName": "padding"
|
|
2681
|
-
}
|
|
2682
|
-
],
|
|
2683
|
-
"superclass": {
|
|
2684
|
-
"name": "LitElement",
|
|
2685
|
-
"package": "lit"
|
|
2686
|
-
},
|
|
2687
|
-
"localization": [],
|
|
2688
|
-
"status": "ready",
|
|
2689
|
-
"category": "structure",
|
|
2690
|
-
"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",
|
|
2691
|
-
"examples": [],
|
|
2692
|
-
"tagName": "nord-card",
|
|
2693
|
-
"customElement": true
|
|
2694
|
-
}
|
|
2695
|
-
],
|
|
2696
|
-
"exports": [
|
|
2697
|
-
{
|
|
2698
|
-
"kind": "js",
|
|
2699
|
-
"name": "default",
|
|
2700
|
-
"declaration": {
|
|
2701
|
-
"name": "Card",
|
|
2702
|
-
"module": "src/card/Card.ts"
|
|
2703
|
-
}
|
|
2704
|
-
},
|
|
2705
|
-
{
|
|
2706
|
-
"kind": "custom-element-definition",
|
|
2707
|
-
"name": "nord-card",
|
|
2708
|
-
"declaration": {
|
|
2709
|
-
"name": "Card",
|
|
2710
|
-
"module": "src/card/Card.ts"
|
|
2711
|
-
}
|
|
2712
|
-
}
|
|
2713
|
-
]
|
|
2714
|
-
},
|
|
2715
2715
|
{
|
|
2716
2716
|
"kind": "javascript-module",
|
|
2717
2717
|
"path": "src/command-menu/CommandMenu.ts",
|
|
@@ -6559,7 +6559,7 @@
|
|
|
6559
6559
|
"localization": [],
|
|
6560
6560
|
"status": "ready",
|
|
6561
6561
|
"category": "structure",
|
|
6562
|
-
"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 header component to show a heading to describe the current view.\n- Use the header component to hold primary actions.\n- Use the header component at a visual high position at full width.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t overcrowd the header component with too many actions or information.\n- Don’t nest the header component too deeply and restrict its available space.\n\n</div>\n\n
|
|
6562
|
+
"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 header component to show a heading to describe the current view.\n- Use the header component to hold primary actions.\n- Use the header component at a visual high position at full width.\n- Utilise the [`n-truncate`](/css/#miscellaneous-utilities) CSS helper to prevent long headings from wrapping.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t overcrowd the header component with too many actions or information.\n- Don’t nest the header component too deeply and restrict its available space.\n- Don’t add large amounts of content or long headings. Aim for headings that are short and concise.\n\n</div>\n\n---\n\n## Content guidelines\n\nThe header component should be a containing element placed high on the page to present high level controls and to describe the page itself. It shouldn’t be overcrowded with controls or information.\n\n<div class=\"n-usage n-usage-do\">[Menu] Dashboard [Account] [Log out]</div>\n<div class=\"n-usage n-usage-dont\">[Menu] Use the cards below to view various information [Export] [Save] [Edit Profile] [Log out] [Preferences]</div>\n",
|
|
6563
6563
|
"examples": [],
|
|
6564
6564
|
"tagName": "nord-header",
|
|
6565
6565
|
"customElement": true
|
|
@@ -6586,190 +6586,497 @@
|
|
|
6586
6586
|
},
|
|
6587
6587
|
{
|
|
6588
6588
|
"kind": "javascript-module",
|
|
6589
|
-
"path": "src/
|
|
6589
|
+
"path": "src/icon/Icon.ts",
|
|
6590
6590
|
"declarations": [
|
|
6591
6591
|
{
|
|
6592
6592
|
"kind": "class",
|
|
6593
|
-
"description": "
|
|
6594
|
-
"name": "
|
|
6595
|
-
"
|
|
6593
|
+
"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.",
|
|
6594
|
+
"name": "Icon",
|
|
6595
|
+
"slots": [
|
|
6596
6596
|
{
|
|
6597
|
-
"description": "
|
|
6598
|
-
"name": "
|
|
6599
|
-
|
|
6600
|
-
|
|
6597
|
+
"description": "The default slot used for placing a custom SVG icon.",
|
|
6598
|
+
"name": ""
|
|
6599
|
+
}
|
|
6600
|
+
],
|
|
6601
|
+
"members": [
|
|
6601
6602
|
{
|
|
6602
|
-
"
|
|
6603
|
-
"name": "
|
|
6604
|
-
"
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
"description": "Controls the text color of the input, using our [color tokens](/tokens/#color).",
|
|
6608
|
-
"name": "--n-input-color",
|
|
6609
|
-
"default": "var(--n-color-text)"
|
|
6610
|
-
},
|
|
6611
|
-
{
|
|
6612
|
-
"description": "Controls the border color of the input, using our [color tokens](/tokens/#color).",
|
|
6613
|
-
"name": "--n-input-border-color",
|
|
6614
|
-
"default": "var(--n-color-border-strong)"
|
|
6615
|
-
},
|
|
6616
|
-
{
|
|
6617
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
6618
|
-
"name": "--n-input-border-radius",
|
|
6619
|
-
"default": "var(--n-border-radius-s)"
|
|
6620
|
-
}
|
|
6621
|
-
],
|
|
6622
|
-
"slots": [
|
|
6623
|
-
{
|
|
6624
|
-
"description": "Use when a label requires more than plain text.",
|
|
6625
|
-
"name": "label"
|
|
6626
|
-
},
|
|
6627
|
-
{
|
|
6628
|
-
"description": "Optional slot that holds hint text for the input.",
|
|
6629
|
-
"name": "hint"
|
|
6630
|
-
},
|
|
6631
|
-
{
|
|
6632
|
-
"description": "Optional slot that holds error text for the input.",
|
|
6633
|
-
"name": "error"
|
|
6603
|
+
"kind": "field",
|
|
6604
|
+
"name": "manager",
|
|
6605
|
+
"privacy": "private",
|
|
6606
|
+
"static": true,
|
|
6607
|
+
"default": "new IconManager()"
|
|
6634
6608
|
},
|
|
6635
6609
|
{
|
|
6636
|
-
"
|
|
6637
|
-
"name": "
|
|
6610
|
+
"kind": "method",
|
|
6611
|
+
"name": "registerResolver",
|
|
6612
|
+
"static": true,
|
|
6613
|
+
"parameters": [
|
|
6614
|
+
{
|
|
6615
|
+
"name": "resolver",
|
|
6616
|
+
"type": {
|
|
6617
|
+
"text": "IconResolver"
|
|
6618
|
+
},
|
|
6619
|
+
"description": "The resolver function to register."
|
|
6620
|
+
}
|
|
6621
|
+
],
|
|
6622
|
+
"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."
|
|
6638
6623
|
},
|
|
6639
6624
|
{
|
|
6640
|
-
"
|
|
6641
|
-
"name": "
|
|
6642
|
-
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
|
|
6646
|
-
|
|
6647
|
-
|
|
6648
|
-
"
|
|
6649
|
-
|
|
6625
|
+
"kind": "method",
|
|
6626
|
+
"name": "registerIcon",
|
|
6627
|
+
"static": true,
|
|
6628
|
+
"return": {
|
|
6629
|
+
"type": {
|
|
6630
|
+
"text": "void"
|
|
6631
|
+
}
|
|
6632
|
+
},
|
|
6633
|
+
"parameters": [
|
|
6634
|
+
{
|
|
6635
|
+
"name": "icon",
|
|
6636
|
+
"type": {
|
|
6637
|
+
"text": "{ title: string; default: string }"
|
|
6638
|
+
},
|
|
6639
|
+
"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."
|
|
6640
|
+
}
|
|
6641
|
+
],
|
|
6642
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
6650
6643
|
},
|
|
6651
6644
|
{
|
|
6652
|
-
"kind": "
|
|
6653
|
-
"name": "
|
|
6654
|
-
"
|
|
6655
|
-
"
|
|
6645
|
+
"kind": "method",
|
|
6646
|
+
"name": "registerIcon",
|
|
6647
|
+
"static": true,
|
|
6648
|
+
"return": {
|
|
6649
|
+
"type": {
|
|
6650
|
+
"text": "void"
|
|
6651
|
+
}
|
|
6652
|
+
},
|
|
6653
|
+
"parameters": [
|
|
6654
|
+
{
|
|
6655
|
+
"name": "name",
|
|
6656
|
+
"type": {
|
|
6657
|
+
"text": "string"
|
|
6658
|
+
},
|
|
6659
|
+
"description": "The name of the icon to be registered."
|
|
6660
|
+
},
|
|
6661
|
+
{
|
|
6662
|
+
"name": "icon",
|
|
6663
|
+
"type": {
|
|
6664
|
+
"text": "string"
|
|
6665
|
+
},
|
|
6666
|
+
"description": "The SVG string for the icon."
|
|
6667
|
+
}
|
|
6668
|
+
],
|
|
6669
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
6656
6670
|
},
|
|
6657
6671
|
{
|
|
6658
|
-
"kind": "
|
|
6659
|
-
"name": "
|
|
6660
|
-
"
|
|
6661
|
-
"
|
|
6672
|
+
"kind": "method",
|
|
6673
|
+
"name": "registerIcon",
|
|
6674
|
+
"static": true,
|
|
6675
|
+
"parameters": [
|
|
6676
|
+
{
|
|
6677
|
+
"name": "iconOrName",
|
|
6678
|
+
"type": {
|
|
6679
|
+
"text": "string | { title: string; default: string }"
|
|
6680
|
+
},
|
|
6681
|
+
"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."
|
|
6682
|
+
},
|
|
6683
|
+
{
|
|
6684
|
+
"name": "icon",
|
|
6685
|
+
"optional": true,
|
|
6686
|
+
"type": {
|
|
6687
|
+
"text": "string"
|
|
6688
|
+
},
|
|
6689
|
+
"description": "The SVG string for the icon."
|
|
6690
|
+
}
|
|
6691
|
+
],
|
|
6692
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
6662
6693
|
},
|
|
6663
6694
|
{
|
|
6664
6695
|
"kind": "field",
|
|
6665
|
-
"name": "
|
|
6696
|
+
"name": "name",
|
|
6666
6697
|
"type": {
|
|
6667
|
-
"text": "
|
|
6698
|
+
"text": "string"
|
|
6668
6699
|
},
|
|
6669
|
-
"default": "\"
|
|
6670
|
-
"description": "The
|
|
6671
|
-
"attribute": "
|
|
6700
|
+
"default": "\"\"",
|
|
6701
|
+
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
6702
|
+
"attribute": "name",
|
|
6672
6703
|
"reflects": true
|
|
6673
6704
|
},
|
|
6674
6705
|
{
|
|
6675
6706
|
"kind": "field",
|
|
6676
|
-
"name": "
|
|
6707
|
+
"name": "size",
|
|
6677
6708
|
"type": {
|
|
6678
|
-
"text": "
|
|
6709
|
+
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
6679
6710
|
},
|
|
6680
|
-
"
|
|
6681
|
-
"
|
|
6682
|
-
"attribute": "expand",
|
|
6711
|
+
"description": "The size of the icon.",
|
|
6712
|
+
"attribute": "size",
|
|
6683
6713
|
"reflects": true
|
|
6684
6714
|
},
|
|
6685
6715
|
{
|
|
6686
6716
|
"kind": "field",
|
|
6687
|
-
"name": "
|
|
6717
|
+
"name": "color",
|
|
6688
6718
|
"type": {
|
|
6689
6719
|
"text": "string | undefined"
|
|
6690
6720
|
},
|
|
6691
|
-
"
|
|
6692
|
-
"
|
|
6693
|
-
"attribute": "disallow-pattern",
|
|
6721
|
+
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
6722
|
+
"attribute": "color",
|
|
6694
6723
|
"reflects": true
|
|
6695
6724
|
},
|
|
6696
|
-
{
|
|
6697
|
-
"kind": "method",
|
|
6698
|
-
"name": "handleKeydown",
|
|
6699
|
-
"privacy": "private",
|
|
6700
|
-
"parameters": [
|
|
6701
|
-
{
|
|
6702
|
-
"name": "e",
|
|
6703
|
-
"type": {
|
|
6704
|
-
"text": "KeyboardEvent"
|
|
6705
|
-
}
|
|
6706
|
-
}
|
|
6707
|
-
]
|
|
6708
|
-
},
|
|
6709
6725
|
{
|
|
6710
6726
|
"kind": "field",
|
|
6711
|
-
"name": "
|
|
6712
|
-
"
|
|
6727
|
+
"name": "label",
|
|
6728
|
+
"type": {
|
|
6729
|
+
"text": "string | undefined"
|
|
6730
|
+
},
|
|
6731
|
+
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
6732
|
+
"attribute": "label",
|
|
6733
|
+
"reflects": true
|
|
6713
6734
|
},
|
|
6714
6735
|
{
|
|
6715
6736
|
"kind": "field",
|
|
6716
|
-
"name": "
|
|
6737
|
+
"name": "svg",
|
|
6717
6738
|
"type": {
|
|
6718
|
-
"text": "
|
|
6739
|
+
"text": "string"
|
|
6719
6740
|
},
|
|
6720
|
-
"
|
|
6721
|
-
"
|
|
6722
|
-
"attribute": "size",
|
|
6723
|
-
"reflects": true,
|
|
6724
|
-
"inheritedFrom": {
|
|
6725
|
-
"name": "SizeMixin",
|
|
6726
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
6727
|
-
}
|
|
6741
|
+
"privacy": "private",
|
|
6742
|
+
"default": "\"\""
|
|
6728
6743
|
},
|
|
6729
6744
|
{
|
|
6730
|
-
"kind": "
|
|
6731
|
-
"name": "
|
|
6732
|
-
"privacy": "protected"
|
|
6733
|
-
|
|
6734
|
-
|
|
6735
|
-
|
|
6736
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
6737
|
-
}
|
|
6738
|
-
},
|
|
6745
|
+
"kind": "method",
|
|
6746
|
+
"name": "handleNameChange",
|
|
6747
|
+
"privacy": "protected"
|
|
6748
|
+
}
|
|
6749
|
+
],
|
|
6750
|
+
"attributes": [
|
|
6739
6751
|
{
|
|
6740
|
-
"
|
|
6741
|
-
"
|
|
6742
|
-
|
|
6743
|
-
|
|
6744
|
-
"
|
|
6745
|
-
|
|
6746
|
-
|
|
6747
|
-
}
|
|
6752
|
+
"name": "name",
|
|
6753
|
+
"type": {
|
|
6754
|
+
"text": "string"
|
|
6755
|
+
},
|
|
6756
|
+
"default": "\"\"",
|
|
6757
|
+
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
6758
|
+
"fieldName": "name"
|
|
6748
6759
|
},
|
|
6749
6760
|
{
|
|
6750
|
-
"
|
|
6751
|
-
"
|
|
6752
|
-
|
|
6753
|
-
|
|
6754
|
-
"
|
|
6755
|
-
|
|
6756
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
6757
|
-
}
|
|
6761
|
+
"name": "size",
|
|
6762
|
+
"type": {
|
|
6763
|
+
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
6764
|
+
},
|
|
6765
|
+
"description": "The size of the icon.",
|
|
6766
|
+
"fieldName": "size"
|
|
6758
6767
|
},
|
|
6759
6768
|
{
|
|
6760
|
-
"
|
|
6761
|
-
"
|
|
6762
|
-
|
|
6763
|
-
|
|
6764
|
-
"
|
|
6765
|
-
|
|
6766
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
6767
|
-
}
|
|
6769
|
+
"name": "color",
|
|
6770
|
+
"type": {
|
|
6771
|
+
"text": "string | undefined"
|
|
6772
|
+
},
|
|
6773
|
+
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
6774
|
+
"fieldName": "color"
|
|
6768
6775
|
},
|
|
6769
6776
|
{
|
|
6770
|
-
"
|
|
6771
|
-
"
|
|
6772
|
-
|
|
6777
|
+
"name": "label",
|
|
6778
|
+
"type": {
|
|
6779
|
+
"text": "string | undefined"
|
|
6780
|
+
},
|
|
6781
|
+
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
6782
|
+
"fieldName": "label"
|
|
6783
|
+
}
|
|
6784
|
+
],
|
|
6785
|
+
"superclass": {
|
|
6786
|
+
"name": "LitElement",
|
|
6787
|
+
"package": "lit"
|
|
6788
|
+
},
|
|
6789
|
+
"localization": [],
|
|
6790
|
+
"status": "ready",
|
|
6791
|
+
"category": "image",
|
|
6792
|
+
"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",
|
|
6793
|
+
"examples": [],
|
|
6794
|
+
"tagName": "nord-icon",
|
|
6795
|
+
"customElement": true
|
|
6796
|
+
}
|
|
6797
|
+
],
|
|
6798
|
+
"exports": [
|
|
6799
|
+
{
|
|
6800
|
+
"kind": "js",
|
|
6801
|
+
"name": "default",
|
|
6802
|
+
"declaration": {
|
|
6803
|
+
"name": "Icon",
|
|
6804
|
+
"module": "src/icon/Icon.ts"
|
|
6805
|
+
}
|
|
6806
|
+
},
|
|
6807
|
+
{
|
|
6808
|
+
"kind": "custom-element-definition",
|
|
6809
|
+
"name": "nord-icon",
|
|
6810
|
+
"declaration": {
|
|
6811
|
+
"name": "Icon",
|
|
6812
|
+
"module": "src/icon/Icon.ts"
|
|
6813
|
+
}
|
|
6814
|
+
}
|
|
6815
|
+
]
|
|
6816
|
+
},
|
|
6817
|
+
{
|
|
6818
|
+
"kind": "javascript-module",
|
|
6819
|
+
"path": "src/icon/IconManager.ts",
|
|
6820
|
+
"declarations": [
|
|
6821
|
+
{
|
|
6822
|
+
"kind": "class",
|
|
6823
|
+
"description": "",
|
|
6824
|
+
"name": "IconManager",
|
|
6825
|
+
"members": [
|
|
6826
|
+
{
|
|
6827
|
+
"kind": "field",
|
|
6828
|
+
"name": "cache",
|
|
6829
|
+
"privacy": "private",
|
|
6830
|
+
"default": "new Map<string, string | Promise<string>>()"
|
|
6831
|
+
},
|
|
6832
|
+
{
|
|
6833
|
+
"kind": "field",
|
|
6834
|
+
"name": "resolver",
|
|
6835
|
+
"type": {
|
|
6836
|
+
"text": "IconResolver"
|
|
6837
|
+
}
|
|
6838
|
+
},
|
|
6839
|
+
{
|
|
6840
|
+
"kind": "method",
|
|
6841
|
+
"name": "resolve",
|
|
6842
|
+
"parameters": [
|
|
6843
|
+
{
|
|
6844
|
+
"name": "name",
|
|
6845
|
+
"type": {
|
|
6846
|
+
"text": "string"
|
|
6847
|
+
}
|
|
6848
|
+
},
|
|
6849
|
+
{
|
|
6850
|
+
"name": "onResolved",
|
|
6851
|
+
"type": {
|
|
6852
|
+
"text": "(svg: string) => void"
|
|
6853
|
+
}
|
|
6854
|
+
}
|
|
6855
|
+
]
|
|
6856
|
+
},
|
|
6857
|
+
{
|
|
6858
|
+
"kind": "method",
|
|
6859
|
+
"name": "registerIcon",
|
|
6860
|
+
"parameters": [
|
|
6861
|
+
{
|
|
6862
|
+
"name": "iconOrName",
|
|
6863
|
+
"type": {
|
|
6864
|
+
"text": "string | { title: string; default: string }"
|
|
6865
|
+
}
|
|
6866
|
+
},
|
|
6867
|
+
{
|
|
6868
|
+
"name": "icon",
|
|
6869
|
+
"optional": true,
|
|
6870
|
+
"type": {
|
|
6871
|
+
"text": "string"
|
|
6872
|
+
}
|
|
6873
|
+
}
|
|
6874
|
+
]
|
|
6875
|
+
},
|
|
6876
|
+
{
|
|
6877
|
+
"kind": "method",
|
|
6878
|
+
"name": "clear"
|
|
6879
|
+
}
|
|
6880
|
+
]
|
|
6881
|
+
}
|
|
6882
|
+
],
|
|
6883
|
+
"exports": [
|
|
6884
|
+
{
|
|
6885
|
+
"kind": "js",
|
|
6886
|
+
"name": "IconManager",
|
|
6887
|
+
"declaration": {
|
|
6888
|
+
"name": "IconManager",
|
|
6889
|
+
"module": "src/icon/IconManager.ts"
|
|
6890
|
+
}
|
|
6891
|
+
}
|
|
6892
|
+
]
|
|
6893
|
+
},
|
|
6894
|
+
{
|
|
6895
|
+
"kind": "javascript-module",
|
|
6896
|
+
"path": "src/input/Input.ts",
|
|
6897
|
+
"declarations": [
|
|
6898
|
+
{
|
|
6899
|
+
"kind": "class",
|
|
6900
|
+
"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.",
|
|
6901
|
+
"name": "Input",
|
|
6902
|
+
"cssProperties": [
|
|
6903
|
+
{
|
|
6904
|
+
"description": "Controls the inline size, or width, of the input.",
|
|
6905
|
+
"name": "--n-input-inline-size",
|
|
6906
|
+
"default": "240px"
|
|
6907
|
+
},
|
|
6908
|
+
{
|
|
6909
|
+
"description": "Controls the background of the input, using our [color tokens](/tokens/#color).",
|
|
6910
|
+
"name": "--n-input-background",
|
|
6911
|
+
"default": "var(--n-color-active)"
|
|
6912
|
+
},
|
|
6913
|
+
{
|
|
6914
|
+
"description": "Controls the text color of the input, using our [color tokens](/tokens/#color).",
|
|
6915
|
+
"name": "--n-input-color",
|
|
6916
|
+
"default": "var(--n-color-text)"
|
|
6917
|
+
},
|
|
6918
|
+
{
|
|
6919
|
+
"description": "Controls the border color of the input, using our [color tokens](/tokens/#color).",
|
|
6920
|
+
"name": "--n-input-border-color",
|
|
6921
|
+
"default": "var(--n-color-border-strong)"
|
|
6922
|
+
},
|
|
6923
|
+
{
|
|
6924
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
6925
|
+
"name": "--n-input-border-radius",
|
|
6926
|
+
"default": "var(--n-border-radius-s)"
|
|
6927
|
+
}
|
|
6928
|
+
],
|
|
6929
|
+
"slots": [
|
|
6930
|
+
{
|
|
6931
|
+
"description": "Use when a label requires more than plain text.",
|
|
6932
|
+
"name": "label"
|
|
6933
|
+
},
|
|
6934
|
+
{
|
|
6935
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
6936
|
+
"name": "hint"
|
|
6937
|
+
},
|
|
6938
|
+
{
|
|
6939
|
+
"description": "Optional slot that holds error text for the input.",
|
|
6940
|
+
"name": "error"
|
|
6941
|
+
},
|
|
6942
|
+
{
|
|
6943
|
+
"description": "Optional slot used to place an icon or prefix at the start of the input.",
|
|
6944
|
+
"name": "start"
|
|
6945
|
+
},
|
|
6946
|
+
{
|
|
6947
|
+
"description": "Optional slot used to place an icon or suffix at the end of the input.",
|
|
6948
|
+
"name": "end"
|
|
6949
|
+
}
|
|
6950
|
+
],
|
|
6951
|
+
"members": [
|
|
6952
|
+
{
|
|
6953
|
+
"kind": "field",
|
|
6954
|
+
"name": "startSlot",
|
|
6955
|
+
"privacy": "private",
|
|
6956
|
+
"default": "new SlotController(this, \"start\")"
|
|
6957
|
+
},
|
|
6958
|
+
{
|
|
6959
|
+
"kind": "field",
|
|
6960
|
+
"name": "endSlot",
|
|
6961
|
+
"privacy": "private",
|
|
6962
|
+
"default": "new SlotController(this, \"end\")"
|
|
6963
|
+
},
|
|
6964
|
+
{
|
|
6965
|
+
"kind": "field",
|
|
6966
|
+
"name": "direction",
|
|
6967
|
+
"privacy": "private",
|
|
6968
|
+
"default": "new DirectionController(this)"
|
|
6969
|
+
},
|
|
6970
|
+
{
|
|
6971
|
+
"kind": "field",
|
|
6972
|
+
"name": "type",
|
|
6973
|
+
"type": {
|
|
6974
|
+
"text": "\"text\" | \"email\" | \"password\" | \"tel\" | \"url\" | \"search\" | \"number\""
|
|
6975
|
+
},
|
|
6976
|
+
"default": "\"text\"",
|
|
6977
|
+
"description": "The type of the input.",
|
|
6978
|
+
"attribute": "type",
|
|
6979
|
+
"reflects": true
|
|
6980
|
+
},
|
|
6981
|
+
{
|
|
6982
|
+
"kind": "field",
|
|
6983
|
+
"name": "expand",
|
|
6984
|
+
"type": {
|
|
6985
|
+
"text": "boolean"
|
|
6986
|
+
},
|
|
6987
|
+
"default": "false",
|
|
6988
|
+
"description": "Controls whether the input expands to fill the width of its container.",
|
|
6989
|
+
"attribute": "expand",
|
|
6990
|
+
"reflects": true
|
|
6991
|
+
},
|
|
6992
|
+
{
|
|
6993
|
+
"kind": "field",
|
|
6994
|
+
"name": "disallowPattern",
|
|
6995
|
+
"type": {
|
|
6996
|
+
"text": "string | undefined"
|
|
6997
|
+
},
|
|
6998
|
+
"default": "undefined",
|
|
6999
|
+
"description": "Optionally disallow certain characters from being used inside the input, using a regex pattern.",
|
|
7000
|
+
"attribute": "disallow-pattern",
|
|
7001
|
+
"reflects": true
|
|
7002
|
+
},
|
|
7003
|
+
{
|
|
7004
|
+
"kind": "method",
|
|
7005
|
+
"name": "handleKeydown",
|
|
7006
|
+
"privacy": "private",
|
|
7007
|
+
"parameters": [
|
|
7008
|
+
{
|
|
7009
|
+
"name": "e",
|
|
7010
|
+
"type": {
|
|
7011
|
+
"text": "KeyboardEvent"
|
|
7012
|
+
}
|
|
7013
|
+
}
|
|
7014
|
+
]
|
|
7015
|
+
},
|
|
7016
|
+
{
|
|
7017
|
+
"kind": "field",
|
|
7018
|
+
"name": "handleInputChange",
|
|
7019
|
+
"privacy": "private"
|
|
7020
|
+
},
|
|
7021
|
+
{
|
|
7022
|
+
"kind": "field",
|
|
7023
|
+
"name": "size",
|
|
7024
|
+
"type": {
|
|
7025
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
7026
|
+
},
|
|
7027
|
+
"default": "\"m\"",
|
|
7028
|
+
"description": "The size of the component.",
|
|
7029
|
+
"attribute": "size",
|
|
7030
|
+
"reflects": true,
|
|
7031
|
+
"inheritedFrom": {
|
|
7032
|
+
"name": "SizeMixin",
|
|
7033
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
7034
|
+
}
|
|
7035
|
+
},
|
|
7036
|
+
{
|
|
7037
|
+
"kind": "field",
|
|
7038
|
+
"name": "labelSlot",
|
|
7039
|
+
"privacy": "protected",
|
|
7040
|
+
"default": "new SlotController(this, \"label\")",
|
|
7041
|
+
"inheritedFrom": {
|
|
7042
|
+
"name": "FormAssociatedMixin",
|
|
7043
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7044
|
+
}
|
|
7045
|
+
},
|
|
7046
|
+
{
|
|
7047
|
+
"kind": "field",
|
|
7048
|
+
"name": "errorSlot",
|
|
7049
|
+
"privacy": "protected",
|
|
7050
|
+
"default": "new SlotController(this, \"error\")",
|
|
7051
|
+
"inheritedFrom": {
|
|
7052
|
+
"name": "FormAssociatedMixin",
|
|
7053
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7054
|
+
}
|
|
7055
|
+
},
|
|
7056
|
+
{
|
|
7057
|
+
"kind": "field",
|
|
7058
|
+
"name": "hintSlot",
|
|
7059
|
+
"privacy": "protected",
|
|
7060
|
+
"default": "new SlotController(this, \"hint\")",
|
|
7061
|
+
"inheritedFrom": {
|
|
7062
|
+
"name": "FormAssociatedMixin",
|
|
7063
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7064
|
+
}
|
|
7065
|
+
},
|
|
7066
|
+
{
|
|
7067
|
+
"kind": "field",
|
|
7068
|
+
"name": "formData",
|
|
7069
|
+
"privacy": "protected",
|
|
7070
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
7071
|
+
"inheritedFrom": {
|
|
7072
|
+
"name": "FormAssociatedMixin",
|
|
7073
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7074
|
+
}
|
|
7075
|
+
},
|
|
7076
|
+
{
|
|
7077
|
+
"kind": "field",
|
|
7078
|
+
"name": "formValue",
|
|
7079
|
+
"privacy": "protected",
|
|
6773
7080
|
"inheritedFrom": {
|
|
6774
7081
|
"name": "FormAssociatedMixin",
|
|
6775
7082
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -7064,550 +7371,296 @@
|
|
|
7064
7371
|
}
|
|
7065
7372
|
},
|
|
7066
7373
|
{
|
|
7067
|
-
"kind": "field",
|
|
7068
|
-
"name": "value",
|
|
7069
|
-
"type": {
|
|
7070
|
-
"text": "string"
|
|
7071
|
-
},
|
|
7072
|
-
"default": "\"\"",
|
|
7073
|
-
"description": "The value of the form component.",
|
|
7074
|
-
"attribute": "value",
|
|
7075
|
-
"inheritedFrom": {
|
|
7076
|
-
"name": "InputMixin",
|
|
7077
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
7078
|
-
}
|
|
7079
|
-
},
|
|
7080
|
-
{
|
|
7081
|
-
"kind": "field",
|
|
7082
|
-
"name": "form",
|
|
7083
|
-
"description": "Gets the form, if any, associated with the form element.",
|
|
7084
|
-
"inheritedFrom": {
|
|
7085
|
-
"name": "InputMixin",
|
|
7086
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
7087
|
-
}
|
|
7088
|
-
},
|
|
7089
|
-
{
|
|
7090
|
-
"kind": "field",
|
|
7091
|
-
"name": "focusableRef",
|
|
7092
|
-
"privacy": "protected",
|
|
7093
|
-
"inheritedFrom": {
|
|
7094
|
-
"name": "FocusableMixin",
|
|
7095
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7096
|
-
}
|
|
7097
|
-
},
|
|
7098
|
-
{
|
|
7099
|
-
"kind": "method",
|
|
7100
|
-
"name": "focus",
|
|
7101
|
-
"parameters": [
|
|
7102
|
-
{
|
|
7103
|
-
"name": "options",
|
|
7104
|
-
"optional": true,
|
|
7105
|
-
"type": {
|
|
7106
|
-
"text": "FocusOptions"
|
|
7107
|
-
},
|
|
7108
|
-
"description": "An object which controls aspects of the focusing process."
|
|
7109
|
-
}
|
|
7110
|
-
],
|
|
7111
|
-
"description": "Programmatically move focus to the component.",
|
|
7112
|
-
"inheritedFrom": {
|
|
7113
|
-
"name": "FocusableMixin",
|
|
7114
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7115
|
-
}
|
|
7116
|
-
},
|
|
7117
|
-
{
|
|
7118
|
-
"kind": "method",
|
|
7119
|
-
"name": "blur",
|
|
7120
|
-
"description": "Programmatically remove focus from the component.",
|
|
7121
|
-
"inheritedFrom": {
|
|
7122
|
-
"name": "FocusableMixin",
|
|
7123
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7124
|
-
}
|
|
7125
|
-
},
|
|
7126
|
-
{
|
|
7127
|
-
"kind": "method",
|
|
7128
|
-
"name": "click",
|
|
7129
|
-
"description": "Programmatically simulates a click on the component.",
|
|
7130
|
-
"inheritedFrom": {
|
|
7131
|
-
"name": "FocusableMixin",
|
|
7132
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7133
|
-
}
|
|
7134
|
-
}
|
|
7135
|
-
],
|
|
7136
|
-
"attributes": [
|
|
7137
|
-
{
|
|
7138
|
-
"name": "type",
|
|
7139
|
-
"type": {
|
|
7140
|
-
"text": "\"text\" | \"email\" | \"password\" | \"tel\" | \"url\" | \"search\" | \"number\""
|
|
7141
|
-
},
|
|
7142
|
-
"default": "\"text\"",
|
|
7143
|
-
"description": "The type of the input.",
|
|
7144
|
-
"fieldName": "type"
|
|
7145
|
-
},
|
|
7146
|
-
{
|
|
7147
|
-
"name": "expand",
|
|
7148
|
-
"type": {
|
|
7149
|
-
"text": "boolean"
|
|
7150
|
-
},
|
|
7151
|
-
"default": "false",
|
|
7152
|
-
"description": "Controls whether the input expands to fill the width of its container.",
|
|
7153
|
-
"fieldName": "expand"
|
|
7154
|
-
},
|
|
7155
|
-
{
|
|
7156
|
-
"name": "disallow-pattern",
|
|
7157
|
-
"type": {
|
|
7158
|
-
"text": "string | undefined"
|
|
7159
|
-
},
|
|
7160
|
-
"default": "undefined",
|
|
7161
|
-
"description": "Optionally disallow certain characters from being used inside the input, using a regex pattern.",
|
|
7162
|
-
"resolveInitializer": {
|
|
7163
|
-
"module": "src/input/Input.ts"
|
|
7164
|
-
},
|
|
7165
|
-
"fieldName": "disallowPattern"
|
|
7166
|
-
},
|
|
7167
|
-
{
|
|
7168
|
-
"name": "size",
|
|
7169
|
-
"type": {
|
|
7170
|
-
"text": "\"s\" | \"m\" | \"l\""
|
|
7171
|
-
},
|
|
7172
|
-
"default": "\"m\"",
|
|
7173
|
-
"description": "The size of the component.",
|
|
7174
|
-
"fieldName": "size",
|
|
7175
|
-
"inheritedFrom": {
|
|
7176
|
-
"name": "SizeMixin",
|
|
7177
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
7178
|
-
}
|
|
7179
|
-
},
|
|
7180
|
-
{
|
|
7181
|
-
"name": "label",
|
|
7182
|
-
"type": {
|
|
7183
|
-
"text": "string"
|
|
7184
|
-
},
|
|
7185
|
-
"default": "\"\"",
|
|
7186
|
-
"description": "Label for the input.",
|
|
7187
|
-
"fieldName": "label",
|
|
7188
|
-
"inheritedFrom": {
|
|
7189
|
-
"name": "FormAssociatedMixin",
|
|
7190
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7191
|
-
}
|
|
7192
|
-
},
|
|
7193
|
-
{
|
|
7194
|
-
"name": "hint",
|
|
7195
|
-
"type": {
|
|
7196
|
-
"text": "string | undefined"
|
|
7197
|
-
},
|
|
7198
|
-
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
7199
|
-
"fieldName": "hint",
|
|
7200
|
-
"inheritedFrom": {
|
|
7201
|
-
"name": "FormAssociatedMixin",
|
|
7202
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7203
|
-
}
|
|
7204
|
-
},
|
|
7205
|
-
{
|
|
7206
|
-
"name": "hide-label",
|
|
7207
|
-
"type": {
|
|
7208
|
-
"text": "boolean"
|
|
7209
|
-
},
|
|
7210
|
-
"default": "false",
|
|
7211
|
-
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
7212
|
-
"fieldName": "hideLabel",
|
|
7213
|
-
"inheritedFrom": {
|
|
7214
|
-
"name": "FormAssociatedMixin",
|
|
7215
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7216
|
-
}
|
|
7217
|
-
},
|
|
7218
|
-
{
|
|
7219
|
-
"name": "placeholder",
|
|
7220
|
-
"type": {
|
|
7221
|
-
"text": "string | undefined"
|
|
7222
|
-
},
|
|
7223
|
-
"description": "Placeholder text to display within the input.",
|
|
7224
|
-
"fieldName": "placeholder",
|
|
7225
|
-
"inheritedFrom": {
|
|
7226
|
-
"name": "FormAssociatedMixin",
|
|
7227
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7228
|
-
}
|
|
7229
|
-
},
|
|
7230
|
-
{
|
|
7231
|
-
"name": "error",
|
|
7232
|
-
"type": {
|
|
7233
|
-
"text": "string | undefined"
|
|
7234
|
-
},
|
|
7235
|
-
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
7236
|
-
"fieldName": "error",
|
|
7237
|
-
"inheritedFrom": {
|
|
7238
|
-
"name": "FormAssociatedMixin",
|
|
7239
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7240
|
-
}
|
|
7241
|
-
},
|
|
7242
|
-
{
|
|
7243
|
-
"name": "required",
|
|
7244
|
-
"type": {
|
|
7245
|
-
"text": "boolean"
|
|
7246
|
-
},
|
|
7247
|
-
"default": "false",
|
|
7248
|
-
"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.",
|
|
7249
|
-
"fieldName": "required",
|
|
7250
|
-
"inheritedFrom": {
|
|
7251
|
-
"name": "FormAssociatedMixin",
|
|
7252
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7253
|
-
}
|
|
7254
|
-
},
|
|
7255
|
-
{
|
|
7256
|
-
"name": "hide-required",
|
|
7257
|
-
"type": {
|
|
7258
|
-
"text": "boolean"
|
|
7259
|
-
},
|
|
7260
|
-
"default": "false",
|
|
7261
|
-
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
7262
|
-
"fieldName": "hideRequired",
|
|
7263
|
-
"inheritedFrom": {
|
|
7264
|
-
"name": "FormAssociatedMixin",
|
|
7265
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7266
|
-
}
|
|
7267
|
-
},
|
|
7268
|
-
{
|
|
7269
|
-
"name": "autocomplete",
|
|
7270
|
-
"type": {
|
|
7271
|
-
"text": "AutocompleteAttribute"
|
|
7272
|
-
},
|
|
7273
|
-
"default": "\"off\"",
|
|
7274
|
-
"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.",
|
|
7275
|
-
"fieldName": "autocomplete",
|
|
7276
|
-
"inheritedFrom": {
|
|
7277
|
-
"name": "AutocompleteMixin",
|
|
7278
|
-
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
7279
|
-
}
|
|
7280
|
-
},
|
|
7281
|
-
{
|
|
7282
|
-
"name": "readonly",
|
|
7283
|
-
"type": {
|
|
7284
|
-
"text": "boolean"
|
|
7285
|
-
},
|
|
7286
|
-
"default": "false",
|
|
7287
|
-
"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.",
|
|
7288
|
-
"fieldName": "readonly",
|
|
7289
|
-
"inheritedFrom": {
|
|
7290
|
-
"name": "ReadonlyMixin",
|
|
7291
|
-
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
7292
|
-
}
|
|
7293
|
-
},
|
|
7294
|
-
{
|
|
7295
|
-
"name": "disabled",
|
|
7296
|
-
"type": {
|
|
7297
|
-
"text": "boolean"
|
|
7298
|
-
},
|
|
7299
|
-
"default": "false",
|
|
7300
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
7301
|
-
"fieldName": "disabled",
|
|
7302
|
-
"inheritedFrom": {
|
|
7303
|
-
"name": "InputMixin",
|
|
7304
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
7305
|
-
}
|
|
7306
|
-
},
|
|
7307
|
-
{
|
|
7308
|
-
"name": "name",
|
|
7309
|
-
"type": {
|
|
7310
|
-
"text": "string | undefined"
|
|
7311
|
-
},
|
|
7312
|
-
"description": "The name of the form component.",
|
|
7313
|
-
"fieldName": "name",
|
|
7314
|
-
"inheritedFrom": {
|
|
7315
|
-
"name": "InputMixin",
|
|
7316
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
7317
|
-
}
|
|
7318
|
-
},
|
|
7319
|
-
{
|
|
7374
|
+
"kind": "field",
|
|
7320
7375
|
"name": "value",
|
|
7321
7376
|
"type": {
|
|
7322
7377
|
"text": "string"
|
|
7323
7378
|
},
|
|
7324
7379
|
"default": "\"\"",
|
|
7325
7380
|
"description": "The value of the form component.",
|
|
7326
|
-
"
|
|
7381
|
+
"attribute": "value",
|
|
7327
7382
|
"inheritedFrom": {
|
|
7328
7383
|
"name": "InputMixin",
|
|
7329
7384
|
"module": "src/common/mixins/InputMixin.ts"
|
|
7330
7385
|
}
|
|
7331
|
-
}
|
|
7332
|
-
],
|
|
7333
|
-
"mixins": [
|
|
7334
|
-
{
|
|
7335
|
-
"name": "SizeMixin",
|
|
7336
|
-
"module": "/src/common/mixins/SizeMixin.js"
|
|
7337
7386
|
},
|
|
7338
7387
|
{
|
|
7339
|
-
"
|
|
7340
|
-
"
|
|
7388
|
+
"kind": "field",
|
|
7389
|
+
"name": "form",
|
|
7390
|
+
"description": "Gets the form, if any, associated with the form element.",
|
|
7391
|
+
"inheritedFrom": {
|
|
7392
|
+
"name": "InputMixin",
|
|
7393
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7394
|
+
}
|
|
7341
7395
|
},
|
|
7342
7396
|
{
|
|
7343
|
-
"
|
|
7344
|
-
"
|
|
7397
|
+
"kind": "field",
|
|
7398
|
+
"name": "focusableRef",
|
|
7399
|
+
"privacy": "protected",
|
|
7400
|
+
"inheritedFrom": {
|
|
7401
|
+
"name": "FocusableMixin",
|
|
7402
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7403
|
+
}
|
|
7345
7404
|
},
|
|
7346
7405
|
{
|
|
7347
|
-
"
|
|
7348
|
-
"
|
|
7406
|
+
"kind": "method",
|
|
7407
|
+
"name": "focus",
|
|
7408
|
+
"parameters": [
|
|
7409
|
+
{
|
|
7410
|
+
"name": "options",
|
|
7411
|
+
"optional": true,
|
|
7412
|
+
"type": {
|
|
7413
|
+
"text": "FocusOptions"
|
|
7414
|
+
},
|
|
7415
|
+
"description": "An object which controls aspects of the focusing process."
|
|
7416
|
+
}
|
|
7417
|
+
],
|
|
7418
|
+
"description": "Programmatically move focus to the component.",
|
|
7419
|
+
"inheritedFrom": {
|
|
7420
|
+
"name": "FocusableMixin",
|
|
7421
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7422
|
+
}
|
|
7349
7423
|
},
|
|
7350
7424
|
{
|
|
7351
|
-
"
|
|
7352
|
-
"
|
|
7425
|
+
"kind": "method",
|
|
7426
|
+
"name": "blur",
|
|
7427
|
+
"description": "Programmatically remove focus from the component.",
|
|
7428
|
+
"inheritedFrom": {
|
|
7429
|
+
"name": "FocusableMixin",
|
|
7430
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7431
|
+
}
|
|
7353
7432
|
},
|
|
7354
7433
|
{
|
|
7355
|
-
"
|
|
7356
|
-
"
|
|
7434
|
+
"kind": "method",
|
|
7435
|
+
"name": "click",
|
|
7436
|
+
"description": "Programmatically simulates a click on the component.",
|
|
7437
|
+
"inheritedFrom": {
|
|
7438
|
+
"name": "FocusableMixin",
|
|
7439
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
7440
|
+
}
|
|
7357
7441
|
}
|
|
7358
7442
|
],
|
|
7359
|
-
"
|
|
7360
|
-
"name": "LitElement",
|
|
7361
|
-
"package": "lit"
|
|
7362
|
-
},
|
|
7363
|
-
"localization": [],
|
|
7364
|
-
"status": "ready",
|
|
7365
|
-
"category": "form",
|
|
7366
|
-
"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## 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",
|
|
7367
|
-
"examples": [],
|
|
7368
|
-
"tagName": "nord-input",
|
|
7369
|
-
"customElement": true,
|
|
7370
|
-
"events": [
|
|
7443
|
+
"attributes": [
|
|
7371
7444
|
{
|
|
7372
|
-
"name": "
|
|
7445
|
+
"name": "type",
|
|
7373
7446
|
"type": {
|
|
7374
|
-
"text": "
|
|
7447
|
+
"text": "\"text\" | \"email\" | \"password\" | \"tel\" | \"url\" | \"search\" | \"number\""
|
|
7375
7448
|
},
|
|
7376
|
-
"
|
|
7377
|
-
"
|
|
7378
|
-
|
|
7379
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7380
|
-
}
|
|
7449
|
+
"default": "\"text\"",
|
|
7450
|
+
"description": "The type of the input.",
|
|
7451
|
+
"fieldName": "type"
|
|
7381
7452
|
},
|
|
7382
7453
|
{
|
|
7383
|
-
"name": "
|
|
7454
|
+
"name": "expand",
|
|
7384
7455
|
"type": {
|
|
7385
|
-
"text": "
|
|
7456
|
+
"text": "boolean"
|
|
7386
7457
|
},
|
|
7387
|
-
"
|
|
7388
|
-
"
|
|
7389
|
-
|
|
7390
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7391
|
-
}
|
|
7392
|
-
}
|
|
7393
|
-
]
|
|
7394
|
-
}
|
|
7395
|
-
],
|
|
7396
|
-
"exports": [
|
|
7397
|
-
{
|
|
7398
|
-
"kind": "js",
|
|
7399
|
-
"name": "default",
|
|
7400
|
-
"declaration": {
|
|
7401
|
-
"name": "Input",
|
|
7402
|
-
"module": "src/input/Input.ts"
|
|
7403
|
-
}
|
|
7404
|
-
},
|
|
7405
|
-
{
|
|
7406
|
-
"kind": "custom-element-definition",
|
|
7407
|
-
"name": "nord-input",
|
|
7408
|
-
"declaration": {
|
|
7409
|
-
"name": "Input",
|
|
7410
|
-
"module": "src/input/Input.ts"
|
|
7411
|
-
}
|
|
7412
|
-
}
|
|
7413
|
-
]
|
|
7414
|
-
},
|
|
7415
|
-
{
|
|
7416
|
-
"kind": "javascript-module",
|
|
7417
|
-
"path": "src/icon/Icon.ts",
|
|
7418
|
-
"declarations": [
|
|
7419
|
-
{
|
|
7420
|
-
"kind": "class",
|
|
7421
|
-
"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.",
|
|
7422
|
-
"name": "Icon",
|
|
7423
|
-
"slots": [
|
|
7424
|
-
{
|
|
7425
|
-
"description": "The default slot used for placing a custom SVG icon.",
|
|
7426
|
-
"name": ""
|
|
7427
|
-
}
|
|
7428
|
-
],
|
|
7429
|
-
"members": [
|
|
7430
|
-
{
|
|
7431
|
-
"kind": "field",
|
|
7432
|
-
"name": "manager",
|
|
7433
|
-
"privacy": "private",
|
|
7434
|
-
"static": true,
|
|
7435
|
-
"default": "new IconManager()"
|
|
7458
|
+
"default": "false",
|
|
7459
|
+
"description": "Controls whether the input expands to fill the width of its container.",
|
|
7460
|
+
"fieldName": "expand"
|
|
7436
7461
|
},
|
|
7437
7462
|
{
|
|
7438
|
-
"
|
|
7439
|
-
"
|
|
7440
|
-
|
|
7441
|
-
|
|
7442
|
-
|
|
7443
|
-
|
|
7444
|
-
|
|
7445
|
-
|
|
7446
|
-
|
|
7447
|
-
|
|
7448
|
-
}
|
|
7449
|
-
],
|
|
7450
|
-
"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."
|
|
7463
|
+
"name": "disallow-pattern",
|
|
7464
|
+
"type": {
|
|
7465
|
+
"text": "string | undefined"
|
|
7466
|
+
},
|
|
7467
|
+
"default": "undefined",
|
|
7468
|
+
"description": "Optionally disallow certain characters from being used inside the input, using a regex pattern.",
|
|
7469
|
+
"resolveInitializer": {
|
|
7470
|
+
"module": "src/input/Input.ts"
|
|
7471
|
+
},
|
|
7472
|
+
"fieldName": "disallowPattern"
|
|
7451
7473
|
},
|
|
7452
7474
|
{
|
|
7453
|
-
"
|
|
7454
|
-
"
|
|
7455
|
-
|
|
7456
|
-
"return": {
|
|
7457
|
-
"type": {
|
|
7458
|
-
"text": "void"
|
|
7459
|
-
}
|
|
7475
|
+
"name": "size",
|
|
7476
|
+
"type": {
|
|
7477
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
7460
7478
|
},
|
|
7461
|
-
"
|
|
7462
|
-
|
|
7463
|
-
|
|
7464
|
-
|
|
7465
|
-
|
|
7466
|
-
|
|
7467
|
-
|
|
7468
|
-
}
|
|
7469
|
-
],
|
|
7470
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
7479
|
+
"default": "\"m\"",
|
|
7480
|
+
"description": "The size of the component.",
|
|
7481
|
+
"fieldName": "size",
|
|
7482
|
+
"inheritedFrom": {
|
|
7483
|
+
"name": "SizeMixin",
|
|
7484
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
7485
|
+
}
|
|
7471
7486
|
},
|
|
7472
7487
|
{
|
|
7473
|
-
"
|
|
7474
|
-
"
|
|
7475
|
-
|
|
7476
|
-
"return": {
|
|
7477
|
-
"type": {
|
|
7478
|
-
"text": "void"
|
|
7479
|
-
}
|
|
7488
|
+
"name": "label",
|
|
7489
|
+
"type": {
|
|
7490
|
+
"text": "string"
|
|
7480
7491
|
},
|
|
7481
|
-
"
|
|
7482
|
-
|
|
7483
|
-
|
|
7484
|
-
|
|
7485
|
-
|
|
7486
|
-
|
|
7487
|
-
|
|
7488
|
-
},
|
|
7489
|
-
{
|
|
7490
|
-
"name": "icon",
|
|
7491
|
-
"type": {
|
|
7492
|
-
"text": "string"
|
|
7493
|
-
},
|
|
7494
|
-
"description": "The SVG string for the icon."
|
|
7495
|
-
}
|
|
7496
|
-
],
|
|
7497
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
7492
|
+
"default": "\"\"",
|
|
7493
|
+
"description": "Label for the input.",
|
|
7494
|
+
"fieldName": "label",
|
|
7495
|
+
"inheritedFrom": {
|
|
7496
|
+
"name": "FormAssociatedMixin",
|
|
7497
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7498
|
+
}
|
|
7498
7499
|
},
|
|
7499
7500
|
{
|
|
7500
|
-
"
|
|
7501
|
-
"
|
|
7502
|
-
|
|
7503
|
-
|
|
7504
|
-
|
|
7505
|
-
|
|
7506
|
-
|
|
7507
|
-
|
|
7508
|
-
|
|
7509
|
-
|
|
7510
|
-
},
|
|
7511
|
-
{
|
|
7512
|
-
"name": "icon",
|
|
7513
|
-
"optional": true,
|
|
7514
|
-
"type": {
|
|
7515
|
-
"text": "string"
|
|
7516
|
-
},
|
|
7517
|
-
"description": "The SVG string for the icon."
|
|
7518
|
-
}
|
|
7519
|
-
],
|
|
7520
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
7501
|
+
"name": "hint",
|
|
7502
|
+
"type": {
|
|
7503
|
+
"text": "string | undefined"
|
|
7504
|
+
},
|
|
7505
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
7506
|
+
"fieldName": "hint",
|
|
7507
|
+
"inheritedFrom": {
|
|
7508
|
+
"name": "FormAssociatedMixin",
|
|
7509
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7510
|
+
}
|
|
7521
7511
|
},
|
|
7522
7512
|
{
|
|
7523
|
-
"
|
|
7524
|
-
"name": "name",
|
|
7513
|
+
"name": "hide-label",
|
|
7525
7514
|
"type": {
|
|
7526
|
-
"text": "
|
|
7515
|
+
"text": "boolean"
|
|
7527
7516
|
},
|
|
7528
|
-
"default": "
|
|
7529
|
-
"description": "
|
|
7530
|
-
"
|
|
7531
|
-
"
|
|
7517
|
+
"default": "false",
|
|
7518
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
7519
|
+
"fieldName": "hideLabel",
|
|
7520
|
+
"inheritedFrom": {
|
|
7521
|
+
"name": "FormAssociatedMixin",
|
|
7522
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7523
|
+
}
|
|
7532
7524
|
},
|
|
7533
7525
|
{
|
|
7534
|
-
"
|
|
7535
|
-
"name": "size",
|
|
7526
|
+
"name": "placeholder",
|
|
7536
7527
|
"type": {
|
|
7537
|
-
"text": "
|
|
7528
|
+
"text": "string | undefined"
|
|
7538
7529
|
},
|
|
7539
|
-
"description": "
|
|
7540
|
-
"
|
|
7541
|
-
"
|
|
7530
|
+
"description": "Placeholder text to display within the input.",
|
|
7531
|
+
"fieldName": "placeholder",
|
|
7532
|
+
"inheritedFrom": {
|
|
7533
|
+
"name": "FormAssociatedMixin",
|
|
7534
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7535
|
+
}
|
|
7542
7536
|
},
|
|
7543
7537
|
{
|
|
7544
|
-
"
|
|
7545
|
-
"name": "color",
|
|
7538
|
+
"name": "error",
|
|
7546
7539
|
"type": {
|
|
7547
7540
|
"text": "string | undefined"
|
|
7548
7541
|
},
|
|
7549
|
-
"description": "
|
|
7550
|
-
"
|
|
7551
|
-
"
|
|
7542
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
7543
|
+
"fieldName": "error",
|
|
7544
|
+
"inheritedFrom": {
|
|
7545
|
+
"name": "FormAssociatedMixin",
|
|
7546
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7547
|
+
}
|
|
7552
7548
|
},
|
|
7553
7549
|
{
|
|
7554
|
-
"
|
|
7555
|
-
"name": "label",
|
|
7550
|
+
"name": "required",
|
|
7556
7551
|
"type": {
|
|
7557
|
-
"text": "
|
|
7552
|
+
"text": "boolean"
|
|
7558
7553
|
},
|
|
7559
|
-
"
|
|
7560
|
-
"
|
|
7561
|
-
"
|
|
7554
|
+
"default": "false",
|
|
7555
|
+
"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.",
|
|
7556
|
+
"fieldName": "required",
|
|
7557
|
+
"inheritedFrom": {
|
|
7558
|
+
"name": "FormAssociatedMixin",
|
|
7559
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7560
|
+
}
|
|
7562
7561
|
},
|
|
7563
7562
|
{
|
|
7564
|
-
"
|
|
7565
|
-
"name": "svg",
|
|
7563
|
+
"name": "hide-required",
|
|
7566
7564
|
"type": {
|
|
7567
|
-
"text": "
|
|
7565
|
+
"text": "boolean"
|
|
7568
7566
|
},
|
|
7569
|
-
"
|
|
7570
|
-
"
|
|
7567
|
+
"default": "false",
|
|
7568
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
7569
|
+
"fieldName": "hideRequired",
|
|
7570
|
+
"inheritedFrom": {
|
|
7571
|
+
"name": "FormAssociatedMixin",
|
|
7572
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7573
|
+
}
|
|
7571
7574
|
},
|
|
7572
7575
|
{
|
|
7573
|
-
"
|
|
7574
|
-
"
|
|
7575
|
-
|
|
7576
|
-
|
|
7577
|
-
|
|
7578
|
-
|
|
7576
|
+
"name": "autocomplete",
|
|
7577
|
+
"type": {
|
|
7578
|
+
"text": "AutocompleteAttribute"
|
|
7579
|
+
},
|
|
7580
|
+
"default": "\"off\"",
|
|
7581
|
+
"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.",
|
|
7582
|
+
"fieldName": "autocomplete",
|
|
7583
|
+
"inheritedFrom": {
|
|
7584
|
+
"name": "AutocompleteMixin",
|
|
7585
|
+
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
7586
|
+
}
|
|
7587
|
+
},
|
|
7579
7588
|
{
|
|
7580
|
-
"name": "
|
|
7589
|
+
"name": "readonly",
|
|
7581
7590
|
"type": {
|
|
7582
|
-
"text": "
|
|
7591
|
+
"text": "boolean"
|
|
7583
7592
|
},
|
|
7584
|
-
"default": "
|
|
7585
|
-
"description": "
|
|
7586
|
-
"fieldName": "
|
|
7593
|
+
"default": "false",
|
|
7594
|
+
"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.",
|
|
7595
|
+
"fieldName": "readonly",
|
|
7596
|
+
"inheritedFrom": {
|
|
7597
|
+
"name": "ReadonlyMixin",
|
|
7598
|
+
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
7599
|
+
}
|
|
7587
7600
|
},
|
|
7588
7601
|
{
|
|
7589
|
-
"name": "
|
|
7602
|
+
"name": "disabled",
|
|
7590
7603
|
"type": {
|
|
7591
|
-
"text": "
|
|
7604
|
+
"text": "boolean"
|
|
7592
7605
|
},
|
|
7593
|
-
"
|
|
7594
|
-
"
|
|
7606
|
+
"default": "false",
|
|
7607
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
7608
|
+
"fieldName": "disabled",
|
|
7609
|
+
"inheritedFrom": {
|
|
7610
|
+
"name": "InputMixin",
|
|
7611
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7612
|
+
}
|
|
7595
7613
|
},
|
|
7596
7614
|
{
|
|
7597
|
-
"name": "
|
|
7615
|
+
"name": "name",
|
|
7598
7616
|
"type": {
|
|
7599
7617
|
"text": "string | undefined"
|
|
7600
7618
|
},
|
|
7601
|
-
"description": "The
|
|
7602
|
-
"fieldName": "
|
|
7619
|
+
"description": "The name of the form component.",
|
|
7620
|
+
"fieldName": "name",
|
|
7621
|
+
"inheritedFrom": {
|
|
7622
|
+
"name": "InputMixin",
|
|
7623
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7624
|
+
}
|
|
7603
7625
|
},
|
|
7604
7626
|
{
|
|
7605
|
-
"name": "
|
|
7627
|
+
"name": "value",
|
|
7606
7628
|
"type": {
|
|
7607
|
-
"text": "string
|
|
7629
|
+
"text": "string"
|
|
7608
7630
|
},
|
|
7609
|
-
"
|
|
7610
|
-
"
|
|
7631
|
+
"default": "\"\"",
|
|
7632
|
+
"description": "The value of the form component.",
|
|
7633
|
+
"fieldName": "value",
|
|
7634
|
+
"inheritedFrom": {
|
|
7635
|
+
"name": "InputMixin",
|
|
7636
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7637
|
+
}
|
|
7638
|
+
}
|
|
7639
|
+
],
|
|
7640
|
+
"mixins": [
|
|
7641
|
+
{
|
|
7642
|
+
"name": "SizeMixin",
|
|
7643
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
7644
|
+
},
|
|
7645
|
+
{
|
|
7646
|
+
"name": "FormAssociatedMixin",
|
|
7647
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
7648
|
+
},
|
|
7649
|
+
{
|
|
7650
|
+
"name": "AutocompleteMixin",
|
|
7651
|
+
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
7652
|
+
},
|
|
7653
|
+
{
|
|
7654
|
+
"name": "ReadonlyMixin",
|
|
7655
|
+
"module": "/src/common/mixins/ReadonlyMixin.js"
|
|
7656
|
+
},
|
|
7657
|
+
{
|
|
7658
|
+
"name": "InputMixin",
|
|
7659
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
7660
|
+
},
|
|
7661
|
+
{
|
|
7662
|
+
"name": "FocusableMixin",
|
|
7663
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
7611
7664
|
}
|
|
7612
7665
|
],
|
|
7613
7666
|
"superclass": {
|
|
@@ -7616,94 +7669,33 @@
|
|
|
7616
7669
|
},
|
|
7617
7670
|
"localization": [],
|
|
7618
7671
|
"status": "ready",
|
|
7619
|
-
"category": "
|
|
7620
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<
|
|
7672
|
+
"category": "form",
|
|
7673
|
+
"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## 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",
|
|
7621
7674
|
"examples": [],
|
|
7622
|
-
"tagName": "nord-
|
|
7623
|
-
"customElement": true
|
|
7624
|
-
|
|
7625
|
-
],
|
|
7626
|
-
"exports": [
|
|
7627
|
-
{
|
|
7628
|
-
"kind": "js",
|
|
7629
|
-
"name": "default",
|
|
7630
|
-
"declaration": {
|
|
7631
|
-
"name": "Icon",
|
|
7632
|
-
"module": "src/icon/Icon.ts"
|
|
7633
|
-
}
|
|
7634
|
-
},
|
|
7635
|
-
{
|
|
7636
|
-
"kind": "custom-element-definition",
|
|
7637
|
-
"name": "nord-icon",
|
|
7638
|
-
"declaration": {
|
|
7639
|
-
"name": "Icon",
|
|
7640
|
-
"module": "src/icon/Icon.ts"
|
|
7641
|
-
}
|
|
7642
|
-
}
|
|
7643
|
-
]
|
|
7644
|
-
},
|
|
7645
|
-
{
|
|
7646
|
-
"kind": "javascript-module",
|
|
7647
|
-
"path": "src/icon/IconManager.ts",
|
|
7648
|
-
"declarations": [
|
|
7649
|
-
{
|
|
7650
|
-
"kind": "class",
|
|
7651
|
-
"description": "",
|
|
7652
|
-
"name": "IconManager",
|
|
7653
|
-
"members": [
|
|
7654
|
-
{
|
|
7655
|
-
"kind": "field",
|
|
7656
|
-
"name": "cache",
|
|
7657
|
-
"privacy": "private",
|
|
7658
|
-
"default": "new Map<string, string | Promise<string>>()"
|
|
7659
|
-
},
|
|
7675
|
+
"tagName": "nord-input",
|
|
7676
|
+
"customElement": true,
|
|
7677
|
+
"events": [
|
|
7660
7678
|
{
|
|
7661
|
-
"
|
|
7662
|
-
"name": "resolver",
|
|
7679
|
+
"name": "input",
|
|
7663
7680
|
"type": {
|
|
7664
|
-
"text": "
|
|
7665
|
-
}
|
|
7666
|
-
|
|
7667
|
-
|
|
7668
|
-
|
|
7669
|
-
|
|
7670
|
-
|
|
7671
|
-
{
|
|
7672
|
-
"name": "name",
|
|
7673
|
-
"type": {
|
|
7674
|
-
"text": "string"
|
|
7675
|
-
}
|
|
7676
|
-
},
|
|
7677
|
-
{
|
|
7678
|
-
"name": "onResolved",
|
|
7679
|
-
"type": {
|
|
7680
|
-
"text": "(svg: string) => void"
|
|
7681
|
-
}
|
|
7682
|
-
}
|
|
7683
|
-
]
|
|
7684
|
-
},
|
|
7685
|
-
{
|
|
7686
|
-
"kind": "method",
|
|
7687
|
-
"name": "registerIcon",
|
|
7688
|
-
"parameters": [
|
|
7689
|
-
{
|
|
7690
|
-
"name": "iconOrName",
|
|
7691
|
-
"type": {
|
|
7692
|
-
"text": "string | { title: string; default: string }"
|
|
7693
|
-
}
|
|
7694
|
-
},
|
|
7695
|
-
{
|
|
7696
|
-
"name": "icon",
|
|
7697
|
-
"optional": true,
|
|
7698
|
-
"type": {
|
|
7699
|
-
"text": "string"
|
|
7700
|
-
}
|
|
7701
|
-
}
|
|
7702
|
-
]
|
|
7681
|
+
"text": "NordEvent"
|
|
7682
|
+
},
|
|
7683
|
+
"description": "Fired as the user types into the input.",
|
|
7684
|
+
"inheritedFrom": {
|
|
7685
|
+
"name": "FormAssociatedMixin",
|
|
7686
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7687
|
+
}
|
|
7703
7688
|
},
|
|
7704
7689
|
{
|
|
7705
|
-
"
|
|
7706
|
-
"
|
|
7690
|
+
"name": "change",
|
|
7691
|
+
"type": {
|
|
7692
|
+
"text": "NordEvent"
|
|
7693
|
+
},
|
|
7694
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
7695
|
+
"inheritedFrom": {
|
|
7696
|
+
"name": "FormAssociatedMixin",
|
|
7697
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
7698
|
+
}
|
|
7707
7699
|
}
|
|
7708
7700
|
]
|
|
7709
7701
|
}
|
|
@@ -7711,10 +7703,18 @@
|
|
|
7711
7703
|
"exports": [
|
|
7712
7704
|
{
|
|
7713
7705
|
"kind": "js",
|
|
7714
|
-
"name": "
|
|
7706
|
+
"name": "default",
|
|
7715
7707
|
"declaration": {
|
|
7716
|
-
"name": "
|
|
7717
|
-
"module": "src/
|
|
7708
|
+
"name": "Input",
|
|
7709
|
+
"module": "src/input/Input.ts"
|
|
7710
|
+
}
|
|
7711
|
+
},
|
|
7712
|
+
{
|
|
7713
|
+
"kind": "custom-element-definition",
|
|
7714
|
+
"name": "nord-input",
|
|
7715
|
+
"declaration": {
|
|
7716
|
+
"name": "Input",
|
|
7717
|
+
"module": "src/input/Input.ts"
|
|
7718
7718
|
}
|
|
7719
7719
|
}
|
|
7720
7720
|
]
|
|
@@ -8188,679 +8188,746 @@
|
|
|
8188
8188
|
},
|
|
8189
8189
|
{
|
|
8190
8190
|
"kind": "javascript-module",
|
|
8191
|
-
"path": "src/
|
|
8191
|
+
"path": "src/modal/Modal.ts",
|
|
8192
8192
|
"declarations": [
|
|
8193
8193
|
{
|
|
8194
8194
|
"kind": "class",
|
|
8195
|
-
"description": "",
|
|
8196
|
-
"name": "
|
|
8195
|
+
"description": "Modal component is used to display content that temporarily blocks interactions\nwith the main view of an application. Modal should be used sparingly and\nonly when necessary.",
|
|
8196
|
+
"name": "Modal",
|
|
8197
|
+
"cssProperties": [
|
|
8198
|
+
{
|
|
8199
|
+
"description": "Controls the padding on the sides of the modal, using our [spacing tokens](/tokens/#space).",
|
|
8200
|
+
"name": "--n-modal-padding-inline",
|
|
8201
|
+
"default": "var(--n-space-m)"
|
|
8202
|
+
},
|
|
8203
|
+
{
|
|
8204
|
+
"description": "Controls the padding above and below the modal, using our [spacing tokens](/tokens/#space).",
|
|
8205
|
+
"name": "--n-modal-padding-block",
|
|
8206
|
+
"default": "var(--n-space-m)"
|
|
8207
|
+
},
|
|
8208
|
+
{
|
|
8209
|
+
"description": "Controls the width of the modal.",
|
|
8210
|
+
"name": "--n-modal-max-inline-size",
|
|
8211
|
+
"default": "620px"
|
|
8212
|
+
}
|
|
8213
|
+
],
|
|
8214
|
+
"slots": [
|
|
8215
|
+
{
|
|
8216
|
+
"description": "Default slot",
|
|
8217
|
+
"name": ""
|
|
8218
|
+
},
|
|
8219
|
+
{
|
|
8220
|
+
"description": "Slot which holds the header of the modal, positioned next to the close button.",
|
|
8221
|
+
"name": "header"
|
|
8222
|
+
},
|
|
8223
|
+
{
|
|
8224
|
+
"description": "Slot which is typically used to hold call to action buttons, but can also be used to build custom footers.",
|
|
8225
|
+
"name": "footer"
|
|
8226
|
+
}
|
|
8227
|
+
],
|
|
8197
8228
|
"members": [
|
|
8198
8229
|
{
|
|
8199
8230
|
"kind": "field",
|
|
8200
|
-
"name": "
|
|
8231
|
+
"name": "modal",
|
|
8201
8232
|
"type": {
|
|
8202
|
-
"text": "
|
|
8233
|
+
"text": "HTMLDivElement"
|
|
8203
8234
|
},
|
|
8204
8235
|
"privacy": "private"
|
|
8205
8236
|
},
|
|
8206
8237
|
{
|
|
8207
8238
|
"kind": "field",
|
|
8208
|
-
"name": "
|
|
8239
|
+
"name": "backdrop",
|
|
8209
8240
|
"type": {
|
|
8210
|
-
"text": "
|
|
8241
|
+
"text": "HTMLDivElement"
|
|
8211
8242
|
},
|
|
8212
8243
|
"privacy": "private"
|
|
8213
8244
|
},
|
|
8214
8245
|
{
|
|
8215
8246
|
"kind": "field",
|
|
8216
|
-
"name": "
|
|
8217
|
-
"
|
|
8247
|
+
"name": "headerSlot",
|
|
8248
|
+
"privacy": "private",
|
|
8249
|
+
"default": "new SlotController(this, \"header\")"
|
|
8218
8250
|
},
|
|
8219
8251
|
{
|
|
8220
8252
|
"kind": "field",
|
|
8221
|
-
"name": "
|
|
8222
|
-
"
|
|
8253
|
+
"name": "featureSlot",
|
|
8254
|
+
"privacy": "private",
|
|
8255
|
+
"default": "new SlotController(this, \"feature\")"
|
|
8223
8256
|
},
|
|
8224
8257
|
{
|
|
8225
|
-
"kind": "
|
|
8226
|
-
"name": "
|
|
8258
|
+
"kind": "field",
|
|
8259
|
+
"name": "footerSlot",
|
|
8260
|
+
"privacy": "private",
|
|
8261
|
+
"default": "new SlotController(this, \"footer\")"
|
|
8262
|
+
},
|
|
8263
|
+
{
|
|
8264
|
+
"kind": "field",
|
|
8265
|
+
"name": "localize",
|
|
8266
|
+
"privacy": "private",
|
|
8267
|
+
"default": "new LocalizeController<\"nord-modal\">(this)"
|
|
8268
|
+
},
|
|
8269
|
+
{
|
|
8270
|
+
"kind": "field",
|
|
8271
|
+
"name": "modalController",
|
|
8272
|
+
"privacy": "private",
|
|
8273
|
+
"default": "new ModalController(this, {\n isOpen: () => this.open,\n onDismiss: () => this.handleDismiss(),\n dialog: () => this.modal,\n backdrop: () => this.backdrop,\n close: returnValue => this.close(returnValue),\n })"
|
|
8274
|
+
},
|
|
8275
|
+
{
|
|
8276
|
+
"kind": "field",
|
|
8277
|
+
"name": "open",
|
|
8278
|
+
"type": {
|
|
8279
|
+
"text": "boolean"
|
|
8280
|
+
},
|
|
8281
|
+
"default": "false",
|
|
8282
|
+
"description": "Controls whether the modal is open or not.",
|
|
8283
|
+
"attribute": "open",
|
|
8284
|
+
"reflects": true
|
|
8285
|
+
},
|
|
8286
|
+
{
|
|
8287
|
+
"kind": "field",
|
|
8288
|
+
"name": "size",
|
|
8289
|
+
"type": {
|
|
8290
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
8291
|
+
},
|
|
8292
|
+
"default": "\"m\"",
|
|
8293
|
+
"description": "Controls the max-width of the modal when open.",
|
|
8294
|
+
"attribute": "size",
|
|
8295
|
+
"reflects": true
|
|
8296
|
+
},
|
|
8297
|
+
{
|
|
8298
|
+
"kind": "field",
|
|
8299
|
+
"name": "returnValue",
|
|
8300
|
+
"type": {
|
|
8301
|
+
"text": "string"
|
|
8302
|
+
},
|
|
8303
|
+
"default": "\"\"",
|
|
8304
|
+
"description": "The reason why the modal was closed. This typically indicates\nwhich button the user pressed to close the modal, though any value\ncan be supplied if the modal is programmatically closed."
|
|
8305
|
+
},
|
|
8306
|
+
{
|
|
8307
|
+
"kind": "field",
|
|
8308
|
+
"name": "scrollable",
|
|
8309
|
+
"type": {
|
|
8310
|
+
"text": "boolean"
|
|
8311
|
+
},
|
|
8312
|
+
"default": "false",
|
|
8313
|
+
"description": "By default if a modal is too big for the browser window,\nthe entire modal will scroll. This setting changes that behavior\nso that the body of the modal scrolls instead, with the modal\nitself remaining fixed.",
|
|
8314
|
+
"attribute": "scrollable",
|
|
8315
|
+
"reflects": true
|
|
8227
8316
|
},
|
|
8228
8317
|
{
|
|
8229
8318
|
"kind": "method",
|
|
8230
|
-
"name": "
|
|
8319
|
+
"name": "showModal",
|
|
8320
|
+
"description": "Show the modal, automatically moving focus to the modal or a child\nelement with an `autofocus` attribute."
|
|
8231
8321
|
},
|
|
8232
8322
|
{
|
|
8233
8323
|
"kind": "method",
|
|
8234
|
-
"name": "
|
|
8235
|
-
"return": {
|
|
8236
|
-
"type": {
|
|
8237
|
-
"text": "Result<Translation[TComponentName], Key>"
|
|
8238
|
-
}
|
|
8239
|
-
},
|
|
8324
|
+
"name": "close",
|
|
8240
8325
|
"parameters": [
|
|
8241
8326
|
{
|
|
8242
|
-
"name": "
|
|
8243
|
-
"
|
|
8244
|
-
"text": "Key"
|
|
8245
|
-
}
|
|
8246
|
-
},
|
|
8247
|
-
{
|
|
8248
|
-
"name": "args",
|
|
8327
|
+
"name": "returnValue",
|
|
8328
|
+
"optional": true,
|
|
8249
8329
|
"type": {
|
|
8250
|
-
"text": "
|
|
8251
|
-
}
|
|
8330
|
+
"text": "string"
|
|
8331
|
+
},
|
|
8332
|
+
"description": "An optional value to indicate why the modal was closed."
|
|
8252
8333
|
}
|
|
8253
|
-
]
|
|
8334
|
+
],
|
|
8335
|
+
"description": "Programmatically close the modal."
|
|
8254
8336
|
},
|
|
8255
8337
|
{
|
|
8256
|
-
"kind": "
|
|
8257
|
-
"name": "
|
|
8258
|
-
"
|
|
8259
|
-
|
|
8260
|
-
|
|
8261
|
-
|
|
8262
|
-
|
|
8263
|
-
|
|
8264
|
-
|
|
8265
|
-
|
|
8266
|
-
|
|
8267
|
-
|
|
8268
|
-
|
|
8269
|
-
|
|
8270
|
-
}
|
|
8271
|
-
}
|
|
8272
|
-
]
|
|
8273
|
-
},
|
|
8274
|
-
{
|
|
8275
|
-
"kind": "javascript-module",
|
|
8276
|
-
"path": "src/localization/en-us.ts",
|
|
8277
|
-
"declarations": [
|
|
8278
|
-
{
|
|
8279
|
-
"kind": "variable",
|
|
8280
|
-
"name": "en",
|
|
8281
|
-
"type": {
|
|
8282
|
-
"text": "object"
|
|
8283
|
-
},
|
|
8284
|
-
"default": "{\n $lang: \"en-US\",\n $name: \"English\",\n $dir: \"ltr\" as \"ltr\" | \"rtl\",\n \"nord-command-menu\": commandMenuLocalization,\n \"nord-calendar\": calendarLocalization,\n \"nord-date-picker\": datePickerLocalization,\n \"nord-modal\": modalLocalization,\n \"nord-nav-toggle\": navToggleLocalization,\n \"nord-textarea\": textareaLocalization,\n}"
|
|
8285
|
-
}
|
|
8286
|
-
],
|
|
8287
|
-
"exports": [
|
|
8288
|
-
{
|
|
8289
|
-
"kind": "js",
|
|
8290
|
-
"name": "default",
|
|
8291
|
-
"declaration": {
|
|
8292
|
-
"name": "en",
|
|
8293
|
-
"module": "src/localization/en-us.ts"
|
|
8294
|
-
}
|
|
8295
|
-
}
|
|
8296
|
-
]
|
|
8297
|
-
},
|
|
8298
|
-
{
|
|
8299
|
-
"kind": "javascript-module",
|
|
8300
|
-
"path": "src/localization/fi-fi.ts",
|
|
8301
|
-
"declarations": [
|
|
8302
|
-
{
|
|
8303
|
-
"kind": "variable",
|
|
8304
|
-
"name": "fi",
|
|
8305
|
-
"type": {
|
|
8306
|
-
"text": "Translation"
|
|
8307
|
-
},
|
|
8308
|
-
"default": "{\n $lang: \"fi\",\n $name: \"Suomi\",\n $dir: \"ltr\",\n\n \"nord-command-menu\": {\n instructions: \"Paina 'Enter' vahvistaaksesi valinnan tai 'Escape' peruuttaaksesi\",\n inputLabel: \"Kirjoita komento jonka haluat suorittaa.\",\n footerArrowKeys: \"Siirry\",\n footerEnterKey: \"Valitse\",\n footerEscapeKey: \"Esc sulje\",\n footerBackspaceKey: \"Siirry takaisin\",\n noResults: searchTerm => `Ei tuloksia haulle \"${searchTerm}\"`,\n tip: \"Vinkki: jotkin haut vaativat tarkan hakutermin. Koita kirjoittaa koko hakutermi kokonaisuudessaan, tai kokeile toista sanaa tai fraasia.\",\n },\n\n \"nord-calendar\": {\n prevMonthLabel: \"Edellinen kuukausi\",\n nextMonthLabel: \"Seuraava kuukausi\",\n monthSelectLabel: \"Kuukausi\",\n yearSelectLabel: \"Vuosi\",\n },\n\n \"nord-date-picker\": {\n modalHeading: \"Valitse päivämäärä\",\n closeLabel: \"Sulje ikkuna\",\n buttonLabel: \"Valitse päivämäärä\",\n selectedDateMessage: \"Valittu päivämäärä on\",\n },\n\n \"nord-modal\": {\n closeLabel: \"Sulje ikkuna\",\n },\n\n \"nord-nav-toggle\": {\n label: \"Näytä/Piilota valikko\",\n },\n\n \"nord-textarea\": {\n remainingCharacters: (remaining: number) => `${remaining} merkkiä jäljellä`,\n },\n}"
|
|
8309
|
-
}
|
|
8310
|
-
],
|
|
8311
|
-
"exports": [
|
|
8312
|
-
{
|
|
8313
|
-
"kind": "js",
|
|
8314
|
-
"name": "default",
|
|
8315
|
-
"declaration": {
|
|
8316
|
-
"name": "fi",
|
|
8317
|
-
"module": "src/localization/fi-fi.ts"
|
|
8318
|
-
}
|
|
8319
|
-
}
|
|
8320
|
-
]
|
|
8321
|
-
},
|
|
8322
|
-
{
|
|
8323
|
-
"kind": "javascript-module",
|
|
8324
|
-
"path": "src/localization/translation.ts",
|
|
8325
|
-
"declarations": [
|
|
8326
|
-
{
|
|
8327
|
-
"kind": "function",
|
|
8328
|
-
"name": "clearTranslations",
|
|
8329
|
-
"description": "Removes all registered translations"
|
|
8330
|
-
},
|
|
8331
|
-
{
|
|
8332
|
-
"kind": "function",
|
|
8333
|
-
"name": "registerTranslation",
|
|
8334
|
-
"parameters": [
|
|
8338
|
+
"kind": "method",
|
|
8339
|
+
"name": "focus",
|
|
8340
|
+
"parameters": [
|
|
8341
|
+
{
|
|
8342
|
+
"name": "options",
|
|
8343
|
+
"optional": true,
|
|
8344
|
+
"type": {
|
|
8345
|
+
"text": "FocusOptions"
|
|
8346
|
+
},
|
|
8347
|
+
"description": "An object which controls aspects of the focusing process."
|
|
8348
|
+
}
|
|
8349
|
+
],
|
|
8350
|
+
"description": "Programmatically focus the modal."
|
|
8351
|
+
},
|
|
8335
8352
|
{
|
|
8336
|
-
"
|
|
8337
|
-
"
|
|
8338
|
-
|
|
8339
|
-
|
|
8353
|
+
"kind": "method",
|
|
8354
|
+
"name": "handleOpenUpdated",
|
|
8355
|
+
"privacy": "protected",
|
|
8356
|
+
"parameters": [
|
|
8357
|
+
{
|
|
8358
|
+
"name": "prev",
|
|
8359
|
+
"type": {
|
|
8360
|
+
"text": "boolean"
|
|
8361
|
+
}
|
|
8362
|
+
}
|
|
8363
|
+
]
|
|
8364
|
+
},
|
|
8365
|
+
{
|
|
8366
|
+
"kind": "method",
|
|
8367
|
+
"name": "handleDismiss",
|
|
8368
|
+
"privacy": "private"
|
|
8340
8369
|
}
|
|
8341
8370
|
],
|
|
8342
|
-
"
|
|
8343
|
-
},
|
|
8344
|
-
{
|
|
8345
|
-
"kind": "function",
|
|
8346
|
-
"name": "subscribe",
|
|
8347
|
-
"return": {
|
|
8348
|
-
"type": {
|
|
8349
|
-
"text": ""
|
|
8350
|
-
}
|
|
8351
|
-
},
|
|
8352
|
-
"parameters": [
|
|
8371
|
+
"events": [
|
|
8353
8372
|
{
|
|
8354
|
-
"name": "
|
|
8373
|
+
"name": "close",
|
|
8355
8374
|
"type": {
|
|
8356
|
-
"text": "
|
|
8375
|
+
"text": "NordEvent"
|
|
8357
8376
|
},
|
|
8358
|
-
"description": "
|
|
8377
|
+
"description": "Dispatched when a modal is closed for any reason."
|
|
8378
|
+
},
|
|
8379
|
+
{
|
|
8380
|
+
"name": "cancel",
|
|
8381
|
+
"type": {
|
|
8382
|
+
"text": "NordEvent"
|
|
8383
|
+
},
|
|
8384
|
+
"description": "Dispatched before the modal has closed when a user attempts to dismiss a modal. Call `preventDefault()` on the event to prevent the modal closing."
|
|
8359
8385
|
}
|
|
8360
8386
|
],
|
|
8361
|
-
"
|
|
8362
|
-
},
|
|
8363
|
-
{
|
|
8364
|
-
"kind": "function",
|
|
8365
|
-
"name": "isTranslationRegistered",
|
|
8366
|
-
"parameters": [
|
|
8387
|
+
"attributes": [
|
|
8367
8388
|
{
|
|
8368
|
-
"name": "
|
|
8389
|
+
"name": "open",
|
|
8369
8390
|
"type": {
|
|
8370
|
-
"text": "
|
|
8391
|
+
"text": "boolean"
|
|
8371
8392
|
},
|
|
8372
|
-
"
|
|
8393
|
+
"default": "false",
|
|
8394
|
+
"description": "Controls whether the modal is open or not.",
|
|
8395
|
+
"fieldName": "open"
|
|
8396
|
+
},
|
|
8397
|
+
{
|
|
8398
|
+
"name": "size",
|
|
8399
|
+
"type": {
|
|
8400
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
8401
|
+
},
|
|
8402
|
+
"default": "\"m\"",
|
|
8403
|
+
"description": "Controls the max-width of the modal when open.",
|
|
8404
|
+
"fieldName": "size"
|
|
8405
|
+
},
|
|
8406
|
+
{
|
|
8407
|
+
"name": "scrollable",
|
|
8408
|
+
"type": {
|
|
8409
|
+
"text": "boolean"
|
|
8410
|
+
},
|
|
8411
|
+
"default": "false",
|
|
8412
|
+
"description": "By default if a modal is too big for the browser window,\nthe entire modal will scroll. This setting changes that behavior\nso that the body of the modal scrolls instead, with the modal\nitself remaining fixed.",
|
|
8413
|
+
"fieldName": "scrollable"
|
|
8373
8414
|
}
|
|
8374
8415
|
],
|
|
8375
|
-
"
|
|
8376
|
-
|
|
8377
|
-
|
|
8378
|
-
|
|
8379
|
-
"
|
|
8380
|
-
"parameters": [
|
|
8416
|
+
"superclass": {
|
|
8417
|
+
"name": "LitElement",
|
|
8418
|
+
"package": "lit"
|
|
8419
|
+
},
|
|
8420
|
+
"localization": [
|
|
8381
8421
|
{
|
|
8382
|
-
"name": "
|
|
8383
|
-
"
|
|
8384
|
-
"text": "string"
|
|
8385
|
-
}
|
|
8422
|
+
"name": "closeLabel",
|
|
8423
|
+
"description": "Accessible label for the close button."
|
|
8386
8424
|
}
|
|
8387
8425
|
],
|
|
8388
|
-
"
|
|
8426
|
+
"status": "ready",
|
|
8427
|
+
"category": "overlay",
|
|
8428
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for confirmations and conditional changes.\n- Use when the user is required to take an action.\n- Use when you need to display content that temporarily blocks interactions with the main view of an application.\n- Use when you need to ask a confirmation from a user before proceeding.\n- Use for important warnings, as a way to prevent or correct critical errors.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for nonessential information that is not related to the current userflow.\n- Don’t use when the modal requires additional information for decision making that is unavailable in the modal itself.\n- Don’t open a modal window on top of another modal.\n\n</div>\n\n---\n\n## Content guidelines\n\nModal title should be clear, accurate and predictable. Always lead with a strong verb that encourages action. To provide enough context to user, use the {verb} + {noun} content formula:\n\n<div class=\"n-usage n-usage-do\">Edit patient</div>\n<div class=\"n-usage n-usage-dont\">Edit the patient called John Doe</div>\n<div class=\"n-usage n-usage-do\">Discard changes?</div>\n<div class=\"n-usage n-usage-dont\">Discard?</div>\n<div class=\"n-usage n-usage-do\">Delete patient?</div>\n<div class=\"n-usage n-usage-dont\">Are you sure you want to delete this patent?</div>\n\nWhen writing modal titles, 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\">New appointment</div>\n<div class=\"n-usage n-usage-dont\">New Appointment</div>\n\nAvoid unnecessary words and articles in modal titles, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending in punctuation:\n\n<div class=\"n-usage n-usage-do\">Edit patient</div>\n<div class=\"n-usage n-usage-dont\">Edit patient.</div>\n\n---\n\n## Focus behaviour\n\n- Use the `autofocus` attribute to set the initial focus to the first location that accepts user input.\n- If it is a transactional modal without form inputs, then `autofocus` should be set on the primary button in the modal footer. This is for efficiency since most users will simply dismiss the dialog as soon as they have read the message.\n- If the modal contains a form, use `autofocus` in the first form field.\n- Focus remains trapped inside the modal dialog until it is closed.\n- For more examples and best practices, please see [WAI-ARIA Authoring Practices Modal Dialog Example](https://www.w3.org/TR/2017/NOTE-wai-aria-practices-1.1-20171214/examples/dialog-modal/dialog.html).\n",
|
|
8429
|
+
"examples": [],
|
|
8430
|
+
"tagName": "nord-modal",
|
|
8431
|
+
"customElement": true
|
|
8389
8432
|
}
|
|
8390
8433
|
],
|
|
8391
8434
|
"exports": [
|
|
8392
8435
|
{
|
|
8393
8436
|
"kind": "js",
|
|
8394
|
-
"name": "
|
|
8395
|
-
"declaration": {
|
|
8396
|
-
"name": "clearTranslations",
|
|
8397
|
-
"module": "src/localization/translation.ts"
|
|
8398
|
-
}
|
|
8399
|
-
},
|
|
8400
|
-
{
|
|
8401
|
-
"kind": "js",
|
|
8402
|
-
"name": "registerTranslation",
|
|
8403
|
-
"declaration": {
|
|
8404
|
-
"name": "registerTranslation",
|
|
8405
|
-
"module": "src/localization/translation.ts"
|
|
8406
|
-
}
|
|
8407
|
-
},
|
|
8408
|
-
{
|
|
8409
|
-
"kind": "js",
|
|
8410
|
-
"name": "subscribe",
|
|
8411
|
-
"declaration": {
|
|
8412
|
-
"name": "subscribe",
|
|
8413
|
-
"module": "src/localization/translation.ts"
|
|
8414
|
-
}
|
|
8415
|
-
},
|
|
8416
|
-
{
|
|
8417
|
-
"kind": "js",
|
|
8418
|
-
"name": "isTranslationRegistered",
|
|
8419
|
-
"declaration": {
|
|
8420
|
-
"name": "isTranslationRegistered",
|
|
8421
|
-
"module": "src/localization/translation.ts"
|
|
8422
|
-
}
|
|
8423
|
-
},
|
|
8424
|
-
{
|
|
8425
|
-
"kind": "js",
|
|
8426
|
-
"name": "resolveTranslation",
|
|
8437
|
+
"name": "default",
|
|
8427
8438
|
"declaration": {
|
|
8428
|
-
"name": "
|
|
8429
|
-
"module": "src/
|
|
8439
|
+
"name": "Modal",
|
|
8440
|
+
"module": "src/modal/Modal.ts"
|
|
8430
8441
|
}
|
|
8431
8442
|
},
|
|
8432
8443
|
{
|
|
8433
|
-
"kind": "
|
|
8434
|
-
"name": "
|
|
8444
|
+
"kind": "custom-element-definition",
|
|
8445
|
+
"name": "nord-modal",
|
|
8435
8446
|
"declaration": {
|
|
8436
|
-
"name": "
|
|
8437
|
-
"module": "src/
|
|
8447
|
+
"name": "Modal",
|
|
8448
|
+
"module": "src/modal/Modal.ts"
|
|
8438
8449
|
}
|
|
8439
8450
|
}
|
|
8440
8451
|
]
|
|
8441
8452
|
},
|
|
8442
8453
|
{
|
|
8443
8454
|
"kind": "javascript-module",
|
|
8444
|
-
"path": "src/modal/
|
|
8455
|
+
"path": "src/modal/ModalController.ts",
|
|
8445
8456
|
"declarations": [
|
|
8446
8457
|
{
|
|
8447
8458
|
"kind": "class",
|
|
8448
|
-
"description": "
|
|
8449
|
-
"name": "
|
|
8450
|
-
"
|
|
8459
|
+
"description": "",
|
|
8460
|
+
"name": "ModalController",
|
|
8461
|
+
"members": [
|
|
8451
8462
|
{
|
|
8452
|
-
"
|
|
8453
|
-
"name": "
|
|
8454
|
-
"
|
|
8463
|
+
"kind": "field",
|
|
8464
|
+
"name": "openModals",
|
|
8465
|
+
"privacy": "private",
|
|
8466
|
+
"static": true,
|
|
8467
|
+
"default": "new Stack<ModalController>()"
|
|
8455
8468
|
},
|
|
8456
8469
|
{
|
|
8457
|
-
"
|
|
8458
|
-
"name": "
|
|
8459
|
-
"
|
|
8470
|
+
"kind": "field",
|
|
8471
|
+
"name": "scrollBar",
|
|
8472
|
+
"type": {
|
|
8473
|
+
"text": "ScrollbarController"
|
|
8474
|
+
},
|
|
8475
|
+
"privacy": "private",
|
|
8476
|
+
"default": "new ScrollbarController(host)"
|
|
8460
8477
|
},
|
|
8461
8478
|
{
|
|
8462
|
-
"
|
|
8463
|
-
"name": "
|
|
8464
|
-
"
|
|
8465
|
-
|
|
8466
|
-
|
|
8467
|
-
|
|
8479
|
+
"kind": "field",
|
|
8480
|
+
"name": "focusTrap",
|
|
8481
|
+
"type": {
|
|
8482
|
+
"text": "FocusTrapController"
|
|
8483
|
+
},
|
|
8484
|
+
"privacy": "private",
|
|
8485
|
+
"default": "new FocusTrapController(host, options.dialog)"
|
|
8486
|
+
},
|
|
8468
8487
|
{
|
|
8469
|
-
"
|
|
8470
|
-
"name": ""
|
|
8488
|
+
"kind": "field",
|
|
8489
|
+
"name": "lightDismiss",
|
|
8490
|
+
"type": {
|
|
8491
|
+
"text": "LightDismissController"
|
|
8492
|
+
},
|
|
8493
|
+
"privacy": "private",
|
|
8494
|
+
"default": "new LightDismissController(host, {\n isOpen: options.isOpen,\n isDismissible: node => node !== options.dialog(),\n onDismiss: this.handleLightDismiss,\n })"
|
|
8471
8495
|
},
|
|
8472
8496
|
{
|
|
8473
|
-
"
|
|
8474
|
-
"name": "
|
|
8497
|
+
"kind": "field",
|
|
8498
|
+
"name": "events",
|
|
8499
|
+
"type": {
|
|
8500
|
+
"text": "EventController"
|
|
8501
|
+
},
|
|
8502
|
+
"privacy": "private",
|
|
8503
|
+
"default": "new EventController(host)"
|
|
8475
8504
|
},
|
|
8476
8505
|
{
|
|
8477
|
-
"
|
|
8478
|
-
"name": "
|
|
8479
|
-
|
|
8480
|
-
|
|
8481
|
-
|
|
8506
|
+
"kind": "field",
|
|
8507
|
+
"name": "options",
|
|
8508
|
+
"type": {
|
|
8509
|
+
"text": "ModalControllerOptions"
|
|
8510
|
+
},
|
|
8511
|
+
"privacy": "private",
|
|
8512
|
+
"default": "options"
|
|
8513
|
+
},
|
|
8514
|
+
{
|
|
8515
|
+
"kind": "field",
|
|
8516
|
+
"name": "trigger",
|
|
8517
|
+
"type": {
|
|
8518
|
+
"text": "HTMLElement | undefined"
|
|
8519
|
+
},
|
|
8520
|
+
"privacy": "private"
|
|
8521
|
+
},
|
|
8522
|
+
{
|
|
8523
|
+
"kind": "field",
|
|
8524
|
+
"name": "lastButton",
|
|
8525
|
+
"type": {
|
|
8526
|
+
"text": "HTMLButtonElement | undefined"
|
|
8527
|
+
},
|
|
8528
|
+
"privacy": "private"
|
|
8529
|
+
},
|
|
8530
|
+
{
|
|
8531
|
+
"kind": "method",
|
|
8532
|
+
"name": "hostConnected"
|
|
8533
|
+
},
|
|
8534
|
+
{
|
|
8535
|
+
"kind": "method",
|
|
8536
|
+
"name": "hostDisconnected",
|
|
8537
|
+
"return": {
|
|
8538
|
+
"type": {
|
|
8539
|
+
"text": "void"
|
|
8540
|
+
}
|
|
8541
|
+
}
|
|
8542
|
+
},
|
|
8482
8543
|
{
|
|
8483
|
-
"kind": "
|
|
8484
|
-
"name": "
|
|
8485
|
-
"type": {
|
|
8486
|
-
"text": "HTMLDivElement"
|
|
8487
|
-
},
|
|
8488
|
-
"privacy": "private"
|
|
8544
|
+
"kind": "method",
|
|
8545
|
+
"name": "block"
|
|
8489
8546
|
},
|
|
8490
8547
|
{
|
|
8491
|
-
"kind": "
|
|
8492
|
-
"name": "
|
|
8493
|
-
"type": {
|
|
8494
|
-
"text": "HTMLDivElement"
|
|
8495
|
-
},
|
|
8496
|
-
"privacy": "private"
|
|
8548
|
+
"kind": "method",
|
|
8549
|
+
"name": "unblock"
|
|
8497
8550
|
},
|
|
8498
8551
|
{
|
|
8499
8552
|
"kind": "field",
|
|
8500
|
-
"name": "
|
|
8553
|
+
"name": "trackLastButton",
|
|
8501
8554
|
"privacy": "private",
|
|
8502
|
-
"
|
|
8555
|
+
"description": "capture the last button clicked, so that we can polyfill `submitter` property in submit event"
|
|
8503
8556
|
},
|
|
8504
8557
|
{
|
|
8505
8558
|
"kind": "field",
|
|
8506
|
-
"name": "
|
|
8507
|
-
"privacy": "private"
|
|
8508
|
-
"default": "new SlotController(this, \"feature\")"
|
|
8559
|
+
"name": "polyfillSubmitter",
|
|
8560
|
+
"privacy": "private"
|
|
8509
8561
|
},
|
|
8510
8562
|
{
|
|
8511
8563
|
"kind": "field",
|
|
8512
|
-
"name": "
|
|
8513
|
-
"privacy": "private"
|
|
8514
|
-
"default": "new SlotController(this, \"footer\")"
|
|
8564
|
+
"name": "handleTransitionEnd",
|
|
8565
|
+
"privacy": "private"
|
|
8515
8566
|
},
|
|
8516
8567
|
{
|
|
8517
8568
|
"kind": "field",
|
|
8518
|
-
"name": "
|
|
8519
|
-
"privacy": "private"
|
|
8520
|
-
"default": "new LocalizeController<\"nord-modal\">(this)"
|
|
8569
|
+
"name": "handleLightDismiss",
|
|
8570
|
+
"privacy": "private"
|
|
8521
8571
|
},
|
|
8522
8572
|
{
|
|
8523
8573
|
"kind": "field",
|
|
8524
|
-
"name": "
|
|
8525
|
-
"privacy": "private"
|
|
8526
|
-
|
|
8527
|
-
|
|
8574
|
+
"name": "handleSubmit",
|
|
8575
|
+
"privacy": "private"
|
|
8576
|
+
}
|
|
8577
|
+
]
|
|
8578
|
+
}
|
|
8579
|
+
],
|
|
8580
|
+
"exports": [
|
|
8581
|
+
{
|
|
8582
|
+
"kind": "js",
|
|
8583
|
+
"name": "ModalController",
|
|
8584
|
+
"declaration": {
|
|
8585
|
+
"name": "ModalController",
|
|
8586
|
+
"module": "src/modal/ModalController.ts"
|
|
8587
|
+
}
|
|
8588
|
+
}
|
|
8589
|
+
]
|
|
8590
|
+
},
|
|
8591
|
+
{
|
|
8592
|
+
"kind": "javascript-module",
|
|
8593
|
+
"path": "src/modal/localization.ts",
|
|
8594
|
+
"declarations": [
|
|
8595
|
+
{
|
|
8596
|
+
"kind": "variable",
|
|
8597
|
+
"name": "localization",
|
|
8598
|
+
"type": {
|
|
8599
|
+
"text": "object"
|
|
8600
|
+
},
|
|
8601
|
+
"default": "{\n closeLabel: \"Close dialog\",\n}"
|
|
8602
|
+
}
|
|
8603
|
+
],
|
|
8604
|
+
"exports": [
|
|
8605
|
+
{
|
|
8606
|
+
"kind": "js",
|
|
8607
|
+
"name": "default",
|
|
8608
|
+
"declaration": {
|
|
8609
|
+
"name": "localization",
|
|
8610
|
+
"module": "src/modal/localization.ts"
|
|
8611
|
+
}
|
|
8612
|
+
}
|
|
8613
|
+
]
|
|
8614
|
+
},
|
|
8615
|
+
{
|
|
8616
|
+
"kind": "javascript-module",
|
|
8617
|
+
"path": "src/localization/LocalizeController.ts",
|
|
8618
|
+
"declarations": [
|
|
8619
|
+
{
|
|
8620
|
+
"kind": "class",
|
|
8621
|
+
"description": "",
|
|
8622
|
+
"name": "LocalizeController",
|
|
8623
|
+
"members": [
|
|
8528
8624
|
{
|
|
8529
8625
|
"kind": "field",
|
|
8530
|
-
"name": "
|
|
8626
|
+
"name": "unsubscribe",
|
|
8531
8627
|
"type": {
|
|
8532
|
-
"text": "
|
|
8628
|
+
"text": "ReturnType<typeof subscribe> | undefined"
|
|
8533
8629
|
},
|
|
8534
|
-
"
|
|
8535
|
-
"description": "Controls whether the modal is open or not.",
|
|
8536
|
-
"attribute": "open",
|
|
8537
|
-
"reflects": true
|
|
8630
|
+
"privacy": "private"
|
|
8538
8631
|
},
|
|
8539
8632
|
{
|
|
8540
8633
|
"kind": "field",
|
|
8541
|
-
"name": "
|
|
8634
|
+
"name": "resolvedTranslation",
|
|
8542
8635
|
"type": {
|
|
8543
|
-
"text": "
|
|
8636
|
+
"text": "Translation"
|
|
8544
8637
|
},
|
|
8545
|
-
"
|
|
8546
|
-
"description": "Controls the max-width of the modal when open.",
|
|
8547
|
-
"attribute": "size",
|
|
8548
|
-
"reflects": true
|
|
8638
|
+
"privacy": "private"
|
|
8549
8639
|
},
|
|
8550
8640
|
{
|
|
8551
8641
|
"kind": "field",
|
|
8552
|
-
"name": "
|
|
8553
|
-
"
|
|
8554
|
-
"text": "string"
|
|
8555
|
-
},
|
|
8556
|
-
"default": "\"\"",
|
|
8557
|
-
"description": "The reason why the modal was closed. This typically indicates\nwhich button the user pressed to close the modal, though any value\ncan be supplied if the modal is programmatically closed."
|
|
8642
|
+
"name": "lang",
|
|
8643
|
+
"description": "The lang of the document or element, with element taking precedence"
|
|
8558
8644
|
},
|
|
8559
8645
|
{
|
|
8560
8646
|
"kind": "field",
|
|
8561
|
-
"name": "
|
|
8562
|
-
"
|
|
8563
|
-
"text": "boolean"
|
|
8564
|
-
},
|
|
8565
|
-
"default": "false",
|
|
8566
|
-
"description": "By default if a modal is too big for the browser window,\nthe entire modal will scroll. This setting changes that behavior\nso that the body of the modal scrolls instead, with the modal\nitself remaining fixed.",
|
|
8567
|
-
"attribute": "scrollable",
|
|
8568
|
-
"reflects": true
|
|
8647
|
+
"name": "resolvedLang",
|
|
8648
|
+
"description": "The lang of the translation being applied.\nThis may not match the document/element lang, in case of fallback translation"
|
|
8569
8649
|
},
|
|
8570
8650
|
{
|
|
8571
8651
|
"kind": "method",
|
|
8572
|
-
"name": "
|
|
8573
|
-
"description": "Show the modal, automatically moving focus to the modal or a child\nelement with an `autofocus` attribute."
|
|
8652
|
+
"name": "hostConnected"
|
|
8574
8653
|
},
|
|
8575
8654
|
{
|
|
8576
8655
|
"kind": "method",
|
|
8577
|
-
"name": "
|
|
8578
|
-
"parameters": [
|
|
8579
|
-
{
|
|
8580
|
-
"name": "returnValue",
|
|
8581
|
-
"optional": true,
|
|
8582
|
-
"type": {
|
|
8583
|
-
"text": "string"
|
|
8584
|
-
},
|
|
8585
|
-
"description": "An optional value to indicate why the modal was closed."
|
|
8586
|
-
}
|
|
8587
|
-
],
|
|
8588
|
-
"description": "Programmatically close the modal."
|
|
8656
|
+
"name": "hostDisconnected"
|
|
8589
8657
|
},
|
|
8590
8658
|
{
|
|
8591
8659
|
"kind": "method",
|
|
8592
|
-
"name": "
|
|
8660
|
+
"name": "term",
|
|
8661
|
+
"return": {
|
|
8662
|
+
"type": {
|
|
8663
|
+
"text": "Result<Translation[TComponentName], Key>"
|
|
8664
|
+
}
|
|
8665
|
+
},
|
|
8593
8666
|
"parameters": [
|
|
8594
8667
|
{
|
|
8595
|
-
"name": "
|
|
8596
|
-
"optional": true,
|
|
8668
|
+
"name": "key",
|
|
8597
8669
|
"type": {
|
|
8598
|
-
"text": "
|
|
8599
|
-
}
|
|
8600
|
-
|
|
8601
|
-
}
|
|
8602
|
-
],
|
|
8603
|
-
"description": "Programmatically focus the modal."
|
|
8604
|
-
},
|
|
8605
|
-
{
|
|
8606
|
-
"kind": "method",
|
|
8607
|
-
"name": "handleOpenUpdated",
|
|
8608
|
-
"privacy": "protected",
|
|
8609
|
-
"parameters": [
|
|
8670
|
+
"text": "Key"
|
|
8671
|
+
}
|
|
8672
|
+
},
|
|
8610
8673
|
{
|
|
8611
|
-
"name": "
|
|
8674
|
+
"name": "args",
|
|
8612
8675
|
"type": {
|
|
8613
|
-
"text": "
|
|
8676
|
+
"text": "FuncParams<Translation[TComponentName], Key>"
|
|
8614
8677
|
}
|
|
8615
8678
|
}
|
|
8616
8679
|
]
|
|
8617
8680
|
},
|
|
8618
8681
|
{
|
|
8619
|
-
"kind": "
|
|
8620
|
-
"name": "
|
|
8682
|
+
"kind": "field",
|
|
8683
|
+
"name": "handleLangChange",
|
|
8621
8684
|
"privacy": "private"
|
|
8622
8685
|
}
|
|
8623
|
-
]
|
|
8624
|
-
|
|
8625
|
-
|
|
8626
|
-
|
|
8627
|
-
|
|
8628
|
-
|
|
8629
|
-
|
|
8630
|
-
|
|
8631
|
-
|
|
8686
|
+
]
|
|
8687
|
+
}
|
|
8688
|
+
],
|
|
8689
|
+
"exports": [
|
|
8690
|
+
{
|
|
8691
|
+
"kind": "js",
|
|
8692
|
+
"name": "LocalizeController",
|
|
8693
|
+
"declaration": {
|
|
8694
|
+
"name": "LocalizeController",
|
|
8695
|
+
"module": "src/localization/LocalizeController.ts"
|
|
8696
|
+
}
|
|
8697
|
+
}
|
|
8698
|
+
]
|
|
8699
|
+
},
|
|
8700
|
+
{
|
|
8701
|
+
"kind": "javascript-module",
|
|
8702
|
+
"path": "src/localization/en-us.ts",
|
|
8703
|
+
"declarations": [
|
|
8704
|
+
{
|
|
8705
|
+
"kind": "variable",
|
|
8706
|
+
"name": "en",
|
|
8707
|
+
"type": {
|
|
8708
|
+
"text": "object"
|
|
8709
|
+
},
|
|
8710
|
+
"default": "{\n $lang: \"en-US\",\n $name: \"English\",\n $dir: \"ltr\" as \"ltr\" | \"rtl\",\n \"nord-command-menu\": commandMenuLocalization,\n \"nord-calendar\": calendarLocalization,\n \"nord-date-picker\": datePickerLocalization,\n \"nord-modal\": modalLocalization,\n \"nord-nav-toggle\": navToggleLocalization,\n \"nord-textarea\": textareaLocalization,\n}"
|
|
8711
|
+
}
|
|
8712
|
+
],
|
|
8713
|
+
"exports": [
|
|
8714
|
+
{
|
|
8715
|
+
"kind": "js",
|
|
8716
|
+
"name": "default",
|
|
8717
|
+
"declaration": {
|
|
8718
|
+
"name": "en",
|
|
8719
|
+
"module": "src/localization/en-us.ts"
|
|
8720
|
+
}
|
|
8721
|
+
}
|
|
8722
|
+
]
|
|
8723
|
+
},
|
|
8724
|
+
{
|
|
8725
|
+
"kind": "javascript-module",
|
|
8726
|
+
"path": "src/localization/fi-fi.ts",
|
|
8727
|
+
"declarations": [
|
|
8728
|
+
{
|
|
8729
|
+
"kind": "variable",
|
|
8730
|
+
"name": "fi",
|
|
8731
|
+
"type": {
|
|
8732
|
+
"text": "Translation"
|
|
8733
|
+
},
|
|
8734
|
+
"default": "{\n $lang: \"fi\",\n $name: \"Suomi\",\n $dir: \"ltr\",\n\n \"nord-command-menu\": {\n instructions: \"Paina 'Enter' vahvistaaksesi valinnan tai 'Escape' peruuttaaksesi\",\n inputLabel: \"Kirjoita komento jonka haluat suorittaa.\",\n footerArrowKeys: \"Siirry\",\n footerEnterKey: \"Valitse\",\n footerEscapeKey: \"Esc sulje\",\n footerBackspaceKey: \"Siirry takaisin\",\n noResults: searchTerm => `Ei tuloksia haulle \"${searchTerm}\"`,\n tip: \"Vinkki: jotkin haut vaativat tarkan hakutermin. Koita kirjoittaa koko hakutermi kokonaisuudessaan, tai kokeile toista sanaa tai fraasia.\",\n },\n\n \"nord-calendar\": {\n prevMonthLabel: \"Edellinen kuukausi\",\n nextMonthLabel: \"Seuraava kuukausi\",\n monthSelectLabel: \"Kuukausi\",\n yearSelectLabel: \"Vuosi\",\n },\n\n \"nord-date-picker\": {\n modalHeading: \"Valitse päivämäärä\",\n closeLabel: \"Sulje ikkuna\",\n buttonLabel: \"Valitse päivämäärä\",\n selectedDateMessage: \"Valittu päivämäärä on\",\n },\n\n \"nord-modal\": {\n closeLabel: \"Sulje ikkuna\",\n },\n\n \"nord-nav-toggle\": {\n label: \"Näytä/Piilota valikko\",\n },\n\n \"nord-textarea\": {\n remainingCharacters: (remaining: number) => `${remaining} merkkiä jäljellä`,\n },\n}"
|
|
8735
|
+
}
|
|
8736
|
+
],
|
|
8737
|
+
"exports": [
|
|
8738
|
+
{
|
|
8739
|
+
"kind": "js",
|
|
8740
|
+
"name": "default",
|
|
8741
|
+
"declaration": {
|
|
8742
|
+
"name": "fi",
|
|
8743
|
+
"module": "src/localization/fi-fi.ts"
|
|
8744
|
+
}
|
|
8745
|
+
}
|
|
8746
|
+
]
|
|
8747
|
+
},
|
|
8748
|
+
{
|
|
8749
|
+
"kind": "javascript-module",
|
|
8750
|
+
"path": "src/localization/translation.ts",
|
|
8751
|
+
"declarations": [
|
|
8752
|
+
{
|
|
8753
|
+
"kind": "function",
|
|
8754
|
+
"name": "clearTranslations",
|
|
8755
|
+
"description": "Removes all registered translations"
|
|
8756
|
+
},
|
|
8757
|
+
{
|
|
8758
|
+
"kind": "function",
|
|
8759
|
+
"name": "registerTranslation",
|
|
8760
|
+
"parameters": [
|
|
8632
8761
|
{
|
|
8633
|
-
"name": "
|
|
8762
|
+
"name": "translation",
|
|
8634
8763
|
"type": {
|
|
8635
|
-
"text": "
|
|
8636
|
-
}
|
|
8637
|
-
"description": "Dispatched before the modal has closed when a user attempts to dismiss a modal. Call `preventDefault()` on the event to prevent the modal closing."
|
|
8764
|
+
"text": "Translation[]"
|
|
8765
|
+
}
|
|
8638
8766
|
}
|
|
8639
8767
|
],
|
|
8640
|
-
"
|
|
8641
|
-
|
|
8642
|
-
|
|
8643
|
-
|
|
8644
|
-
|
|
8645
|
-
|
|
8646
|
-
|
|
8647
|
-
"
|
|
8648
|
-
|
|
8649
|
-
|
|
8768
|
+
"description": "Registers one or more translations"
|
|
8769
|
+
},
|
|
8770
|
+
{
|
|
8771
|
+
"kind": "function",
|
|
8772
|
+
"name": "subscribe",
|
|
8773
|
+
"return": {
|
|
8774
|
+
"type": {
|
|
8775
|
+
"text": ""
|
|
8776
|
+
}
|
|
8777
|
+
},
|
|
8778
|
+
"parameters": [
|
|
8650
8779
|
{
|
|
8651
|
-
"name": "
|
|
8780
|
+
"name": "onChange",
|
|
8652
8781
|
"type": {
|
|
8653
|
-
"text": "
|
|
8782
|
+
"text": "() => void"
|
|
8654
8783
|
},
|
|
8655
|
-
"
|
|
8656
|
-
|
|
8657
|
-
|
|
8658
|
-
|
|
8784
|
+
"description": "callback for when either `lang` attr changes, or a new language is registered."
|
|
8785
|
+
}
|
|
8786
|
+
],
|
|
8787
|
+
"description": "subscribe to language changes"
|
|
8788
|
+
},
|
|
8789
|
+
{
|
|
8790
|
+
"kind": "function",
|
|
8791
|
+
"name": "isTranslationRegistered",
|
|
8792
|
+
"parameters": [
|
|
8659
8793
|
{
|
|
8660
|
-
"name": "
|
|
8794
|
+
"name": "lang",
|
|
8661
8795
|
"type": {
|
|
8662
|
-
"text": "
|
|
8796
|
+
"text": "string"
|
|
8663
8797
|
},
|
|
8664
|
-
"
|
|
8665
|
-
"description": "By default if a modal is too big for the browser window,\nthe entire modal will scroll. This setting changes that behavior\nso that the body of the modal scrolls instead, with the modal\nitself remaining fixed.",
|
|
8666
|
-
"fieldName": "scrollable"
|
|
8798
|
+
"description": "the lang code e.g. \"en\" or \"en-GB\""
|
|
8667
8799
|
}
|
|
8668
8800
|
],
|
|
8669
|
-
"
|
|
8670
|
-
|
|
8671
|
-
|
|
8672
|
-
|
|
8673
|
-
"
|
|
8801
|
+
"description": "Check whether there is a translation registered for the given lang"
|
|
8802
|
+
},
|
|
8803
|
+
{
|
|
8804
|
+
"kind": "function",
|
|
8805
|
+
"name": "resolveTranslation",
|
|
8806
|
+
"parameters": [
|
|
8674
8807
|
{
|
|
8675
|
-
"name": "
|
|
8676
|
-
"
|
|
8808
|
+
"name": "langCode",
|
|
8809
|
+
"type": {
|
|
8810
|
+
"text": "string"
|
|
8811
|
+
}
|
|
8677
8812
|
}
|
|
8678
8813
|
],
|
|
8679
|
-
"
|
|
8680
|
-
"category": "overlay",
|
|
8681
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for confirmations and conditional changes.\n- Use when the user is required to take an action.\n- Use when you need to display content that temporarily blocks interactions with the main view of an application.\n- Use when you need to ask a confirmation from a user before proceeding.\n- Use for important warnings, as a way to prevent or correct critical errors.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for nonessential information that is not related to the current userflow.\n- Don’t use when the modal requires additional information for decision making that is unavailable in the modal itself.\n- Don’t open a modal window on top of another modal.\n\n</div>\n\n---\n\n## Content guidelines\n\nModal title should be clear, accurate and predictable. Always lead with a strong verb that encourages action. To provide enough context to user, use the {verb} + {noun} content formula:\n\n<div class=\"n-usage n-usage-do\">Edit patient</div>\n<div class=\"n-usage n-usage-dont\">Edit the patient called John Doe</div>\n<div class=\"n-usage n-usage-do\">Discard changes?</div>\n<div class=\"n-usage n-usage-dont\">Discard?</div>\n<div class=\"n-usage n-usage-do\">Delete patient?</div>\n<div class=\"n-usage n-usage-dont\">Are you sure you want to delete this patent?</div>\n\nWhen writing modal titles, 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\">New appointment</div>\n<div class=\"n-usage n-usage-dont\">New Appointment</div>\n\nAvoid unnecessary words and articles in modal titles, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending in punctuation:\n\n<div class=\"n-usage n-usage-do\">Edit patient</div>\n<div class=\"n-usage n-usage-dont\">Edit patient.</div>\n\n---\n\n## Focus behaviour\n\n- Use the `autofocus` attribute to set the initial focus to the first location that accepts user input.\n- If it is a transactional modal without form inputs, then `autofocus` should be set on the primary button in the modal footer. This is for efficiency since most users will simply dismiss the dialog as soon as they have read the message.\n- If the modal contains a form, use `autofocus` in the first form field.\n- Focus remains trapped inside the modal dialog until it is closed.\n- For more examples and best practices, please see [WAI-ARIA Authoring Practices Modal Dialog Example](https://www.w3.org/TR/2017/NOTE-wai-aria-practices-1.1-20171214/examples/dialog-modal/dialog.html).\n",
|
|
8682
|
-
"examples": [],
|
|
8683
|
-
"tagName": "nord-modal",
|
|
8684
|
-
"customElement": true
|
|
8814
|
+
"description": "Picks the most appropriate translation for the given language, from most specific to least specific.\nFirst tries lang + region, then lang only, then fallback."
|
|
8685
8815
|
}
|
|
8686
8816
|
],
|
|
8687
8817
|
"exports": [
|
|
8688
8818
|
{
|
|
8689
8819
|
"kind": "js",
|
|
8690
|
-
"name": "
|
|
8820
|
+
"name": "clearTranslations",
|
|
8691
8821
|
"declaration": {
|
|
8692
|
-
"name": "
|
|
8693
|
-
"module": "src/
|
|
8822
|
+
"name": "clearTranslations",
|
|
8823
|
+
"module": "src/localization/translation.ts"
|
|
8694
8824
|
}
|
|
8695
8825
|
},
|
|
8696
8826
|
{
|
|
8697
|
-
"kind": "
|
|
8698
|
-
"name": "
|
|
8827
|
+
"kind": "js",
|
|
8828
|
+
"name": "registerTranslation",
|
|
8699
8829
|
"declaration": {
|
|
8700
|
-
"name": "
|
|
8701
|
-
"module": "src/
|
|
8830
|
+
"name": "registerTranslation",
|
|
8831
|
+
"module": "src/localization/translation.ts"
|
|
8832
|
+
}
|
|
8833
|
+
},
|
|
8834
|
+
{
|
|
8835
|
+
"kind": "js",
|
|
8836
|
+
"name": "subscribe",
|
|
8837
|
+
"declaration": {
|
|
8838
|
+
"name": "subscribe",
|
|
8839
|
+
"module": "src/localization/translation.ts"
|
|
8840
|
+
}
|
|
8841
|
+
},
|
|
8842
|
+
{
|
|
8843
|
+
"kind": "js",
|
|
8844
|
+
"name": "isTranslationRegistered",
|
|
8845
|
+
"declaration": {
|
|
8846
|
+
"name": "isTranslationRegistered",
|
|
8847
|
+
"module": "src/localization/translation.ts"
|
|
8848
|
+
}
|
|
8849
|
+
},
|
|
8850
|
+
{
|
|
8851
|
+
"kind": "js",
|
|
8852
|
+
"name": "resolveTranslation",
|
|
8853
|
+
"declaration": {
|
|
8854
|
+
"name": "resolveTranslation",
|
|
8855
|
+
"module": "src/localization/translation.ts"
|
|
8856
|
+
}
|
|
8857
|
+
},
|
|
8858
|
+
{
|
|
8859
|
+
"kind": "js",
|
|
8860
|
+
"name": "fallback",
|
|
8861
|
+
"declaration": {
|
|
8862
|
+
"name": "en",
|
|
8863
|
+
"module": "src/localization/translation.ts"
|
|
8702
8864
|
}
|
|
8703
8865
|
}
|
|
8704
8866
|
]
|
|
8705
8867
|
},
|
|
8706
8868
|
{
|
|
8707
8869
|
"kind": "javascript-module",
|
|
8708
|
-
"path": "src/
|
|
8870
|
+
"path": "src/nav-group/NavGroup.ts",
|
|
8709
8871
|
"declarations": [
|
|
8710
8872
|
{
|
|
8711
8873
|
"kind": "class",
|
|
8712
|
-
"description": "",
|
|
8713
|
-
"name": "
|
|
8714
|
-
"
|
|
8715
|
-
{
|
|
8716
|
-
"kind": "field",
|
|
8717
|
-
"name": "openModals",
|
|
8718
|
-
"privacy": "private",
|
|
8719
|
-
"static": true,
|
|
8720
|
-
"default": "new Stack<ModalController>()"
|
|
8721
|
-
},
|
|
8722
|
-
{
|
|
8723
|
-
"kind": "field",
|
|
8724
|
-
"name": "scrollBar",
|
|
8725
|
-
"type": {
|
|
8726
|
-
"text": "ScrollbarController"
|
|
8727
|
-
},
|
|
8728
|
-
"privacy": "private",
|
|
8729
|
-
"default": "new ScrollbarController(host)"
|
|
8730
|
-
},
|
|
8731
|
-
{
|
|
8732
|
-
"kind": "field",
|
|
8733
|
-
"name": "focusTrap",
|
|
8734
|
-
"type": {
|
|
8735
|
-
"text": "FocusTrapController"
|
|
8736
|
-
},
|
|
8737
|
-
"privacy": "private",
|
|
8738
|
-
"default": "new FocusTrapController(host, options.dialog)"
|
|
8739
|
-
},
|
|
8740
|
-
{
|
|
8741
|
-
"kind": "field",
|
|
8742
|
-
"name": "lightDismiss",
|
|
8743
|
-
"type": {
|
|
8744
|
-
"text": "LightDismissController"
|
|
8745
|
-
},
|
|
8746
|
-
"privacy": "private",
|
|
8747
|
-
"default": "new LightDismissController(host, {\n isOpen: options.isOpen,\n isDismissible: node => node !== options.dialog(),\n onDismiss: this.handleLightDismiss,\n })"
|
|
8748
|
-
},
|
|
8749
|
-
{
|
|
8750
|
-
"kind": "field",
|
|
8751
|
-
"name": "events",
|
|
8752
|
-
"type": {
|
|
8753
|
-
"text": "EventController"
|
|
8754
|
-
},
|
|
8755
|
-
"privacy": "private",
|
|
8756
|
-
"default": "new EventController(host)"
|
|
8757
|
-
},
|
|
8758
|
-
{
|
|
8759
|
-
"kind": "field",
|
|
8760
|
-
"name": "options",
|
|
8761
|
-
"type": {
|
|
8762
|
-
"text": "ModalControllerOptions"
|
|
8763
|
-
},
|
|
8764
|
-
"privacy": "private",
|
|
8765
|
-
"default": "options"
|
|
8766
|
-
},
|
|
8874
|
+
"description": "Navigation group includes all the actions or items in a single\ngroup and is used for grouping items into related categories.",
|
|
8875
|
+
"name": "NavGroup",
|
|
8876
|
+
"slots": [
|
|
8767
8877
|
{
|
|
8768
|
-
"
|
|
8769
|
-
"name": "
|
|
8770
|
-
|
|
8771
|
-
|
|
8772
|
-
|
|
8773
|
-
"privacy": "private"
|
|
8774
|
-
},
|
|
8878
|
+
"description": "The default slot used for the nav items.",
|
|
8879
|
+
"name": ""
|
|
8880
|
+
}
|
|
8881
|
+
],
|
|
8882
|
+
"members": [
|
|
8775
8883
|
{
|
|
8776
8884
|
"kind": "field",
|
|
8777
|
-
"name": "
|
|
8885
|
+
"name": "heading",
|
|
8778
8886
|
"type": {
|
|
8779
|
-
"text": "
|
|
8887
|
+
"text": "string | undefined"
|
|
8780
8888
|
},
|
|
8781
|
-
"
|
|
8782
|
-
|
|
8783
|
-
|
|
8784
|
-
|
|
8785
|
-
|
|
8786
|
-
},
|
|
8787
|
-
{
|
|
8788
|
-
"kind": "method",
|
|
8789
|
-
"name": "hostDisconnected",
|
|
8790
|
-
"return": {
|
|
8791
|
-
"type": {
|
|
8792
|
-
"text": "void"
|
|
8793
|
-
}
|
|
8794
|
-
}
|
|
8795
|
-
},
|
|
8796
|
-
{
|
|
8797
|
-
"kind": "method",
|
|
8798
|
-
"name": "block"
|
|
8799
|
-
},
|
|
8800
|
-
{
|
|
8801
|
-
"kind": "method",
|
|
8802
|
-
"name": "unblock"
|
|
8803
|
-
},
|
|
8804
|
-
{
|
|
8805
|
-
"kind": "field",
|
|
8806
|
-
"name": "trackLastButton",
|
|
8807
|
-
"privacy": "private",
|
|
8808
|
-
"description": "capture the last button clicked, so that we can polyfill `submitter` property in submit event"
|
|
8809
|
-
},
|
|
8810
|
-
{
|
|
8811
|
-
"kind": "field",
|
|
8812
|
-
"name": "polyfillSubmitter",
|
|
8813
|
-
"privacy": "private"
|
|
8814
|
-
},
|
|
8815
|
-
{
|
|
8816
|
-
"kind": "field",
|
|
8817
|
-
"name": "handleTransitionEnd",
|
|
8818
|
-
"privacy": "private"
|
|
8819
|
-
},
|
|
8820
|
-
{
|
|
8821
|
-
"kind": "field",
|
|
8822
|
-
"name": "handleLightDismiss",
|
|
8823
|
-
"privacy": "private"
|
|
8824
|
-
},
|
|
8889
|
+
"description": "Heading and accessible label for the nav group",
|
|
8890
|
+
"attribute": "heading"
|
|
8891
|
+
}
|
|
8892
|
+
],
|
|
8893
|
+
"attributes": [
|
|
8825
8894
|
{
|
|
8826
|
-
"
|
|
8827
|
-
"
|
|
8828
|
-
|
|
8895
|
+
"name": "heading",
|
|
8896
|
+
"type": {
|
|
8897
|
+
"text": "string | undefined"
|
|
8898
|
+
},
|
|
8899
|
+
"description": "Heading and accessible label for the nav group",
|
|
8900
|
+
"fieldName": "heading"
|
|
8829
8901
|
}
|
|
8830
|
-
]
|
|
8902
|
+
],
|
|
8903
|
+
"superclass": {
|
|
8904
|
+
"name": "LitElement",
|
|
8905
|
+
"package": "lit"
|
|
8906
|
+
},
|
|
8907
|
+
"localization": [],
|
|
8908
|
+
"status": "ready",
|
|
8909
|
+
"category": "navigation",
|
|
8910
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping other types of content.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
8911
|
+
"examples": [],
|
|
8912
|
+
"tagName": "nord-nav-group",
|
|
8913
|
+
"customElement": true
|
|
8831
8914
|
}
|
|
8832
8915
|
],
|
|
8833
8916
|
"exports": [
|
|
8834
8917
|
{
|
|
8835
8918
|
"kind": "js",
|
|
8836
|
-
"name": "
|
|
8919
|
+
"name": "default",
|
|
8837
8920
|
"declaration": {
|
|
8838
|
-
"name": "
|
|
8839
|
-
"module": "src/
|
|
8921
|
+
"name": "NavGroup",
|
|
8922
|
+
"module": "src/nav-group/NavGroup.ts"
|
|
8840
8923
|
}
|
|
8841
|
-
}
|
|
8842
|
-
]
|
|
8843
|
-
},
|
|
8844
|
-
{
|
|
8845
|
-
"kind": "javascript-module",
|
|
8846
|
-
"path": "src/modal/localization.ts",
|
|
8847
|
-
"declarations": [
|
|
8848
|
-
{
|
|
8849
|
-
"kind": "variable",
|
|
8850
|
-
"name": "localization",
|
|
8851
|
-
"type": {
|
|
8852
|
-
"text": "object"
|
|
8853
|
-
},
|
|
8854
|
-
"default": "{\n closeLabel: \"Close dialog\",\n}"
|
|
8855
|
-
}
|
|
8856
|
-
],
|
|
8857
|
-
"exports": [
|
|
8924
|
+
},
|
|
8858
8925
|
{
|
|
8859
|
-
"kind": "
|
|
8860
|
-
"name": "
|
|
8926
|
+
"kind": "custom-element-definition",
|
|
8927
|
+
"name": "nord-nav-group",
|
|
8861
8928
|
"declaration": {
|
|
8862
|
-
"name": "
|
|
8863
|
-
"module": "src/
|
|
8929
|
+
"name": "NavGroup",
|
|
8930
|
+
"module": "src/nav-group/NavGroup.ts"
|
|
8864
8931
|
}
|
|
8865
8932
|
}
|
|
8866
8933
|
]
|
|
@@ -9128,39 +9195,27 @@
|
|
|
9128
9195
|
},
|
|
9129
9196
|
{
|
|
9130
9197
|
"kind": "javascript-module",
|
|
9131
|
-
"path": "src/
|
|
9198
|
+
"path": "src/navigation/Navigation.ts",
|
|
9132
9199
|
"declarations": [
|
|
9133
9200
|
{
|
|
9134
9201
|
"kind": "class",
|
|
9135
|
-
"description": "Navigation
|
|
9136
|
-
"name": "
|
|
9202
|
+
"description": "Navigation is used to display the primary navigation in the sidebar\nof an application. Navigation includes a list of links that users\nuse to move between sections of the application.",
|
|
9203
|
+
"name": "Navigation",
|
|
9137
9204
|
"slots": [
|
|
9138
9205
|
{
|
|
9139
|
-
"description": "The
|
|
9206
|
+
"description": "The main section of the sidebar, for holding nav components.",
|
|
9140
9207
|
"name": ""
|
|
9141
|
-
}
|
|
9142
|
-
],
|
|
9143
|
-
"members": [
|
|
9208
|
+
},
|
|
9144
9209
|
{
|
|
9145
|
-
"
|
|
9146
|
-
"name": "
|
|
9147
|
-
|
|
9148
|
-
"text": "string | undefined"
|
|
9149
|
-
},
|
|
9150
|
-
"description": "Heading and accessible label for the nav group",
|
|
9151
|
-
"attribute": "heading"
|
|
9152
|
-
}
|
|
9153
|
-
],
|
|
9154
|
-
"attributes": [
|
|
9210
|
+
"description": "The top section of the sidebar.",
|
|
9211
|
+
"name": "header"
|
|
9212
|
+
},
|
|
9155
9213
|
{
|
|
9156
|
-
"
|
|
9157
|
-
"
|
|
9158
|
-
"text": "string | undefined"
|
|
9159
|
-
},
|
|
9160
|
-
"description": "Heading and accessible label for the nav group",
|
|
9161
|
-
"fieldName": "heading"
|
|
9214
|
+
"description": "The bottom section of the sidebar.",
|
|
9215
|
+
"name": "footer"
|
|
9162
9216
|
}
|
|
9163
9217
|
],
|
|
9218
|
+
"members": [],
|
|
9164
9219
|
"superclass": {
|
|
9165
9220
|
"name": "LitElement",
|
|
9166
9221
|
"package": "lit"
|
|
@@ -9168,9 +9223,9 @@
|
|
|
9168
9223
|
"localization": [],
|
|
9169
9224
|
"status": "ready",
|
|
9170
9225
|
"category": "navigation",
|
|
9171
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t
|
|
9226
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for primary navigation items that perform an action when clicked. Each action should navigate to a URL or trigger another action like a modal overlay.\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place a `<nav>` element inside the navigation component, as it already contains one internally.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
9172
9227
|
"examples": [],
|
|
9173
|
-
"tagName": "nord-
|
|
9228
|
+
"tagName": "nord-navigation",
|
|
9174
9229
|
"customElement": true
|
|
9175
9230
|
}
|
|
9176
9231
|
],
|
|
@@ -9179,16 +9234,16 @@
|
|
|
9179
9234
|
"kind": "js",
|
|
9180
9235
|
"name": "default",
|
|
9181
9236
|
"declaration": {
|
|
9182
|
-
"name": "
|
|
9183
|
-
"module": "src/
|
|
9237
|
+
"name": "Navigation",
|
|
9238
|
+
"module": "src/navigation/Navigation.ts"
|
|
9184
9239
|
}
|
|
9185
9240
|
},
|
|
9186
9241
|
{
|
|
9187
9242
|
"kind": "custom-element-definition",
|
|
9188
|
-
"name": "nord-
|
|
9243
|
+
"name": "nord-navigation",
|
|
9189
9244
|
"declaration": {
|
|
9190
|
-
"name": "
|
|
9191
|
-
"module": "src/
|
|
9245
|
+
"name": "Navigation",
|
|
9246
|
+
"module": "src/navigation/Navigation.ts"
|
|
9192
9247
|
}
|
|
9193
9248
|
}
|
|
9194
9249
|
]
|
|
@@ -9328,68 +9383,6 @@
|
|
|
9328
9383
|
}
|
|
9329
9384
|
]
|
|
9330
9385
|
},
|
|
9331
|
-
{
|
|
9332
|
-
"kind": "javascript-module",
|
|
9333
|
-
"path": "src/navigation/Navigation.ts",
|
|
9334
|
-
"declarations": [
|
|
9335
|
-
{
|
|
9336
|
-
"kind": "class",
|
|
9337
|
-
"description": "Navigation is used to display the primary navigation in the sidebar\nof an application. Navigation includes a list of links that users\nuse to move between sections of the application.",
|
|
9338
|
-
"name": "Navigation",
|
|
9339
|
-
"slots": [
|
|
9340
|
-
{
|
|
9341
|
-
"description": "The main section of the sidebar, for holding nav components.",
|
|
9342
|
-
"name": ""
|
|
9343
|
-
},
|
|
9344
|
-
{
|
|
9345
|
-
"description": "The top section of the sidebar.",
|
|
9346
|
-
"name": "header"
|
|
9347
|
-
},
|
|
9348
|
-
{
|
|
9349
|
-
"description": "The bottom section of the sidebar.",
|
|
9350
|
-
"name": "footer"
|
|
9351
|
-
}
|
|
9352
|
-
],
|
|
9353
|
-
"members": [
|
|
9354
|
-
{
|
|
9355
|
-
"kind": "field",
|
|
9356
|
-
"name": "headerSlot",
|
|
9357
|
-
"privacy": "private",
|
|
9358
|
-
"default": "new SlotController(this, \"header\")"
|
|
9359
|
-
}
|
|
9360
|
-
],
|
|
9361
|
-
"superclass": {
|
|
9362
|
-
"name": "LitElement",
|
|
9363
|
-
"package": "lit"
|
|
9364
|
-
},
|
|
9365
|
-
"localization": [],
|
|
9366
|
-
"status": "ready",
|
|
9367
|
-
"category": "navigation",
|
|
9368
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for primary navigation items that perform an action when clicked. Each action should navigate to a URL or trigger another action like a modal overlay.\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place a `<nav>` element inside the navigation component, as it already contains one internally.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
9369
|
-
"examples": [],
|
|
9370
|
-
"tagName": "nord-navigation",
|
|
9371
|
-
"customElement": true
|
|
9372
|
-
}
|
|
9373
|
-
],
|
|
9374
|
-
"exports": [
|
|
9375
|
-
{
|
|
9376
|
-
"kind": "js",
|
|
9377
|
-
"name": "default",
|
|
9378
|
-
"declaration": {
|
|
9379
|
-
"name": "Navigation",
|
|
9380
|
-
"module": "src/navigation/Navigation.ts"
|
|
9381
|
-
}
|
|
9382
|
-
},
|
|
9383
|
-
{
|
|
9384
|
-
"kind": "custom-element-definition",
|
|
9385
|
-
"name": "nord-navigation",
|
|
9386
|
-
"declaration": {
|
|
9387
|
-
"name": "Navigation",
|
|
9388
|
-
"module": "src/navigation/Navigation.ts"
|
|
9389
|
-
}
|
|
9390
|
-
}
|
|
9391
|
-
]
|
|
9392
|
-
},
|
|
9393
9386
|
{
|
|
9394
9387
|
"kind": "javascript-module",
|
|
9395
9388
|
"path": "src/popout/Popout.ts",
|
|
@@ -12280,21 +12273,20 @@
|
|
|
12280
12273
|
"kind": "field",
|
|
12281
12274
|
"name": "effect",
|
|
12282
12275
|
"type": {
|
|
12283
|
-
"text": "\"pulse\" | \"sheen\" |
|
|
12276
|
+
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
12284
12277
|
},
|
|
12285
|
-
"
|
|
12286
|
-
"
|
|
12287
|
-
"
|
|
12278
|
+
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
12279
|
+
"attribute": "effect",
|
|
12280
|
+
"reflects": true
|
|
12288
12281
|
}
|
|
12289
12282
|
],
|
|
12290
12283
|
"attributes": [
|
|
12291
12284
|
{
|
|
12292
12285
|
"name": "effect",
|
|
12293
12286
|
"type": {
|
|
12294
|
-
"text": "\"pulse\" | \"sheen\" |
|
|
12287
|
+
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
12295
12288
|
},
|
|
12296
|
-
"
|
|
12297
|
-
"description": "Determines which animation effect the skeleton will use.",
|
|
12289
|
+
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
12298
12290
|
"fieldName": "effect"
|
|
12299
12291
|
}
|
|
12300
12292
|
],
|
|
@@ -12943,6 +12935,53 @@
|
|
|
12943
12935
|
}
|
|
12944
12936
|
]
|
|
12945
12937
|
},
|
|
12938
|
+
{
|
|
12939
|
+
"kind": "javascript-module",
|
|
12940
|
+
"path": "src/tab-panel/TabPanel.ts",
|
|
12941
|
+
"declarations": [
|
|
12942
|
+
{
|
|
12943
|
+
"kind": "class",
|
|
12944
|
+
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
12945
|
+
"name": "TabPanel",
|
|
12946
|
+
"slots": [
|
|
12947
|
+
{
|
|
12948
|
+
"description": "The tab panel content.",
|
|
12949
|
+
"name": ""
|
|
12950
|
+
}
|
|
12951
|
+
],
|
|
12952
|
+
"members": [],
|
|
12953
|
+
"superclass": {
|
|
12954
|
+
"name": "LitElement",
|
|
12955
|
+
"package": "lit"
|
|
12956
|
+
},
|
|
12957
|
+
"localization": [],
|
|
12958
|
+
"status": "ready",
|
|
12959
|
+
"category": "navigation",
|
|
12960
|
+
"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",
|
|
12961
|
+
"examples": [],
|
|
12962
|
+
"tagName": "nord-tab-panel",
|
|
12963
|
+
"customElement": true
|
|
12964
|
+
}
|
|
12965
|
+
],
|
|
12966
|
+
"exports": [
|
|
12967
|
+
{
|
|
12968
|
+
"kind": "js",
|
|
12969
|
+
"name": "default",
|
|
12970
|
+
"declaration": {
|
|
12971
|
+
"name": "TabPanel",
|
|
12972
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
12973
|
+
}
|
|
12974
|
+
},
|
|
12975
|
+
{
|
|
12976
|
+
"kind": "custom-element-definition",
|
|
12977
|
+
"name": "nord-tab-panel",
|
|
12978
|
+
"declaration": {
|
|
12979
|
+
"name": "TabPanel",
|
|
12980
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
12981
|
+
}
|
|
12982
|
+
}
|
|
12983
|
+
]
|
|
12984
|
+
},
|
|
12946
12985
|
{
|
|
12947
12986
|
"kind": "javascript-module",
|
|
12948
12987
|
"path": "src/table/Table.ts",
|
|
@@ -13094,53 +13133,6 @@
|
|
|
13094
13133
|
}
|
|
13095
13134
|
]
|
|
13096
13135
|
},
|
|
13097
|
-
{
|
|
13098
|
-
"kind": "javascript-module",
|
|
13099
|
-
"path": "src/tab-panel/TabPanel.ts",
|
|
13100
|
-
"declarations": [
|
|
13101
|
-
{
|
|
13102
|
-
"kind": "class",
|
|
13103
|
-
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
13104
|
-
"name": "TabPanel",
|
|
13105
|
-
"slots": [
|
|
13106
|
-
{
|
|
13107
|
-
"description": "The tab panel content.",
|
|
13108
|
-
"name": ""
|
|
13109
|
-
}
|
|
13110
|
-
],
|
|
13111
|
-
"members": [],
|
|
13112
|
-
"superclass": {
|
|
13113
|
-
"name": "LitElement",
|
|
13114
|
-
"package": "lit"
|
|
13115
|
-
},
|
|
13116
|
-
"localization": [],
|
|
13117
|
-
"status": "ready",
|
|
13118
|
-
"category": "navigation",
|
|
13119
|
-
"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",
|
|
13120
|
-
"examples": [],
|
|
13121
|
-
"tagName": "nord-tab-panel",
|
|
13122
|
-
"customElement": true
|
|
13123
|
-
}
|
|
13124
|
-
],
|
|
13125
|
-
"exports": [
|
|
13126
|
-
{
|
|
13127
|
-
"kind": "js",
|
|
13128
|
-
"name": "default",
|
|
13129
|
-
"declaration": {
|
|
13130
|
-
"name": "TabPanel",
|
|
13131
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
13132
|
-
}
|
|
13133
|
-
},
|
|
13134
|
-
{
|
|
13135
|
-
"kind": "custom-element-definition",
|
|
13136
|
-
"name": "nord-tab-panel",
|
|
13137
|
-
"declaration": {
|
|
13138
|
-
"name": "TabPanel",
|
|
13139
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
13140
|
-
}
|
|
13141
|
-
}
|
|
13142
|
-
]
|
|
13143
|
-
},
|
|
13144
13136
|
{
|
|
13145
13137
|
"kind": "javascript-module",
|
|
13146
13138
|
"path": "src/textarea/Textarea.ts",
|