@nordhealth/components 1.0.0-rc.2 → 1.0.0-rc.5
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 +576 -520
- package/lib/Calendar-e496d80f.js +2 -0
- package/lib/Calendar-e496d80f.js.map +1 -0
- package/lib/Calendar.js +1 -1
- package/lib/DatePicker.js +1 -1
- package/lib/DatePicker.js.map +1 -1
- package/lib/Dropdown.js +1 -1
- package/lib/Dropdown.js.map +1 -1
- package/lib/DropdownItem.js +1 -1
- package/lib/DropdownItem.js.map +1 -1
- package/lib/Icon.js +1 -1
- package/lib/Icon.js.map +1 -1
- package/lib/NavItem.js +1 -1
- package/lib/NavItem.js.map +1 -1
- package/lib/Popout.js +1 -1
- package/lib/Popout.js.map +1 -1
- package/lib/Select.js +1 -1
- package/lib/Select.js.map +1 -1
- package/lib/Tooltip.js +1 -1
- package/lib/Tooltip.js.map +1 -1
- package/lib/bundle.js +7 -7
- package/lib/bundle.js.map +1 -1
- package/lib/index.js +1 -1
- package/lib/positioning-72899e14.js +2 -0
- package/lib/{positioning-4898430d.js.map → positioning-72899e14.js.map} +1 -1
- package/lib/query-2d22378e.js +12 -0
- package/lib/query-2d22378e.js.map +1 -0
- package/lib/src/calendar/Calendar.d.ts +4 -0
- package/lib/src/dropdown/Dropdown.d.ts +8 -0
- package/lib/src/icon/Icon.d.ts +1 -0
- package/lib/src/navigation/Navigation.test.d.ts +4 -0
- package/lib/src/popout/Popout.d.ts +4 -0
- package/package.json +3 -3
- package/lib/Calendar-243918b5.js +0 -13
- package/lib/Calendar-243918b5.js.map +0 -1
- package/lib/positioning-4898430d.js +0 -2
package/custom-elements.json
CHANGED
|
@@ -967,6 +967,94 @@
|
|
|
967
967
|
],
|
|
968
968
|
"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 clear and accurate labels.\n- Use established button colors appropriately. For example, only use a danger button style for an action that’s difficult or impossible to undo.\n- Prioritize the most important actions. Too many buttons will cause confusion.\n- Be consistent with positioning of buttons in the user interface.\n- Use strong, actionable verbs in labels such as “Add”, “Close”, “Cancel”, or “Save”.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use buttons to link to other pages. Use regular link or a plain style instead where necessary.\n- Don’t use buttons for navigation where the link appears within or following a sentence.\n- Don’t use labels such as “Read more”, “Click here” or “More”.\n\n</div>\n\n---\n\n## Content guidelines\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `default` | Default style is the most common button variant. Only switch to another variant if you need to adjust the visual weight of the element. |\n| `primary` | Primary style is reserved for main call-to-actions. Should be used only once per content area or panel, e.g. for a “Save” action. |\n| `dashed` | Dashed style should be used for actions that trigger filtering. |\n| `danger` | Danger style should be used for actions that delete data or otherwise make it hard to undo the action. |\n| `plain` | Used for less important or less common actions. Can be also used for linking to other pages. |\n| `disabled` | Used for actions that aren’t currently available or not available anymore. Also prevents users from being able to interact with the component, and conveys its inactive state to assistive technologies. |\n\n---\n\n## Additional considerations\n\n- Users of assistive technology expect a button to submit data or do an action. If you need the button to navigate into another view, use the `href` property which will output `<a>` tag instead of a `<button>`.\n- When you need to disable a button, use `disabled` property as it conveys this information correctly to assistive technologies like screen readers.\n- Button component provides 3 size variants; small, medium and large. The large size should only be used for marketing purposes or on areas such as an empty space/content notice.\n"
|
|
969
969
|
},
|
|
970
|
+
{
|
|
971
|
+
"kind": "javascript-module",
|
|
972
|
+
"path": "src/card/Card.ts",
|
|
973
|
+
"declarations": [
|
|
974
|
+
{
|
|
975
|
+
"kind": "class",
|
|
976
|
+
"description": "Cards are shadowed surfaces that display content and actions on a\nsingle topic. They should be easy to scan for relevant and\nactionable information.",
|
|
977
|
+
"name": "Card",
|
|
978
|
+
"slots": [
|
|
979
|
+
{
|
|
980
|
+
"description": "The card content.",
|
|
981
|
+
"name": ""
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"description": "Optional slot that holds a header for the card.",
|
|
985
|
+
"name": "header"
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"description": "Optional slot that holds footer content for the card.",
|
|
989
|
+
"name": "footer"
|
|
990
|
+
}
|
|
991
|
+
],
|
|
992
|
+
"members": [
|
|
993
|
+
{
|
|
994
|
+
"kind": "field",
|
|
995
|
+
"name": "headerSlot",
|
|
996
|
+
"privacy": "private",
|
|
997
|
+
"default": "new SlotController(this, \"header\")"
|
|
998
|
+
},
|
|
999
|
+
{
|
|
1000
|
+
"kind": "field",
|
|
1001
|
+
"name": "footerSlot",
|
|
1002
|
+
"privacy": "private",
|
|
1003
|
+
"default": "new SlotController(this, \"footer\")"
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"kind": "field",
|
|
1007
|
+
"name": "padding",
|
|
1008
|
+
"type": {
|
|
1009
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
1010
|
+
},
|
|
1011
|
+
"default": "\"m\"",
|
|
1012
|
+
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1013
|
+
"attribute": "padding",
|
|
1014
|
+
"reflects": true
|
|
1015
|
+
}
|
|
1016
|
+
],
|
|
1017
|
+
"attributes": [
|
|
1018
|
+
{
|
|
1019
|
+
"name": "padding",
|
|
1020
|
+
"type": {
|
|
1021
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
1022
|
+
},
|
|
1023
|
+
"default": "\"m\"",
|
|
1024
|
+
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1025
|
+
"fieldName": "padding"
|
|
1026
|
+
}
|
|
1027
|
+
],
|
|
1028
|
+
"superclass": {
|
|
1029
|
+
"name": "LitElement",
|
|
1030
|
+
"package": "lit"
|
|
1031
|
+
},
|
|
1032
|
+
"status": "ready",
|
|
1033
|
+
"category": "structure",
|
|
1034
|
+
"tagName": "nord-card",
|
|
1035
|
+
"customElement": true
|
|
1036
|
+
}
|
|
1037
|
+
],
|
|
1038
|
+
"exports": [
|
|
1039
|
+
{
|
|
1040
|
+
"kind": "js",
|
|
1041
|
+
"name": "default",
|
|
1042
|
+
"declaration": {
|
|
1043
|
+
"name": "Card",
|
|
1044
|
+
"module": "src/card/Card.ts"
|
|
1045
|
+
}
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"kind": "custom-element-definition",
|
|
1049
|
+
"name": "nord-card",
|
|
1050
|
+
"declaration": {
|
|
1051
|
+
"name": "Card",
|
|
1052
|
+
"module": "src/card/Card.ts"
|
|
1053
|
+
}
|
|
1054
|
+
}
|
|
1055
|
+
],
|
|
1056
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n"
|
|
1057
|
+
},
|
|
970
1058
|
{
|
|
971
1059
|
"kind": "javascript-module",
|
|
972
1060
|
"path": "src/calendar/Calendar.ts",
|
|
@@ -1074,6 +1162,17 @@
|
|
|
1074
1162
|
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
1075
1163
|
"attribute": "max"
|
|
1076
1164
|
},
|
|
1165
|
+
{
|
|
1166
|
+
"kind": "field",
|
|
1167
|
+
"name": "expand",
|
|
1168
|
+
"type": {
|
|
1169
|
+
"text": "boolean"
|
|
1170
|
+
},
|
|
1171
|
+
"default": "false",
|
|
1172
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1173
|
+
"attribute": "expand",
|
|
1174
|
+
"reflects": true
|
|
1175
|
+
},
|
|
1077
1176
|
{
|
|
1078
1177
|
"kind": "field",
|
|
1079
1178
|
"name": "isDateDisabled",
|
|
@@ -1293,6 +1392,15 @@
|
|
|
1293
1392
|
"default": "\"\"",
|
|
1294
1393
|
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
1295
1394
|
"fieldName": "max"
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"name": "expand",
|
|
1398
|
+
"type": {
|
|
1399
|
+
"text": "boolean"
|
|
1400
|
+
},
|
|
1401
|
+
"default": "false",
|
|
1402
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1403
|
+
"fieldName": "expand"
|
|
1296
1404
|
}
|
|
1297
1405
|
],
|
|
1298
1406
|
"superclass": {
|
|
@@ -1435,94 +1543,6 @@
|
|
|
1435
1543
|
],
|
|
1436
1544
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
1437
1545
|
},
|
|
1438
|
-
{
|
|
1439
|
-
"kind": "javascript-module",
|
|
1440
|
-
"path": "src/card/Card.ts",
|
|
1441
|
-
"declarations": [
|
|
1442
|
-
{
|
|
1443
|
-
"kind": "class",
|
|
1444
|
-
"description": "Cards are shadowed surfaces that display content and actions on a\nsingle topic. They should be easy to scan for relevant and\nactionable information.",
|
|
1445
|
-
"name": "Card",
|
|
1446
|
-
"slots": [
|
|
1447
|
-
{
|
|
1448
|
-
"description": "The card content.",
|
|
1449
|
-
"name": ""
|
|
1450
|
-
},
|
|
1451
|
-
{
|
|
1452
|
-
"description": "Optional slot that holds a header for the card.",
|
|
1453
|
-
"name": "header"
|
|
1454
|
-
},
|
|
1455
|
-
{
|
|
1456
|
-
"description": "Optional slot that holds footer content for the card.",
|
|
1457
|
-
"name": "footer"
|
|
1458
|
-
}
|
|
1459
|
-
],
|
|
1460
|
-
"members": [
|
|
1461
|
-
{
|
|
1462
|
-
"kind": "field",
|
|
1463
|
-
"name": "headerSlot",
|
|
1464
|
-
"privacy": "private",
|
|
1465
|
-
"default": "new SlotController(this, \"header\")"
|
|
1466
|
-
},
|
|
1467
|
-
{
|
|
1468
|
-
"kind": "field",
|
|
1469
|
-
"name": "footerSlot",
|
|
1470
|
-
"privacy": "private",
|
|
1471
|
-
"default": "new SlotController(this, \"footer\")"
|
|
1472
|
-
},
|
|
1473
|
-
{
|
|
1474
|
-
"kind": "field",
|
|
1475
|
-
"name": "padding",
|
|
1476
|
-
"type": {
|
|
1477
|
-
"text": "\"m\" | \"l\" | \"none\""
|
|
1478
|
-
},
|
|
1479
|
-
"default": "\"m\"",
|
|
1480
|
-
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1481
|
-
"attribute": "padding",
|
|
1482
|
-
"reflects": true
|
|
1483
|
-
}
|
|
1484
|
-
],
|
|
1485
|
-
"attributes": [
|
|
1486
|
-
{
|
|
1487
|
-
"name": "padding",
|
|
1488
|
-
"type": {
|
|
1489
|
-
"text": "\"m\" | \"l\" | \"none\""
|
|
1490
|
-
},
|
|
1491
|
-
"default": "\"m\"",
|
|
1492
|
-
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1493
|
-
"fieldName": "padding"
|
|
1494
|
-
}
|
|
1495
|
-
],
|
|
1496
|
-
"superclass": {
|
|
1497
|
-
"name": "LitElement",
|
|
1498
|
-
"package": "lit"
|
|
1499
|
-
},
|
|
1500
|
-
"status": "ready",
|
|
1501
|
-
"category": "structure",
|
|
1502
|
-
"tagName": "nord-card",
|
|
1503
|
-
"customElement": true
|
|
1504
|
-
}
|
|
1505
|
-
],
|
|
1506
|
-
"exports": [
|
|
1507
|
-
{
|
|
1508
|
-
"kind": "js",
|
|
1509
|
-
"name": "default",
|
|
1510
|
-
"declaration": {
|
|
1511
|
-
"name": "Card",
|
|
1512
|
-
"module": "src/card/Card.ts"
|
|
1513
|
-
}
|
|
1514
|
-
},
|
|
1515
|
-
{
|
|
1516
|
-
"kind": "custom-element-definition",
|
|
1517
|
-
"name": "nord-card",
|
|
1518
|
-
"declaration": {
|
|
1519
|
-
"name": "Card",
|
|
1520
|
-
"module": "src/card/Card.ts"
|
|
1521
|
-
}
|
|
1522
|
-
}
|
|
1523
|
-
],
|
|
1524
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n"
|
|
1525
|
-
},
|
|
1526
1546
|
{
|
|
1527
1547
|
"kind": "javascript-module",
|
|
1528
1548
|
"path": "src/checkbox/Checkbox.ts",
|
|
@@ -3802,59 +3822,222 @@
|
|
|
3802
3822
|
},
|
|
3803
3823
|
{
|
|
3804
3824
|
"kind": "javascript-module",
|
|
3805
|
-
"path": "src/
|
|
3825
|
+
"path": "src/dropdown/Dropdown.ts",
|
|
3806
3826
|
"declarations": [
|
|
3807
3827
|
{
|
|
3808
3828
|
"kind": "class",
|
|
3809
|
-
"description": "
|
|
3810
|
-
"name": "
|
|
3829
|
+
"description": "Dropdown menu displays a list of actions or selectable options for\na user. Dropdown uses popout component internally to create\nthe overlay functionality.",
|
|
3830
|
+
"name": "Dropdown",
|
|
3831
|
+
"slots": [
|
|
3832
|
+
{
|
|
3833
|
+
"description": "The dropdown content.",
|
|
3834
|
+
"name": ""
|
|
3835
|
+
},
|
|
3836
|
+
{
|
|
3837
|
+
"description": "Used to place the toggle for dropdown.",
|
|
3838
|
+
"name": "toggle"
|
|
3839
|
+
}
|
|
3840
|
+
],
|
|
3811
3841
|
"members": [
|
|
3812
3842
|
{
|
|
3813
3843
|
"kind": "field",
|
|
3814
|
-
"name": "
|
|
3844
|
+
"name": "shadowRootOptions",
|
|
3815
3845
|
"type": {
|
|
3816
|
-
"text": "
|
|
3846
|
+
"text": "object"
|
|
3817
3847
|
},
|
|
3818
|
-
"
|
|
3848
|
+
"static": true,
|
|
3849
|
+
"default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }"
|
|
3819
3850
|
},
|
|
3820
3851
|
{
|
|
3821
3852
|
"kind": "field",
|
|
3822
|
-
"name": "
|
|
3853
|
+
"name": "popout",
|
|
3823
3854
|
"type": {
|
|
3824
|
-
"text": "
|
|
3855
|
+
"text": "Popout"
|
|
3825
3856
|
},
|
|
3826
3857
|
"privacy": "private"
|
|
3827
3858
|
},
|
|
3828
3859
|
{
|
|
3829
3860
|
"kind": "field",
|
|
3830
|
-
"name": "
|
|
3861
|
+
"name": "align",
|
|
3831
3862
|
"type": {
|
|
3832
|
-
"text": "
|
|
3863
|
+
"text": "Popout[\"align\"] | undefined"
|
|
3833
3864
|
},
|
|
3834
|
-
"
|
|
3865
|
+
"description": "Set the alignment of the dropdown in relation to the toggle depending on the position.\n`start` will align the left of the dropdown to the left of the toggle.\n`end` will align the right of the dropdown to the right of the toggle.\nA dropdown with a set position of `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom of the dropdown respectively.",
|
|
3866
|
+
"attribute": "align",
|
|
3867
|
+
"reflects": true
|
|
3835
3868
|
},
|
|
3836
3869
|
{
|
|
3837
3870
|
"kind": "field",
|
|
3838
|
-
"name": "
|
|
3871
|
+
"name": "position",
|
|
3839
3872
|
"type": {
|
|
3840
|
-
"text": "
|
|
3873
|
+
"text": "Popout[\"position\"] | undefined"
|
|
3841
3874
|
},
|
|
3842
|
-
"
|
|
3875
|
+
"description": "Set the position of the dropdown in relation to the toggle.\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
3876
|
+
"attribute": "position",
|
|
3877
|
+
"reflects": true
|
|
3843
3878
|
},
|
|
3844
3879
|
{
|
|
3845
3880
|
"kind": "field",
|
|
3846
|
-
"name": "
|
|
3847
|
-
"
|
|
3848
|
-
|
|
3881
|
+
"name": "expand",
|
|
3882
|
+
"type": {
|
|
3883
|
+
"text": "boolean"
|
|
3884
|
+
},
|
|
3885
|
+
"default": "false",
|
|
3886
|
+
"description": "Controls whether the toggle slot expands to fill the width of its container.",
|
|
3887
|
+
"attribute": "expand",
|
|
3888
|
+
"reflects": true
|
|
3849
3889
|
},
|
|
3850
3890
|
{
|
|
3851
|
-
"kind": "
|
|
3852
|
-
"name": "
|
|
3891
|
+
"kind": "method",
|
|
3892
|
+
"name": "handleBlur",
|
|
3853
3893
|
"privacy": "private",
|
|
3854
|
-
"
|
|
3894
|
+
"parameters": [
|
|
3895
|
+
{
|
|
3896
|
+
"name": "e",
|
|
3897
|
+
"type": {
|
|
3898
|
+
"text": "FocusEvent"
|
|
3899
|
+
}
|
|
3900
|
+
}
|
|
3901
|
+
]
|
|
3855
3902
|
},
|
|
3856
3903
|
{
|
|
3857
|
-
"kind": "
|
|
3904
|
+
"kind": "method",
|
|
3905
|
+
"name": "handleOpen",
|
|
3906
|
+
"privacy": "private"
|
|
3907
|
+
},
|
|
3908
|
+
{
|
|
3909
|
+
"kind": "field",
|
|
3910
|
+
"name": "_warningLogged",
|
|
3911
|
+
"type": {
|
|
3912
|
+
"text": "boolean"
|
|
3913
|
+
},
|
|
3914
|
+
"privacy": "private",
|
|
3915
|
+
"static": true,
|
|
3916
|
+
"default": "false",
|
|
3917
|
+
"inheritedFrom": {
|
|
3918
|
+
"name": "DraftComponentMixin",
|
|
3919
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
3920
|
+
}
|
|
3921
|
+
}
|
|
3922
|
+
],
|
|
3923
|
+
"attributes": [
|
|
3924
|
+
{
|
|
3925
|
+
"name": "align",
|
|
3926
|
+
"type": {
|
|
3927
|
+
"text": "Popout[\"align\"] | undefined"
|
|
3928
|
+
},
|
|
3929
|
+
"description": "Set the alignment of the dropdown in relation to the toggle depending on the position.\n`start` will align the left of the dropdown to the left of the toggle.\n`end` will align the right of the dropdown to the right of the toggle.\nA dropdown with a set position of `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom of the dropdown respectively.",
|
|
3930
|
+
"fieldName": "align"
|
|
3931
|
+
},
|
|
3932
|
+
{
|
|
3933
|
+
"name": "position",
|
|
3934
|
+
"type": {
|
|
3935
|
+
"text": "Popout[\"position\"] | undefined"
|
|
3936
|
+
},
|
|
3937
|
+
"description": "Set the position of the dropdown in relation to the toggle.\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
3938
|
+
"fieldName": "position"
|
|
3939
|
+
},
|
|
3940
|
+
{
|
|
3941
|
+
"name": "expand",
|
|
3942
|
+
"type": {
|
|
3943
|
+
"text": "boolean"
|
|
3944
|
+
},
|
|
3945
|
+
"default": "false",
|
|
3946
|
+
"description": "Controls whether the toggle slot expands to fill the width of its container.",
|
|
3947
|
+
"fieldName": "expand"
|
|
3948
|
+
}
|
|
3949
|
+
],
|
|
3950
|
+
"mixins": [
|
|
3951
|
+
{
|
|
3952
|
+
"name": "DraftComponentMixin",
|
|
3953
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
3954
|
+
}
|
|
3955
|
+
],
|
|
3956
|
+
"superclass": {
|
|
3957
|
+
"name": "LitElement",
|
|
3958
|
+
"package": "lit"
|
|
3959
|
+
},
|
|
3960
|
+
"status": "draft",
|
|
3961
|
+
"category": "action",
|
|
3962
|
+
"tagName": "nord-dropdown",
|
|
3963
|
+
"customElement": true
|
|
3964
|
+
}
|
|
3965
|
+
],
|
|
3966
|
+
"exports": [
|
|
3967
|
+
{
|
|
3968
|
+
"kind": "js",
|
|
3969
|
+
"name": "default",
|
|
3970
|
+
"declaration": {
|
|
3971
|
+
"name": "Dropdown",
|
|
3972
|
+
"module": "src/dropdown/Dropdown.ts"
|
|
3973
|
+
}
|
|
3974
|
+
},
|
|
3975
|
+
{
|
|
3976
|
+
"kind": "custom-element-definition",
|
|
3977
|
+
"name": "nord-dropdown",
|
|
3978
|
+
"declaration": {
|
|
3979
|
+
"name": "Dropdown",
|
|
3980
|
+
"module": "src/dropdown/Dropdown.ts"
|
|
3981
|
+
}
|
|
3982
|
+
}
|
|
3983
|
+
],
|
|
3984
|
+
"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- Dropdown menus are typically used when you have 5-15 items to choose from. They’re used for navigation or commands, where an action is initiated based on the selection.\n- When organizing dropdown menu items, sort the list in a logical order by putting the most selected option at the top.\n- Use for a “more” menu, where the control contains an icon.\n- Use for user profiles, where the control is an avatar.\n- Use in conjunction with the [dropdown item](/components/dropdown-item/) and [dropdown group](/components/dropdown-group/) components.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for hiding primary actions since they should be visible by default.\n- Don’t use for selecting an option from a list of options, use the [select component](/components/select/) instead.\n- Don’t nest elements or components other than the [dropdown item](/components/dropdown-item/) and [dropdown group](/components/dropdown-group/) components. Consider using the [popout component](/components/popout/) when creating custom UI.\n\n</div>\n\n---\n\n## Content guidelines\n\nDropdown items 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\nDropdown items 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 dropdown items, 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 dropdown items 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\nAvoud all caps for dropdown items:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\nKeep dropdown items to a single line of text:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme<br/>of the veterinary application.</div>\n"
|
|
3985
|
+
},
|
|
3986
|
+
{
|
|
3987
|
+
"kind": "javascript-module",
|
|
3988
|
+
"path": "src/date-picker/DatePicker.ts",
|
|
3989
|
+
"declarations": [
|
|
3990
|
+
{
|
|
3991
|
+
"kind": "class",
|
|
3992
|
+
"description": "\nDate Picker allows user to enter a date either through text input,\nor by choosing a date from the calendar. Please note that the date\nmust be passed in ISO-8601 format: YYYY-MM-DD.",
|
|
3993
|
+
"name": "DatePicker",
|
|
3994
|
+
"members": [
|
|
3995
|
+
{
|
|
3996
|
+
"kind": "field",
|
|
3997
|
+
"name": "toggleButton",
|
|
3998
|
+
"type": {
|
|
3999
|
+
"text": "Button"
|
|
4000
|
+
},
|
|
4001
|
+
"privacy": "private"
|
|
4002
|
+
},
|
|
4003
|
+
{
|
|
4004
|
+
"kind": "field",
|
|
4005
|
+
"name": "closeButton",
|
|
4006
|
+
"type": {
|
|
4007
|
+
"text": "HTMLButtonElement"
|
|
4008
|
+
},
|
|
4009
|
+
"privacy": "private"
|
|
4010
|
+
},
|
|
4011
|
+
{
|
|
4012
|
+
"kind": "field",
|
|
4013
|
+
"name": "calendar",
|
|
4014
|
+
"type": {
|
|
4015
|
+
"text": "Calendar"
|
|
4016
|
+
},
|
|
4017
|
+
"privacy": "private"
|
|
4018
|
+
},
|
|
4019
|
+
{
|
|
4020
|
+
"kind": "field",
|
|
4021
|
+
"name": "dialog",
|
|
4022
|
+
"type": {
|
|
4023
|
+
"text": "HTMLElement"
|
|
4024
|
+
},
|
|
4025
|
+
"privacy": "private"
|
|
4026
|
+
},
|
|
4027
|
+
{
|
|
4028
|
+
"kind": "field",
|
|
4029
|
+
"name": "dismiss",
|
|
4030
|
+
"privacy": "private",
|
|
4031
|
+
"default": "new LightDismissController(this, {\n isOpen: () => this.open,\n onDismiss: e => this.hide(e.type !== \"click\"),\n isDismissible: node => node !== this.calendar && node !== this.toggleButton,\n })"
|
|
4032
|
+
},
|
|
4033
|
+
{
|
|
4034
|
+
"kind": "field",
|
|
4035
|
+
"name": "swipe",
|
|
4036
|
+
"privacy": "private",
|
|
4037
|
+
"default": "new SwipeController(this, {\n target: () => this.dialog,\n matchesGesture: isDownwardsSwipe,\n onSwipeEnd: () => this.hide(false),\n })"
|
|
4038
|
+
},
|
|
4039
|
+
{
|
|
4040
|
+
"kind": "field",
|
|
3858
4041
|
"name": "dateFormatLong",
|
|
3859
4042
|
"type": {
|
|
3860
4043
|
"text": "Intl.DateTimeFormat"
|
|
@@ -4693,139 +4876,6 @@
|
|
|
4693
4876
|
],
|
|
4694
4877
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use to choose a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nDate picker is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Choose date button\n\n- `Space, Enter`: Opens the date picker dialog and moves focus to the first select menu in the dialog.\n\n### Date picker dialog\n\n- `Esc`: Closes the date picker dialog and moves focus back to the “choose date” button.\n- `Tab`: Moves focus to the next element in the dialog. Please note since the calendar uses `role=\"grid\"`, only one button in the calendar grid is in the tab sequence. Additionally, if focus is on the last focusable element, focus is next moved back to the first focusable element inside the date picker dialog.\n- `Shift + Tab`: Same as above, but in reverse order.\n\n### Date picker dialog: Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Date picker dialog: Date grid\n\n- `Space, Enter`: Selects a date, closes the dialog, and moves focus back to the “Choose Date” button. Additionally updates the value of the date picker input with the selected date, and adds selected date to “Choose Date” button label.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n\n#### Date picker dialog: Close button\n\n- `Space, Enter`: Closes the dialog, moves focus to “choose date” button, but does not update the date in input.\n"
|
|
4695
4878
|
},
|
|
4696
|
-
{
|
|
4697
|
-
"kind": "javascript-module",
|
|
4698
|
-
"path": "src/dropdown/Dropdown.ts",
|
|
4699
|
-
"declarations": [
|
|
4700
|
-
{
|
|
4701
|
-
"kind": "class",
|
|
4702
|
-
"description": "Dropdown menu displays a list of actions or selectable options for\na user. Dropdown uses popout component internally to create\nthe overlay functionality.",
|
|
4703
|
-
"name": "Dropdown",
|
|
4704
|
-
"slots": [
|
|
4705
|
-
{
|
|
4706
|
-
"description": "The dropdown content.",
|
|
4707
|
-
"name": ""
|
|
4708
|
-
},
|
|
4709
|
-
{
|
|
4710
|
-
"description": "Used to place the toggle for dropdown.",
|
|
4711
|
-
"name": "toggle"
|
|
4712
|
-
}
|
|
4713
|
-
],
|
|
4714
|
-
"members": [
|
|
4715
|
-
{
|
|
4716
|
-
"kind": "field",
|
|
4717
|
-
"name": "align",
|
|
4718
|
-
"type": {
|
|
4719
|
-
"text": "Popout[\"align\"] | undefined"
|
|
4720
|
-
},
|
|
4721
|
-
"description": "Set the alignment of the dropdown in relation to the toggle depending on the position.\n`start` will align the left of the dropdown to the left of the toggle.\n`end` will align the right of the dropdown to the right of the toggle.\nA dropdown with a set position of `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom of the dropdown respectively.",
|
|
4722
|
-
"attribute": "align",
|
|
4723
|
-
"reflects": true
|
|
4724
|
-
},
|
|
4725
|
-
{
|
|
4726
|
-
"kind": "field",
|
|
4727
|
-
"name": "position",
|
|
4728
|
-
"type": {
|
|
4729
|
-
"text": "Popout[\"position\"] | undefined"
|
|
4730
|
-
},
|
|
4731
|
-
"description": "Set the position of the dropdown in relation to the toggle.\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
4732
|
-
"attribute": "position",
|
|
4733
|
-
"reflects": true
|
|
4734
|
-
},
|
|
4735
|
-
{
|
|
4736
|
-
"kind": "field",
|
|
4737
|
-
"name": "expand",
|
|
4738
|
-
"type": {
|
|
4739
|
-
"text": "boolean"
|
|
4740
|
-
},
|
|
4741
|
-
"default": "false",
|
|
4742
|
-
"description": "Controls whether the toggle slot expands to fill the width of its container.",
|
|
4743
|
-
"attribute": "expand",
|
|
4744
|
-
"reflects": true
|
|
4745
|
-
},
|
|
4746
|
-
{
|
|
4747
|
-
"kind": "method",
|
|
4748
|
-
"name": "handleOpen",
|
|
4749
|
-
"privacy": "private"
|
|
4750
|
-
},
|
|
4751
|
-
{
|
|
4752
|
-
"kind": "field",
|
|
4753
|
-
"name": "_warningLogged",
|
|
4754
|
-
"type": {
|
|
4755
|
-
"text": "boolean"
|
|
4756
|
-
},
|
|
4757
|
-
"privacy": "private",
|
|
4758
|
-
"static": true,
|
|
4759
|
-
"default": "false",
|
|
4760
|
-
"inheritedFrom": {
|
|
4761
|
-
"name": "DraftComponentMixin",
|
|
4762
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
4763
|
-
}
|
|
4764
|
-
}
|
|
4765
|
-
],
|
|
4766
|
-
"attributes": [
|
|
4767
|
-
{
|
|
4768
|
-
"name": "align",
|
|
4769
|
-
"type": {
|
|
4770
|
-
"text": "Popout[\"align\"] | undefined"
|
|
4771
|
-
},
|
|
4772
|
-
"description": "Set the alignment of the dropdown in relation to the toggle depending on the position.\n`start` will align the left of the dropdown to the left of the toggle.\n`end` will align the right of the dropdown to the right of the toggle.\nA dropdown with a set position of `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom of the dropdown respectively.",
|
|
4773
|
-
"fieldName": "align"
|
|
4774
|
-
},
|
|
4775
|
-
{
|
|
4776
|
-
"name": "position",
|
|
4777
|
-
"type": {
|
|
4778
|
-
"text": "Popout[\"position\"] | undefined"
|
|
4779
|
-
},
|
|
4780
|
-
"description": "Set the position of the dropdown in relation to the toggle.\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
4781
|
-
"fieldName": "position"
|
|
4782
|
-
},
|
|
4783
|
-
{
|
|
4784
|
-
"name": "expand",
|
|
4785
|
-
"type": {
|
|
4786
|
-
"text": "boolean"
|
|
4787
|
-
},
|
|
4788
|
-
"default": "false",
|
|
4789
|
-
"description": "Controls whether the toggle slot expands to fill the width of its container.",
|
|
4790
|
-
"fieldName": "expand"
|
|
4791
|
-
}
|
|
4792
|
-
],
|
|
4793
|
-
"mixins": [
|
|
4794
|
-
{
|
|
4795
|
-
"name": "DraftComponentMixin",
|
|
4796
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
4797
|
-
}
|
|
4798
|
-
],
|
|
4799
|
-
"superclass": {
|
|
4800
|
-
"name": "LitElement",
|
|
4801
|
-
"package": "lit"
|
|
4802
|
-
},
|
|
4803
|
-
"status": "draft",
|
|
4804
|
-
"category": "action",
|
|
4805
|
-
"tagName": "nord-dropdown",
|
|
4806
|
-
"customElement": true
|
|
4807
|
-
}
|
|
4808
|
-
],
|
|
4809
|
-
"exports": [
|
|
4810
|
-
{
|
|
4811
|
-
"kind": "js",
|
|
4812
|
-
"name": "default",
|
|
4813
|
-
"declaration": {
|
|
4814
|
-
"name": "Dropdown",
|
|
4815
|
-
"module": "src/dropdown/Dropdown.ts"
|
|
4816
|
-
}
|
|
4817
|
-
},
|
|
4818
|
-
{
|
|
4819
|
-
"kind": "custom-element-definition",
|
|
4820
|
-
"name": "nord-dropdown",
|
|
4821
|
-
"declaration": {
|
|
4822
|
-
"name": "Dropdown",
|
|
4823
|
-
"module": "src/dropdown/Dropdown.ts"
|
|
4824
|
-
}
|
|
4825
|
-
}
|
|
4826
|
-
],
|
|
4827
|
-
"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- Dropdown menus are typically used when you have 5-15 items to choose from. They’re used for navigation or commands, where an action is initiated based on the selection.\n- When organizing dropdown menu items, sort the list in a logical order by putting the most selected option at the top.\n- Use for a “more” menu, where the control contains an icon.\n- Use for user profiles, where the control is an avatar.\n- Use in conjunction with the [dropdown item](/components/dropdown-item/) and [dropdown group](/components/dropdown-group/) components.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for hiding primary actions since they should be visible by default.\n- Don’t use for selecting an option from a list of options, use the [select component](/components/select/) instead.\n- Don’t nest elements or components other than the [dropdown item](/components/dropdown-item/) and [dropdown group](/components/dropdown-group/) components. Consider using the [popout component](/components/popout/) when creating custom UI.\n\n</div>\n\n---\n\n## Content guidelines\n\nDropdown items 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\nDropdown items 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 dropdown items, 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 dropdown items 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\nAvoud all caps for dropdown items:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\nKeep dropdown items to a single line of text:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme<br/>of the veterinary application.</div>\n"
|
|
4828
|
-
},
|
|
4829
4879
|
{
|
|
4830
4880
|
"kind": "javascript-module",
|
|
4831
4881
|
"path": "src/dropdown-group/DropdownGroup.ts",
|
|
@@ -4909,52 +4959,7 @@
|
|
|
4909
4959
|
}
|
|
4910
4960
|
}
|
|
4911
4961
|
],
|
|
4912
|
-
"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 dropdown items into dropdown groups based on related categories.\n- Use group headings to clarify the category of a section.\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\nDropdown items 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\nDropdown items 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 dropdown items, 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 dropdown items 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\nAvoud all caps for dropdown items:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\nKeep dropdown items to a single line of text:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme<br/>of the veterinary application.</div>\n"
|
|
4913
|
-
},
|
|
4914
|
-
{
|
|
4915
|
-
"kind": "javascript-module",
|
|
4916
|
-
"path": "src/empty-state/EmptyState.ts",
|
|
4917
|
-
"declarations": [
|
|
4918
|
-
{
|
|
4919
|
-
"kind": "class",
|
|
4920
|
-
"description": "Empty state can be used when there is no data to display to\ndescribe what the user can do next. Empty state provides\nexplanation and guidance to help user progress.",
|
|
4921
|
-
"name": "EmptyState",
|
|
4922
|
-
"slots": [
|
|
4923
|
-
{
|
|
4924
|
-
"description": "default slot",
|
|
4925
|
-
"name": ""
|
|
4926
|
-
}
|
|
4927
|
-
],
|
|
4928
|
-
"members": [],
|
|
4929
|
-
"superclass": {
|
|
4930
|
-
"name": "LitElement",
|
|
4931
|
-
"package": "lit"
|
|
4932
|
-
},
|
|
4933
|
-
"status": "new",
|
|
4934
|
-
"category": "feedback",
|
|
4935
|
-
"tagName": "nord-empty-state",
|
|
4936
|
-
"customElement": true
|
|
4937
|
-
}
|
|
4938
|
-
],
|
|
4939
|
-
"exports": [
|
|
4940
|
-
{
|
|
4941
|
-
"kind": "js",
|
|
4942
|
-
"name": "default",
|
|
4943
|
-
"declaration": {
|
|
4944
|
-
"name": "EmptyState",
|
|
4945
|
-
"module": "src/empty-state/EmptyState.ts"
|
|
4946
|
-
}
|
|
4947
|
-
},
|
|
4948
|
-
{
|
|
4949
|
-
"kind": "custom-element-definition",
|
|
4950
|
-
"name": "nord-empty-state",
|
|
4951
|
-
"declaration": {
|
|
4952
|
-
"name": "EmptyState",
|
|
4953
|
-
"module": "src/empty-state/EmptyState.ts"
|
|
4954
|
-
}
|
|
4955
|
-
}
|
|
4956
|
-
],
|
|
4957
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when another component or part of UI has no items or data to show.\n- Help users by clearly explaining the benefit and utility of a product or feature.\n- Be encouraging and never make users feel unsuccessful or guilty.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use as a generic banner to highlight specific content.\n\n</div>\n\n---\n\n## Content guidelines\n\nEmpty state headings should state to the user what’s wrong or why there’s no content:\n\n<div class=\"n-usage n-usage-do\">No results found</div>\n<div class=\"n-usage n-usage-dont\">Error</div>\n\nWhen writing empty state headings, 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\">You don’t have access to this content</div>\n<div class=\"n-usage n-usage-dont\">You Don’t Have Access To This Content</div>\n\nDescriptions in empty states should add useful and relevant additional information:\n\n<div class=\"n-usage n-usage-do\">We were unable to connect to the service. Click Retry to try again or View log to learn what happened.</div>\n<div class=\"n-usage n-usage-dont\">No connection.</div>\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Clear filters</div>\n<div class=\"n-usage n-usage-dont\">Clear</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">View log</div>\n<div class=\"n-usage n-usage-dont\">View Log</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Request access</div>\n<div class=\"n-usage n-usage-dont\">Request an access</div>\n"
|
|
4962
|
+
"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 dropdown items into dropdown groups based on related categories.\n- Use group headings to clarify the category of a section.\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\nDropdown items 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\nDropdown items 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 dropdown items, 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 dropdown items 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\nAvoud all caps for dropdown items:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\nKeep dropdown items to a single line of text:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme<br/>of the veterinary application.</div>\n"
|
|
4958
4963
|
},
|
|
4959
4964
|
{
|
|
4960
4965
|
"kind": "javascript-module",
|
|
@@ -5100,6 +5105,51 @@
|
|
|
5100
5105
|
],
|
|
5101
5106
|
"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 dropdown items into dropdown groups based on related categories.\n- Use group headings to clarify the category of a section.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use dropdown item outside of dropdown group and dropdown components.\n\n</div>\n\n---\n\n## Content guidelines\n\nDropdown items 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\nDropdown items 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 dropdown items, 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 dropdown items 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\nAvoud all caps for dropdown items:\n\n<div class=\"n-usage n-usage-do\">Rename</div>\n<div class=\"n-usage n-usage-dont\">RENAME</div>\n\nKeep dropdown items to a single line of text:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme<br/>of the veterinary application.</div>\n"
|
|
5102
5107
|
},
|
|
5108
|
+
{
|
|
5109
|
+
"kind": "javascript-module",
|
|
5110
|
+
"path": "src/empty-state/EmptyState.ts",
|
|
5111
|
+
"declarations": [
|
|
5112
|
+
{
|
|
5113
|
+
"kind": "class",
|
|
5114
|
+
"description": "Empty state can be used when there is no data to display to\ndescribe what the user can do next. Empty state provides\nexplanation and guidance to help user progress.",
|
|
5115
|
+
"name": "EmptyState",
|
|
5116
|
+
"slots": [
|
|
5117
|
+
{
|
|
5118
|
+
"description": "default slot",
|
|
5119
|
+
"name": ""
|
|
5120
|
+
}
|
|
5121
|
+
],
|
|
5122
|
+
"members": [],
|
|
5123
|
+
"superclass": {
|
|
5124
|
+
"name": "LitElement",
|
|
5125
|
+
"package": "lit"
|
|
5126
|
+
},
|
|
5127
|
+
"status": "new",
|
|
5128
|
+
"category": "feedback",
|
|
5129
|
+
"tagName": "nord-empty-state",
|
|
5130
|
+
"customElement": true
|
|
5131
|
+
}
|
|
5132
|
+
],
|
|
5133
|
+
"exports": [
|
|
5134
|
+
{
|
|
5135
|
+
"kind": "js",
|
|
5136
|
+
"name": "default",
|
|
5137
|
+
"declaration": {
|
|
5138
|
+
"name": "EmptyState",
|
|
5139
|
+
"module": "src/empty-state/EmptyState.ts"
|
|
5140
|
+
}
|
|
5141
|
+
},
|
|
5142
|
+
{
|
|
5143
|
+
"kind": "custom-element-definition",
|
|
5144
|
+
"name": "nord-empty-state",
|
|
5145
|
+
"declaration": {
|
|
5146
|
+
"name": "EmptyState",
|
|
5147
|
+
"module": "src/empty-state/EmptyState.ts"
|
|
5148
|
+
}
|
|
5149
|
+
}
|
|
5150
|
+
],
|
|
5151
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when another component or part of UI has no items or data to show.\n- Help users by clearly explaining the benefit and utility of a product or feature.\n- Be encouraging and never make users feel unsuccessful or guilty.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use as a generic banner to highlight specific content.\n\n</div>\n\n---\n\n## Content guidelines\n\nEmpty state headings should state to the user what’s wrong or why there’s no content:\n\n<div class=\"n-usage n-usage-do\">No results found</div>\n<div class=\"n-usage n-usage-dont\">Error</div>\n\nWhen writing empty state headings, 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\">You don’t have access to this content</div>\n<div class=\"n-usage n-usage-dont\">You Don’t Have Access To This Content</div>\n\nDescriptions in empty states should add useful and relevant additional information:\n\n<div class=\"n-usage n-usage-do\">We were unable to connect to the service. Click Retry to try again or View log to learn what happened.</div>\n<div class=\"n-usage n-usage-dont\">No connection.</div>\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Clear filters</div>\n<div class=\"n-usage n-usage-dont\">Clear</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">View log</div>\n<div class=\"n-usage n-usage-dont\">View Log</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Request access</div>\n<div class=\"n-usage n-usage-dont\">Request an access</div>\n"
|
|
5152
|
+
},
|
|
5103
5153
|
{
|
|
5104
5154
|
"kind": "javascript-module",
|
|
5105
5155
|
"path": "src/fieldset/Fieldset.ts",
|
|
@@ -5315,6 +5365,12 @@
|
|
|
5315
5365
|
"kind": "class",
|
|
5316
5366
|
"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.",
|
|
5317
5367
|
"name": "Icon",
|
|
5368
|
+
"slots": [
|
|
5369
|
+
{
|
|
5370
|
+
"description": "The default slot used for placing a custom SVG icon.",
|
|
5371
|
+
"name": ""
|
|
5372
|
+
}
|
|
5373
|
+
],
|
|
5318
5374
|
"members": [
|
|
5319
5375
|
{
|
|
5320
5376
|
"kind": "field",
|
|
@@ -9375,7 +9431,7 @@
|
|
|
9375
9431
|
"type": {
|
|
9376
9432
|
"text": "number"
|
|
9377
9433
|
},
|
|
9378
|
-
"default": "
|
|
9434
|
+
"default": "500",
|
|
9379
9435
|
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
9380
9436
|
"attribute": "delay",
|
|
9381
9437
|
"reflects": true
|
|
@@ -9468,85 +9524,261 @@
|
|
|
9468
9524
|
"type": {
|
|
9469
9525
|
"text": "number"
|
|
9470
9526
|
},
|
|
9471
|
-
"default": "
|
|
9527
|
+
"default": "500",
|
|
9472
9528
|
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
9473
9529
|
"fieldName": "delay"
|
|
9474
9530
|
}
|
|
9475
9531
|
],
|
|
9476
|
-
"superclass": {
|
|
9477
|
-
"name": "LitElement",
|
|
9478
|
-
"package": "lit"
|
|
9479
|
-
},
|
|
9480
|
-
"status": "ready",
|
|
9481
|
-
"category": "overlay",
|
|
9482
|
-
"tagName": "nord-tooltip",
|
|
9483
|
-
"customElement": true
|
|
9532
|
+
"superclass": {
|
|
9533
|
+
"name": "LitElement",
|
|
9534
|
+
"package": "lit"
|
|
9535
|
+
},
|
|
9536
|
+
"status": "ready",
|
|
9537
|
+
"category": "overlay",
|
|
9538
|
+
"tagName": "nord-tooltip",
|
|
9539
|
+
"customElement": true
|
|
9540
|
+
}
|
|
9541
|
+
],
|
|
9542
|
+
"exports": [
|
|
9543
|
+
{
|
|
9544
|
+
"kind": "js",
|
|
9545
|
+
"name": "default",
|
|
9546
|
+
"declaration": {
|
|
9547
|
+
"name": "Tooltip",
|
|
9548
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
9549
|
+
}
|
|
9550
|
+
},
|
|
9551
|
+
{
|
|
9552
|
+
"kind": "custom-element-definition",
|
|
9553
|
+
"name": "nord-tooltip",
|
|
9554
|
+
"declaration": {
|
|
9555
|
+
"name": "Tooltip",
|
|
9556
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
9557
|
+
}
|
|
9558
|
+
}
|
|
9559
|
+
],
|
|
9560
|
+
"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 if an interactive element requires more explanation.\n- Use a tooltip to provide additional information, such as UI shortcuts.\n- Use the `label` attribute on icons used for shortcuts for accessibility.\n- Use clear and accurate phrasing.\n- Be consistent with positioning of tooltips in the user interface.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use interactive elements such as links or buttons inside a tooltip.\n- Don’t rely on tooltips when you have room to provide more explanation.\n- Don’t depend on tooltips for vital information.\n\n</div>\n\n---\n\n## Content guidelines\n\nTooltips should be clear and informative, but not imperative to using the interface they refer to. They should not contain interactive elements such as buttons or links.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data as a CSV, <u>more information on CSVs</u></div>\n\nTooltips should provide useful information and not repeat information that is already present.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data</div>\n\nWhen writing tooltips, 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\">Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export Data As a Spreadsheet</div>\n\nUse tooltips sparingly. If your UI is requiring a lot of tooltips, consider revising the interface to provide better explanations and better labelling.\n\n---\n\n## Additional considerations\n\n- Always provide a tooltip for icon-only buttons or a button with an associated keyboard shortcut.\n- Don’t use tooltip to communicate critical information, including errors.\n- Use sparingly. If you’re building something that requires a lot of tooltips, take a step back and work on clarifying the design and the language used instead.\n"
|
|
9561
|
+
},
|
|
9562
|
+
{
|
|
9563
|
+
"kind": "javascript-module",
|
|
9564
|
+
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
9565
|
+
"declarations": [
|
|
9566
|
+
{
|
|
9567
|
+
"kind": "class",
|
|
9568
|
+
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
9569
|
+
"name": "VisuallyHidden",
|
|
9570
|
+
"slots": [
|
|
9571
|
+
{
|
|
9572
|
+
"description": "The visually hidden content.",
|
|
9573
|
+
"name": ""
|
|
9574
|
+
}
|
|
9575
|
+
],
|
|
9576
|
+
"members": [],
|
|
9577
|
+
"superclass": {
|
|
9578
|
+
"name": "LitElement",
|
|
9579
|
+
"package": "lit"
|
|
9580
|
+
},
|
|
9581
|
+
"status": "ready",
|
|
9582
|
+
"category": "text",
|
|
9583
|
+
"tagName": "nord-visually-hidden",
|
|
9584
|
+
"customElement": true
|
|
9585
|
+
}
|
|
9586
|
+
],
|
|
9587
|
+
"exports": [
|
|
9588
|
+
{
|
|
9589
|
+
"kind": "js",
|
|
9590
|
+
"name": "default",
|
|
9591
|
+
"declaration": {
|
|
9592
|
+
"name": "VisuallyHidden",
|
|
9593
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
9594
|
+
}
|
|
9595
|
+
},
|
|
9596
|
+
{
|
|
9597
|
+
"kind": "custom-element-definition",
|
|
9598
|
+
"name": "nord-visually-hidden",
|
|
9599
|
+
"declaration": {
|
|
9600
|
+
"name": "VisuallyHidden",
|
|
9601
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
9602
|
+
}
|
|
9603
|
+
}
|
|
9604
|
+
],
|
|
9605
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to hide text visually from the screen, but keep it available to assistive technologies, such as screen readers.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for hiding interactive content.\n\n</div>\n"
|
|
9606
|
+
},
|
|
9607
|
+
{
|
|
9608
|
+
"kind": "javascript-module",
|
|
9609
|
+
"path": "src/common/directives/cond.ts",
|
|
9610
|
+
"declarations": [
|
|
9611
|
+
{
|
|
9612
|
+
"kind": "variable",
|
|
9613
|
+
"name": "cond"
|
|
9614
|
+
}
|
|
9615
|
+
],
|
|
9616
|
+
"exports": [
|
|
9617
|
+
{
|
|
9618
|
+
"kind": "js",
|
|
9619
|
+
"name": "cond",
|
|
9620
|
+
"declaration": {
|
|
9621
|
+
"name": "cond",
|
|
9622
|
+
"module": "src/common/directives/cond.ts"
|
|
9623
|
+
}
|
|
9624
|
+
}
|
|
9625
|
+
]
|
|
9626
|
+
},
|
|
9627
|
+
{
|
|
9628
|
+
"kind": "javascript-module",
|
|
9629
|
+
"path": "src/common/directives/wrapIf.ts",
|
|
9630
|
+
"declarations": [
|
|
9631
|
+
{
|
|
9632
|
+
"kind": "function",
|
|
9633
|
+
"name": "wrapIf",
|
|
9634
|
+
"return": {
|
|
9635
|
+
"type": {
|
|
9636
|
+
"text": "TInner"
|
|
9637
|
+
}
|
|
9638
|
+
},
|
|
9639
|
+
"parameters": [
|
|
9640
|
+
{
|
|
9641
|
+
"name": "condition",
|
|
9642
|
+
"type": {
|
|
9643
|
+
"text": "false"
|
|
9644
|
+
}
|
|
9645
|
+
},
|
|
9646
|
+
{
|
|
9647
|
+
"name": "inner",
|
|
9648
|
+
"type": {
|
|
9649
|
+
"text": "() => TInner"
|
|
9650
|
+
}
|
|
9651
|
+
},
|
|
9652
|
+
{
|
|
9653
|
+
"name": "wrapper",
|
|
9654
|
+
"type": {
|
|
9655
|
+
"text": "(inner: TInner) => TWrapper"
|
|
9656
|
+
}
|
|
9657
|
+
}
|
|
9658
|
+
]
|
|
9659
|
+
},
|
|
9660
|
+
{
|
|
9661
|
+
"kind": "function",
|
|
9662
|
+
"name": "wrapIf",
|
|
9663
|
+
"return": {
|
|
9664
|
+
"type": {
|
|
9665
|
+
"text": "TWrapper"
|
|
9666
|
+
}
|
|
9667
|
+
},
|
|
9668
|
+
"parameters": [
|
|
9669
|
+
{
|
|
9670
|
+
"name": "condition",
|
|
9671
|
+
"type": {
|
|
9672
|
+
"text": "true"
|
|
9673
|
+
}
|
|
9674
|
+
},
|
|
9675
|
+
{
|
|
9676
|
+
"name": "inner",
|
|
9677
|
+
"type": {
|
|
9678
|
+
"text": "() => TInner"
|
|
9679
|
+
}
|
|
9680
|
+
},
|
|
9681
|
+
{
|
|
9682
|
+
"name": "wrapper",
|
|
9683
|
+
"type": {
|
|
9684
|
+
"text": "(inner: TInner) => TWrapper"
|
|
9685
|
+
}
|
|
9686
|
+
}
|
|
9687
|
+
]
|
|
9688
|
+
},
|
|
9689
|
+
{
|
|
9690
|
+
"kind": "function",
|
|
9691
|
+
"name": "wrapIf",
|
|
9692
|
+
"return": {
|
|
9693
|
+
"type": {
|
|
9694
|
+
"text": "TInner | TWrapper"
|
|
9695
|
+
}
|
|
9696
|
+
},
|
|
9697
|
+
"parameters": [
|
|
9698
|
+
{
|
|
9699
|
+
"name": "condition",
|
|
9700
|
+
"type": {
|
|
9701
|
+
"text": "unknown"
|
|
9702
|
+
}
|
|
9703
|
+
},
|
|
9704
|
+
{
|
|
9705
|
+
"name": "inner",
|
|
9706
|
+
"type": {
|
|
9707
|
+
"text": "() => TInner"
|
|
9708
|
+
}
|
|
9709
|
+
},
|
|
9710
|
+
{
|
|
9711
|
+
"name": "wrapper",
|
|
9712
|
+
"type": {
|
|
9713
|
+
"text": "(inner: TInner) => TWrapper"
|
|
9714
|
+
}
|
|
9715
|
+
}
|
|
9716
|
+
]
|
|
9717
|
+
},
|
|
9718
|
+
{
|
|
9719
|
+
"kind": "function",
|
|
9720
|
+
"name": "wrapIf",
|
|
9721
|
+
"parameters": [
|
|
9722
|
+
{
|
|
9723
|
+
"name": "condition",
|
|
9724
|
+
"type": {
|
|
9725
|
+
"text": "any"
|
|
9726
|
+
}
|
|
9727
|
+
},
|
|
9728
|
+
{
|
|
9729
|
+
"name": "inner",
|
|
9730
|
+
"type": {
|
|
9731
|
+
"text": "() => TInner"
|
|
9732
|
+
}
|
|
9733
|
+
},
|
|
9734
|
+
{
|
|
9735
|
+
"name": "wrapper",
|
|
9736
|
+
"type": {
|
|
9737
|
+
"text": "(innards: TInner) => TWrapper"
|
|
9738
|
+
}
|
|
9739
|
+
}
|
|
9740
|
+
],
|
|
9741
|
+
"return": {
|
|
9742
|
+
"type": {
|
|
9743
|
+
"text": ""
|
|
9744
|
+
}
|
|
9745
|
+
}
|
|
9484
9746
|
}
|
|
9485
9747
|
],
|
|
9486
9748
|
"exports": [
|
|
9487
9749
|
{
|
|
9488
9750
|
"kind": "js",
|
|
9489
|
-
"name": "
|
|
9751
|
+
"name": "wrapIf",
|
|
9490
9752
|
"declaration": {
|
|
9491
|
-
"name": "
|
|
9492
|
-
"module": "src/
|
|
9753
|
+
"name": "wrapIf",
|
|
9754
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9493
9755
|
}
|
|
9494
9756
|
},
|
|
9495
9757
|
{
|
|
9496
|
-
"kind": "
|
|
9497
|
-
"name": "
|
|
9758
|
+
"kind": "js",
|
|
9759
|
+
"name": "wrapIf",
|
|
9498
9760
|
"declaration": {
|
|
9499
|
-
"name": "
|
|
9500
|
-
"module": "src/
|
|
9761
|
+
"name": "wrapIf",
|
|
9762
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9501
9763
|
}
|
|
9502
|
-
}
|
|
9503
|
-
],
|
|
9504
|
-
"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 if an interactive element requires more explanation.\n- Use a tooltip to provide additional information, such as UI shortcuts.\n- Use the `label` attribute on icons used for shortcuts for accessibility.\n- Use clear and accurate phrasing.\n- Be consistent with positioning of tooltips in the user interface.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use interactive elements such as links or buttons inside a tooltip.\n- Don’t rely on tooltips when you have room to provide more explanation.\n- Don’t depend on tooltips for vital information.\n\n</div>\n\n---\n\n## Content guidelines\n\nTooltips should be clear and informative, but not imperative to using the interface they refer to. They should not contain interactive elements such as buttons or links.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data as a CSV, <u>more information on CSVs</u></div>\n\nTooltips should provide useful information and not repeat information that is already present.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data</div>\n\nWhen writing tooltips, 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\">Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export Data As a Spreadsheet</div>\n\nUse tooltips sparingly. If your UI is requiring a lot of tooltips, consider revising the interface to provide better explanations and better labelling.\n\n---\n\n## Additional considerations\n\n- Always provide a tooltip for icon-only buttons or a button with an associated keyboard shortcut.\n- Don’t use tooltip to communicate critical information, including errors.\n- Use sparingly. If you’re building something that requires a lot of tooltips, take a step back and work on clarifying the design and the language used instead.\n"
|
|
9505
|
-
},
|
|
9506
|
-
{
|
|
9507
|
-
"kind": "javascript-module",
|
|
9508
|
-
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
9509
|
-
"declarations": [
|
|
9510
|
-
{
|
|
9511
|
-
"kind": "class",
|
|
9512
|
-
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
9513
|
-
"name": "VisuallyHidden",
|
|
9514
|
-
"slots": [
|
|
9515
|
-
{
|
|
9516
|
-
"description": "The visually hidden content.",
|
|
9517
|
-
"name": ""
|
|
9518
|
-
}
|
|
9519
|
-
],
|
|
9520
|
-
"members": [],
|
|
9521
|
-
"superclass": {
|
|
9522
|
-
"name": "LitElement",
|
|
9523
|
-
"package": "lit"
|
|
9524
|
-
},
|
|
9525
|
-
"status": "ready",
|
|
9526
|
-
"category": "text",
|
|
9527
|
-
"tagName": "nord-visually-hidden",
|
|
9528
|
-
"customElement": true
|
|
9529
|
-
}
|
|
9530
|
-
],
|
|
9531
|
-
"exports": [
|
|
9764
|
+
},
|
|
9532
9765
|
{
|
|
9533
9766
|
"kind": "js",
|
|
9534
|
-
"name": "
|
|
9767
|
+
"name": "wrapIf",
|
|
9535
9768
|
"declaration": {
|
|
9536
|
-
"name": "
|
|
9537
|
-
"module": "src/
|
|
9769
|
+
"name": "wrapIf",
|
|
9770
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9538
9771
|
}
|
|
9539
9772
|
},
|
|
9540
9773
|
{
|
|
9541
|
-
"kind": "
|
|
9542
|
-
"name": "
|
|
9774
|
+
"kind": "js",
|
|
9775
|
+
"name": "wrapIf",
|
|
9543
9776
|
"declaration": {
|
|
9544
|
-
"name": "
|
|
9545
|
-
"module": "src/
|
|
9777
|
+
"name": "wrapIf",
|
|
9778
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9546
9779
|
}
|
|
9547
9780
|
}
|
|
9548
|
-
]
|
|
9549
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to hide text visually from the screen, but keep it available to assistive technologies, such as screen readers.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for hiding interactive content.\n\n</div>\n"
|
|
9781
|
+
]
|
|
9550
9782
|
},
|
|
9551
9783
|
{
|
|
9552
9784
|
"kind": "javascript-module",
|
|
@@ -10483,182 +10715,6 @@
|
|
|
10483
10715
|
}
|
|
10484
10716
|
]
|
|
10485
10717
|
},
|
|
10486
|
-
{
|
|
10487
|
-
"kind": "javascript-module",
|
|
10488
|
-
"path": "src/common/directives/cond.ts",
|
|
10489
|
-
"declarations": [
|
|
10490
|
-
{
|
|
10491
|
-
"kind": "variable",
|
|
10492
|
-
"name": "cond"
|
|
10493
|
-
}
|
|
10494
|
-
],
|
|
10495
|
-
"exports": [
|
|
10496
|
-
{
|
|
10497
|
-
"kind": "js",
|
|
10498
|
-
"name": "cond",
|
|
10499
|
-
"declaration": {
|
|
10500
|
-
"name": "cond",
|
|
10501
|
-
"module": "src/common/directives/cond.ts"
|
|
10502
|
-
}
|
|
10503
|
-
}
|
|
10504
|
-
]
|
|
10505
|
-
},
|
|
10506
|
-
{
|
|
10507
|
-
"kind": "javascript-module",
|
|
10508
|
-
"path": "src/common/directives/wrapIf.ts",
|
|
10509
|
-
"declarations": [
|
|
10510
|
-
{
|
|
10511
|
-
"kind": "function",
|
|
10512
|
-
"name": "wrapIf",
|
|
10513
|
-
"return": {
|
|
10514
|
-
"type": {
|
|
10515
|
-
"text": "TInner"
|
|
10516
|
-
}
|
|
10517
|
-
},
|
|
10518
|
-
"parameters": [
|
|
10519
|
-
{
|
|
10520
|
-
"name": "condition",
|
|
10521
|
-
"type": {
|
|
10522
|
-
"text": "false"
|
|
10523
|
-
}
|
|
10524
|
-
},
|
|
10525
|
-
{
|
|
10526
|
-
"name": "inner",
|
|
10527
|
-
"type": {
|
|
10528
|
-
"text": "() => TInner"
|
|
10529
|
-
}
|
|
10530
|
-
},
|
|
10531
|
-
{
|
|
10532
|
-
"name": "wrapper",
|
|
10533
|
-
"type": {
|
|
10534
|
-
"text": "(inner: TInner) => TWrapper"
|
|
10535
|
-
}
|
|
10536
|
-
}
|
|
10537
|
-
]
|
|
10538
|
-
},
|
|
10539
|
-
{
|
|
10540
|
-
"kind": "function",
|
|
10541
|
-
"name": "wrapIf",
|
|
10542
|
-
"return": {
|
|
10543
|
-
"type": {
|
|
10544
|
-
"text": "TWrapper"
|
|
10545
|
-
}
|
|
10546
|
-
},
|
|
10547
|
-
"parameters": [
|
|
10548
|
-
{
|
|
10549
|
-
"name": "condition",
|
|
10550
|
-
"type": {
|
|
10551
|
-
"text": "true"
|
|
10552
|
-
}
|
|
10553
|
-
},
|
|
10554
|
-
{
|
|
10555
|
-
"name": "inner",
|
|
10556
|
-
"type": {
|
|
10557
|
-
"text": "() => TInner"
|
|
10558
|
-
}
|
|
10559
|
-
},
|
|
10560
|
-
{
|
|
10561
|
-
"name": "wrapper",
|
|
10562
|
-
"type": {
|
|
10563
|
-
"text": "(inner: TInner) => TWrapper"
|
|
10564
|
-
}
|
|
10565
|
-
}
|
|
10566
|
-
]
|
|
10567
|
-
},
|
|
10568
|
-
{
|
|
10569
|
-
"kind": "function",
|
|
10570
|
-
"name": "wrapIf",
|
|
10571
|
-
"return": {
|
|
10572
|
-
"type": {
|
|
10573
|
-
"text": "TInner | TWrapper"
|
|
10574
|
-
}
|
|
10575
|
-
},
|
|
10576
|
-
"parameters": [
|
|
10577
|
-
{
|
|
10578
|
-
"name": "condition",
|
|
10579
|
-
"type": {
|
|
10580
|
-
"text": "unknown"
|
|
10581
|
-
}
|
|
10582
|
-
},
|
|
10583
|
-
{
|
|
10584
|
-
"name": "inner",
|
|
10585
|
-
"type": {
|
|
10586
|
-
"text": "() => TInner"
|
|
10587
|
-
}
|
|
10588
|
-
},
|
|
10589
|
-
{
|
|
10590
|
-
"name": "wrapper",
|
|
10591
|
-
"type": {
|
|
10592
|
-
"text": "(inner: TInner) => TWrapper"
|
|
10593
|
-
}
|
|
10594
|
-
}
|
|
10595
|
-
]
|
|
10596
|
-
},
|
|
10597
|
-
{
|
|
10598
|
-
"kind": "function",
|
|
10599
|
-
"name": "wrapIf",
|
|
10600
|
-
"parameters": [
|
|
10601
|
-
{
|
|
10602
|
-
"name": "condition",
|
|
10603
|
-
"type": {
|
|
10604
|
-
"text": "any"
|
|
10605
|
-
}
|
|
10606
|
-
},
|
|
10607
|
-
{
|
|
10608
|
-
"name": "inner",
|
|
10609
|
-
"type": {
|
|
10610
|
-
"text": "() => TInner"
|
|
10611
|
-
}
|
|
10612
|
-
},
|
|
10613
|
-
{
|
|
10614
|
-
"name": "wrapper",
|
|
10615
|
-
"type": {
|
|
10616
|
-
"text": "(innards: TInner) => TWrapper"
|
|
10617
|
-
}
|
|
10618
|
-
}
|
|
10619
|
-
],
|
|
10620
|
-
"return": {
|
|
10621
|
-
"type": {
|
|
10622
|
-
"text": ""
|
|
10623
|
-
}
|
|
10624
|
-
}
|
|
10625
|
-
}
|
|
10626
|
-
],
|
|
10627
|
-
"exports": [
|
|
10628
|
-
{
|
|
10629
|
-
"kind": "js",
|
|
10630
|
-
"name": "wrapIf",
|
|
10631
|
-
"declaration": {
|
|
10632
|
-
"name": "wrapIf",
|
|
10633
|
-
"module": "src/common/directives/wrapIf.ts"
|
|
10634
|
-
}
|
|
10635
|
-
},
|
|
10636
|
-
{
|
|
10637
|
-
"kind": "js",
|
|
10638
|
-
"name": "wrapIf",
|
|
10639
|
-
"declaration": {
|
|
10640
|
-
"name": "wrapIf",
|
|
10641
|
-
"module": "src/common/directives/wrapIf.ts"
|
|
10642
|
-
}
|
|
10643
|
-
},
|
|
10644
|
-
{
|
|
10645
|
-
"kind": "js",
|
|
10646
|
-
"name": "wrapIf",
|
|
10647
|
-
"declaration": {
|
|
10648
|
-
"name": "wrapIf",
|
|
10649
|
-
"module": "src/common/directives/wrapIf.ts"
|
|
10650
|
-
}
|
|
10651
|
-
},
|
|
10652
|
-
{
|
|
10653
|
-
"kind": "js",
|
|
10654
|
-
"name": "wrapIf",
|
|
10655
|
-
"declaration": {
|
|
10656
|
-
"name": "wrapIf",
|
|
10657
|
-
"module": "src/common/directives/wrapIf.ts"
|
|
10658
|
-
}
|
|
10659
|
-
}
|
|
10660
|
-
]
|
|
10661
|
-
},
|
|
10662
10718
|
{
|
|
10663
10719
|
"kind": "javascript-module",
|
|
10664
10720
|
"path": "src/common/mixins/DraftComponentMixin.ts",
|