@nordhealth/components 3.5.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +1667 -1667
- package/lib/Layout.js +1 -1
- package/lib/Layout.js.map +1 -1
- package/lib/bundle.js +1 -1
- package/lib/bundle.js.map +1 -1
- package/package.json +3 -3
package/custom-elements.json
CHANGED
|
@@ -546,6 +546,91 @@
|
|
|
546
546
|
}
|
|
547
547
|
]
|
|
548
548
|
},
|
|
549
|
+
{
|
|
550
|
+
"kind": "javascript-module",
|
|
551
|
+
"path": "src/banner/Banner.ts",
|
|
552
|
+
"declarations": [
|
|
553
|
+
{
|
|
554
|
+
"kind": "class",
|
|
555
|
+
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
556
|
+
"name": "Banner",
|
|
557
|
+
"cssProperties": [
|
|
558
|
+
{
|
|
559
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
560
|
+
"name": "--n-banner-border-radius",
|
|
561
|
+
"default": "var(--n-border-radius)"
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
565
|
+
"name": "--n-banner-box-shadow",
|
|
566
|
+
"default": "var(--n-box-shadow-card)"
|
|
567
|
+
}
|
|
568
|
+
],
|
|
569
|
+
"slots": [
|
|
570
|
+
{
|
|
571
|
+
"description": "default slot",
|
|
572
|
+
"name": ""
|
|
573
|
+
}
|
|
574
|
+
],
|
|
575
|
+
"members": [
|
|
576
|
+
{
|
|
577
|
+
"kind": "field",
|
|
578
|
+
"name": "variant",
|
|
579
|
+
"type": {
|
|
580
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
581
|
+
},
|
|
582
|
+
"default": "\"info\"",
|
|
583
|
+
"description": "The style variant of the banner.",
|
|
584
|
+
"attribute": "variant",
|
|
585
|
+
"reflects": true
|
|
586
|
+
}
|
|
587
|
+
],
|
|
588
|
+
"attributes": [
|
|
589
|
+
{
|
|
590
|
+
"name": "variant",
|
|
591
|
+
"type": {
|
|
592
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
593
|
+
},
|
|
594
|
+
"default": "\"info\"",
|
|
595
|
+
"description": "The style variant of the banner.",
|
|
596
|
+
"fieldName": "variant"
|
|
597
|
+
}
|
|
598
|
+
],
|
|
599
|
+
"superclass": {
|
|
600
|
+
"name": "LitElement",
|
|
601
|
+
"package": "lit"
|
|
602
|
+
},
|
|
603
|
+
"localization": [],
|
|
604
|
+
"status": "ready",
|
|
605
|
+
"category": "feedback",
|
|
606
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
607
|
+
"examples": [],
|
|
608
|
+
"dependencies": [
|
|
609
|
+
"icon"
|
|
610
|
+
],
|
|
611
|
+
"tagName": "nord-banner",
|
|
612
|
+
"customElement": true
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"exports": [
|
|
616
|
+
{
|
|
617
|
+
"kind": "js",
|
|
618
|
+
"name": "default",
|
|
619
|
+
"declaration": {
|
|
620
|
+
"name": "Banner",
|
|
621
|
+
"module": "src/banner/Banner.ts"
|
|
622
|
+
}
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
"kind": "custom-element-definition",
|
|
626
|
+
"name": "nord-banner",
|
|
627
|
+
"declaration": {
|
|
628
|
+
"name": "Banner",
|
|
629
|
+
"module": "src/banner/Banner.ts"
|
|
630
|
+
}
|
|
631
|
+
}
|
|
632
|
+
]
|
|
633
|
+
},
|
|
549
634
|
{
|
|
550
635
|
"kind": "javascript-module",
|
|
551
636
|
"path": "src/avatar/Avatar.ts",
|
|
@@ -1330,91 +1415,6 @@
|
|
|
1330
1415
|
}
|
|
1331
1416
|
]
|
|
1332
1417
|
},
|
|
1333
|
-
{
|
|
1334
|
-
"kind": "javascript-module",
|
|
1335
|
-
"path": "src/banner/Banner.ts",
|
|
1336
|
-
"declarations": [
|
|
1337
|
-
{
|
|
1338
|
-
"kind": "class",
|
|
1339
|
-
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
1340
|
-
"name": "Banner",
|
|
1341
|
-
"cssProperties": [
|
|
1342
|
-
{
|
|
1343
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1344
|
-
"name": "--n-banner-border-radius",
|
|
1345
|
-
"default": "var(--n-border-radius)"
|
|
1346
|
-
},
|
|
1347
|
-
{
|
|
1348
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1349
|
-
"name": "--n-banner-box-shadow",
|
|
1350
|
-
"default": "var(--n-box-shadow-card)"
|
|
1351
|
-
}
|
|
1352
|
-
],
|
|
1353
|
-
"slots": [
|
|
1354
|
-
{
|
|
1355
|
-
"description": "default slot",
|
|
1356
|
-
"name": ""
|
|
1357
|
-
}
|
|
1358
|
-
],
|
|
1359
|
-
"members": [
|
|
1360
|
-
{
|
|
1361
|
-
"kind": "field",
|
|
1362
|
-
"name": "variant",
|
|
1363
|
-
"type": {
|
|
1364
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1365
|
-
},
|
|
1366
|
-
"default": "\"info\"",
|
|
1367
|
-
"description": "The style variant of the banner.",
|
|
1368
|
-
"attribute": "variant",
|
|
1369
|
-
"reflects": true
|
|
1370
|
-
}
|
|
1371
|
-
],
|
|
1372
|
-
"attributes": [
|
|
1373
|
-
{
|
|
1374
|
-
"name": "variant",
|
|
1375
|
-
"type": {
|
|
1376
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1377
|
-
},
|
|
1378
|
-
"default": "\"info\"",
|
|
1379
|
-
"description": "The style variant of the banner.",
|
|
1380
|
-
"fieldName": "variant"
|
|
1381
|
-
}
|
|
1382
|
-
],
|
|
1383
|
-
"superclass": {
|
|
1384
|
-
"name": "LitElement",
|
|
1385
|
-
"package": "lit"
|
|
1386
|
-
},
|
|
1387
|
-
"localization": [],
|
|
1388
|
-
"status": "ready",
|
|
1389
|
-
"category": "feedback",
|
|
1390
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
1391
|
-
"examples": [],
|
|
1392
|
-
"dependencies": [
|
|
1393
|
-
"icon"
|
|
1394
|
-
],
|
|
1395
|
-
"tagName": "nord-banner",
|
|
1396
|
-
"customElement": true
|
|
1397
|
-
}
|
|
1398
|
-
],
|
|
1399
|
-
"exports": [
|
|
1400
|
-
{
|
|
1401
|
-
"kind": "js",
|
|
1402
|
-
"name": "default",
|
|
1403
|
-
"declaration": {
|
|
1404
|
-
"name": "Banner",
|
|
1405
|
-
"module": "src/banner/Banner.ts"
|
|
1406
|
-
}
|
|
1407
|
-
},
|
|
1408
|
-
{
|
|
1409
|
-
"kind": "custom-element-definition",
|
|
1410
|
-
"name": "nord-banner",
|
|
1411
|
-
"declaration": {
|
|
1412
|
-
"name": "Banner",
|
|
1413
|
-
"module": "src/banner/Banner.ts"
|
|
1414
|
-
}
|
|
1415
|
-
}
|
|
1416
|
-
]
|
|
1417
|
-
},
|
|
1418
1418
|
{
|
|
1419
1419
|
"kind": "javascript-module",
|
|
1420
1420
|
"path": "src/button-group/ButtonGroup.ts",
|
|
@@ -4831,88 +4831,6 @@
|
|
|
4831
4831
|
}
|
|
4832
4832
|
]
|
|
4833
4833
|
},
|
|
4834
|
-
{
|
|
4835
|
-
"kind": "javascript-module",
|
|
4836
|
-
"path": "src/divider/Divider.ts",
|
|
4837
|
-
"declarations": [
|
|
4838
|
-
{
|
|
4839
|
-
"kind": "class",
|
|
4840
|
-
"description": "Divider components are used to separate and distinguish sections of\ncontent or groups of menu items. Visually, they look like\nhorizontal or vertical lines.",
|
|
4841
|
-
"name": "Divider",
|
|
4842
|
-
"cssProperties": [
|
|
4843
|
-
{
|
|
4844
|
-
"description": "Controls the color of the divider, using our [color tokens](/tokens/#color).",
|
|
4845
|
-
"name": "--n-divider-color",
|
|
4846
|
-
"default": "var(--n-color-border)"
|
|
4847
|
-
},
|
|
4848
|
-
{
|
|
4849
|
-
"description": "Controls the size, or thickness, of the divider.",
|
|
4850
|
-
"name": "--n-divider-size",
|
|
4851
|
-
"default": "1px"
|
|
4852
|
-
}
|
|
4853
|
-
],
|
|
4854
|
-
"members": [
|
|
4855
|
-
{
|
|
4856
|
-
"kind": "field",
|
|
4857
|
-
"name": "direction",
|
|
4858
|
-
"type": {
|
|
4859
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
4860
|
-
},
|
|
4861
|
-
"default": "\"horizontal\"",
|
|
4862
|
-
"description": "The direction of the divider.",
|
|
4863
|
-
"attribute": "direction",
|
|
4864
|
-
"reflects": true
|
|
4865
|
-
},
|
|
4866
|
-
{
|
|
4867
|
-
"kind": "method",
|
|
4868
|
-
"name": "handleDirectionChange",
|
|
4869
|
-
"privacy": "private"
|
|
4870
|
-
}
|
|
4871
|
-
],
|
|
4872
|
-
"attributes": [
|
|
4873
|
-
{
|
|
4874
|
-
"name": "direction",
|
|
4875
|
-
"type": {
|
|
4876
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
4877
|
-
},
|
|
4878
|
-
"default": "\"horizontal\"",
|
|
4879
|
-
"description": "The direction of the divider.",
|
|
4880
|
-
"fieldName": "direction"
|
|
4881
|
-
}
|
|
4882
|
-
],
|
|
4883
|
-
"superclass": {
|
|
4884
|
-
"name": "LitElement",
|
|
4885
|
-
"package": "lit"
|
|
4886
|
-
},
|
|
4887
|
-
"localization": [],
|
|
4888
|
-
"status": "new",
|
|
4889
|
-
"category": "structure",
|
|
4890
|
-
"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 represent thematic breaks between elements.\n- Use when you need to divide sections of content from each other.\n- Use to separate content into clear groups.\n- Use dividers sparingly, to create groupings or to separate items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Avoid using for presentational purposes only.\n- Don’t use strong colors in dividers.\n- Don’t use dividers for replacing card components.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Divider uses a role called `separator` which indicates that the element is a divider that separates and distinguishes sections of content or groups of menu items. The implicit ARIA role of the native thematic break (`<hr>` element) is a separator.\n- Dividers have an implicit aria-orientation value of `horizontal` which can be changed using the `direction` property.\n- For more details, please see [ARIA: separator role on MDN](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/separator_role).\n",
|
|
4891
|
-
"examples": [],
|
|
4892
|
-
"dependencies": [],
|
|
4893
|
-
"tagName": "nord-divider",
|
|
4894
|
-
"customElement": true
|
|
4895
|
-
}
|
|
4896
|
-
],
|
|
4897
|
-
"exports": [
|
|
4898
|
-
{
|
|
4899
|
-
"kind": "js",
|
|
4900
|
-
"name": "default",
|
|
4901
|
-
"declaration": {
|
|
4902
|
-
"name": "Divider",
|
|
4903
|
-
"module": "src/divider/Divider.ts"
|
|
4904
|
-
}
|
|
4905
|
-
},
|
|
4906
|
-
{
|
|
4907
|
-
"kind": "custom-element-definition",
|
|
4908
|
-
"name": "nord-divider",
|
|
4909
|
-
"declaration": {
|
|
4910
|
-
"name": "Divider",
|
|
4911
|
-
"module": "src/divider/Divider.ts"
|
|
4912
|
-
}
|
|
4913
|
-
}
|
|
4914
|
-
]
|
|
4915
|
-
},
|
|
4916
4834
|
{
|
|
4917
4835
|
"kind": "javascript-module",
|
|
4918
4836
|
"path": "src/date-picker/DatePicker.ts",
|
|
@@ -5952,12 +5870,94 @@
|
|
|
5952
5870
|
},
|
|
5953
5871
|
{
|
|
5954
5872
|
"kind": "javascript-module",
|
|
5955
|
-
"path": "src/
|
|
5873
|
+
"path": "src/divider/Divider.ts",
|
|
5956
5874
|
"declarations": [
|
|
5957
5875
|
{
|
|
5958
5876
|
"kind": "class",
|
|
5959
|
-
"description": "
|
|
5960
|
-
"name": "
|
|
5877
|
+
"description": "Divider components are used to separate and distinguish sections of\ncontent or groups of menu items. Visually, they look like\nhorizontal or vertical lines.",
|
|
5878
|
+
"name": "Divider",
|
|
5879
|
+
"cssProperties": [
|
|
5880
|
+
{
|
|
5881
|
+
"description": "Controls the color of the divider, using our [color tokens](/tokens/#color).",
|
|
5882
|
+
"name": "--n-divider-color",
|
|
5883
|
+
"default": "var(--n-color-border)"
|
|
5884
|
+
},
|
|
5885
|
+
{
|
|
5886
|
+
"description": "Controls the size, or thickness, of the divider.",
|
|
5887
|
+
"name": "--n-divider-size",
|
|
5888
|
+
"default": "1px"
|
|
5889
|
+
}
|
|
5890
|
+
],
|
|
5891
|
+
"members": [
|
|
5892
|
+
{
|
|
5893
|
+
"kind": "field",
|
|
5894
|
+
"name": "direction",
|
|
5895
|
+
"type": {
|
|
5896
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
5897
|
+
},
|
|
5898
|
+
"default": "\"horizontal\"",
|
|
5899
|
+
"description": "The direction of the divider.",
|
|
5900
|
+
"attribute": "direction",
|
|
5901
|
+
"reflects": true
|
|
5902
|
+
},
|
|
5903
|
+
{
|
|
5904
|
+
"kind": "method",
|
|
5905
|
+
"name": "handleDirectionChange",
|
|
5906
|
+
"privacy": "private"
|
|
5907
|
+
}
|
|
5908
|
+
],
|
|
5909
|
+
"attributes": [
|
|
5910
|
+
{
|
|
5911
|
+
"name": "direction",
|
|
5912
|
+
"type": {
|
|
5913
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
5914
|
+
},
|
|
5915
|
+
"default": "\"horizontal\"",
|
|
5916
|
+
"description": "The direction of the divider.",
|
|
5917
|
+
"fieldName": "direction"
|
|
5918
|
+
}
|
|
5919
|
+
],
|
|
5920
|
+
"superclass": {
|
|
5921
|
+
"name": "LitElement",
|
|
5922
|
+
"package": "lit"
|
|
5923
|
+
},
|
|
5924
|
+
"localization": [],
|
|
5925
|
+
"status": "new",
|
|
5926
|
+
"category": "structure",
|
|
5927
|
+
"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 represent thematic breaks between elements.\n- Use when you need to divide sections of content from each other.\n- Use to separate content into clear groups.\n- Use dividers sparingly, to create groupings or to separate items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Avoid using for presentational purposes only.\n- Don’t use strong colors in dividers.\n- Don’t use dividers for replacing card components.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Divider uses a role called `separator` which indicates that the element is a divider that separates and distinguishes sections of content or groups of menu items. The implicit ARIA role of the native thematic break (`<hr>` element) is a separator.\n- Dividers have an implicit aria-orientation value of `horizontal` which can be changed using the `direction` property.\n- For more details, please see [ARIA: separator role on MDN](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/separator_role).\n",
|
|
5928
|
+
"examples": [],
|
|
5929
|
+
"dependencies": [],
|
|
5930
|
+
"tagName": "nord-divider",
|
|
5931
|
+
"customElement": true
|
|
5932
|
+
}
|
|
5933
|
+
],
|
|
5934
|
+
"exports": [
|
|
5935
|
+
{
|
|
5936
|
+
"kind": "js",
|
|
5937
|
+
"name": "default",
|
|
5938
|
+
"declaration": {
|
|
5939
|
+
"name": "Divider",
|
|
5940
|
+
"module": "src/divider/Divider.ts"
|
|
5941
|
+
}
|
|
5942
|
+
},
|
|
5943
|
+
{
|
|
5944
|
+
"kind": "custom-element-definition",
|
|
5945
|
+
"name": "nord-divider",
|
|
5946
|
+
"declaration": {
|
|
5947
|
+
"name": "Divider",
|
|
5948
|
+
"module": "src/divider/Divider.ts"
|
|
5949
|
+
}
|
|
5950
|
+
}
|
|
5951
|
+
]
|
|
5952
|
+
},
|
|
5953
|
+
{
|
|
5954
|
+
"kind": "javascript-module",
|
|
5955
|
+
"path": "src/drawer/Drawer.ts",
|
|
5956
|
+
"declarations": [
|
|
5957
|
+
{
|
|
5958
|
+
"kind": "class",
|
|
5959
|
+
"description": "Drawer is used to display context-sensitive actions and information.\nDrawer doesn’t block users from completing their task, like a modal would.",
|
|
5960
|
+
"name": "Drawer",
|
|
5961
5961
|
"cssProperties": [
|
|
5962
5962
|
{
|
|
5963
5963
|
"description": "Controls the padding around the main area (the default slot), using our [spacing tokens](/tokens/#space).",
|
|
@@ -6870,495 +6870,325 @@
|
|
|
6870
6870
|
},
|
|
6871
6871
|
{
|
|
6872
6872
|
"kind": "javascript-module",
|
|
6873
|
-
"path": "src/
|
|
6873
|
+
"path": "src/icon/Icon.ts",
|
|
6874
6874
|
"declarations": [
|
|
6875
6875
|
{
|
|
6876
6876
|
"kind": "class",
|
|
6877
|
-
"description": "
|
|
6878
|
-
"name": "
|
|
6879
|
-
"
|
|
6880
|
-
{
|
|
6881
|
-
"description": "Controls the padding around the main layout area (the main slot), using our [spacing tokens](/tokens/#space).",
|
|
6882
|
-
"name": "--n-layout-padding",
|
|
6883
|
-
"default": "var(--n-space-l)"
|
|
6884
|
-
},
|
|
6885
|
-
{
|
|
6886
|
-
"description": "Controls the width of the drawer area, when used.",
|
|
6887
|
-
"name": "--n-layout-drawer-inline-size",
|
|
6888
|
-
"default": "320px"
|
|
6889
|
-
},
|
|
6877
|
+
"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.",
|
|
6878
|
+
"name": "Icon",
|
|
6879
|
+
"slots": [
|
|
6890
6880
|
{
|
|
6891
|
-
"description": "
|
|
6892
|
-
"name": "
|
|
6893
|
-
"default": "var(--n-color-background)"
|
|
6881
|
+
"description": "The default slot used for placing a custom SVG icon.",
|
|
6882
|
+
"name": ""
|
|
6894
6883
|
}
|
|
6895
6884
|
],
|
|
6896
|
-
"
|
|
6885
|
+
"members": [
|
|
6897
6886
|
{
|
|
6898
|
-
"
|
|
6899
|
-
"name": ""
|
|
6887
|
+
"kind": "field",
|
|
6888
|
+
"name": "manager",
|
|
6889
|
+
"privacy": "private",
|
|
6890
|
+
"static": true,
|
|
6891
|
+
"default": "new IconManager()"
|
|
6900
6892
|
},
|
|
6901
6893
|
{
|
|
6902
|
-
"
|
|
6903
|
-
"name": "
|
|
6894
|
+
"kind": "method",
|
|
6895
|
+
"name": "registerResolver",
|
|
6896
|
+
"static": true,
|
|
6897
|
+
"parameters": [
|
|
6898
|
+
{
|
|
6899
|
+
"name": "resolver",
|
|
6900
|
+
"type": {
|
|
6901
|
+
"text": "IconResolver"
|
|
6902
|
+
},
|
|
6903
|
+
"description": "The resolver function to register."
|
|
6904
|
+
}
|
|
6905
|
+
],
|
|
6906
|
+
"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."
|
|
6904
6907
|
},
|
|
6905
6908
|
{
|
|
6906
|
-
"
|
|
6907
|
-
"name": "
|
|
6909
|
+
"kind": "method",
|
|
6910
|
+
"name": "registerIcon",
|
|
6911
|
+
"static": true,
|
|
6912
|
+
"return": {
|
|
6913
|
+
"type": {
|
|
6914
|
+
"text": "void"
|
|
6915
|
+
}
|
|
6916
|
+
},
|
|
6917
|
+
"parameters": [
|
|
6918
|
+
{
|
|
6919
|
+
"name": "icon",
|
|
6920
|
+
"type": {
|
|
6921
|
+
"text": "{ title: string; default: string }"
|
|
6922
|
+
},
|
|
6923
|
+
"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."
|
|
6924
|
+
}
|
|
6925
|
+
],
|
|
6926
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
6908
6927
|
},
|
|
6909
6928
|
{
|
|
6910
|
-
"
|
|
6911
|
-
"name": "
|
|
6929
|
+
"kind": "method",
|
|
6930
|
+
"name": "registerIcon",
|
|
6931
|
+
"static": true,
|
|
6932
|
+
"return": {
|
|
6933
|
+
"type": {
|
|
6934
|
+
"text": "void"
|
|
6935
|
+
}
|
|
6936
|
+
},
|
|
6937
|
+
"parameters": [
|
|
6938
|
+
{
|
|
6939
|
+
"name": "name",
|
|
6940
|
+
"type": {
|
|
6941
|
+
"text": "string"
|
|
6942
|
+
},
|
|
6943
|
+
"description": "The name of the icon to be registered."
|
|
6944
|
+
},
|
|
6945
|
+
{
|
|
6946
|
+
"name": "icon",
|
|
6947
|
+
"type": {
|
|
6948
|
+
"text": "string"
|
|
6949
|
+
},
|
|
6950
|
+
"description": "The SVG string for the icon."
|
|
6951
|
+
}
|
|
6952
|
+
],
|
|
6953
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
6912
6954
|
},
|
|
6913
6955
|
{
|
|
6914
|
-
"
|
|
6915
|
-
"name": "
|
|
6956
|
+
"kind": "method",
|
|
6957
|
+
"name": "registerIcon",
|
|
6958
|
+
"static": true,
|
|
6959
|
+
"parameters": [
|
|
6960
|
+
{
|
|
6961
|
+
"name": "iconOrName",
|
|
6962
|
+
"type": {
|
|
6963
|
+
"text": "string | { title: string; default: string }"
|
|
6964
|
+
},
|
|
6965
|
+
"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."
|
|
6966
|
+
},
|
|
6967
|
+
{
|
|
6968
|
+
"name": "icon",
|
|
6969
|
+
"optional": true,
|
|
6970
|
+
"type": {
|
|
6971
|
+
"text": "string"
|
|
6972
|
+
},
|
|
6973
|
+
"description": "The SVG string for the icon."
|
|
6974
|
+
}
|
|
6975
|
+
],
|
|
6976
|
+
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
6916
6977
|
},
|
|
6917
|
-
{
|
|
6918
|
-
"description": "Used to place a own nav-toggle component, for cases where you might need to add a tooltip.",
|
|
6919
|
-
"name": "nav-toggle"
|
|
6920
|
-
}
|
|
6921
|
-
],
|
|
6922
|
-
"members": [
|
|
6923
6978
|
{
|
|
6924
6979
|
"kind": "field",
|
|
6925
|
-
"name": "
|
|
6980
|
+
"name": "name",
|
|
6926
6981
|
"type": {
|
|
6927
|
-
"text": "
|
|
6982
|
+
"text": "string"
|
|
6928
6983
|
},
|
|
6929
|
-
"
|
|
6984
|
+
"default": "\"\"",
|
|
6985
|
+
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
6986
|
+
"attribute": "name",
|
|
6987
|
+
"reflects": true
|
|
6930
6988
|
},
|
|
6931
6989
|
{
|
|
6932
6990
|
"kind": "field",
|
|
6933
|
-
"name": "
|
|
6934
|
-
"
|
|
6935
|
-
|
|
6991
|
+
"name": "size",
|
|
6992
|
+
"type": {
|
|
6993
|
+
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
6994
|
+
},
|
|
6995
|
+
"description": "The size of the icon.",
|
|
6996
|
+
"attribute": "size",
|
|
6997
|
+
"reflects": true
|
|
6936
6998
|
},
|
|
6937
6999
|
{
|
|
6938
7000
|
"kind": "field",
|
|
6939
|
-
"name": "
|
|
6940
|
-
"
|
|
6941
|
-
|
|
7001
|
+
"name": "color",
|
|
7002
|
+
"type": {
|
|
7003
|
+
"text": "string | undefined"
|
|
7004
|
+
},
|
|
7005
|
+
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
7006
|
+
"attribute": "color",
|
|
7007
|
+
"reflects": true
|
|
6942
7008
|
},
|
|
6943
7009
|
{
|
|
6944
7010
|
"kind": "field",
|
|
6945
|
-
"name": "
|
|
6946
|
-
"
|
|
6947
|
-
|
|
7011
|
+
"name": "label",
|
|
7012
|
+
"type": {
|
|
7013
|
+
"text": "string | undefined"
|
|
7014
|
+
},
|
|
7015
|
+
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
7016
|
+
"attribute": "label",
|
|
7017
|
+
"reflects": true
|
|
6948
7018
|
},
|
|
6949
7019
|
{
|
|
6950
7020
|
"kind": "field",
|
|
6951
|
-
"name": "
|
|
7021
|
+
"name": "svg",
|
|
7022
|
+
"type": {
|
|
7023
|
+
"text": "string"
|
|
7024
|
+
},
|
|
6952
7025
|
"privacy": "private",
|
|
6953
|
-
"default": "
|
|
7026
|
+
"default": "\"\""
|
|
6954
7027
|
},
|
|
6955
7028
|
{
|
|
6956
|
-
"kind": "
|
|
6957
|
-
"name": "
|
|
6958
|
-
"privacy": "
|
|
6959
|
-
|
|
6960
|
-
|
|
6961
|
-
|
|
6962
|
-
"kind": "field",
|
|
6963
|
-
"name": "events",
|
|
6964
|
-
"privacy": "private",
|
|
6965
|
-
"default": "new EventController(this)"
|
|
6966
|
-
},
|
|
6967
|
-
{
|
|
6968
|
-
"kind": "field",
|
|
6969
|
-
"name": "lightDismiss",
|
|
6970
|
-
"privacy": "private",
|
|
6971
|
-
"default": "new LightDismissController(this, {\n isOpen: () => this.navState === \"opened\" && !this.wideScreen,\n onDismiss: () => this.navTransition(\"close\"),\n isDismissible: node => node !== this.navEl,\n })"
|
|
6972
|
-
},
|
|
6973
|
-
{
|
|
6974
|
-
"kind": "field",
|
|
6975
|
-
"name": "broadcast",
|
|
6976
|
-
"privacy": "private",
|
|
6977
|
-
"default": "new BroadcastChannelController<{ navOpen: boolean } | { navWidth: number }>(this, {\n channelName: \"nord-layout-nav-state\",\n enabled: () => this.syncNavState && this.wideScreen,\n onMessage: data => {\n if (\"navOpen\" in data) {\n this.navOpen = data.navOpen\n }\n if (\"navWidth\" in data) {\n this.navWidth = data.navWidth\n }\n },\n })"
|
|
6978
|
-
},
|
|
6979
|
-
{
|
|
6980
|
-
"kind": "field",
|
|
6981
|
-
"name": "navEl",
|
|
6982
|
-
"type": {
|
|
6983
|
-
"text": "HTMLDivElement"
|
|
6984
|
-
},
|
|
6985
|
-
"privacy": "private"
|
|
6986
|
-
},
|
|
6987
|
-
{
|
|
6988
|
-
"kind": "field",
|
|
6989
|
-
"name": "navWidth",
|
|
6990
|
-
"privacy": "private"
|
|
6991
|
-
},
|
|
6992
|
-
{
|
|
6993
|
-
"kind": "field",
|
|
6994
|
-
"name": "isDragging",
|
|
6995
|
-
"type": {
|
|
6996
|
-
"text": "boolean"
|
|
6997
|
-
},
|
|
6998
|
-
"privacy": "private",
|
|
6999
|
-
"default": "false"
|
|
7000
|
-
},
|
|
7001
|
-
{
|
|
7002
|
-
"kind": "field",
|
|
7003
|
-
"name": "navState",
|
|
7004
|
-
"type": {
|
|
7005
|
-
"text": "NavState"
|
|
7006
|
-
},
|
|
7007
|
-
"privacy": "private"
|
|
7008
|
-
},
|
|
7009
|
-
{
|
|
7010
|
-
"kind": "field",
|
|
7011
|
-
"name": "wideScreen",
|
|
7012
|
-
"privacy": "private"
|
|
7013
|
-
},
|
|
7029
|
+
"kind": "method",
|
|
7030
|
+
"name": "handleNameChange",
|
|
7031
|
+
"privacy": "protected"
|
|
7032
|
+
}
|
|
7033
|
+
],
|
|
7034
|
+
"attributes": [
|
|
7014
7035
|
{
|
|
7015
|
-
"
|
|
7016
|
-
"name": "navOpen",
|
|
7036
|
+
"name": "name",
|
|
7017
7037
|
"type": {
|
|
7018
|
-
"text": "
|
|
7038
|
+
"text": "string"
|
|
7019
7039
|
},
|
|
7020
|
-
"
|
|
7021
|
-
"
|
|
7022
|
-
"
|
|
7040
|
+
"default": "\"\"",
|
|
7041
|
+
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
7042
|
+
"fieldName": "name"
|
|
7023
7043
|
},
|
|
7024
7044
|
{
|
|
7025
|
-
"
|
|
7026
|
-
"name": "persistNavState",
|
|
7045
|
+
"name": "size",
|
|
7027
7046
|
"type": {
|
|
7028
|
-
"text": "
|
|
7047
|
+
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
7029
7048
|
},
|
|
7030
|
-
"
|
|
7031
|
-
"
|
|
7032
|
-
"attribute": "persist-nav-state"
|
|
7049
|
+
"description": "The size of the icon.",
|
|
7050
|
+
"fieldName": "size"
|
|
7033
7051
|
},
|
|
7034
7052
|
{
|
|
7035
|
-
"
|
|
7036
|
-
"name": "syncNavState",
|
|
7053
|
+
"name": "color",
|
|
7037
7054
|
"type": {
|
|
7038
|
-
"text": "
|
|
7055
|
+
"text": "string | undefined"
|
|
7039
7056
|
},
|
|
7040
|
-
"
|
|
7041
|
-
"
|
|
7042
|
-
"attribute": "sync-nav-state",
|
|
7043
|
-
"reflects": true
|
|
7057
|
+
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
7058
|
+
"fieldName": "color"
|
|
7044
7059
|
},
|
|
7045
7060
|
{
|
|
7046
|
-
"
|
|
7047
|
-
"name": "padding",
|
|
7061
|
+
"name": "label",
|
|
7048
7062
|
"type": {
|
|
7049
|
-
"text": "
|
|
7063
|
+
"text": "string | undefined"
|
|
7050
7064
|
},
|
|
7051
|
-
"
|
|
7052
|
-
"
|
|
7053
|
-
|
|
7054
|
-
|
|
7055
|
-
|
|
7065
|
+
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
7066
|
+
"fieldName": "label"
|
|
7067
|
+
}
|
|
7068
|
+
],
|
|
7069
|
+
"superclass": {
|
|
7070
|
+
"name": "LitElement",
|
|
7071
|
+
"package": "lit"
|
|
7072
|
+
},
|
|
7073
|
+
"localization": [],
|
|
7074
|
+
"status": "ready",
|
|
7075
|
+
"category": "image",
|
|
7076
|
+
"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",
|
|
7077
|
+
"examples": [],
|
|
7078
|
+
"dependencies": [],
|
|
7079
|
+
"tagName": "nord-icon",
|
|
7080
|
+
"customElement": true
|
|
7081
|
+
}
|
|
7082
|
+
],
|
|
7083
|
+
"exports": [
|
|
7084
|
+
{
|
|
7085
|
+
"kind": "js",
|
|
7086
|
+
"name": "default",
|
|
7087
|
+
"declaration": {
|
|
7088
|
+
"name": "Icon",
|
|
7089
|
+
"module": "src/icon/Icon.ts"
|
|
7090
|
+
}
|
|
7091
|
+
},
|
|
7092
|
+
{
|
|
7093
|
+
"kind": "custom-element-definition",
|
|
7094
|
+
"name": "nord-icon",
|
|
7095
|
+
"declaration": {
|
|
7096
|
+
"name": "Icon",
|
|
7097
|
+
"module": "src/icon/Icon.ts"
|
|
7098
|
+
}
|
|
7099
|
+
}
|
|
7100
|
+
]
|
|
7101
|
+
},
|
|
7102
|
+
{
|
|
7103
|
+
"kind": "javascript-module",
|
|
7104
|
+
"path": "src/icon/IconManager.ts",
|
|
7105
|
+
"declarations": [
|
|
7106
|
+
{
|
|
7107
|
+
"kind": "class",
|
|
7108
|
+
"description": "",
|
|
7109
|
+
"name": "IconManager",
|
|
7110
|
+
"members": [
|
|
7056
7111
|
{
|
|
7057
7112
|
"kind": "field",
|
|
7058
|
-
"name": "
|
|
7059
|
-
"
|
|
7060
|
-
|
|
7061
|
-
},
|
|
7062
|
-
"default": "false",
|
|
7063
|
-
"description": "Controls whether the layout's header has sticky positioning.",
|
|
7064
|
-
"attribute": "sticky",
|
|
7065
|
-
"reflects": true
|
|
7113
|
+
"name": "cache",
|
|
7114
|
+
"privacy": "private",
|
|
7115
|
+
"default": "new Map<string, string | Promise<string>>()"
|
|
7066
7116
|
},
|
|
7067
7117
|
{
|
|
7068
7118
|
"kind": "field",
|
|
7069
|
-
"name": "
|
|
7119
|
+
"name": "resolver",
|
|
7070
7120
|
"type": {
|
|
7071
|
-
"text": "
|
|
7072
|
-
}
|
|
7073
|
-
"description": "A getter whose values reflects whether the layout component considers the viewport to be narrow or not.\nA narrow viewport is considered to be less than 768px wide.",
|
|
7074
|
-
"readonly": true
|
|
7075
|
-
},
|
|
7076
|
-
{
|
|
7077
|
-
"kind": "method",
|
|
7078
|
-
"name": "renderNavToggle",
|
|
7079
|
-
"privacy": "private"
|
|
7080
|
-
},
|
|
7081
|
-
{
|
|
7082
|
-
"kind": "method",
|
|
7083
|
-
"name": "renderNavCollapse",
|
|
7084
|
-
"privacy": "private"
|
|
7085
|
-
},
|
|
7086
|
-
{
|
|
7087
|
-
"kind": "method",
|
|
7088
|
-
"name": "handleNavWidthChange",
|
|
7089
|
-
"privacy": "protected"
|
|
7121
|
+
"text": "IconResolver"
|
|
7122
|
+
}
|
|
7090
7123
|
},
|
|
7091
7124
|
{
|
|
7092
7125
|
"kind": "method",
|
|
7093
|
-
"name": "
|
|
7094
|
-
"privacy": "protected",
|
|
7126
|
+
"name": "resolve",
|
|
7095
7127
|
"parameters": [
|
|
7096
7128
|
{
|
|
7097
|
-
"name": "
|
|
7129
|
+
"name": "name",
|
|
7098
7130
|
"type": {
|
|
7099
|
-
"text": "
|
|
7131
|
+
"text": "string"
|
|
7100
7132
|
}
|
|
7101
|
-
}
|
|
7102
|
-
]
|
|
7103
|
-
},
|
|
7104
|
-
{
|
|
7105
|
-
"kind": "method",
|
|
7106
|
-
"name": "handleOpenChange",
|
|
7107
|
-
"privacy": "protected",
|
|
7108
|
-
"parameters": [
|
|
7133
|
+
},
|
|
7109
7134
|
{
|
|
7110
|
-
"name": "
|
|
7135
|
+
"name": "onResolved",
|
|
7111
7136
|
"type": {
|
|
7112
|
-
"text": "
|
|
7137
|
+
"text": "(svg: string) => void"
|
|
7113
7138
|
}
|
|
7114
7139
|
}
|
|
7115
7140
|
]
|
|
7116
7141
|
},
|
|
7117
7142
|
{
|
|
7118
7143
|
"kind": "method",
|
|
7119
|
-
"name": "
|
|
7120
|
-
"privacy": "private",
|
|
7144
|
+
"name": "registerIcon",
|
|
7121
7145
|
"parameters": [
|
|
7122
7146
|
{
|
|
7123
|
-
"name": "
|
|
7147
|
+
"name": "iconOrName",
|
|
7124
7148
|
"type": {
|
|
7125
|
-
"text": "
|
|
7149
|
+
"text": "string | { title: string; default: string }"
|
|
7126
7150
|
}
|
|
7127
|
-
}
|
|
7128
|
-
]
|
|
7129
|
-
},
|
|
7130
|
-
{
|
|
7131
|
-
"kind": "method",
|
|
7132
|
-
"name": "handleNavClick",
|
|
7133
|
-
"privacy": "private",
|
|
7134
|
-
"parameters": [
|
|
7151
|
+
},
|
|
7135
7152
|
{
|
|
7136
|
-
"name": "
|
|
7153
|
+
"name": "icon",
|
|
7154
|
+
"optional": true,
|
|
7137
7155
|
"type": {
|
|
7138
|
-
"text": "
|
|
7156
|
+
"text": "string"
|
|
7139
7157
|
}
|
|
7140
7158
|
}
|
|
7141
7159
|
]
|
|
7142
7160
|
},
|
|
7143
7161
|
{
|
|
7144
7162
|
"kind": "method",
|
|
7145
|
-
"name": "
|
|
7146
|
-
|
|
7147
|
-
|
|
7148
|
-
|
|
7149
|
-
|
|
7150
|
-
|
|
7151
|
-
|
|
7152
|
-
|
|
7153
|
-
|
|
7154
|
-
|
|
7155
|
-
|
|
7156
|
-
|
|
7157
|
-
|
|
7158
|
-
|
|
7159
|
-
|
|
7160
|
-
|
|
7161
|
-
|
|
7162
|
-
|
|
7163
|
-
|
|
7164
|
-
|
|
7165
|
-
|
|
7166
|
-
|
|
7167
|
-
|
|
7168
|
-
|
|
7169
|
-
|
|
7170
|
-
|
|
7171
|
-
|
|
7172
|
-
|
|
7173
|
-
|
|
7174
|
-
{
|
|
7175
|
-
"kind": "field",
|
|
7176
|
-
"name": "handleMediaQueryChange",
|
|
7177
|
-
"privacy": "private"
|
|
7178
|
-
},
|
|
7179
|
-
{
|
|
7180
|
-
"kind": "field",
|
|
7181
|
-
"name": "handleToggleClick",
|
|
7182
|
-
"privacy": "private"
|
|
7183
|
-
},
|
|
7184
|
-
{
|
|
7185
|
-
"kind": "field",
|
|
7186
|
-
"name": "handleNavFocus",
|
|
7187
|
-
"privacy": "private"
|
|
7188
|
-
},
|
|
7189
|
-
{
|
|
7190
|
-
"kind": "field",
|
|
7191
|
-
"name": "handleMainFocus",
|
|
7192
|
-
"privacy": "private"
|
|
7193
|
-
},
|
|
7194
|
-
{
|
|
7195
|
-
"kind": "field",
|
|
7196
|
-
"name": "handleMouseEnter",
|
|
7197
|
-
"privacy": "private"
|
|
7198
|
-
},
|
|
7199
|
-
{
|
|
7200
|
-
"kind": "field",
|
|
7201
|
-
"name": "handleMouseLeave",
|
|
7202
|
-
"privacy": "private"
|
|
7203
|
-
},
|
|
7204
|
-
{
|
|
7205
|
-
"kind": "field",
|
|
7206
|
-
"name": "handleTransitionEnd",
|
|
7207
|
-
"privacy": "private"
|
|
7208
|
-
},
|
|
7209
|
-
{
|
|
7210
|
-
"kind": "method",
|
|
7211
|
-
"name": "handleKeyboardResize",
|
|
7212
|
-
"privacy": "private",
|
|
7213
|
-
"parameters": [
|
|
7214
|
-
{
|
|
7215
|
-
"name": "e",
|
|
7216
|
-
"type": {
|
|
7217
|
-
"text": "KeyboardEvent"
|
|
7218
|
-
}
|
|
7219
|
-
}
|
|
7220
|
-
]
|
|
7221
|
-
},
|
|
7222
|
-
{
|
|
7223
|
-
"kind": "method",
|
|
7224
|
-
"name": "setNavWidth",
|
|
7225
|
-
"privacy": "private",
|
|
7226
|
-
"parameters": [
|
|
7227
|
-
{
|
|
7228
|
-
"name": "width",
|
|
7229
|
-
"type": {
|
|
7230
|
-
"text": "number"
|
|
7231
|
-
}
|
|
7232
|
-
}
|
|
7233
|
-
]
|
|
7234
|
-
},
|
|
7235
|
-
{
|
|
7236
|
-
"kind": "method",
|
|
7237
|
-
"name": "startDragging",
|
|
7238
|
-
"privacy": "private",
|
|
7239
|
-
"parameters": [
|
|
7240
|
-
{
|
|
7241
|
-
"name": "e",
|
|
7242
|
-
"type": {
|
|
7243
|
-
"text": "PointerEvent"
|
|
7244
|
-
}
|
|
7245
|
-
}
|
|
7246
|
-
]
|
|
7247
|
-
},
|
|
7248
|
-
{
|
|
7249
|
-
"kind": "method",
|
|
7250
|
-
"name": "stopDragging",
|
|
7251
|
-
"privacy": "private"
|
|
7252
|
-
},
|
|
7253
|
-
{
|
|
7254
|
-
"kind": "method",
|
|
7255
|
-
"name": "handleDrag",
|
|
7256
|
-
"privacy": "private",
|
|
7257
|
-
"parameters": [
|
|
7258
|
-
{
|
|
7259
|
-
"name": "e",
|
|
7260
|
-
"type": {
|
|
7261
|
-
"text": "PointerEvent"
|
|
7262
|
-
}
|
|
7263
|
-
}
|
|
7264
|
-
]
|
|
7265
|
-
}
|
|
7266
|
-
],
|
|
7267
|
-
"attributes": [
|
|
7268
|
-
{
|
|
7269
|
-
"name": "nav-open",
|
|
7270
|
-
"type": {
|
|
7271
|
-
"text": "boolean"
|
|
7272
|
-
},
|
|
7273
|
-
"description": "Controls whether the navigation is hidden off-screen or not.\nDefaults to `true` for wide viewports, and `false` otherwise.",
|
|
7274
|
-
"fieldName": "navOpen"
|
|
7275
|
-
},
|
|
7276
|
-
{
|
|
7277
|
-
"name": "persist-nav-state",
|
|
7278
|
-
"type": {
|
|
7279
|
-
"text": "boolean"
|
|
7280
|
-
},
|
|
7281
|
-
"default": "false",
|
|
7282
|
-
"description": "Controls whether the navigation's open/closed state is persisted across page loads.\nThis is useful for multi-page apps, where clicks on links trigger a full page load.",
|
|
7283
|
-
"fieldName": "persistNavState"
|
|
7284
|
-
},
|
|
7285
|
-
{
|
|
7286
|
-
"name": "sync-nav-state",
|
|
7287
|
-
"type": {
|
|
7288
|
-
"text": "boolean"
|
|
7289
|
-
},
|
|
7290
|
-
"default": "false",
|
|
7291
|
-
"description": "Controls whether the navigation's open/closed state and width is synced across tabs/windows on the same origin.\nThis is useful for long-lived app sessions where you may have multiple tabs/windows open at once.",
|
|
7292
|
-
"fieldName": "syncNavState"
|
|
7293
|
-
},
|
|
7294
|
-
{
|
|
7295
|
-
"name": "padding",
|
|
7296
|
-
"type": {
|
|
7297
|
-
"text": "\"m\" | \"none\""
|
|
7298
|
-
},
|
|
7299
|
-
"default": "\"m\"",
|
|
7300
|
-
"description": "Controls the padding of the default main section slot. When set to “none”,\nthe nav and header slots will still have padding.",
|
|
7301
|
-
"fieldName": "padding"
|
|
7302
|
-
},
|
|
7303
|
-
{
|
|
7304
|
-
"name": "sticky",
|
|
7305
|
-
"type": {
|
|
7306
|
-
"text": "boolean"
|
|
7307
|
-
},
|
|
7308
|
-
"default": "false",
|
|
7309
|
-
"description": "Controls whether the layout's header has sticky positioning.",
|
|
7310
|
-
"fieldName": "sticky"
|
|
7311
|
-
}
|
|
7312
|
-
],
|
|
7313
|
-
"superclass": {
|
|
7314
|
-
"name": "LitElement",
|
|
7315
|
-
"package": "lit"
|
|
7316
|
-
},
|
|
7317
|
-
"localization": [],
|
|
7318
|
-
"status": "ready",
|
|
7319
|
-
"category": "structure",
|
|
7320
|
-
"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- To visually group content in a layout section, use the Card component.\n- To lay out a set of smaller components, use the Stack component.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Never put layout component inside another HTML landmark.\n- Don’t use when you need a vertical or horizontal layout system. Use Stack component instead.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Layout component uses `<main>` element internally which is an HTML sectioning element which by default defines an ARIA landmark role. For that reason you should never put layout component inside another HTML landmark.\n\n---\n\n## Theming\n\nPlease see the [Accent color](/themes/#accent-color) and [Top Bar theming](/themes/#top-bar-theming) sections in our theming documentation for detailed guidelines.\n\n<nord-button variant=\"primary\" href=\"/themes/#accent-color\">Theming Guidelines</nord-button>\n",
|
|
7321
|
-
"examples": [],
|
|
7322
|
-
"dependencies": [
|
|
7323
|
-
"icon",
|
|
7324
|
-
"nav-toggle"
|
|
7325
|
-
],
|
|
7326
|
-
"tagName": "nord-layout",
|
|
7327
|
-
"customElement": true
|
|
7328
|
-
}
|
|
7329
|
-
],
|
|
7330
|
-
"exports": [
|
|
7331
|
-
{
|
|
7332
|
-
"kind": "js",
|
|
7333
|
-
"name": "default",
|
|
7334
|
-
"declaration": {
|
|
7335
|
-
"name": "Layout",
|
|
7336
|
-
"module": "src/layout/Layout.ts"
|
|
7337
|
-
}
|
|
7338
|
-
},
|
|
7339
|
-
{
|
|
7340
|
-
"kind": "custom-element-definition",
|
|
7341
|
-
"name": "nord-layout",
|
|
7342
|
-
"declaration": {
|
|
7343
|
-
"name": "Layout",
|
|
7344
|
-
"module": "src/layout/Layout.ts"
|
|
7345
|
-
}
|
|
7346
|
-
}
|
|
7347
|
-
]
|
|
7348
|
-
},
|
|
7349
|
-
{
|
|
7350
|
-
"kind": "javascript-module",
|
|
7351
|
-
"path": "src/input/Input.ts",
|
|
7352
|
-
"declarations": [
|
|
7353
|
-
{
|
|
7354
|
-
"kind": "class",
|
|
7355
|
-
"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.",
|
|
7356
|
-
"name": "Input",
|
|
7357
|
-
"cssProperties": [
|
|
7358
|
-
{
|
|
7359
|
-
"description": "Controls the inline size, or width, of the input.",
|
|
7360
|
-
"name": "--n-input-inline-size",
|
|
7361
|
-
"default": "240px"
|
|
7163
|
+
"name": "clear"
|
|
7164
|
+
}
|
|
7165
|
+
]
|
|
7166
|
+
}
|
|
7167
|
+
],
|
|
7168
|
+
"exports": [
|
|
7169
|
+
{
|
|
7170
|
+
"kind": "js",
|
|
7171
|
+
"name": "IconManager",
|
|
7172
|
+
"declaration": {
|
|
7173
|
+
"name": "IconManager",
|
|
7174
|
+
"module": "src/icon/IconManager.ts"
|
|
7175
|
+
}
|
|
7176
|
+
}
|
|
7177
|
+
]
|
|
7178
|
+
},
|
|
7179
|
+
{
|
|
7180
|
+
"kind": "javascript-module",
|
|
7181
|
+
"path": "src/input/Input.ts",
|
|
7182
|
+
"declarations": [
|
|
7183
|
+
{
|
|
7184
|
+
"kind": "class",
|
|
7185
|
+
"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.",
|
|
7186
|
+
"name": "Input",
|
|
7187
|
+
"cssProperties": [
|
|
7188
|
+
{
|
|
7189
|
+
"description": "Controls the inline size, or width, of the input.",
|
|
7190
|
+
"name": "--n-input-inline-size",
|
|
7191
|
+
"default": "240px"
|
|
7362
7192
|
},
|
|
7363
7193
|
{
|
|
7364
7194
|
"description": "Controls the background of the input, using our [color tokens](/tokens/#color).",
|
|
@@ -8081,471 +7911,641 @@
|
|
|
8081
7911
|
}
|
|
8082
7912
|
},
|
|
8083
7913
|
{
|
|
8084
|
-
"name": "autocomplete",
|
|
7914
|
+
"name": "autocomplete",
|
|
7915
|
+
"type": {
|
|
7916
|
+
"text": "AutocompleteAttribute"
|
|
7917
|
+
},
|
|
7918
|
+
"default": "\"off\"",
|
|
7919
|
+
"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.",
|
|
7920
|
+
"fieldName": "autocomplete",
|
|
7921
|
+
"inheritedFrom": {
|
|
7922
|
+
"name": "AutocompleteMixin",
|
|
7923
|
+
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
7924
|
+
}
|
|
7925
|
+
},
|
|
7926
|
+
{
|
|
7927
|
+
"name": "readonly",
|
|
7928
|
+
"type": {
|
|
7929
|
+
"text": "boolean"
|
|
7930
|
+
},
|
|
7931
|
+
"default": "false",
|
|
7932
|
+
"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.",
|
|
7933
|
+
"fieldName": "readonly",
|
|
7934
|
+
"inheritedFrom": {
|
|
7935
|
+
"name": "ReadonlyMixin",
|
|
7936
|
+
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
7937
|
+
}
|
|
7938
|
+
},
|
|
7939
|
+
{
|
|
7940
|
+
"name": "disabled",
|
|
7941
|
+
"type": {
|
|
7942
|
+
"text": "boolean"
|
|
7943
|
+
},
|
|
7944
|
+
"default": "false",
|
|
7945
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
7946
|
+
"fieldName": "disabled",
|
|
7947
|
+
"inheritedFrom": {
|
|
7948
|
+
"name": "InputMixin",
|
|
7949
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7950
|
+
}
|
|
7951
|
+
},
|
|
7952
|
+
{
|
|
7953
|
+
"name": "name",
|
|
7954
|
+
"type": {
|
|
7955
|
+
"text": "string | undefined"
|
|
7956
|
+
},
|
|
7957
|
+
"description": "The name of the form component.",
|
|
7958
|
+
"fieldName": "name",
|
|
7959
|
+
"inheritedFrom": {
|
|
7960
|
+
"name": "InputMixin",
|
|
7961
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7962
|
+
}
|
|
7963
|
+
},
|
|
7964
|
+
{
|
|
7965
|
+
"name": "value",
|
|
7966
|
+
"type": {
|
|
7967
|
+
"text": "string"
|
|
7968
|
+
},
|
|
7969
|
+
"default": "\"\"",
|
|
7970
|
+
"description": "The value of the form component.",
|
|
7971
|
+
"fieldName": "value",
|
|
7972
|
+
"inheritedFrom": {
|
|
7973
|
+
"name": "InputMixin",
|
|
7974
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7975
|
+
}
|
|
7976
|
+
},
|
|
7977
|
+
{
|
|
7978
|
+
"name": "form",
|
|
7979
|
+
"type": {
|
|
7980
|
+
"text": "HTMLFormElement | null"
|
|
7981
|
+
},
|
|
7982
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
7983
|
+
"fieldName": "form",
|
|
7984
|
+
"inheritedFrom": {
|
|
7985
|
+
"name": "InputMixin",
|
|
7986
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
7987
|
+
}
|
|
7988
|
+
}
|
|
7989
|
+
],
|
|
7990
|
+
"mixins": [
|
|
7991
|
+
{
|
|
7992
|
+
"name": "SizeMixin",
|
|
7993
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
7994
|
+
},
|
|
7995
|
+
{
|
|
7996
|
+
"name": "FormAssociatedMixin",
|
|
7997
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
7998
|
+
},
|
|
7999
|
+
{
|
|
8000
|
+
"name": "AutocompleteMixin",
|
|
8001
|
+
"module": "/src/common/mixins/AutocompleteMixin.js"
|
|
8002
|
+
},
|
|
8003
|
+
{
|
|
8004
|
+
"name": "ReadonlyMixin",
|
|
8005
|
+
"module": "/src/common/mixins/ReadonlyMixin.js"
|
|
8006
|
+
},
|
|
8007
|
+
{
|
|
8008
|
+
"name": "InputMixin",
|
|
8009
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
8010
|
+
},
|
|
8011
|
+
{
|
|
8012
|
+
"name": "FocusableMixin",
|
|
8013
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
8014
|
+
}
|
|
8015
|
+
],
|
|
8016
|
+
"superclass": {
|
|
8017
|
+
"name": "LitElement",
|
|
8018
|
+
"package": "lit"
|
|
8019
|
+
},
|
|
8020
|
+
"localization": [],
|
|
8021
|
+
"status": "ready",
|
|
8022
|
+
"category": "form",
|
|
8023
|
+
"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",
|
|
8024
|
+
"examples": [],
|
|
8025
|
+
"dependencies": [
|
|
8026
|
+
"icon"
|
|
8027
|
+
],
|
|
8028
|
+
"tagName": "nord-input",
|
|
8029
|
+
"customElement": true,
|
|
8030
|
+
"events": [
|
|
8031
|
+
{
|
|
8032
|
+
"name": "input",
|
|
8033
|
+
"type": {
|
|
8034
|
+
"text": "NordEvent"
|
|
8035
|
+
},
|
|
8036
|
+
"description": "Fired as the user types into the input.",
|
|
8037
|
+
"inheritedFrom": {
|
|
8038
|
+
"name": "FormAssociatedMixin",
|
|
8039
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8040
|
+
}
|
|
8041
|
+
},
|
|
8042
|
+
{
|
|
8043
|
+
"name": "change",
|
|
8044
|
+
"type": {
|
|
8045
|
+
"text": "NordEvent"
|
|
8046
|
+
},
|
|
8047
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
8048
|
+
"inheritedFrom": {
|
|
8049
|
+
"name": "FormAssociatedMixin",
|
|
8050
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8051
|
+
}
|
|
8052
|
+
}
|
|
8053
|
+
]
|
|
8054
|
+
}
|
|
8055
|
+
],
|
|
8056
|
+
"exports": [
|
|
8057
|
+
{
|
|
8058
|
+
"kind": "js",
|
|
8059
|
+
"name": "default",
|
|
8060
|
+
"declaration": {
|
|
8061
|
+
"name": "Input",
|
|
8062
|
+
"module": "src/input/Input.ts"
|
|
8063
|
+
}
|
|
8064
|
+
},
|
|
8065
|
+
{
|
|
8066
|
+
"kind": "custom-element-definition",
|
|
8067
|
+
"name": "nord-input",
|
|
8068
|
+
"declaration": {
|
|
8069
|
+
"name": "Input",
|
|
8070
|
+
"module": "src/input/Input.ts"
|
|
8071
|
+
}
|
|
8072
|
+
}
|
|
8073
|
+
]
|
|
8074
|
+
},
|
|
8075
|
+
{
|
|
8076
|
+
"kind": "javascript-module",
|
|
8077
|
+
"path": "src/layout/Layout.ts",
|
|
8078
|
+
"declarations": [
|
|
8079
|
+
{
|
|
8080
|
+
"kind": "class",
|
|
8081
|
+
"description": "Layout component is used to create the main layout of an app. Layout\ncurrently comes with one main configuration: two-column.",
|
|
8082
|
+
"name": "Layout",
|
|
8083
|
+
"cssProperties": [
|
|
8084
|
+
{
|
|
8085
|
+
"description": "Controls the padding around the main layout area (the main slot), using our [spacing tokens](/tokens/#space).",
|
|
8086
|
+
"name": "--n-layout-padding",
|
|
8087
|
+
"default": "var(--n-space-l)"
|
|
8088
|
+
},
|
|
8089
|
+
{
|
|
8090
|
+
"description": "Controls the width of the drawer area, when used.",
|
|
8091
|
+
"name": "--n-layout-drawer-inline-size",
|
|
8092
|
+
"default": "320px"
|
|
8093
|
+
},
|
|
8094
|
+
{
|
|
8095
|
+
"description": "Controls the background color of the layout, using [color tokens](/tokens/#color).",
|
|
8096
|
+
"name": "--n-layout-background-color",
|
|
8097
|
+
"default": "var(--n-color-background)"
|
|
8098
|
+
}
|
|
8099
|
+
],
|
|
8100
|
+
"slots": [
|
|
8101
|
+
{
|
|
8102
|
+
"description": "The default main section content.",
|
|
8103
|
+
"name": ""
|
|
8104
|
+
},
|
|
8105
|
+
{
|
|
8106
|
+
"description": "Used to place content inside the navigation sidebar.",
|
|
8107
|
+
"name": "nav"
|
|
8108
|
+
},
|
|
8109
|
+
{
|
|
8110
|
+
"description": "Used to place the [Top Bar](../top-bar/) component.",
|
|
8111
|
+
"name": "top-bar"
|
|
8112
|
+
},
|
|
8113
|
+
{
|
|
8114
|
+
"description": "Used to place content inside the header section.",
|
|
8115
|
+
"name": "header"
|
|
8116
|
+
},
|
|
8117
|
+
{
|
|
8118
|
+
"description": "Used to place additional content/details relating to a selected item.",
|
|
8119
|
+
"name": "drawer"
|
|
8120
|
+
},
|
|
8121
|
+
{
|
|
8122
|
+
"description": "Used to place a own nav-toggle component, for cases where you might need to add a tooltip.",
|
|
8123
|
+
"name": "nav-toggle"
|
|
8124
|
+
}
|
|
8125
|
+
],
|
|
8126
|
+
"members": [
|
|
8127
|
+
{
|
|
8128
|
+
"kind": "field",
|
|
8129
|
+
"name": "peekTimeoutId",
|
|
8130
|
+
"type": {
|
|
8131
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
8132
|
+
},
|
|
8133
|
+
"privacy": "private"
|
|
8134
|
+
},
|
|
8135
|
+
{
|
|
8136
|
+
"kind": "field",
|
|
8137
|
+
"name": "navSlot",
|
|
8138
|
+
"privacy": "private",
|
|
8139
|
+
"default": "new SlotController(this, \"nav\")"
|
|
8140
|
+
},
|
|
8141
|
+
{
|
|
8142
|
+
"kind": "field",
|
|
8143
|
+
"name": "drawerSlot",
|
|
8144
|
+
"privacy": "private",
|
|
8145
|
+
"default": "new SlotController(this, \"drawer\")"
|
|
8146
|
+
},
|
|
8147
|
+
{
|
|
8148
|
+
"kind": "field",
|
|
8149
|
+
"name": "topBarSlot",
|
|
8150
|
+
"privacy": "private",
|
|
8151
|
+
"default": "new SlotController(this, \"top-bar\")"
|
|
8152
|
+
},
|
|
8153
|
+
{
|
|
8154
|
+
"kind": "field",
|
|
8155
|
+
"name": "headerSlot",
|
|
8156
|
+
"privacy": "private",
|
|
8157
|
+
"default": "new SlotController(this, \"header\")"
|
|
8158
|
+
},
|
|
8159
|
+
{
|
|
8160
|
+
"kind": "field",
|
|
8161
|
+
"name": "direction",
|
|
8162
|
+
"privacy": "private",
|
|
8163
|
+
"default": "new DirectionController(this)"
|
|
8164
|
+
},
|
|
8165
|
+
{
|
|
8166
|
+
"kind": "field",
|
|
8167
|
+
"name": "events",
|
|
8168
|
+
"privacy": "private",
|
|
8169
|
+
"default": "new EventController(this)"
|
|
8170
|
+
},
|
|
8171
|
+
{
|
|
8172
|
+
"kind": "field",
|
|
8173
|
+
"name": "lightDismiss",
|
|
8174
|
+
"privacy": "private",
|
|
8175
|
+
"default": "new LightDismissController(this, {\n isOpen: () => this.navState === \"opened\" && !this.wideScreen,\n onDismiss: () => this.navTransition(\"close\"),\n isDismissible: node => node !== this.navEl,\n })"
|
|
8176
|
+
},
|
|
8177
|
+
{
|
|
8178
|
+
"kind": "field",
|
|
8179
|
+
"name": "broadcast",
|
|
8180
|
+
"privacy": "private",
|
|
8181
|
+
"default": "new BroadcastChannelController<{ navOpen: boolean } | { navWidth: number }>(this, {\n channelName: \"nord-layout-nav-state\",\n enabled: () => this.syncNavState && this.wideScreen,\n onMessage: data => {\n if (\"navOpen\" in data) {\n this.navOpen = data.navOpen\n }\n if (\"navWidth\" in data) {\n this.navWidth = data.navWidth\n }\n },\n })"
|
|
8182
|
+
},
|
|
8183
|
+
{
|
|
8184
|
+
"kind": "field",
|
|
8185
|
+
"name": "navEl",
|
|
8186
|
+
"type": {
|
|
8187
|
+
"text": "HTMLDivElement"
|
|
8188
|
+
},
|
|
8189
|
+
"privacy": "private"
|
|
8190
|
+
},
|
|
8191
|
+
{
|
|
8192
|
+
"kind": "field",
|
|
8193
|
+
"name": "navWidth",
|
|
8194
|
+
"privacy": "private"
|
|
8195
|
+
},
|
|
8196
|
+
{
|
|
8197
|
+
"kind": "field",
|
|
8198
|
+
"name": "isDragging",
|
|
8199
|
+
"type": {
|
|
8200
|
+
"text": "boolean"
|
|
8201
|
+
},
|
|
8202
|
+
"privacy": "private",
|
|
8203
|
+
"default": "false"
|
|
8204
|
+
},
|
|
8205
|
+
{
|
|
8206
|
+
"kind": "field",
|
|
8207
|
+
"name": "navState",
|
|
8208
|
+
"type": {
|
|
8209
|
+
"text": "NavState"
|
|
8210
|
+
},
|
|
8211
|
+
"privacy": "private"
|
|
8212
|
+
},
|
|
8213
|
+
{
|
|
8214
|
+
"kind": "field",
|
|
8215
|
+
"name": "wideScreen",
|
|
8216
|
+
"privacy": "private"
|
|
8217
|
+
},
|
|
8218
|
+
{
|
|
8219
|
+
"kind": "field",
|
|
8220
|
+
"name": "navOpen",
|
|
8085
8221
|
"type": {
|
|
8086
|
-
"text": "
|
|
8222
|
+
"text": "boolean"
|
|
8087
8223
|
},
|
|
8088
|
-
"
|
|
8089
|
-
"
|
|
8090
|
-
"
|
|
8091
|
-
"inheritedFrom": {
|
|
8092
|
-
"name": "AutocompleteMixin",
|
|
8093
|
-
"module": "src/common/mixins/AutocompleteMixin.ts"
|
|
8094
|
-
}
|
|
8224
|
+
"description": "Controls whether the navigation is hidden off-screen or not.\nDefaults to `true` for wide viewports, and `false` otherwise.",
|
|
8225
|
+
"attribute": "nav-open",
|
|
8226
|
+
"reflects": true
|
|
8095
8227
|
},
|
|
8096
8228
|
{
|
|
8097
|
-
"
|
|
8229
|
+
"kind": "field",
|
|
8230
|
+
"name": "persistNavState",
|
|
8098
8231
|
"type": {
|
|
8099
8232
|
"text": "boolean"
|
|
8100
8233
|
},
|
|
8101
8234
|
"default": "false",
|
|
8102
|
-
"description": "
|
|
8103
|
-
"
|
|
8104
|
-
"inheritedFrom": {
|
|
8105
|
-
"name": "ReadonlyMixin",
|
|
8106
|
-
"module": "src/common/mixins/ReadonlyMixin.ts"
|
|
8107
|
-
}
|
|
8235
|
+
"description": "Controls whether the navigation's open/closed state is persisted across page loads.\nThis is useful for multi-page apps, where clicks on links trigger a full page load.",
|
|
8236
|
+
"attribute": "persist-nav-state"
|
|
8108
8237
|
},
|
|
8109
8238
|
{
|
|
8110
|
-
"
|
|
8239
|
+
"kind": "field",
|
|
8240
|
+
"name": "syncNavState",
|
|
8111
8241
|
"type": {
|
|
8112
8242
|
"text": "boolean"
|
|
8113
8243
|
},
|
|
8114
8244
|
"default": "false",
|
|
8115
|
-
"description": "
|
|
8116
|
-
"
|
|
8117
|
-
"
|
|
8118
|
-
"name": "InputMixin",
|
|
8119
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8120
|
-
}
|
|
8245
|
+
"description": "Controls whether the navigation's open/closed state and width is synced across tabs/windows on the same origin.\nThis is useful for long-lived app sessions where you may have multiple tabs/windows open at once.",
|
|
8246
|
+
"attribute": "sync-nav-state",
|
|
8247
|
+
"reflects": true
|
|
8121
8248
|
},
|
|
8122
8249
|
{
|
|
8123
|
-
"
|
|
8250
|
+
"kind": "field",
|
|
8251
|
+
"name": "padding",
|
|
8124
8252
|
"type": {
|
|
8125
|
-
"text": "
|
|
8253
|
+
"text": "\"m\" | \"none\""
|
|
8126
8254
|
},
|
|
8127
|
-
"
|
|
8128
|
-
"
|
|
8129
|
-
"
|
|
8130
|
-
|
|
8131
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8132
|
-
}
|
|
8255
|
+
"default": "\"m\"",
|
|
8256
|
+
"description": "Controls the padding of the default main section slot. When set to “none”,\nthe nav and header slots will still have padding.",
|
|
8257
|
+
"attribute": "padding",
|
|
8258
|
+
"reflects": true
|
|
8133
8259
|
},
|
|
8134
8260
|
{
|
|
8135
|
-
"
|
|
8261
|
+
"kind": "field",
|
|
8262
|
+
"name": "sticky",
|
|
8136
8263
|
"type": {
|
|
8137
|
-
"text": "
|
|
8264
|
+
"text": "boolean"
|
|
8138
8265
|
},
|
|
8139
|
-
"default": "
|
|
8140
|
-
"description": "
|
|
8141
|
-
"
|
|
8142
|
-
"
|
|
8143
|
-
"name": "InputMixin",
|
|
8144
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8145
|
-
}
|
|
8266
|
+
"default": "false",
|
|
8267
|
+
"description": "Controls whether the layout's header has sticky positioning.",
|
|
8268
|
+
"attribute": "sticky",
|
|
8269
|
+
"reflects": true
|
|
8146
8270
|
},
|
|
8147
8271
|
{
|
|
8148
|
-
"
|
|
8272
|
+
"kind": "field",
|
|
8273
|
+
"name": "isNarrow",
|
|
8149
8274
|
"type": {
|
|
8150
|
-
"text": "
|
|
8275
|
+
"text": "boolean"
|
|
8151
8276
|
},
|
|
8152
|
-
"description": "
|
|
8153
|
-
"
|
|
8154
|
-
"inheritedFrom": {
|
|
8155
|
-
"name": "InputMixin",
|
|
8156
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
8157
|
-
}
|
|
8158
|
-
}
|
|
8159
|
-
],
|
|
8160
|
-
"mixins": [
|
|
8161
|
-
{
|
|
8162
|
-
"name": "SizeMixin",
|
|
8163
|
-
"module": "/src/common/mixins/SizeMixin.js"
|
|
8164
|
-
},
|
|
8165
|
-
{
|
|
8166
|
-
"name": "FormAssociatedMixin",
|
|
8167
|
-
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
8277
|
+
"description": "A getter whose values reflects whether the layout component considers the viewport to be narrow or not.\nA narrow viewport is considered to be less than 768px wide.",
|
|
8278
|
+
"readonly": true
|
|
8168
8279
|
},
|
|
8169
8280
|
{
|
|
8170
|
-
"
|
|
8171
|
-
"
|
|
8281
|
+
"kind": "method",
|
|
8282
|
+
"name": "renderNavToggle",
|
|
8283
|
+
"privacy": "private"
|
|
8172
8284
|
},
|
|
8173
8285
|
{
|
|
8174
|
-
"
|
|
8175
|
-
"
|
|
8286
|
+
"kind": "method",
|
|
8287
|
+
"name": "renderNavCollapse",
|
|
8288
|
+
"privacy": "private"
|
|
8176
8289
|
},
|
|
8177
8290
|
{
|
|
8178
|
-
"
|
|
8179
|
-
"
|
|
8291
|
+
"kind": "method",
|
|
8292
|
+
"name": "handleNavWidthChange",
|
|
8293
|
+
"privacy": "protected"
|
|
8180
8294
|
},
|
|
8181
8295
|
{
|
|
8182
|
-
"
|
|
8183
|
-
"
|
|
8184
|
-
|
|
8185
|
-
|
|
8186
|
-
|
|
8187
|
-
|
|
8188
|
-
|
|
8189
|
-
|
|
8190
|
-
|
|
8191
|
-
|
|
8192
|
-
|
|
8193
|
-
"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",
|
|
8194
|
-
"examples": [],
|
|
8195
|
-
"dependencies": [
|
|
8196
|
-
"icon"
|
|
8197
|
-
],
|
|
8198
|
-
"tagName": "nord-input",
|
|
8199
|
-
"customElement": true,
|
|
8200
|
-
"events": [
|
|
8201
|
-
{
|
|
8202
|
-
"name": "input",
|
|
8203
|
-
"type": {
|
|
8204
|
-
"text": "NordEvent"
|
|
8205
|
-
},
|
|
8206
|
-
"description": "Fired as the user types into the input.",
|
|
8207
|
-
"inheritedFrom": {
|
|
8208
|
-
"name": "FormAssociatedMixin",
|
|
8209
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
8210
|
-
}
|
|
8296
|
+
"kind": "method",
|
|
8297
|
+
"name": "handleNavStateChange",
|
|
8298
|
+
"privacy": "protected",
|
|
8299
|
+
"parameters": [
|
|
8300
|
+
{
|
|
8301
|
+
"name": "prev",
|
|
8302
|
+
"type": {
|
|
8303
|
+
"text": "NavState"
|
|
8304
|
+
}
|
|
8305
|
+
}
|
|
8306
|
+
]
|
|
8211
8307
|
},
|
|
8212
8308
|
{
|
|
8213
|
-
"
|
|
8214
|
-
"
|
|
8215
|
-
|
|
8216
|
-
|
|
8217
|
-
|
|
8218
|
-
|
|
8219
|
-
|
|
8220
|
-
|
|
8221
|
-
|
|
8222
|
-
|
|
8223
|
-
|
|
8224
|
-
}
|
|
8225
|
-
],
|
|
8226
|
-
"exports": [
|
|
8227
|
-
{
|
|
8228
|
-
"kind": "js",
|
|
8229
|
-
"name": "default",
|
|
8230
|
-
"declaration": {
|
|
8231
|
-
"name": "Input",
|
|
8232
|
-
"module": "src/input/Input.ts"
|
|
8233
|
-
}
|
|
8234
|
-
},
|
|
8235
|
-
{
|
|
8236
|
-
"kind": "custom-element-definition",
|
|
8237
|
-
"name": "nord-input",
|
|
8238
|
-
"declaration": {
|
|
8239
|
-
"name": "Input",
|
|
8240
|
-
"module": "src/input/Input.ts"
|
|
8241
|
-
}
|
|
8242
|
-
}
|
|
8243
|
-
]
|
|
8244
|
-
},
|
|
8245
|
-
{
|
|
8246
|
-
"kind": "javascript-module",
|
|
8247
|
-
"path": "src/icon/Icon.ts",
|
|
8248
|
-
"declarations": [
|
|
8249
|
-
{
|
|
8250
|
-
"kind": "class",
|
|
8251
|
-
"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.",
|
|
8252
|
-
"name": "Icon",
|
|
8253
|
-
"slots": [
|
|
8254
|
-
{
|
|
8255
|
-
"description": "The default slot used for placing a custom SVG icon.",
|
|
8256
|
-
"name": ""
|
|
8257
|
-
}
|
|
8258
|
-
],
|
|
8259
|
-
"members": [
|
|
8260
|
-
{
|
|
8261
|
-
"kind": "field",
|
|
8262
|
-
"name": "manager",
|
|
8263
|
-
"privacy": "private",
|
|
8264
|
-
"static": true,
|
|
8265
|
-
"default": "new IconManager()"
|
|
8309
|
+
"kind": "method",
|
|
8310
|
+
"name": "handleOpenChange",
|
|
8311
|
+
"privacy": "protected",
|
|
8312
|
+
"parameters": [
|
|
8313
|
+
{
|
|
8314
|
+
"name": "prev",
|
|
8315
|
+
"type": {
|
|
8316
|
+
"text": "boolean"
|
|
8317
|
+
}
|
|
8318
|
+
}
|
|
8319
|
+
]
|
|
8266
8320
|
},
|
|
8267
8321
|
{
|
|
8268
8322
|
"kind": "method",
|
|
8269
|
-
"name": "
|
|
8270
|
-
"
|
|
8323
|
+
"name": "navTransition",
|
|
8324
|
+
"privacy": "private",
|
|
8271
8325
|
"parameters": [
|
|
8272
8326
|
{
|
|
8273
|
-
"name": "
|
|
8327
|
+
"name": "event",
|
|
8274
8328
|
"type": {
|
|
8275
|
-
"text": "
|
|
8276
|
-
}
|
|
8277
|
-
"description": "The resolver function to register."
|
|
8329
|
+
"text": "NavEvent"
|
|
8330
|
+
}
|
|
8278
8331
|
}
|
|
8279
|
-
]
|
|
8280
|
-
"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."
|
|
8332
|
+
]
|
|
8281
8333
|
},
|
|
8282
8334
|
{
|
|
8283
8335
|
"kind": "method",
|
|
8284
|
-
"name": "
|
|
8285
|
-
"
|
|
8286
|
-
"return": {
|
|
8287
|
-
"type": {
|
|
8288
|
-
"text": "void"
|
|
8289
|
-
}
|
|
8290
|
-
},
|
|
8336
|
+
"name": "handleNavClick",
|
|
8337
|
+
"privacy": "private",
|
|
8291
8338
|
"parameters": [
|
|
8292
8339
|
{
|
|
8293
|
-
"name": "
|
|
8340
|
+
"name": "e",
|
|
8294
8341
|
"type": {
|
|
8295
|
-
"text": "
|
|
8296
|
-
}
|
|
8297
|
-
"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."
|
|
8342
|
+
"text": "Event"
|
|
8343
|
+
}
|
|
8298
8344
|
}
|
|
8299
|
-
]
|
|
8300
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
8345
|
+
]
|
|
8301
8346
|
},
|
|
8302
8347
|
{
|
|
8303
8348
|
"kind": "method",
|
|
8304
|
-
"name": "
|
|
8305
|
-
"
|
|
8306
|
-
|
|
8307
|
-
|
|
8308
|
-
|
|
8309
|
-
|
|
8310
|
-
|
|
8349
|
+
"name": "handleMainClick",
|
|
8350
|
+
"privacy": "private"
|
|
8351
|
+
},
|
|
8352
|
+
{
|
|
8353
|
+
"kind": "method",
|
|
8354
|
+
"name": "handleDropdownOpen",
|
|
8355
|
+
"privacy": "private",
|
|
8311
8356
|
"parameters": [
|
|
8312
8357
|
{
|
|
8313
|
-
"name": "
|
|
8314
|
-
"type": {
|
|
8315
|
-
"text": "string"
|
|
8316
|
-
},
|
|
8317
|
-
"description": "The name of the icon to be registered."
|
|
8318
|
-
},
|
|
8319
|
-
{
|
|
8320
|
-
"name": "icon",
|
|
8358
|
+
"name": "e",
|
|
8321
8359
|
"type": {
|
|
8322
|
-
"text": "
|
|
8323
|
-
}
|
|
8324
|
-
"description": "The SVG string for the icon."
|
|
8360
|
+
"text": "Event"
|
|
8361
|
+
}
|
|
8325
8362
|
}
|
|
8326
|
-
]
|
|
8327
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
8363
|
+
]
|
|
8328
8364
|
},
|
|
8329
8365
|
{
|
|
8330
8366
|
"kind": "method",
|
|
8331
|
-
"name": "
|
|
8332
|
-
"
|
|
8367
|
+
"name": "handleDropdownClose",
|
|
8368
|
+
"privacy": "private",
|
|
8333
8369
|
"parameters": [
|
|
8334
8370
|
{
|
|
8335
|
-
"name": "
|
|
8336
|
-
"type": {
|
|
8337
|
-
"text": "string | { title: string; default: string }"
|
|
8338
|
-
},
|
|
8339
|
-
"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."
|
|
8340
|
-
},
|
|
8341
|
-
{
|
|
8342
|
-
"name": "icon",
|
|
8343
|
-
"optional": true,
|
|
8371
|
+
"name": "e",
|
|
8344
8372
|
"type": {
|
|
8345
|
-
"text": "
|
|
8346
|
-
}
|
|
8347
|
-
"description": "The SVG string for the icon."
|
|
8373
|
+
"text": "Event"
|
|
8374
|
+
}
|
|
8348
8375
|
}
|
|
8349
|
-
]
|
|
8350
|
-
"description": "Register an individual icon so it can be rendered synchronously, to avoid loading over the network."
|
|
8376
|
+
]
|
|
8351
8377
|
},
|
|
8352
8378
|
{
|
|
8353
8379
|
"kind": "field",
|
|
8354
|
-
"name": "
|
|
8355
|
-
"
|
|
8356
|
-
"text": "string"
|
|
8357
|
-
},
|
|
8358
|
-
"default": "\"\"",
|
|
8359
|
-
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
8360
|
-
"attribute": "name",
|
|
8361
|
-
"reflects": true
|
|
8380
|
+
"name": "handleMediaQueryChange",
|
|
8381
|
+
"privacy": "private"
|
|
8362
8382
|
},
|
|
8363
8383
|
{
|
|
8364
8384
|
"kind": "field",
|
|
8365
|
-
"name": "
|
|
8366
|
-
"
|
|
8367
|
-
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
8368
|
-
},
|
|
8369
|
-
"description": "The size of the icon.",
|
|
8370
|
-
"attribute": "size",
|
|
8371
|
-
"reflects": true
|
|
8385
|
+
"name": "handleToggleClick",
|
|
8386
|
+
"privacy": "private"
|
|
8372
8387
|
},
|
|
8373
8388
|
{
|
|
8374
8389
|
"kind": "field",
|
|
8375
|
-
"name": "
|
|
8376
|
-
"
|
|
8377
|
-
"text": "string | undefined"
|
|
8378
|
-
},
|
|
8379
|
-
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
8380
|
-
"attribute": "color",
|
|
8381
|
-
"reflects": true
|
|
8390
|
+
"name": "handleNavFocus",
|
|
8391
|
+
"privacy": "private"
|
|
8382
8392
|
},
|
|
8383
8393
|
{
|
|
8384
8394
|
"kind": "field",
|
|
8385
|
-
"name": "
|
|
8386
|
-
"
|
|
8387
|
-
"text": "string | undefined"
|
|
8388
|
-
},
|
|
8389
|
-
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
8390
|
-
"attribute": "label",
|
|
8391
|
-
"reflects": true
|
|
8395
|
+
"name": "handleMainFocus",
|
|
8396
|
+
"privacy": "private"
|
|
8392
8397
|
},
|
|
8393
8398
|
{
|
|
8394
8399
|
"kind": "field",
|
|
8395
|
-
"name": "
|
|
8396
|
-
"
|
|
8397
|
-
"text": "string"
|
|
8398
|
-
},
|
|
8399
|
-
"privacy": "private",
|
|
8400
|
-
"default": "\"\""
|
|
8401
|
-
},
|
|
8402
|
-
{
|
|
8403
|
-
"kind": "method",
|
|
8404
|
-
"name": "handleNameChange",
|
|
8405
|
-
"privacy": "protected"
|
|
8406
|
-
}
|
|
8407
|
-
],
|
|
8408
|
-
"attributes": [
|
|
8409
|
-
{
|
|
8410
|
-
"name": "name",
|
|
8411
|
-
"type": {
|
|
8412
|
-
"text": "string"
|
|
8413
|
-
},
|
|
8414
|
-
"default": "\"\"",
|
|
8415
|
-
"description": "The name of the icon to display, as defined by [nordicons](/nordicons/).",
|
|
8416
|
-
"fieldName": "name"
|
|
8417
|
-
},
|
|
8418
|
-
{
|
|
8419
|
-
"name": "size",
|
|
8420
|
-
"type": {
|
|
8421
|
-
"text": "\"xxs\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\" | undefined"
|
|
8422
|
-
},
|
|
8423
|
-
"description": "The size of the icon.",
|
|
8424
|
-
"fieldName": "size"
|
|
8425
|
-
},
|
|
8426
|
-
{
|
|
8427
|
-
"name": "color",
|
|
8428
|
-
"type": {
|
|
8429
|
-
"text": "string | undefined"
|
|
8430
|
-
},
|
|
8431
|
-
"description": "The color of the icon.\nCan accept any valid CSS color value, including custom properties.",
|
|
8432
|
-
"fieldName": "color"
|
|
8400
|
+
"name": "handleMouseEnter",
|
|
8401
|
+
"privacy": "private"
|
|
8433
8402
|
},
|
|
8434
|
-
{
|
|
8435
|
-
"name": "label",
|
|
8436
|
-
"type": {
|
|
8437
|
-
"text": "string | undefined"
|
|
8438
|
-
},
|
|
8439
|
-
"description": "An accessible label for the icon.\nIf no label is supplied, the icon is hidden from assistive technology.",
|
|
8440
|
-
"fieldName": "label"
|
|
8441
|
-
}
|
|
8442
|
-
],
|
|
8443
|
-
"superclass": {
|
|
8444
|
-
"name": "LitElement",
|
|
8445
|
-
"package": "lit"
|
|
8446
|
-
},
|
|
8447
|
-
"localization": [],
|
|
8448
|
-
"status": "ready",
|
|
8449
|
-
"category": "image",
|
|
8450
|
-
"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",
|
|
8451
|
-
"examples": [],
|
|
8452
|
-
"dependencies": [],
|
|
8453
|
-
"tagName": "nord-icon",
|
|
8454
|
-
"customElement": true
|
|
8455
|
-
}
|
|
8456
|
-
],
|
|
8457
|
-
"exports": [
|
|
8458
|
-
{
|
|
8459
|
-
"kind": "js",
|
|
8460
|
-
"name": "default",
|
|
8461
|
-
"declaration": {
|
|
8462
|
-
"name": "Icon",
|
|
8463
|
-
"module": "src/icon/Icon.ts"
|
|
8464
|
-
}
|
|
8465
|
-
},
|
|
8466
|
-
{
|
|
8467
|
-
"kind": "custom-element-definition",
|
|
8468
|
-
"name": "nord-icon",
|
|
8469
|
-
"declaration": {
|
|
8470
|
-
"name": "Icon",
|
|
8471
|
-
"module": "src/icon/Icon.ts"
|
|
8472
|
-
}
|
|
8473
|
-
}
|
|
8474
|
-
]
|
|
8475
|
-
},
|
|
8476
|
-
{
|
|
8477
|
-
"kind": "javascript-module",
|
|
8478
|
-
"path": "src/icon/IconManager.ts",
|
|
8479
|
-
"declarations": [
|
|
8480
|
-
{
|
|
8481
|
-
"kind": "class",
|
|
8482
|
-
"description": "",
|
|
8483
|
-
"name": "IconManager",
|
|
8484
|
-
"members": [
|
|
8485
8403
|
{
|
|
8486
8404
|
"kind": "field",
|
|
8487
|
-
"name": "
|
|
8488
|
-
"privacy": "private"
|
|
8489
|
-
"default": "new Map<string, string | Promise<string>>()"
|
|
8405
|
+
"name": "handleMouseLeave",
|
|
8406
|
+
"privacy": "private"
|
|
8490
8407
|
},
|
|
8491
8408
|
{
|
|
8492
8409
|
"kind": "field",
|
|
8493
|
-
"name": "
|
|
8494
|
-
"
|
|
8495
|
-
"text": "IconResolver"
|
|
8496
|
-
}
|
|
8410
|
+
"name": "handleTransitionEnd",
|
|
8411
|
+
"privacy": "private"
|
|
8497
8412
|
},
|
|
8498
8413
|
{
|
|
8499
8414
|
"kind": "method",
|
|
8500
|
-
"name": "
|
|
8415
|
+
"name": "handleKeyboardResize",
|
|
8416
|
+
"privacy": "private",
|
|
8501
8417
|
"parameters": [
|
|
8502
8418
|
{
|
|
8503
|
-
"name": "
|
|
8419
|
+
"name": "e",
|
|
8504
8420
|
"type": {
|
|
8505
|
-
"text": "
|
|
8421
|
+
"text": "KeyboardEvent"
|
|
8506
8422
|
}
|
|
8507
|
-
}
|
|
8423
|
+
}
|
|
8424
|
+
]
|
|
8425
|
+
},
|
|
8426
|
+
{
|
|
8427
|
+
"kind": "method",
|
|
8428
|
+
"name": "setNavWidth",
|
|
8429
|
+
"privacy": "private",
|
|
8430
|
+
"parameters": [
|
|
8508
8431
|
{
|
|
8509
|
-
"name": "
|
|
8432
|
+
"name": "width",
|
|
8510
8433
|
"type": {
|
|
8511
|
-
"text": "
|
|
8434
|
+
"text": "number"
|
|
8512
8435
|
}
|
|
8513
8436
|
}
|
|
8514
8437
|
]
|
|
8515
8438
|
},
|
|
8516
8439
|
{
|
|
8517
8440
|
"kind": "method",
|
|
8518
|
-
"name": "
|
|
8441
|
+
"name": "startDragging",
|
|
8442
|
+
"privacy": "private",
|
|
8519
8443
|
"parameters": [
|
|
8520
8444
|
{
|
|
8521
|
-
"name": "
|
|
8445
|
+
"name": "e",
|
|
8522
8446
|
"type": {
|
|
8523
|
-
"text": "
|
|
8447
|
+
"text": "PointerEvent"
|
|
8524
8448
|
}
|
|
8525
|
-
}
|
|
8449
|
+
}
|
|
8450
|
+
]
|
|
8451
|
+
},
|
|
8452
|
+
{
|
|
8453
|
+
"kind": "method",
|
|
8454
|
+
"name": "stopDragging",
|
|
8455
|
+
"privacy": "private"
|
|
8456
|
+
},
|
|
8457
|
+
{
|
|
8458
|
+
"kind": "method",
|
|
8459
|
+
"name": "handleDrag",
|
|
8460
|
+
"privacy": "private",
|
|
8461
|
+
"parameters": [
|
|
8526
8462
|
{
|
|
8527
|
-
"name": "
|
|
8528
|
-
"optional": true,
|
|
8463
|
+
"name": "e",
|
|
8529
8464
|
"type": {
|
|
8530
|
-
"text": "
|
|
8465
|
+
"text": "PointerEvent"
|
|
8531
8466
|
}
|
|
8532
8467
|
}
|
|
8533
8468
|
]
|
|
8469
|
+
}
|
|
8470
|
+
],
|
|
8471
|
+
"attributes": [
|
|
8472
|
+
{
|
|
8473
|
+
"name": "nav-open",
|
|
8474
|
+
"type": {
|
|
8475
|
+
"text": "boolean"
|
|
8476
|
+
},
|
|
8477
|
+
"description": "Controls whether the navigation is hidden off-screen or not.\nDefaults to `true` for wide viewports, and `false` otherwise.",
|
|
8478
|
+
"fieldName": "navOpen"
|
|
8479
|
+
},
|
|
8480
|
+
{
|
|
8481
|
+
"name": "persist-nav-state",
|
|
8482
|
+
"type": {
|
|
8483
|
+
"text": "boolean"
|
|
8484
|
+
},
|
|
8485
|
+
"default": "false",
|
|
8486
|
+
"description": "Controls whether the navigation's open/closed state is persisted across page loads.\nThis is useful for multi-page apps, where clicks on links trigger a full page load.",
|
|
8487
|
+
"fieldName": "persistNavState"
|
|
8488
|
+
},
|
|
8489
|
+
{
|
|
8490
|
+
"name": "sync-nav-state",
|
|
8491
|
+
"type": {
|
|
8492
|
+
"text": "boolean"
|
|
8493
|
+
},
|
|
8494
|
+
"default": "false",
|
|
8495
|
+
"description": "Controls whether the navigation's open/closed state and width is synced across tabs/windows on the same origin.\nThis is useful for long-lived app sessions where you may have multiple tabs/windows open at once.",
|
|
8496
|
+
"fieldName": "syncNavState"
|
|
8497
|
+
},
|
|
8498
|
+
{
|
|
8499
|
+
"name": "padding",
|
|
8500
|
+
"type": {
|
|
8501
|
+
"text": "\"m\" | \"none\""
|
|
8502
|
+
},
|
|
8503
|
+
"default": "\"m\"",
|
|
8504
|
+
"description": "Controls the padding of the default main section slot. When set to “none”,\nthe nav and header slots will still have padding.",
|
|
8505
|
+
"fieldName": "padding"
|
|
8534
8506
|
},
|
|
8535
8507
|
{
|
|
8536
|
-
"
|
|
8537
|
-
"
|
|
8508
|
+
"name": "sticky",
|
|
8509
|
+
"type": {
|
|
8510
|
+
"text": "boolean"
|
|
8511
|
+
},
|
|
8512
|
+
"default": "false",
|
|
8513
|
+
"description": "Controls whether the layout's header has sticky positioning.",
|
|
8514
|
+
"fieldName": "sticky"
|
|
8538
8515
|
}
|
|
8539
|
-
]
|
|
8516
|
+
],
|
|
8517
|
+
"superclass": {
|
|
8518
|
+
"name": "LitElement",
|
|
8519
|
+
"package": "lit"
|
|
8520
|
+
},
|
|
8521
|
+
"localization": [],
|
|
8522
|
+
"status": "ready",
|
|
8523
|
+
"category": "structure",
|
|
8524
|
+
"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- To visually group content in a layout section, use the Card component.\n- To lay out a set of smaller components, use the Stack component.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Never put layout component inside another HTML landmark.\n- Don’t use when you need a vertical or horizontal layout system. Use Stack component instead.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Layout component uses `<main>` element internally which is an HTML sectioning element which by default defines an ARIA landmark role. For that reason you should never put layout component inside another HTML landmark.\n\n---\n\n## Theming\n\nPlease see the [Accent color](/themes/#accent-color) and [Top Bar theming](/themes/#top-bar-theming) sections in our theming documentation for detailed guidelines.\n\n<nord-button variant=\"primary\" href=\"/themes/#accent-color\">Theming Guidelines</nord-button>\n",
|
|
8525
|
+
"examples": [],
|
|
8526
|
+
"dependencies": [
|
|
8527
|
+
"icon",
|
|
8528
|
+
"nav-toggle"
|
|
8529
|
+
],
|
|
8530
|
+
"tagName": "nord-layout",
|
|
8531
|
+
"customElement": true
|
|
8540
8532
|
}
|
|
8541
8533
|
],
|
|
8542
8534
|
"exports": [
|
|
8543
8535
|
{
|
|
8544
8536
|
"kind": "js",
|
|
8545
|
-
"name": "
|
|
8537
|
+
"name": "default",
|
|
8546
8538
|
"declaration": {
|
|
8547
|
-
"name": "
|
|
8548
|
-
"module": "src/
|
|
8539
|
+
"name": "Layout",
|
|
8540
|
+
"module": "src/layout/Layout.ts"
|
|
8541
|
+
}
|
|
8542
|
+
},
|
|
8543
|
+
{
|
|
8544
|
+
"kind": "custom-element-definition",
|
|
8545
|
+
"name": "nord-layout",
|
|
8546
|
+
"declaration": {
|
|
8547
|
+
"name": "Layout",
|
|
8548
|
+
"module": "src/layout/Layout.ts"
|
|
8549
8549
|
}
|
|
8550
8550
|
}
|
|
8551
8551
|
]
|
|
@@ -8738,69 +8738,274 @@
|
|
|
8738
8738
|
"description": "the lang code e.g. \"en\" or \"en-GB\""
|
|
8739
8739
|
}
|
|
8740
8740
|
],
|
|
8741
|
-
"description": "Check whether there is a translation registered for the given lang"
|
|
8742
|
-
},
|
|
8743
|
-
{
|
|
8744
|
-
"kind": "function",
|
|
8745
|
-
"name": "resolveTranslation",
|
|
8746
|
-
"parameters": [
|
|
8741
|
+
"description": "Check whether there is a translation registered for the given lang"
|
|
8742
|
+
},
|
|
8743
|
+
{
|
|
8744
|
+
"kind": "function",
|
|
8745
|
+
"name": "resolveTranslation",
|
|
8746
|
+
"parameters": [
|
|
8747
|
+
{
|
|
8748
|
+
"name": "langCode",
|
|
8749
|
+
"type": {
|
|
8750
|
+
"text": "string"
|
|
8751
|
+
}
|
|
8752
|
+
}
|
|
8753
|
+
],
|
|
8754
|
+
"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."
|
|
8755
|
+
}
|
|
8756
|
+
],
|
|
8757
|
+
"exports": [
|
|
8758
|
+
{
|
|
8759
|
+
"kind": "js",
|
|
8760
|
+
"name": "clearTranslations",
|
|
8761
|
+
"declaration": {
|
|
8762
|
+
"name": "clearTranslations",
|
|
8763
|
+
"module": "src/localization/translation.ts"
|
|
8764
|
+
}
|
|
8765
|
+
},
|
|
8766
|
+
{
|
|
8767
|
+
"kind": "js",
|
|
8768
|
+
"name": "registerTranslation",
|
|
8769
|
+
"declaration": {
|
|
8770
|
+
"name": "registerTranslation",
|
|
8771
|
+
"module": "src/localization/translation.ts"
|
|
8772
|
+
}
|
|
8773
|
+
},
|
|
8774
|
+
{
|
|
8775
|
+
"kind": "js",
|
|
8776
|
+
"name": "subscribe",
|
|
8777
|
+
"declaration": {
|
|
8778
|
+
"name": "subscribe",
|
|
8779
|
+
"module": "src/localization/translation.ts"
|
|
8780
|
+
}
|
|
8781
|
+
},
|
|
8782
|
+
{
|
|
8783
|
+
"kind": "js",
|
|
8784
|
+
"name": "isTranslationRegistered",
|
|
8785
|
+
"declaration": {
|
|
8786
|
+
"name": "isTranslationRegistered",
|
|
8787
|
+
"module": "src/localization/translation.ts"
|
|
8788
|
+
}
|
|
8789
|
+
},
|
|
8790
|
+
{
|
|
8791
|
+
"kind": "js",
|
|
8792
|
+
"name": "resolveTranslation",
|
|
8793
|
+
"declaration": {
|
|
8794
|
+
"name": "resolveTranslation",
|
|
8795
|
+
"module": "src/localization/translation.ts"
|
|
8796
|
+
}
|
|
8797
|
+
},
|
|
8798
|
+
{
|
|
8799
|
+
"kind": "js",
|
|
8800
|
+
"name": "fallback",
|
|
8801
|
+
"declaration": {
|
|
8802
|
+
"name": "en",
|
|
8803
|
+
"module": "src/localization/translation.ts"
|
|
8804
|
+
}
|
|
8805
|
+
}
|
|
8806
|
+
]
|
|
8807
|
+
},
|
|
8808
|
+
{
|
|
8809
|
+
"kind": "javascript-module",
|
|
8810
|
+
"path": "src/message/Message.ts",
|
|
8811
|
+
"declarations": [
|
|
8812
|
+
{
|
|
8813
|
+
"kind": "class",
|
|
8814
|
+
"description": "Message represents a specific item within a collection,\nsuch as notifications, tasks or conversations. Message\ncan be placed directly inside a dropdown component.",
|
|
8815
|
+
"name": "Message",
|
|
8816
|
+
"cssProperties": [
|
|
8817
|
+
{
|
|
8818
|
+
"description": "Controls the border color of the message, using our [color tokens](/tokens/#color).",
|
|
8819
|
+
"name": "--n-message-border-color",
|
|
8820
|
+
"default": "var(--n-color-border)"
|
|
8821
|
+
}
|
|
8822
|
+
],
|
|
8823
|
+
"slots": [
|
|
8824
|
+
{
|
|
8825
|
+
"description": "The message content.",
|
|
8826
|
+
"name": ""
|
|
8827
|
+
},
|
|
8828
|
+
{
|
|
8829
|
+
"description": "Used to place content after the message. Typically used for a timestamp.",
|
|
8830
|
+
"name": "footer"
|
|
8831
|
+
}
|
|
8832
|
+
],
|
|
8833
|
+
"members": [
|
|
8834
|
+
{
|
|
8835
|
+
"kind": "field",
|
|
8836
|
+
"name": "localize",
|
|
8837
|
+
"privacy": "private",
|
|
8838
|
+
"default": "new LocalizeController<\"nord-message\">(this)"
|
|
8839
|
+
},
|
|
8840
|
+
{
|
|
8841
|
+
"kind": "field",
|
|
8842
|
+
"name": "href",
|
|
8843
|
+
"type": {
|
|
8844
|
+
"text": "string | undefined"
|
|
8845
|
+
},
|
|
8846
|
+
"description": "The url the message should link to.",
|
|
8847
|
+
"attribute": "href",
|
|
8848
|
+
"reflects": true
|
|
8849
|
+
},
|
|
8850
|
+
{
|
|
8851
|
+
"kind": "field",
|
|
8852
|
+
"name": "highlight",
|
|
8853
|
+
"type": {
|
|
8854
|
+
"text": "boolean | undefined"
|
|
8855
|
+
},
|
|
8856
|
+
"description": "Highlight the message visually. This is meant for highlighting\na new message that just appeared. Highlight style should be removed\nafter the user has seen the message and there’s been a timeout of\ne.g. 30 seconds.",
|
|
8857
|
+
"attribute": "highlight",
|
|
8858
|
+
"reflects": true
|
|
8859
|
+
},
|
|
8860
|
+
{
|
|
8861
|
+
"kind": "field",
|
|
8862
|
+
"name": "unread",
|
|
8863
|
+
"type": {
|
|
8864
|
+
"text": "boolean | undefined"
|
|
8865
|
+
},
|
|
8866
|
+
"description": "Mark the message as unread. By default messages are read.",
|
|
8867
|
+
"attribute": "unread",
|
|
8868
|
+
"reflects": true
|
|
8869
|
+
},
|
|
8870
|
+
{
|
|
8871
|
+
"kind": "field",
|
|
8872
|
+
"name": "focusableRef",
|
|
8873
|
+
"privacy": "protected",
|
|
8874
|
+
"inheritedFrom": {
|
|
8875
|
+
"name": "FocusableMixin",
|
|
8876
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8877
|
+
}
|
|
8878
|
+
},
|
|
8879
|
+
{
|
|
8880
|
+
"kind": "method",
|
|
8881
|
+
"name": "focus",
|
|
8882
|
+
"parameters": [
|
|
8883
|
+
{
|
|
8884
|
+
"name": "options",
|
|
8885
|
+
"optional": true,
|
|
8886
|
+
"type": {
|
|
8887
|
+
"text": "FocusOptions"
|
|
8888
|
+
},
|
|
8889
|
+
"description": "An object which controls aspects of the focusing process."
|
|
8890
|
+
}
|
|
8891
|
+
],
|
|
8892
|
+
"description": "Programmatically move focus to the component.",
|
|
8893
|
+
"inheritedFrom": {
|
|
8894
|
+
"name": "FocusableMixin",
|
|
8895
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8896
|
+
}
|
|
8897
|
+
},
|
|
8898
|
+
{
|
|
8899
|
+
"kind": "method",
|
|
8900
|
+
"name": "blur",
|
|
8901
|
+
"description": "Programmatically remove focus from the component.",
|
|
8902
|
+
"inheritedFrom": {
|
|
8903
|
+
"name": "FocusableMixin",
|
|
8904
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8905
|
+
}
|
|
8906
|
+
},
|
|
8907
|
+
{
|
|
8908
|
+
"kind": "method",
|
|
8909
|
+
"name": "click",
|
|
8910
|
+
"description": "Programmatically simulates a click on the component.",
|
|
8911
|
+
"inheritedFrom": {
|
|
8912
|
+
"name": "FocusableMixin",
|
|
8913
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8914
|
+
}
|
|
8915
|
+
}
|
|
8916
|
+
],
|
|
8917
|
+
"attributes": [
|
|
8918
|
+
{
|
|
8919
|
+
"name": "href",
|
|
8920
|
+
"type": {
|
|
8921
|
+
"text": "string | undefined"
|
|
8922
|
+
},
|
|
8923
|
+
"description": "The url the message should link to.",
|
|
8924
|
+
"fieldName": "href"
|
|
8925
|
+
},
|
|
8926
|
+
{
|
|
8927
|
+
"name": "highlight",
|
|
8928
|
+
"type": {
|
|
8929
|
+
"text": "boolean | undefined"
|
|
8930
|
+
},
|
|
8931
|
+
"description": "Highlight the message visually. This is meant for highlighting\na new message that just appeared. Highlight style should be removed\nafter the user has seen the message and there’s been a timeout of\ne.g. 30 seconds.",
|
|
8932
|
+
"fieldName": "highlight"
|
|
8933
|
+
},
|
|
8934
|
+
{
|
|
8935
|
+
"name": "unread",
|
|
8936
|
+
"type": {
|
|
8937
|
+
"text": "boolean | undefined"
|
|
8938
|
+
},
|
|
8939
|
+
"description": "Mark the message as unread. By default messages are read.",
|
|
8940
|
+
"fieldName": "unread"
|
|
8941
|
+
}
|
|
8942
|
+
],
|
|
8943
|
+
"mixins": [
|
|
8944
|
+
{
|
|
8945
|
+
"name": "FocusableMixin",
|
|
8946
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
8947
|
+
}
|
|
8948
|
+
],
|
|
8949
|
+
"superclass": {
|
|
8950
|
+
"name": "LitElement",
|
|
8951
|
+
"package": "lit"
|
|
8952
|
+
},
|
|
8953
|
+
"localization": [
|
|
8747
8954
|
{
|
|
8748
|
-
"name": "
|
|
8749
|
-
"
|
|
8750
|
-
"text": "string"
|
|
8751
|
-
}
|
|
8955
|
+
"name": "unreadLabel",
|
|
8956
|
+
"description": "Label for the unread messages."
|
|
8752
8957
|
}
|
|
8753
8958
|
],
|
|
8754
|
-
"
|
|
8959
|
+
"status": "draft",
|
|
8960
|
+
"category": "action",
|
|
8961
|
+
"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- Messages should always perform an action when clicked.\n- The click action should navigate to a new page or provide more detail about the message.\n- Mark unread messages as read on user interaction.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t slot other components inside a message.\n\n</div>\n\n---\n\n## Content guidelines\n\nMessage content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the message content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAvoid all caps for messages:\n\n<div class=\"n-usage n-usage-do\">Nina Williams arrived to clinic with Norfryd</div>\n<div class=\"n-usage n-usage-dont\">NINA WILLIAMS ARRIVED TO CLINIC WITH NORFRYD</div>\n",
|
|
8962
|
+
"examples": [],
|
|
8963
|
+
"dependencies": [
|
|
8964
|
+
"dropdown-item"
|
|
8965
|
+
],
|
|
8966
|
+
"tagName": "nord-message",
|
|
8967
|
+
"customElement": true
|
|
8755
8968
|
}
|
|
8756
8969
|
],
|
|
8757
8970
|
"exports": [
|
|
8758
8971
|
{
|
|
8759
8972
|
"kind": "js",
|
|
8760
|
-
"name": "
|
|
8761
|
-
"declaration": {
|
|
8762
|
-
"name": "clearTranslations",
|
|
8763
|
-
"module": "src/localization/translation.ts"
|
|
8764
|
-
}
|
|
8765
|
-
},
|
|
8766
|
-
{
|
|
8767
|
-
"kind": "js",
|
|
8768
|
-
"name": "registerTranslation",
|
|
8769
|
-
"declaration": {
|
|
8770
|
-
"name": "registerTranslation",
|
|
8771
|
-
"module": "src/localization/translation.ts"
|
|
8772
|
-
}
|
|
8773
|
-
},
|
|
8774
|
-
{
|
|
8775
|
-
"kind": "js",
|
|
8776
|
-
"name": "subscribe",
|
|
8973
|
+
"name": "default",
|
|
8777
8974
|
"declaration": {
|
|
8778
|
-
"name": "
|
|
8779
|
-
"module": "src/
|
|
8975
|
+
"name": "Message",
|
|
8976
|
+
"module": "src/message/Message.ts"
|
|
8780
8977
|
}
|
|
8781
8978
|
},
|
|
8782
8979
|
{
|
|
8783
|
-
"kind": "
|
|
8784
|
-
"name": "
|
|
8980
|
+
"kind": "custom-element-definition",
|
|
8981
|
+
"name": "nord-message",
|
|
8785
8982
|
"declaration": {
|
|
8786
|
-
"name": "
|
|
8787
|
-
"module": "src/
|
|
8983
|
+
"name": "Message",
|
|
8984
|
+
"module": "src/message/Message.ts"
|
|
8788
8985
|
}
|
|
8789
|
-
}
|
|
8986
|
+
}
|
|
8987
|
+
]
|
|
8988
|
+
},
|
|
8989
|
+
{
|
|
8990
|
+
"kind": "javascript-module",
|
|
8991
|
+
"path": "src/message/localization.ts",
|
|
8992
|
+
"declarations": [
|
|
8790
8993
|
{
|
|
8791
|
-
"kind": "
|
|
8792
|
-
"name": "
|
|
8793
|
-
"
|
|
8794
|
-
"
|
|
8795
|
-
|
|
8796
|
-
}
|
|
8797
|
-
}
|
|
8994
|
+
"kind": "variable",
|
|
8995
|
+
"name": "localization",
|
|
8996
|
+
"type": {
|
|
8997
|
+
"text": "object"
|
|
8998
|
+
},
|
|
8999
|
+
"default": "{\n unreadLabel: \"Unread\",\n}"
|
|
9000
|
+
}
|
|
9001
|
+
],
|
|
9002
|
+
"exports": [
|
|
8798
9003
|
{
|
|
8799
9004
|
"kind": "js",
|
|
8800
|
-
"name": "
|
|
9005
|
+
"name": "default",
|
|
8801
9006
|
"declaration": {
|
|
8802
|
-
"name": "
|
|
8803
|
-
"module": "src/localization
|
|
9007
|
+
"name": "localization",
|
|
9008
|
+
"module": "src/message/localization.ts"
|
|
8804
9009
|
}
|
|
8805
9010
|
}
|
|
8806
9011
|
]
|
|
@@ -9147,277 +9352,72 @@
|
|
|
9147
9352
|
"type": {
|
|
9148
9353
|
"text": "HTMLButtonElement | undefined"
|
|
9149
9354
|
},
|
|
9150
|
-
"privacy": "private"
|
|
9151
|
-
},
|
|
9152
|
-
{
|
|
9153
|
-
"kind": "method",
|
|
9154
|
-
"name": "hostConnected"
|
|
9155
|
-
},
|
|
9156
|
-
{
|
|
9157
|
-
"kind": "method",
|
|
9158
|
-
"name": "hostDisconnected",
|
|
9159
|
-
"return": {
|
|
9160
|
-
"type": {
|
|
9161
|
-
"text": "void"
|
|
9162
|
-
}
|
|
9163
|
-
}
|
|
9164
|
-
},
|
|
9165
|
-
{
|
|
9166
|
-
"kind": "method",
|
|
9167
|
-
"name": "block"
|
|
9168
|
-
},
|
|
9169
|
-
{
|
|
9170
|
-
"kind": "method",
|
|
9171
|
-
"name": "unblock"
|
|
9172
|
-
},
|
|
9173
|
-
{
|
|
9174
|
-
"kind": "field",
|
|
9175
|
-
"name": "trackLastButton",
|
|
9176
|
-
"privacy": "private",
|
|
9177
|
-
"description": "capture the last button clicked, so that we can polyfill `submitter` property in submit event"
|
|
9178
|
-
},
|
|
9179
|
-
{
|
|
9180
|
-
"kind": "field",
|
|
9181
|
-
"name": "polyfillSubmitter",
|
|
9182
|
-
"privacy": "private"
|
|
9183
|
-
},
|
|
9184
|
-
{
|
|
9185
|
-
"kind": "field",
|
|
9186
|
-
"name": "handleTransitionEnd",
|
|
9187
|
-
"privacy": "private"
|
|
9188
|
-
},
|
|
9189
|
-
{
|
|
9190
|
-
"kind": "field",
|
|
9191
|
-
"name": "handleLightDismiss",
|
|
9192
|
-
"privacy": "private"
|
|
9193
|
-
},
|
|
9194
|
-
{
|
|
9195
|
-
"kind": "field",
|
|
9196
|
-
"name": "handleSubmit",
|
|
9197
|
-
"privacy": "private"
|
|
9198
|
-
}
|
|
9199
|
-
]
|
|
9200
|
-
}
|
|
9201
|
-
],
|
|
9202
|
-
"exports": [
|
|
9203
|
-
{
|
|
9204
|
-
"kind": "js",
|
|
9205
|
-
"name": "ModalController",
|
|
9206
|
-
"declaration": {
|
|
9207
|
-
"name": "ModalController",
|
|
9208
|
-
"module": "src/modal/ModalController.ts"
|
|
9209
|
-
}
|
|
9210
|
-
}
|
|
9211
|
-
]
|
|
9212
|
-
},
|
|
9213
|
-
{
|
|
9214
|
-
"kind": "javascript-module",
|
|
9215
|
-
"path": "src/modal/localization.ts",
|
|
9216
|
-
"declarations": [
|
|
9217
|
-
{
|
|
9218
|
-
"kind": "variable",
|
|
9219
|
-
"name": "localization",
|
|
9220
|
-
"type": {
|
|
9221
|
-
"text": "object"
|
|
9222
|
-
},
|
|
9223
|
-
"default": "{\n closeLabel: \"Close dialog\",\n}"
|
|
9224
|
-
}
|
|
9225
|
-
],
|
|
9226
|
-
"exports": [
|
|
9227
|
-
{
|
|
9228
|
-
"kind": "js",
|
|
9229
|
-
"name": "default",
|
|
9230
|
-
"declaration": {
|
|
9231
|
-
"name": "localization",
|
|
9232
|
-
"module": "src/modal/localization.ts"
|
|
9233
|
-
}
|
|
9234
|
-
}
|
|
9235
|
-
]
|
|
9236
|
-
},
|
|
9237
|
-
{
|
|
9238
|
-
"kind": "javascript-module",
|
|
9239
|
-
"path": "src/message/Message.ts",
|
|
9240
|
-
"declarations": [
|
|
9241
|
-
{
|
|
9242
|
-
"kind": "class",
|
|
9243
|
-
"description": "Message represents a specific item within a collection,\nsuch as notifications, tasks or conversations. Message\ncan be placed directly inside a dropdown component.",
|
|
9244
|
-
"name": "Message",
|
|
9245
|
-
"cssProperties": [
|
|
9246
|
-
{
|
|
9247
|
-
"description": "Controls the border color of the message, using our [color tokens](/tokens/#color).",
|
|
9248
|
-
"name": "--n-message-border-color",
|
|
9249
|
-
"default": "var(--n-color-border)"
|
|
9250
|
-
}
|
|
9251
|
-
],
|
|
9252
|
-
"slots": [
|
|
9253
|
-
{
|
|
9254
|
-
"description": "The message content.",
|
|
9255
|
-
"name": ""
|
|
9256
|
-
},
|
|
9257
|
-
{
|
|
9258
|
-
"description": "Used to place content after the message. Typically used for a timestamp.",
|
|
9259
|
-
"name": "footer"
|
|
9260
|
-
}
|
|
9261
|
-
],
|
|
9262
|
-
"members": [
|
|
9263
|
-
{
|
|
9264
|
-
"kind": "field",
|
|
9265
|
-
"name": "localize",
|
|
9266
|
-
"privacy": "private",
|
|
9267
|
-
"default": "new LocalizeController<\"nord-message\">(this)"
|
|
9268
|
-
},
|
|
9269
|
-
{
|
|
9270
|
-
"kind": "field",
|
|
9271
|
-
"name": "href",
|
|
9272
|
-
"type": {
|
|
9273
|
-
"text": "string | undefined"
|
|
9274
|
-
},
|
|
9275
|
-
"description": "The url the message should link to.",
|
|
9276
|
-
"attribute": "href",
|
|
9277
|
-
"reflects": true
|
|
9278
|
-
},
|
|
9279
|
-
{
|
|
9280
|
-
"kind": "field",
|
|
9281
|
-
"name": "highlight",
|
|
9282
|
-
"type": {
|
|
9283
|
-
"text": "boolean | undefined"
|
|
9284
|
-
},
|
|
9285
|
-
"description": "Highlight the message visually. This is meant for highlighting\na new message that just appeared. Highlight style should be removed\nafter the user has seen the message and there’s been a timeout of\ne.g. 30 seconds.",
|
|
9286
|
-
"attribute": "highlight",
|
|
9287
|
-
"reflects": true
|
|
9288
|
-
},
|
|
9289
|
-
{
|
|
9290
|
-
"kind": "field",
|
|
9291
|
-
"name": "unread",
|
|
9292
|
-
"type": {
|
|
9293
|
-
"text": "boolean | undefined"
|
|
9294
|
-
},
|
|
9295
|
-
"description": "Mark the message as unread. By default messages are read.",
|
|
9296
|
-
"attribute": "unread",
|
|
9297
|
-
"reflects": true
|
|
9298
|
-
},
|
|
9299
|
-
{
|
|
9300
|
-
"kind": "field",
|
|
9301
|
-
"name": "focusableRef",
|
|
9302
|
-
"privacy": "protected",
|
|
9303
|
-
"inheritedFrom": {
|
|
9304
|
-
"name": "FocusableMixin",
|
|
9305
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9306
|
-
}
|
|
9307
|
-
},
|
|
9308
|
-
{
|
|
9309
|
-
"kind": "method",
|
|
9310
|
-
"name": "focus",
|
|
9311
|
-
"parameters": [
|
|
9312
|
-
{
|
|
9313
|
-
"name": "options",
|
|
9314
|
-
"optional": true,
|
|
9315
|
-
"type": {
|
|
9316
|
-
"text": "FocusOptions"
|
|
9317
|
-
},
|
|
9318
|
-
"description": "An object which controls aspects of the focusing process."
|
|
9355
|
+
"privacy": "private"
|
|
9356
|
+
},
|
|
9357
|
+
{
|
|
9358
|
+
"kind": "method",
|
|
9359
|
+
"name": "hostConnected"
|
|
9360
|
+
},
|
|
9361
|
+
{
|
|
9362
|
+
"kind": "method",
|
|
9363
|
+
"name": "hostDisconnected",
|
|
9364
|
+
"return": {
|
|
9365
|
+
"type": {
|
|
9366
|
+
"text": "void"
|
|
9319
9367
|
}
|
|
9320
|
-
],
|
|
9321
|
-
"description": "Programmatically move focus to the component.",
|
|
9322
|
-
"inheritedFrom": {
|
|
9323
|
-
"name": "FocusableMixin",
|
|
9324
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9325
9368
|
}
|
|
9326
9369
|
},
|
|
9327
9370
|
{
|
|
9328
9371
|
"kind": "method",
|
|
9329
|
-
"name": "
|
|
9330
|
-
"description": "Programmatically remove focus from the component.",
|
|
9331
|
-
"inheritedFrom": {
|
|
9332
|
-
"name": "FocusableMixin",
|
|
9333
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9334
|
-
}
|
|
9372
|
+
"name": "block"
|
|
9335
9373
|
},
|
|
9336
9374
|
{
|
|
9337
9375
|
"kind": "method",
|
|
9338
|
-
"name": "
|
|
9339
|
-
|
|
9340
|
-
"inheritedFrom": {
|
|
9341
|
-
"name": "FocusableMixin",
|
|
9342
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9343
|
-
}
|
|
9344
|
-
}
|
|
9345
|
-
],
|
|
9346
|
-
"attributes": [
|
|
9376
|
+
"name": "unblock"
|
|
9377
|
+
},
|
|
9347
9378
|
{
|
|
9348
|
-
"
|
|
9349
|
-
"
|
|
9350
|
-
|
|
9351
|
-
|
|
9352
|
-
"description": "The url the message should link to.",
|
|
9353
|
-
"fieldName": "href"
|
|
9379
|
+
"kind": "field",
|
|
9380
|
+
"name": "trackLastButton",
|
|
9381
|
+
"privacy": "private",
|
|
9382
|
+
"description": "capture the last button clicked, so that we can polyfill `submitter` property in submit event"
|
|
9354
9383
|
},
|
|
9355
9384
|
{
|
|
9356
|
-
"
|
|
9357
|
-
"
|
|
9358
|
-
|
|
9359
|
-
},
|
|
9360
|
-
"description": "Highlight the message visually. This is meant for highlighting\na new message that just appeared. Highlight style should be removed\nafter the user has seen the message and there’s been a timeout of\ne.g. 30 seconds.",
|
|
9361
|
-
"fieldName": "highlight"
|
|
9385
|
+
"kind": "field",
|
|
9386
|
+
"name": "polyfillSubmitter",
|
|
9387
|
+
"privacy": "private"
|
|
9362
9388
|
},
|
|
9363
9389
|
{
|
|
9364
|
-
"
|
|
9365
|
-
"
|
|
9366
|
-
|
|
9367
|
-
|
|
9368
|
-
"description": "Mark the message as unread. By default messages are read.",
|
|
9369
|
-
"fieldName": "unread"
|
|
9370
|
-
}
|
|
9371
|
-
],
|
|
9372
|
-
"mixins": [
|
|
9390
|
+
"kind": "field",
|
|
9391
|
+
"name": "handleTransitionEnd",
|
|
9392
|
+
"privacy": "private"
|
|
9393
|
+
},
|
|
9373
9394
|
{
|
|
9374
|
-
"
|
|
9375
|
-
"
|
|
9376
|
-
|
|
9377
|
-
|
|
9378
|
-
"superclass": {
|
|
9379
|
-
"name": "LitElement",
|
|
9380
|
-
"package": "lit"
|
|
9381
|
-
},
|
|
9382
|
-
"localization": [
|
|
9395
|
+
"kind": "field",
|
|
9396
|
+
"name": "handleLightDismiss",
|
|
9397
|
+
"privacy": "private"
|
|
9398
|
+
},
|
|
9383
9399
|
{
|
|
9384
|
-
"
|
|
9385
|
-
"
|
|
9400
|
+
"kind": "field",
|
|
9401
|
+
"name": "handleSubmit",
|
|
9402
|
+
"privacy": "private"
|
|
9386
9403
|
}
|
|
9387
|
-
]
|
|
9388
|
-
"status": "draft",
|
|
9389
|
-
"category": "action",
|
|
9390
|
-
"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- Messages should always perform an action when clicked.\n- The click action should navigate to a new page or provide more detail about the message.\n- Mark unread messages as read on user interaction.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t slot other components inside a message.\n\n</div>\n\n---\n\n## Content guidelines\n\nMessage content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the message content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAvoid all caps for messages:\n\n<div class=\"n-usage n-usage-do\">Nina Williams arrived to clinic with Norfryd</div>\n<div class=\"n-usage n-usage-dont\">NINA WILLIAMS ARRIVED TO CLINIC WITH NORFRYD</div>\n",
|
|
9391
|
-
"examples": [],
|
|
9392
|
-
"dependencies": [
|
|
9393
|
-
"dropdown-item"
|
|
9394
|
-
],
|
|
9395
|
-
"tagName": "nord-message",
|
|
9396
|
-
"customElement": true
|
|
9404
|
+
]
|
|
9397
9405
|
}
|
|
9398
9406
|
],
|
|
9399
9407
|
"exports": [
|
|
9400
9408
|
{
|
|
9401
9409
|
"kind": "js",
|
|
9402
|
-
"name": "
|
|
9403
|
-
"declaration": {
|
|
9404
|
-
"name": "Message",
|
|
9405
|
-
"module": "src/message/Message.ts"
|
|
9406
|
-
}
|
|
9407
|
-
},
|
|
9408
|
-
{
|
|
9409
|
-
"kind": "custom-element-definition",
|
|
9410
|
-
"name": "nord-message",
|
|
9410
|
+
"name": "ModalController",
|
|
9411
9411
|
"declaration": {
|
|
9412
|
-
"name": "
|
|
9413
|
-
"module": "src/
|
|
9412
|
+
"name": "ModalController",
|
|
9413
|
+
"module": "src/modal/ModalController.ts"
|
|
9414
9414
|
}
|
|
9415
9415
|
}
|
|
9416
9416
|
]
|
|
9417
9417
|
},
|
|
9418
9418
|
{
|
|
9419
9419
|
"kind": "javascript-module",
|
|
9420
|
-
"path": "src/
|
|
9420
|
+
"path": "src/modal/localization.ts",
|
|
9421
9421
|
"declarations": [
|
|
9422
9422
|
{
|
|
9423
9423
|
"kind": "variable",
|
|
@@ -9425,7 +9425,7 @@
|
|
|
9425
9425
|
"type": {
|
|
9426
9426
|
"text": "object"
|
|
9427
9427
|
},
|
|
9428
|
-
"default": "{\n
|
|
9428
|
+
"default": "{\n closeLabel: \"Close dialog\",\n}"
|
|
9429
9429
|
}
|
|
9430
9430
|
],
|
|
9431
9431
|
"exports": [
|
|
@@ -9434,77 +9434,7 @@
|
|
|
9434
9434
|
"name": "default",
|
|
9435
9435
|
"declaration": {
|
|
9436
9436
|
"name": "localization",
|
|
9437
|
-
"module": "src/
|
|
9438
|
-
}
|
|
9439
|
-
}
|
|
9440
|
-
]
|
|
9441
|
-
},
|
|
9442
|
-
{
|
|
9443
|
-
"kind": "javascript-module",
|
|
9444
|
-
"path": "src/nav-group/NavGroup.ts",
|
|
9445
|
-
"declarations": [
|
|
9446
|
-
{
|
|
9447
|
-
"kind": "class",
|
|
9448
|
-
"description": "Navigation group includes all the actions or items in a single\ngroup and is used for grouping items into related categories.",
|
|
9449
|
-
"name": "NavGroup",
|
|
9450
|
-
"slots": [
|
|
9451
|
-
{
|
|
9452
|
-
"description": "The default slot used for the nav items.",
|
|
9453
|
-
"name": ""
|
|
9454
|
-
}
|
|
9455
|
-
],
|
|
9456
|
-
"members": [
|
|
9457
|
-
{
|
|
9458
|
-
"kind": "field",
|
|
9459
|
-
"name": "heading",
|
|
9460
|
-
"type": {
|
|
9461
|
-
"text": "string | undefined"
|
|
9462
|
-
},
|
|
9463
|
-
"description": "Heading and accessible label for the nav group",
|
|
9464
|
-
"attribute": "heading"
|
|
9465
|
-
}
|
|
9466
|
-
],
|
|
9467
|
-
"attributes": [
|
|
9468
|
-
{
|
|
9469
|
-
"name": "heading",
|
|
9470
|
-
"type": {
|
|
9471
|
-
"text": "string | undefined"
|
|
9472
|
-
},
|
|
9473
|
-
"description": "Heading and accessible label for the nav group",
|
|
9474
|
-
"fieldName": "heading"
|
|
9475
|
-
}
|
|
9476
|
-
],
|
|
9477
|
-
"superclass": {
|
|
9478
|
-
"name": "LitElement",
|
|
9479
|
-
"package": "lit"
|
|
9480
|
-
},
|
|
9481
|
-
"localization": [],
|
|
9482
|
-
"status": "ready",
|
|
9483
|
-
"category": "navigation",
|
|
9484
|
-
"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",
|
|
9485
|
-
"examples": [],
|
|
9486
|
-
"dependencies": [
|
|
9487
|
-
"icon"
|
|
9488
|
-
],
|
|
9489
|
-
"tagName": "nord-nav-group",
|
|
9490
|
-
"customElement": true
|
|
9491
|
-
}
|
|
9492
|
-
],
|
|
9493
|
-
"exports": [
|
|
9494
|
-
{
|
|
9495
|
-
"kind": "js",
|
|
9496
|
-
"name": "default",
|
|
9497
|
-
"declaration": {
|
|
9498
|
-
"name": "NavGroup",
|
|
9499
|
-
"module": "src/nav-group/NavGroup.ts"
|
|
9500
|
-
}
|
|
9501
|
-
},
|
|
9502
|
-
{
|
|
9503
|
-
"kind": "custom-element-definition",
|
|
9504
|
-
"name": "nord-nav-group",
|
|
9505
|
-
"declaration": {
|
|
9506
|
-
"name": "NavGroup",
|
|
9507
|
-
"module": "src/nav-group/NavGroup.ts"
|
|
9437
|
+
"module": "src/modal/localization.ts"
|
|
9508
9438
|
}
|
|
9509
9439
|
}
|
|
9510
9440
|
]
|
|
@@ -9776,8 +9706,78 @@
|
|
|
9776
9706
|
"kind": "custom-element-definition",
|
|
9777
9707
|
"name": "nord-nav-item",
|
|
9778
9708
|
"declaration": {
|
|
9779
|
-
"name": "NavItem",
|
|
9780
|
-
"module": "src/nav-item/NavItem.ts"
|
|
9709
|
+
"name": "NavItem",
|
|
9710
|
+
"module": "src/nav-item/NavItem.ts"
|
|
9711
|
+
}
|
|
9712
|
+
}
|
|
9713
|
+
]
|
|
9714
|
+
},
|
|
9715
|
+
{
|
|
9716
|
+
"kind": "javascript-module",
|
|
9717
|
+
"path": "src/nav-group/NavGroup.ts",
|
|
9718
|
+
"declarations": [
|
|
9719
|
+
{
|
|
9720
|
+
"kind": "class",
|
|
9721
|
+
"description": "Navigation group includes all the actions or items in a single\ngroup and is used for grouping items into related categories.",
|
|
9722
|
+
"name": "NavGroup",
|
|
9723
|
+
"slots": [
|
|
9724
|
+
{
|
|
9725
|
+
"description": "The default slot used for the nav items.",
|
|
9726
|
+
"name": ""
|
|
9727
|
+
}
|
|
9728
|
+
],
|
|
9729
|
+
"members": [
|
|
9730
|
+
{
|
|
9731
|
+
"kind": "field",
|
|
9732
|
+
"name": "heading",
|
|
9733
|
+
"type": {
|
|
9734
|
+
"text": "string | undefined"
|
|
9735
|
+
},
|
|
9736
|
+
"description": "Heading and accessible label for the nav group",
|
|
9737
|
+
"attribute": "heading"
|
|
9738
|
+
}
|
|
9739
|
+
],
|
|
9740
|
+
"attributes": [
|
|
9741
|
+
{
|
|
9742
|
+
"name": "heading",
|
|
9743
|
+
"type": {
|
|
9744
|
+
"text": "string | undefined"
|
|
9745
|
+
},
|
|
9746
|
+
"description": "Heading and accessible label for the nav group",
|
|
9747
|
+
"fieldName": "heading"
|
|
9748
|
+
}
|
|
9749
|
+
],
|
|
9750
|
+
"superclass": {
|
|
9751
|
+
"name": "LitElement",
|
|
9752
|
+
"package": "lit"
|
|
9753
|
+
},
|
|
9754
|
+
"localization": [],
|
|
9755
|
+
"status": "ready",
|
|
9756
|
+
"category": "navigation",
|
|
9757
|
+
"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",
|
|
9758
|
+
"examples": [],
|
|
9759
|
+
"dependencies": [
|
|
9760
|
+
"icon"
|
|
9761
|
+
],
|
|
9762
|
+
"tagName": "nord-nav-group",
|
|
9763
|
+
"customElement": true
|
|
9764
|
+
}
|
|
9765
|
+
],
|
|
9766
|
+
"exports": [
|
|
9767
|
+
{
|
|
9768
|
+
"kind": "js",
|
|
9769
|
+
"name": "default",
|
|
9770
|
+
"declaration": {
|
|
9771
|
+
"name": "NavGroup",
|
|
9772
|
+
"module": "src/nav-group/NavGroup.ts"
|
|
9773
|
+
}
|
|
9774
|
+
},
|
|
9775
|
+
{
|
|
9776
|
+
"kind": "custom-element-definition",
|
|
9777
|
+
"name": "nord-nav-group",
|
|
9778
|
+
"declaration": {
|
|
9779
|
+
"name": "NavGroup",
|
|
9780
|
+
"module": "src/nav-group/NavGroup.ts"
|
|
9781
9781
|
}
|
|
9782
9782
|
}
|
|
9783
9783
|
]
|
|
@@ -9871,11 +9871,262 @@
|
|
|
9871
9871
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a tooltip with the toggle that’s labelled as `Toggle navigation`.\n- We recommend setting a keyboard shortcut that toggles the navigation.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use as a generic button or toggle. Use the [Button component](/components/button/) instead.\n\n</div>\n",
|
|
9872
9872
|
"examples": [],
|
|
9873
9873
|
"dependencies": [
|
|
9874
|
-
"button",
|
|
9875
|
-
"icon",
|
|
9876
|
-
"visually-hidden"
|
|
9874
|
+
"button",
|
|
9875
|
+
"icon",
|
|
9876
|
+
"visually-hidden"
|
|
9877
|
+
],
|
|
9878
|
+
"tagName": "nord-nav-toggle",
|
|
9879
|
+
"customElement": true
|
|
9880
|
+
}
|
|
9881
|
+
],
|
|
9882
|
+
"exports": [
|
|
9883
|
+
{
|
|
9884
|
+
"kind": "js",
|
|
9885
|
+
"name": "default",
|
|
9886
|
+
"declaration": {
|
|
9887
|
+
"name": "NavToggle",
|
|
9888
|
+
"module": "src/nav-toggle/NavToggle.ts"
|
|
9889
|
+
}
|
|
9890
|
+
},
|
|
9891
|
+
{
|
|
9892
|
+
"kind": "custom-element-definition",
|
|
9893
|
+
"name": "nord-nav-toggle",
|
|
9894
|
+
"declaration": {
|
|
9895
|
+
"name": "NavToggle",
|
|
9896
|
+
"module": "src/nav-toggle/NavToggle.ts"
|
|
9897
|
+
}
|
|
9898
|
+
}
|
|
9899
|
+
]
|
|
9900
|
+
},
|
|
9901
|
+
{
|
|
9902
|
+
"kind": "javascript-module",
|
|
9903
|
+
"path": "src/nav-toggle/localization.ts",
|
|
9904
|
+
"declarations": [
|
|
9905
|
+
{
|
|
9906
|
+
"kind": "variable",
|
|
9907
|
+
"name": "localization",
|
|
9908
|
+
"type": {
|
|
9909
|
+
"text": "object"
|
|
9910
|
+
},
|
|
9911
|
+
"default": "{\n label: \"Toggle navigation\",\n}"
|
|
9912
|
+
}
|
|
9913
|
+
],
|
|
9914
|
+
"exports": [
|
|
9915
|
+
{
|
|
9916
|
+
"kind": "js",
|
|
9917
|
+
"name": "default",
|
|
9918
|
+
"declaration": {
|
|
9919
|
+
"name": "localization",
|
|
9920
|
+
"module": "src/nav-toggle/localization.ts"
|
|
9921
|
+
}
|
|
9922
|
+
}
|
|
9923
|
+
]
|
|
9924
|
+
},
|
|
9925
|
+
{
|
|
9926
|
+
"kind": "javascript-module",
|
|
9927
|
+
"path": "src/navigation/Navigation.ts",
|
|
9928
|
+
"declarations": [
|
|
9929
|
+
{
|
|
9930
|
+
"kind": "class",
|
|
9931
|
+
"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.",
|
|
9932
|
+
"name": "Navigation",
|
|
9933
|
+
"cssProperties": [
|
|
9934
|
+
{
|
|
9935
|
+
"description": "Controls the background color of the navigation element.",
|
|
9936
|
+
"name": "--n-navigation-background-color",
|
|
9937
|
+
"default": "var(--n-color-nav-surface)"
|
|
9938
|
+
}
|
|
9939
|
+
],
|
|
9940
|
+
"slots": [
|
|
9941
|
+
{
|
|
9942
|
+
"description": "The main section of the sidebar, for holding nav components.",
|
|
9943
|
+
"name": ""
|
|
9944
|
+
},
|
|
9945
|
+
{
|
|
9946
|
+
"description": "The top section of the sidebar.",
|
|
9947
|
+
"name": "header"
|
|
9948
|
+
},
|
|
9949
|
+
{
|
|
9950
|
+
"description": "The bottom section of the sidebar.",
|
|
9951
|
+
"name": "footer"
|
|
9952
|
+
}
|
|
9953
|
+
],
|
|
9954
|
+
"members": [
|
|
9955
|
+
{
|
|
9956
|
+
"kind": "field",
|
|
9957
|
+
"name": "headerSlot",
|
|
9958
|
+
"privacy": "private",
|
|
9959
|
+
"default": "new SlotController(this, \"header\")"
|
|
9960
|
+
},
|
|
9961
|
+
{
|
|
9962
|
+
"kind": "field",
|
|
9963
|
+
"name": "events",
|
|
9964
|
+
"privacy": "private",
|
|
9965
|
+
"default": "new EventController(this)"
|
|
9966
|
+
},
|
|
9967
|
+
{
|
|
9968
|
+
"kind": "field",
|
|
9969
|
+
"name": "allowItemsToRemainOpen",
|
|
9970
|
+
"type": {
|
|
9971
|
+
"text": "boolean"
|
|
9972
|
+
},
|
|
9973
|
+
"privacy": "private",
|
|
9974
|
+
"default": "false"
|
|
9975
|
+
},
|
|
9976
|
+
{
|
|
9977
|
+
"kind": "field",
|
|
9978
|
+
"name": "handleActivate",
|
|
9979
|
+
"privacy": "private"
|
|
9980
|
+
}
|
|
9981
|
+
],
|
|
9982
|
+
"superclass": {
|
|
9983
|
+
"name": "LitElement",
|
|
9984
|
+
"package": "lit"
|
|
9985
|
+
},
|
|
9986
|
+
"localization": [],
|
|
9987
|
+
"status": "ready",
|
|
9988
|
+
"category": "navigation",
|
|
9989
|
+
"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",
|
|
9990
|
+
"examples": [],
|
|
9991
|
+
"dependencies": [
|
|
9992
|
+
"nav-item"
|
|
9993
|
+
],
|
|
9994
|
+
"tagName": "nord-navigation",
|
|
9995
|
+
"customElement": true
|
|
9996
|
+
}
|
|
9997
|
+
],
|
|
9998
|
+
"exports": [
|
|
9999
|
+
{
|
|
10000
|
+
"kind": "js",
|
|
10001
|
+
"name": "default",
|
|
10002
|
+
"declaration": {
|
|
10003
|
+
"name": "Navigation",
|
|
10004
|
+
"module": "src/navigation/Navigation.ts"
|
|
10005
|
+
}
|
|
10006
|
+
},
|
|
10007
|
+
{
|
|
10008
|
+
"kind": "custom-element-definition",
|
|
10009
|
+
"name": "nord-navigation",
|
|
10010
|
+
"declaration": {
|
|
10011
|
+
"name": "Navigation",
|
|
10012
|
+
"module": "src/navigation/Navigation.ts"
|
|
10013
|
+
}
|
|
10014
|
+
}
|
|
10015
|
+
]
|
|
10016
|
+
},
|
|
10017
|
+
{
|
|
10018
|
+
"kind": "javascript-module",
|
|
10019
|
+
"path": "src/notification/Notification.ts",
|
|
10020
|
+
"declarations": [
|
|
10021
|
+
{
|
|
10022
|
+
"kind": "class",
|
|
10023
|
+
"description": "Notifications provide important information that requires action or acknowledgement.\nA notification is displayed until the user dismisses it.",
|
|
10024
|
+
"name": "Notification",
|
|
10025
|
+
"slots": [
|
|
10026
|
+
{
|
|
10027
|
+
"description": "Default slot used for the notification text/message.",
|
|
10028
|
+
"name": ""
|
|
10029
|
+
},
|
|
10030
|
+
{
|
|
10031
|
+
"description": "Slot used for the notification icon.",
|
|
10032
|
+
"name": "icon"
|
|
10033
|
+
}
|
|
10034
|
+
],
|
|
10035
|
+
"members": [
|
|
10036
|
+
{
|
|
10037
|
+
"kind": "field",
|
|
10038
|
+
"name": "localize",
|
|
10039
|
+
"privacy": "private",
|
|
10040
|
+
"default": "new LocalizeController<\"nord-notification\">(this)"
|
|
10041
|
+
},
|
|
10042
|
+
{
|
|
10043
|
+
"kind": "field",
|
|
10044
|
+
"name": "notificationRef",
|
|
10045
|
+
"privacy": "protected",
|
|
10046
|
+
"inheritedFrom": {
|
|
10047
|
+
"name": "NotificationMixin",
|
|
10048
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10049
|
+
}
|
|
10050
|
+
},
|
|
10051
|
+
{
|
|
10052
|
+
"kind": "field",
|
|
10053
|
+
"name": "dismissed",
|
|
10054
|
+
"type": {
|
|
10055
|
+
"text": "boolean"
|
|
10056
|
+
},
|
|
10057
|
+
"privacy": "protected",
|
|
10058
|
+
"default": "false",
|
|
10059
|
+
"inheritedFrom": {
|
|
10060
|
+
"name": "NotificationMixin",
|
|
10061
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10062
|
+
}
|
|
10063
|
+
},
|
|
10064
|
+
{
|
|
10065
|
+
"kind": "method",
|
|
10066
|
+
"name": "dismiss",
|
|
10067
|
+
"description": "Programmatically dismiss the notification.\nThe returned promise resolves when notification's exit animation is complete.",
|
|
10068
|
+
"inheritedFrom": {
|
|
10069
|
+
"name": "NotificationMixin",
|
|
10070
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10071
|
+
}
|
|
10072
|
+
},
|
|
10073
|
+
{
|
|
10074
|
+
"kind": "field",
|
|
10075
|
+
"name": "_warningLogged",
|
|
10076
|
+
"type": {
|
|
10077
|
+
"text": "boolean"
|
|
10078
|
+
},
|
|
10079
|
+
"privacy": "private",
|
|
10080
|
+
"static": true,
|
|
10081
|
+
"default": "false",
|
|
10082
|
+
"inheritedFrom": {
|
|
10083
|
+
"name": "DraftComponentMixin",
|
|
10084
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
10085
|
+
}
|
|
10086
|
+
}
|
|
10087
|
+
],
|
|
10088
|
+
"events": [
|
|
10089
|
+
{
|
|
10090
|
+
"name": "dismiss",
|
|
10091
|
+
"type": {
|
|
10092
|
+
"text": "NordEvent"
|
|
10093
|
+
},
|
|
10094
|
+
"description": "Fired when the notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
10095
|
+
"inheritedFrom": {
|
|
10096
|
+
"name": "NotificationMixin",
|
|
10097
|
+
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10098
|
+
}
|
|
10099
|
+
}
|
|
10100
|
+
],
|
|
10101
|
+
"mixins": [
|
|
10102
|
+
{
|
|
10103
|
+
"name": "NotificationMixin",
|
|
10104
|
+
"module": "/src/common/mixins/NotificationMixin.js"
|
|
10105
|
+
},
|
|
10106
|
+
{
|
|
10107
|
+
"name": "DraftComponentMixin",
|
|
10108
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
10109
|
+
}
|
|
10110
|
+
],
|
|
10111
|
+
"superclass": {
|
|
10112
|
+
"name": "LitElement",
|
|
10113
|
+
"package": "lit"
|
|
10114
|
+
},
|
|
10115
|
+
"localization": [
|
|
10116
|
+
{
|
|
10117
|
+
"name": "dismissLabel",
|
|
10118
|
+
"description": "Accessible label for the dismiss button."
|
|
10119
|
+
}
|
|
10120
|
+
],
|
|
10121
|
+
"status": "draft",
|
|
10122
|
+
"category": "feedback",
|
|
10123
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for short messages that describe the purpose of the notification.\n- Use for important updates that require user action/attention.\n- Provide a single call to action within the notification.\n- Use in combination with [Notification group](../notification-group/) so that notifications get styled and positioned correctly.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for transient or unimportant messages. Consider using a [Toast](/components/toast) instead.\n- Don't remove a notification until a user has explicitly dismissed, or acted on the notification.\n- Don’t use for error messages unless absolutely necessary. Try to favor a [Banner](/components/banner/) for error messaging instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
10124
|
+
"examples": [],
|
|
10125
|
+
"dependencies": [
|
|
10126
|
+
"stack",
|
|
10127
|
+
"icon"
|
|
9877
10128
|
],
|
|
9878
|
-
"tagName": "nord-
|
|
10129
|
+
"tagName": "nord-notification",
|
|
9879
10130
|
"customElement": true
|
|
9880
10131
|
}
|
|
9881
10132
|
],
|
|
@@ -9884,23 +10135,23 @@
|
|
|
9884
10135
|
"kind": "js",
|
|
9885
10136
|
"name": "default",
|
|
9886
10137
|
"declaration": {
|
|
9887
|
-
"name": "
|
|
9888
|
-
"module": "src/
|
|
10138
|
+
"name": "Notification",
|
|
10139
|
+
"module": "src/notification/Notification.ts"
|
|
9889
10140
|
}
|
|
9890
10141
|
},
|
|
9891
10142
|
{
|
|
9892
10143
|
"kind": "custom-element-definition",
|
|
9893
|
-
"name": "nord-
|
|
10144
|
+
"name": "nord-notification",
|
|
9894
10145
|
"declaration": {
|
|
9895
|
-
"name": "
|
|
9896
|
-
"module": "src/
|
|
10146
|
+
"name": "Notification",
|
|
10147
|
+
"module": "src/notification/Notification.ts"
|
|
9897
10148
|
}
|
|
9898
10149
|
}
|
|
9899
10150
|
]
|
|
9900
10151
|
},
|
|
9901
10152
|
{
|
|
9902
10153
|
"kind": "javascript-module",
|
|
9903
|
-
"path": "src/
|
|
10154
|
+
"path": "src/notification/localization.ts",
|
|
9904
10155
|
"declarations": [
|
|
9905
10156
|
{
|
|
9906
10157
|
"kind": "variable",
|
|
@@ -9908,7 +10159,7 @@
|
|
|
9908
10159
|
"type": {
|
|
9909
10160
|
"text": "object"
|
|
9910
10161
|
},
|
|
9911
|
-
"default": "{\n
|
|
10162
|
+
"default": "{\n dismissLabel: \"Dismiss notification\",\n}"
|
|
9912
10163
|
}
|
|
9913
10164
|
],
|
|
9914
10165
|
"exports": [
|
|
@@ -9917,99 +10168,7 @@
|
|
|
9917
10168
|
"name": "default",
|
|
9918
10169
|
"declaration": {
|
|
9919
10170
|
"name": "localization",
|
|
9920
|
-
"module": "src/
|
|
9921
|
-
}
|
|
9922
|
-
}
|
|
9923
|
-
]
|
|
9924
|
-
},
|
|
9925
|
-
{
|
|
9926
|
-
"kind": "javascript-module",
|
|
9927
|
-
"path": "src/navigation/Navigation.ts",
|
|
9928
|
-
"declarations": [
|
|
9929
|
-
{
|
|
9930
|
-
"kind": "class",
|
|
9931
|
-
"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.",
|
|
9932
|
-
"name": "Navigation",
|
|
9933
|
-
"cssProperties": [
|
|
9934
|
-
{
|
|
9935
|
-
"description": "Controls the background color of the navigation element.",
|
|
9936
|
-
"name": "--n-navigation-background-color",
|
|
9937
|
-
"default": "var(--n-color-nav-surface)"
|
|
9938
|
-
}
|
|
9939
|
-
],
|
|
9940
|
-
"slots": [
|
|
9941
|
-
{
|
|
9942
|
-
"description": "The main section of the sidebar, for holding nav components.",
|
|
9943
|
-
"name": ""
|
|
9944
|
-
},
|
|
9945
|
-
{
|
|
9946
|
-
"description": "The top section of the sidebar.",
|
|
9947
|
-
"name": "header"
|
|
9948
|
-
},
|
|
9949
|
-
{
|
|
9950
|
-
"description": "The bottom section of the sidebar.",
|
|
9951
|
-
"name": "footer"
|
|
9952
|
-
}
|
|
9953
|
-
],
|
|
9954
|
-
"members": [
|
|
9955
|
-
{
|
|
9956
|
-
"kind": "field",
|
|
9957
|
-
"name": "headerSlot",
|
|
9958
|
-
"privacy": "private",
|
|
9959
|
-
"default": "new SlotController(this, \"header\")"
|
|
9960
|
-
},
|
|
9961
|
-
{
|
|
9962
|
-
"kind": "field",
|
|
9963
|
-
"name": "events",
|
|
9964
|
-
"privacy": "private",
|
|
9965
|
-
"default": "new EventController(this)"
|
|
9966
|
-
},
|
|
9967
|
-
{
|
|
9968
|
-
"kind": "field",
|
|
9969
|
-
"name": "allowItemsToRemainOpen",
|
|
9970
|
-
"type": {
|
|
9971
|
-
"text": "boolean"
|
|
9972
|
-
},
|
|
9973
|
-
"privacy": "private",
|
|
9974
|
-
"default": "false"
|
|
9975
|
-
},
|
|
9976
|
-
{
|
|
9977
|
-
"kind": "field",
|
|
9978
|
-
"name": "handleActivate",
|
|
9979
|
-
"privacy": "private"
|
|
9980
|
-
}
|
|
9981
|
-
],
|
|
9982
|
-
"superclass": {
|
|
9983
|
-
"name": "LitElement",
|
|
9984
|
-
"package": "lit"
|
|
9985
|
-
},
|
|
9986
|
-
"localization": [],
|
|
9987
|
-
"status": "ready",
|
|
9988
|
-
"category": "navigation",
|
|
9989
|
-
"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",
|
|
9990
|
-
"examples": [],
|
|
9991
|
-
"dependencies": [
|
|
9992
|
-
"nav-item"
|
|
9993
|
-
],
|
|
9994
|
-
"tagName": "nord-navigation",
|
|
9995
|
-
"customElement": true
|
|
9996
|
-
}
|
|
9997
|
-
],
|
|
9998
|
-
"exports": [
|
|
9999
|
-
{
|
|
10000
|
-
"kind": "js",
|
|
10001
|
-
"name": "default",
|
|
10002
|
-
"declaration": {
|
|
10003
|
-
"name": "Navigation",
|
|
10004
|
-
"module": "src/navigation/Navigation.ts"
|
|
10005
|
-
}
|
|
10006
|
-
},
|
|
10007
|
-
{
|
|
10008
|
-
"kind": "custom-element-definition",
|
|
10009
|
-
"name": "nord-navigation",
|
|
10010
|
-
"declaration": {
|
|
10011
|
-
"name": "Navigation",
|
|
10012
|
-
"module": "src/navigation/Navigation.ts"
|
|
10171
|
+
"module": "src/notification/localization.ts"
|
|
10013
10172
|
}
|
|
10014
10173
|
}
|
|
10015
10174
|
]
|
|
@@ -10398,147 +10557,12 @@
|
|
|
10398
10557
|
"package": "lit"
|
|
10399
10558
|
},
|
|
10400
10559
|
"localization": [],
|
|
10401
|
-
"status": "ready",
|
|
10402
|
-
"category": "overlay",
|
|
10403
|
-
"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- Always position popout next to the button or other interface element that toggles it.\n- Use a popout to contain controls or information that doesn’t need to be shown immediately.\n- Use a popout to contain items that will most likely not fit into the current view.\n- Use a clearly labelled button to reveal the popout.\n- Use the appropriate `aria-haspopup` and `role` attributes for both the toggle button and containing items. Please refer to the [MDN documentation on both role values](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup#values) and [child role values](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup#associated_roles).\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t hide information inside a popout that is imperative to using the current view.\n- Don’t obscure other controls that are important with the popout.\n- Don’t allow the popout to be obscured by other controls or the outer bounds of the current view.\n</div>\n\n---\n\n## Content guidelines\n\nIf a popout contains actions, they should be always written 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\">Create user</div>\n<div class=\"n-usage n-usage-dont\">Create User</div>\n\nPopout actions should always lead with a strong verb that encourages action. Use the `{verb}+{noun}` format except in the case of common actions like Save, Close or Cancel:\n\n<div class=\"n-usage n-usage-do\">Edit row</div>\n<div class=\"n-usage n-usage-dont\">Editing options</div>\n\nAvoid unnecessary words and articles in popout actions, 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 popout actions 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\nAvoid all caps for popout actions:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\n---\n\n## Additional considerations\n\n- The popout component is a containing component, only providing a way to reveal and hide controls by using a single button.\n",
|
|
10404
|
-
"examples": [],
|
|
10405
|
-
"dependencies": [],
|
|
10406
|
-
"tagName": "nord-popout",
|
|
10407
|
-
"customElement": true
|
|
10408
|
-
}
|
|
10409
|
-
],
|
|
10410
|
-
"exports": [
|
|
10411
|
-
{
|
|
10412
|
-
"kind": "js",
|
|
10413
|
-
"name": "default",
|
|
10414
|
-
"declaration": {
|
|
10415
|
-
"name": "Popout",
|
|
10416
|
-
"module": "src/popout/Popout.ts"
|
|
10417
|
-
}
|
|
10418
|
-
},
|
|
10419
|
-
{
|
|
10420
|
-
"kind": "custom-element-definition",
|
|
10421
|
-
"name": "nord-popout",
|
|
10422
|
-
"declaration": {
|
|
10423
|
-
"name": "Popout",
|
|
10424
|
-
"module": "src/popout/Popout.ts"
|
|
10425
|
-
}
|
|
10426
|
-
}
|
|
10427
|
-
]
|
|
10428
|
-
},
|
|
10429
|
-
{
|
|
10430
|
-
"kind": "javascript-module",
|
|
10431
|
-
"path": "src/notification/Notification.ts",
|
|
10432
|
-
"declarations": [
|
|
10433
|
-
{
|
|
10434
|
-
"kind": "class",
|
|
10435
|
-
"description": "Notifications provide important information that requires action or acknowledgement.\nA notification is displayed until the user dismisses it.",
|
|
10436
|
-
"name": "Notification",
|
|
10437
|
-
"slots": [
|
|
10438
|
-
{
|
|
10439
|
-
"description": "Default slot used for the notification text/message.",
|
|
10440
|
-
"name": ""
|
|
10441
|
-
},
|
|
10442
|
-
{
|
|
10443
|
-
"description": "Slot used for the notification icon.",
|
|
10444
|
-
"name": "icon"
|
|
10445
|
-
}
|
|
10446
|
-
],
|
|
10447
|
-
"members": [
|
|
10448
|
-
{
|
|
10449
|
-
"kind": "field",
|
|
10450
|
-
"name": "localize",
|
|
10451
|
-
"privacy": "private",
|
|
10452
|
-
"default": "new LocalizeController<\"nord-notification\">(this)"
|
|
10453
|
-
},
|
|
10454
|
-
{
|
|
10455
|
-
"kind": "field",
|
|
10456
|
-
"name": "notificationRef",
|
|
10457
|
-
"privacy": "protected",
|
|
10458
|
-
"inheritedFrom": {
|
|
10459
|
-
"name": "NotificationMixin",
|
|
10460
|
-
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10461
|
-
}
|
|
10462
|
-
},
|
|
10463
|
-
{
|
|
10464
|
-
"kind": "field",
|
|
10465
|
-
"name": "dismissed",
|
|
10466
|
-
"type": {
|
|
10467
|
-
"text": "boolean"
|
|
10468
|
-
},
|
|
10469
|
-
"privacy": "protected",
|
|
10470
|
-
"default": "false",
|
|
10471
|
-
"inheritedFrom": {
|
|
10472
|
-
"name": "NotificationMixin",
|
|
10473
|
-
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10474
|
-
}
|
|
10475
|
-
},
|
|
10476
|
-
{
|
|
10477
|
-
"kind": "method",
|
|
10478
|
-
"name": "dismiss",
|
|
10479
|
-
"description": "Programmatically dismiss the notification.\nThe returned promise resolves when notification's exit animation is complete.",
|
|
10480
|
-
"inheritedFrom": {
|
|
10481
|
-
"name": "NotificationMixin",
|
|
10482
|
-
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10483
|
-
}
|
|
10484
|
-
},
|
|
10485
|
-
{
|
|
10486
|
-
"kind": "field",
|
|
10487
|
-
"name": "_warningLogged",
|
|
10488
|
-
"type": {
|
|
10489
|
-
"text": "boolean"
|
|
10490
|
-
},
|
|
10491
|
-
"privacy": "private",
|
|
10492
|
-
"static": true,
|
|
10493
|
-
"default": "false",
|
|
10494
|
-
"inheritedFrom": {
|
|
10495
|
-
"name": "DraftComponentMixin",
|
|
10496
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
10497
|
-
}
|
|
10498
|
-
}
|
|
10499
|
-
],
|
|
10500
|
-
"events": [
|
|
10501
|
-
{
|
|
10502
|
-
"name": "dismiss",
|
|
10503
|
-
"type": {
|
|
10504
|
-
"text": "NordEvent"
|
|
10505
|
-
},
|
|
10506
|
-
"description": "Fired when the notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
10507
|
-
"inheritedFrom": {
|
|
10508
|
-
"name": "NotificationMixin",
|
|
10509
|
-
"module": "src/common/mixins/NotificationMixin.ts"
|
|
10510
|
-
}
|
|
10511
|
-
}
|
|
10512
|
-
],
|
|
10513
|
-
"mixins": [
|
|
10514
|
-
{
|
|
10515
|
-
"name": "NotificationMixin",
|
|
10516
|
-
"module": "/src/common/mixins/NotificationMixin.js"
|
|
10517
|
-
},
|
|
10518
|
-
{
|
|
10519
|
-
"name": "DraftComponentMixin",
|
|
10520
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
10521
|
-
}
|
|
10522
|
-
],
|
|
10523
|
-
"superclass": {
|
|
10524
|
-
"name": "LitElement",
|
|
10525
|
-
"package": "lit"
|
|
10526
|
-
},
|
|
10527
|
-
"localization": [
|
|
10528
|
-
{
|
|
10529
|
-
"name": "dismissLabel",
|
|
10530
|
-
"description": "Accessible label for the dismiss button."
|
|
10531
|
-
}
|
|
10532
|
-
],
|
|
10533
|
-
"status": "draft",
|
|
10534
|
-
"category": "feedback",
|
|
10535
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for short messages that describe the purpose of the notification.\n- Use for important updates that require user action/attention.\n- Provide a single call to action within the notification.\n- Use in combination with [Notification group](../notification-group/) so that notifications get styled and positioned correctly.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for transient or unimportant messages. Consider using a [Toast](/components/toast) instead.\n- Don't remove a notification until a user has explicitly dismissed, or acted on the notification.\n- Don’t use for error messages unless absolutely necessary. Try to favor a [Banner](/components/banner/) for error messaging instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
10536
|
-
"examples": [],
|
|
10537
|
-
"dependencies": [
|
|
10538
|
-
"stack",
|
|
10539
|
-
"icon"
|
|
10540
|
-
],
|
|
10541
|
-
"tagName": "nord-notification",
|
|
10560
|
+
"status": "ready",
|
|
10561
|
+
"category": "overlay",
|
|
10562
|
+
"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- Always position popout next to the button or other interface element that toggles it.\n- Use a popout to contain controls or information that doesn’t need to be shown immediately.\n- Use a popout to contain items that will most likely not fit into the current view.\n- Use a clearly labelled button to reveal the popout.\n- Use the appropriate `aria-haspopup` and `role` attributes for both the toggle button and containing items. Please refer to the [MDN documentation on both role values](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup#values) and [child role values](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup#associated_roles).\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t hide information inside a popout that is imperative to using the current view.\n- Don’t obscure other controls that are important with the popout.\n- Don’t allow the popout to be obscured by other controls or the outer bounds of the current view.\n</div>\n\n---\n\n## Content guidelines\n\nIf a popout contains actions, they should be always written 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\">Create user</div>\n<div class=\"n-usage n-usage-dont\">Create User</div>\n\nPopout actions should always lead with a strong verb that encourages action. Use the `{verb}+{noun}` format except in the case of common actions like Save, Close or Cancel:\n\n<div class=\"n-usage n-usage-do\">Edit row</div>\n<div class=\"n-usage n-usage-dont\">Editing options</div>\n\nAvoid unnecessary words and articles in popout actions, 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 popout actions 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\nAvoid all caps for popout actions:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\n---\n\n## Additional considerations\n\n- The popout component is a containing component, only providing a way to reveal and hide controls by using a single button.\n",
|
|
10563
|
+
"examples": [],
|
|
10564
|
+
"dependencies": [],
|
|
10565
|
+
"tagName": "nord-popout",
|
|
10542
10566
|
"customElement": true
|
|
10543
10567
|
}
|
|
10544
10568
|
],
|
|
@@ -10547,40 +10571,16 @@
|
|
|
10547
10571
|
"kind": "js",
|
|
10548
10572
|
"name": "default",
|
|
10549
10573
|
"declaration": {
|
|
10550
|
-
"name": "
|
|
10551
|
-
"module": "src/
|
|
10574
|
+
"name": "Popout",
|
|
10575
|
+
"module": "src/popout/Popout.ts"
|
|
10552
10576
|
}
|
|
10553
10577
|
},
|
|
10554
10578
|
{
|
|
10555
10579
|
"kind": "custom-element-definition",
|
|
10556
|
-
"name": "nord-
|
|
10557
|
-
"declaration": {
|
|
10558
|
-
"name": "Notification",
|
|
10559
|
-
"module": "src/notification/Notification.ts"
|
|
10560
|
-
}
|
|
10561
|
-
}
|
|
10562
|
-
]
|
|
10563
|
-
},
|
|
10564
|
-
{
|
|
10565
|
-
"kind": "javascript-module",
|
|
10566
|
-
"path": "src/notification/localization.ts",
|
|
10567
|
-
"declarations": [
|
|
10568
|
-
{
|
|
10569
|
-
"kind": "variable",
|
|
10570
|
-
"name": "localization",
|
|
10571
|
-
"type": {
|
|
10572
|
-
"text": "object"
|
|
10573
|
-
},
|
|
10574
|
-
"default": "{\n dismissLabel: \"Dismiss notification\",\n}"
|
|
10575
|
-
}
|
|
10576
|
-
],
|
|
10577
|
-
"exports": [
|
|
10578
|
-
{
|
|
10579
|
-
"kind": "js",
|
|
10580
|
-
"name": "default",
|
|
10580
|
+
"name": "nord-popout",
|
|
10581
10581
|
"declaration": {
|
|
10582
|
-
"name": "
|
|
10583
|
-
"module": "src/
|
|
10582
|
+
"name": "Popout",
|
|
10583
|
+
"module": "src/popout/Popout.ts"
|
|
10584
10584
|
}
|
|
10585
10585
|
}
|
|
10586
10586
|
]
|
|
@@ -13328,114 +13328,6 @@
|
|
|
13328
13328
|
}
|
|
13329
13329
|
]
|
|
13330
13330
|
},
|
|
13331
|
-
{
|
|
13332
|
-
"kind": "javascript-module",
|
|
13333
|
-
"path": "src/spinner/Spinner.ts",
|
|
13334
|
-
"declarations": [
|
|
13335
|
-
{
|
|
13336
|
-
"kind": "class",
|
|
13337
|
-
"description": "Spinner component is used to indicate users that their action is being\nprocessed. You can customize the size and color of the spinner with the\nprovided properties.",
|
|
13338
|
-
"name": "Spinner",
|
|
13339
|
-
"cssProperties": [
|
|
13340
|
-
{
|
|
13341
|
-
"description": "Controls the color the spinner.",
|
|
13342
|
-
"name": "--n-spinner-color",
|
|
13343
|
-
"default": "var(--n-color-accent)"
|
|
13344
|
-
}
|
|
13345
|
-
],
|
|
13346
|
-
"members": [
|
|
13347
|
-
{
|
|
13348
|
-
"kind": "field",
|
|
13349
|
-
"name": "size",
|
|
13350
|
-
"type": {
|
|
13351
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
13352
|
-
},
|
|
13353
|
-
"default": "\"m\"",
|
|
13354
|
-
"description": "The size of the spinner.",
|
|
13355
|
-
"attribute": "size",
|
|
13356
|
-
"reflects": true
|
|
13357
|
-
},
|
|
13358
|
-
{
|
|
13359
|
-
"kind": "field",
|
|
13360
|
-
"name": "color",
|
|
13361
|
-
"type": {
|
|
13362
|
-
"text": "string | undefined"
|
|
13363
|
-
},
|
|
13364
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-spinner-color` CSS custom property.",
|
|
13365
|
-
"attribute": "color",
|
|
13366
|
-
"reflects": true
|
|
13367
|
-
},
|
|
13368
|
-
{
|
|
13369
|
-
"kind": "field",
|
|
13370
|
-
"name": "label",
|
|
13371
|
-
"type": {
|
|
13372
|
-
"text": "string | undefined"
|
|
13373
|
-
},
|
|
13374
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
13375
|
-
"attribute": "label",
|
|
13376
|
-
"reflects": true
|
|
13377
|
-
}
|
|
13378
|
-
],
|
|
13379
|
-
"attributes": [
|
|
13380
|
-
{
|
|
13381
|
-
"name": "size",
|
|
13382
|
-
"type": {
|
|
13383
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
13384
|
-
},
|
|
13385
|
-
"default": "\"m\"",
|
|
13386
|
-
"description": "The size of the spinner.",
|
|
13387
|
-
"fieldName": "size"
|
|
13388
|
-
},
|
|
13389
|
-
{
|
|
13390
|
-
"name": "color",
|
|
13391
|
-
"type": {
|
|
13392
|
-
"text": "string | undefined"
|
|
13393
|
-
},
|
|
13394
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-spinner-color` CSS custom property.",
|
|
13395
|
-
"fieldName": "color"
|
|
13396
|
-
},
|
|
13397
|
-
{
|
|
13398
|
-
"name": "label",
|
|
13399
|
-
"type": {
|
|
13400
|
-
"text": "string | undefined"
|
|
13401
|
-
},
|
|
13402
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
13403
|
-
"fieldName": "label"
|
|
13404
|
-
}
|
|
13405
|
-
],
|
|
13406
|
-
"superclass": {
|
|
13407
|
-
"name": "LitElement",
|
|
13408
|
-
"package": "lit"
|
|
13409
|
-
},
|
|
13410
|
-
"localization": [],
|
|
13411
|
-
"status": "ready",
|
|
13412
|
-
"category": "feedback",
|
|
13413
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for indicating users that their action is being processed.\n- Use the label property to provide an accessible label for the spinner. If no label is supplied, the spinner is hidden from assistive technology.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to show progress. Favor a progress bar instead.\n\n</div>\n",
|
|
13414
|
-
"examples": [],
|
|
13415
|
-
"dependencies": [],
|
|
13416
|
-
"tagName": "nord-spinner",
|
|
13417
|
-
"customElement": true
|
|
13418
|
-
}
|
|
13419
|
-
],
|
|
13420
|
-
"exports": [
|
|
13421
|
-
{
|
|
13422
|
-
"kind": "js",
|
|
13423
|
-
"name": "default",
|
|
13424
|
-
"declaration": {
|
|
13425
|
-
"name": "Spinner",
|
|
13426
|
-
"module": "src/spinner/Spinner.ts"
|
|
13427
|
-
}
|
|
13428
|
-
},
|
|
13429
|
-
{
|
|
13430
|
-
"kind": "custom-element-definition",
|
|
13431
|
-
"name": "nord-spinner",
|
|
13432
|
-
"declaration": {
|
|
13433
|
-
"name": "Spinner",
|
|
13434
|
-
"module": "src/spinner/Spinner.ts"
|
|
13435
|
-
}
|
|
13436
|
-
}
|
|
13437
|
-
]
|
|
13438
|
-
},
|
|
13439
13331
|
{
|
|
13440
13332
|
"kind": "javascript-module",
|
|
13441
13333
|
"path": "src/stack/Stack.ts",
|
|
@@ -13687,6 +13579,114 @@
|
|
|
13687
13579
|
}
|
|
13688
13580
|
]
|
|
13689
13581
|
},
|
|
13582
|
+
{
|
|
13583
|
+
"kind": "javascript-module",
|
|
13584
|
+
"path": "src/spinner/Spinner.ts",
|
|
13585
|
+
"declarations": [
|
|
13586
|
+
{
|
|
13587
|
+
"kind": "class",
|
|
13588
|
+
"description": "Spinner component is used to indicate users that their action is being\nprocessed. You can customize the size and color of the spinner with the\nprovided properties.",
|
|
13589
|
+
"name": "Spinner",
|
|
13590
|
+
"cssProperties": [
|
|
13591
|
+
{
|
|
13592
|
+
"description": "Controls the color the spinner.",
|
|
13593
|
+
"name": "--n-spinner-color",
|
|
13594
|
+
"default": "var(--n-color-accent)"
|
|
13595
|
+
}
|
|
13596
|
+
],
|
|
13597
|
+
"members": [
|
|
13598
|
+
{
|
|
13599
|
+
"kind": "field",
|
|
13600
|
+
"name": "size",
|
|
13601
|
+
"type": {
|
|
13602
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
13603
|
+
},
|
|
13604
|
+
"default": "\"m\"",
|
|
13605
|
+
"description": "The size of the spinner.",
|
|
13606
|
+
"attribute": "size",
|
|
13607
|
+
"reflects": true
|
|
13608
|
+
},
|
|
13609
|
+
{
|
|
13610
|
+
"kind": "field",
|
|
13611
|
+
"name": "color",
|
|
13612
|
+
"type": {
|
|
13613
|
+
"text": "string | undefined"
|
|
13614
|
+
},
|
|
13615
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-spinner-color` CSS custom property.",
|
|
13616
|
+
"attribute": "color",
|
|
13617
|
+
"reflects": true
|
|
13618
|
+
},
|
|
13619
|
+
{
|
|
13620
|
+
"kind": "field",
|
|
13621
|
+
"name": "label",
|
|
13622
|
+
"type": {
|
|
13623
|
+
"text": "string | undefined"
|
|
13624
|
+
},
|
|
13625
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
13626
|
+
"attribute": "label",
|
|
13627
|
+
"reflects": true
|
|
13628
|
+
}
|
|
13629
|
+
],
|
|
13630
|
+
"attributes": [
|
|
13631
|
+
{
|
|
13632
|
+
"name": "size",
|
|
13633
|
+
"type": {
|
|
13634
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
13635
|
+
},
|
|
13636
|
+
"default": "\"m\"",
|
|
13637
|
+
"description": "The size of the spinner.",
|
|
13638
|
+
"fieldName": "size"
|
|
13639
|
+
},
|
|
13640
|
+
{
|
|
13641
|
+
"name": "color",
|
|
13642
|
+
"type": {
|
|
13643
|
+
"text": "string | undefined"
|
|
13644
|
+
},
|
|
13645
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-spinner-color` CSS custom property.",
|
|
13646
|
+
"fieldName": "color"
|
|
13647
|
+
},
|
|
13648
|
+
{
|
|
13649
|
+
"name": "label",
|
|
13650
|
+
"type": {
|
|
13651
|
+
"text": "string | undefined"
|
|
13652
|
+
},
|
|
13653
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
13654
|
+
"fieldName": "label"
|
|
13655
|
+
}
|
|
13656
|
+
],
|
|
13657
|
+
"superclass": {
|
|
13658
|
+
"name": "LitElement",
|
|
13659
|
+
"package": "lit"
|
|
13660
|
+
},
|
|
13661
|
+
"localization": [],
|
|
13662
|
+
"status": "ready",
|
|
13663
|
+
"category": "feedback",
|
|
13664
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for indicating users that their action is being processed.\n- Use the label property to provide an accessible label for the spinner. If no label is supplied, the spinner is hidden from assistive technology.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to show progress. Favor a progress bar instead.\n\n</div>\n",
|
|
13665
|
+
"examples": [],
|
|
13666
|
+
"dependencies": [],
|
|
13667
|
+
"tagName": "nord-spinner",
|
|
13668
|
+
"customElement": true
|
|
13669
|
+
}
|
|
13670
|
+
],
|
|
13671
|
+
"exports": [
|
|
13672
|
+
{
|
|
13673
|
+
"kind": "js",
|
|
13674
|
+
"name": "default",
|
|
13675
|
+
"declaration": {
|
|
13676
|
+
"name": "Spinner",
|
|
13677
|
+
"module": "src/spinner/Spinner.ts"
|
|
13678
|
+
}
|
|
13679
|
+
},
|
|
13680
|
+
{
|
|
13681
|
+
"kind": "custom-element-definition",
|
|
13682
|
+
"name": "nord-spinner",
|
|
13683
|
+
"declaration": {
|
|
13684
|
+
"name": "Spinner",
|
|
13685
|
+
"module": "src/spinner/Spinner.ts"
|
|
13686
|
+
}
|
|
13687
|
+
}
|
|
13688
|
+
]
|
|
13689
|
+
},
|
|
13690
13690
|
{
|
|
13691
13691
|
"kind": "javascript-module",
|
|
13692
13692
|
"path": "src/tab-group/TabGroup.ts",
|