@nordhealth/components 3.22.0-alpha.0 → 3.22.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 +1233 -1233
- package/lib/Calendar-Cuumq57y.js.map +1 -1
- package/lib/bundle.js.map +1 -1
- package/package.json +2 -2
package/custom-elements.json
CHANGED
|
@@ -790,6 +790,91 @@
|
|
|
790
790
|
}
|
|
791
791
|
]
|
|
792
792
|
},
|
|
793
|
+
{
|
|
794
|
+
"kind": "javascript-module",
|
|
795
|
+
"path": "src/banner/Banner.ts",
|
|
796
|
+
"declarations": [
|
|
797
|
+
{
|
|
798
|
+
"kind": "class",
|
|
799
|
+
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
800
|
+
"name": "Banner",
|
|
801
|
+
"cssProperties": [
|
|
802
|
+
{
|
|
803
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
804
|
+
"name": "--n-banner-border-radius",
|
|
805
|
+
"default": "var(--n-border-radius)"
|
|
806
|
+
},
|
|
807
|
+
{
|
|
808
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
809
|
+
"name": "--n-banner-box-shadow",
|
|
810
|
+
"default": "var(--n-box-shadow-card)"
|
|
811
|
+
}
|
|
812
|
+
],
|
|
813
|
+
"slots": [
|
|
814
|
+
{
|
|
815
|
+
"description": "default slot",
|
|
816
|
+
"name": ""
|
|
817
|
+
}
|
|
818
|
+
],
|
|
819
|
+
"members": [
|
|
820
|
+
{
|
|
821
|
+
"kind": "field",
|
|
822
|
+
"name": "variant",
|
|
823
|
+
"type": {
|
|
824
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
825
|
+
},
|
|
826
|
+
"default": "\"info\"",
|
|
827
|
+
"description": "The style variant of the banner.",
|
|
828
|
+
"attribute": "variant",
|
|
829
|
+
"reflects": true
|
|
830
|
+
}
|
|
831
|
+
],
|
|
832
|
+
"attributes": [
|
|
833
|
+
{
|
|
834
|
+
"name": "variant",
|
|
835
|
+
"type": {
|
|
836
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
837
|
+
},
|
|
838
|
+
"default": "\"info\"",
|
|
839
|
+
"description": "The style variant of the banner.",
|
|
840
|
+
"fieldName": "variant"
|
|
841
|
+
}
|
|
842
|
+
],
|
|
843
|
+
"superclass": {
|
|
844
|
+
"name": "LitElement",
|
|
845
|
+
"package": "lit"
|
|
846
|
+
},
|
|
847
|
+
"localization": [],
|
|
848
|
+
"status": "ready",
|
|
849
|
+
"category": "feedback",
|
|
850
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
851
|
+
"examples": [],
|
|
852
|
+
"dependencies": [
|
|
853
|
+
"icon"
|
|
854
|
+
],
|
|
855
|
+
"tagName": "nord-banner",
|
|
856
|
+
"customElement": true
|
|
857
|
+
}
|
|
858
|
+
],
|
|
859
|
+
"exports": [
|
|
860
|
+
{
|
|
861
|
+
"kind": "js",
|
|
862
|
+
"name": "default",
|
|
863
|
+
"declaration": {
|
|
864
|
+
"name": "Banner",
|
|
865
|
+
"module": "src/banner/Banner.ts"
|
|
866
|
+
}
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"kind": "custom-element-definition",
|
|
870
|
+
"name": "nord-banner",
|
|
871
|
+
"declaration": {
|
|
872
|
+
"name": "Banner",
|
|
873
|
+
"module": "src/banner/Banner.ts"
|
|
874
|
+
}
|
|
875
|
+
}
|
|
876
|
+
]
|
|
877
|
+
},
|
|
793
878
|
{
|
|
794
879
|
"kind": "javascript-module",
|
|
795
880
|
"path": "src/button/Button.ts",
|
|
@@ -1373,7 +1458,7 @@
|
|
|
1373
1458
|
"localization": [],
|
|
1374
1459
|
"status": "ready",
|
|
1375
1460
|
"category": "action",
|
|
1376
|
-
"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- Only use one primary button per section, as a main call-to-action.\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 a primary button in every row of a table.\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## Icon usage in button\n\nIllustrative icons should be always positioned in the `start` slot:\n\n<img src=\"/img/components/button/start-slot.png\" class=\"n-border n-border-radius\" style=\"max-
|
|
1461
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Only use one primary button per section, as a main call-to-action.\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 a primary button in every row of a table.\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## Icon usage in button\n\nIllustrative icons should be always positioned in the `start` slot:\n\n<img src=\"/img/components/button/start-slot.png\" class=\"n-border n-border-radius\" style=\"max-inline-size:700px;\" loading=\"lazy\" height=\"475\" width=\"800\" alt=\"Button with icon in start slot\" />\n\nWhen a button is used as a dropdown toggle, the `interface-dropdown-small` icon from [Nordicons](/nordicons/) is automatically placed in the `end` slot:\n\n<img src=\"/img/components/button/dropdown.png\" class=\"n-border n-border-radius\" style=\"max-inline-size:700px;\" loading=\"lazy\" height=\"475\" width=\"800\" alt=\"Dropdown button\" />\n\nEach button size has a recommended icon size. The medium button uses the `s` icon size, the [small button](/components/button/?example=small+buttons) uses the `xs` icon size, and the [large button](/components/button/?example=large+buttons) uses the `m` icon size. The icon will adjust size automatically based on the button size, so you will get the correct behavior by default. However, this can be overridden by explicitly setting a size on the icon.\n\n<img src=\"/img/components/button/icon-sizes.png\" class=\"n-border n-border-radius\" style=\"max-inline-size:700px;\" loading=\"lazy\" height=\"475\" width=\"800\" alt=\"Button icon sizes\" />\n\nUse `interface-add-small` icon in the `start` slot for create/add type primary actions in the [header](/components/header/):\n\n<img src=\"/img/components/button/create.png\" class=\"n-border n-border-radius\" style=\"max-inline-size:700px;\" loading=\"lazy\" height=\"475\" width=\"800\" alt=\"Create/add type primary action with icon\" />\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",
|
|
1377
1462
|
"examples": [],
|
|
1378
1463
|
"dependencies": [
|
|
1379
1464
|
"spinner"
|
|
@@ -1403,52 +1488,124 @@
|
|
|
1403
1488
|
},
|
|
1404
1489
|
{
|
|
1405
1490
|
"kind": "javascript-module",
|
|
1406
|
-
"path": "src/
|
|
1491
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
1407
1492
|
"declarations": [
|
|
1408
1493
|
{
|
|
1409
1494
|
"kind": "class",
|
|
1410
|
-
"description": "
|
|
1411
|
-
"name": "
|
|
1495
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
1496
|
+
"name": "ButtonGroup",
|
|
1412
1497
|
"cssProperties": [
|
|
1413
1498
|
{
|
|
1414
|
-
"description": "Controls
|
|
1415
|
-
"name": "--n-
|
|
1416
|
-
"default": "var(--n-border-radius)"
|
|
1499
|
+
"description": "Controls the rounded corners of the button group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
1500
|
+
"name": "--n-button-group-border-radius",
|
|
1501
|
+
"default": "var(--n-border-radius-s)"
|
|
1417
1502
|
},
|
|
1418
1503
|
{
|
|
1419
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1420
|
-
"name": "--n-
|
|
1421
|
-
"default": "var(--n-box-shadow
|
|
1504
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
1505
|
+
"name": "--n-button-group-box-shadow",
|
|
1506
|
+
"default": "var(--n-box-shadow)"
|
|
1422
1507
|
}
|
|
1423
1508
|
],
|
|
1424
1509
|
"slots": [
|
|
1425
1510
|
{
|
|
1426
|
-
"description": "
|
|
1511
|
+
"description": "The button group content",
|
|
1427
1512
|
"name": ""
|
|
1428
1513
|
}
|
|
1429
1514
|
],
|
|
1430
1515
|
"members": [
|
|
1516
|
+
{
|
|
1517
|
+
"kind": "field",
|
|
1518
|
+
"name": "defaultSlot",
|
|
1519
|
+
"privacy": "private",
|
|
1520
|
+
"default": "new SlotController(this)"
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"kind": "field",
|
|
1524
|
+
"name": "dirController",
|
|
1525
|
+
"privacy": "private",
|
|
1526
|
+
"default": "new DirectionController(this)"
|
|
1527
|
+
},
|
|
1431
1528
|
{
|
|
1432
1529
|
"kind": "field",
|
|
1433
1530
|
"name": "variant",
|
|
1434
1531
|
"type": {
|
|
1435
|
-
"text": "\"
|
|
1532
|
+
"text": "\"default\" | \"spaced\""
|
|
1436
1533
|
},
|
|
1437
|
-
"default": "\"
|
|
1438
|
-
"description": "The style variant of the
|
|
1534
|
+
"default": "\"default\"",
|
|
1535
|
+
"description": "The style variant of the button group.",
|
|
1439
1536
|
"attribute": "variant",
|
|
1440
1537
|
"reflects": true
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"kind": "field",
|
|
1541
|
+
"name": "direction",
|
|
1542
|
+
"type": {
|
|
1543
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1544
|
+
},
|
|
1545
|
+
"default": "\"horizontal\"",
|
|
1546
|
+
"description": "The direction of the button group.",
|
|
1547
|
+
"attribute": "direction",
|
|
1548
|
+
"reflects": true
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"kind": "field",
|
|
1552
|
+
"name": "wrap",
|
|
1553
|
+
"type": {
|
|
1554
|
+
"text": "boolean"
|
|
1555
|
+
},
|
|
1556
|
+
"default": "false",
|
|
1557
|
+
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
1558
|
+
"attribute": "wrap",
|
|
1559
|
+
"reflects": true
|
|
1560
|
+
},
|
|
1561
|
+
{
|
|
1562
|
+
"kind": "field",
|
|
1563
|
+
"name": "role",
|
|
1564
|
+
"type": {
|
|
1565
|
+
"text": "string"
|
|
1566
|
+
},
|
|
1567
|
+
"default": "\"group\"",
|
|
1568
|
+
"description": "The appropriate role for the containing element.",
|
|
1569
|
+
"attribute": "role",
|
|
1570
|
+
"reflects": true
|
|
1441
1571
|
}
|
|
1442
1572
|
],
|
|
1443
1573
|
"attributes": [
|
|
1444
1574
|
{
|
|
1445
1575
|
"name": "variant",
|
|
1446
1576
|
"type": {
|
|
1447
|
-
"text": "\"
|
|
1577
|
+
"text": "\"default\" | \"spaced\""
|
|
1448
1578
|
},
|
|
1449
|
-
"default": "\"
|
|
1450
|
-
"description": "The style variant of the
|
|
1579
|
+
"default": "\"default\"",
|
|
1580
|
+
"description": "The style variant of the button group.",
|
|
1451
1581
|
"fieldName": "variant"
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"name": "direction",
|
|
1585
|
+
"type": {
|
|
1586
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1587
|
+
},
|
|
1588
|
+
"default": "\"horizontal\"",
|
|
1589
|
+
"description": "The direction of the button group.",
|
|
1590
|
+
"fieldName": "direction"
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"name": "wrap",
|
|
1594
|
+
"type": {
|
|
1595
|
+
"text": "boolean"
|
|
1596
|
+
},
|
|
1597
|
+
"default": "false",
|
|
1598
|
+
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
1599
|
+
"fieldName": "wrap"
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"name": "role",
|
|
1603
|
+
"type": {
|
|
1604
|
+
"text": "string"
|
|
1605
|
+
},
|
|
1606
|
+
"default": "\"group\"",
|
|
1607
|
+
"description": "The appropriate role for the containing element.",
|
|
1608
|
+
"fieldName": "role"
|
|
1452
1609
|
}
|
|
1453
1610
|
],
|
|
1454
1611
|
"superclass": {
|
|
@@ -1457,13 +1614,11 @@
|
|
|
1457
1614
|
},
|
|
1458
1615
|
"localization": [],
|
|
1459
1616
|
"status": "ready",
|
|
1460
|
-
"category": "
|
|
1461
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use
|
|
1617
|
+
"category": "structure",
|
|
1618
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to group together buttons, or dropdowns, of a similar nature or purpose.\n- Use the appropriate `role` attribute on the button group to provide additional semantics.\n- Use an `aria-labelledby` attribute referencing another element to best explain the contents of the button group.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t add components other than buttons, dropdowns and in some instances visually hidden components to the button group.\n- Don’t skip the addition of an appropriate label if the added `role` attribute value calls for it.\n- Don’t use for building grid based layouts.\n\n</div>\n\n---\n\n## Content guidelines\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| --------- | -------------------------------------------------------------------------------------------------------- |\n| `default` | The default variant renders a group of segmented buttons to emphasize that they’re thematically-related. |\n| `spaced` | The spaced variant renders a gap between the buttons to space them out evenly. |\n",
|
|
1462
1619
|
"examples": [],
|
|
1463
|
-
"dependencies": [
|
|
1464
|
-
|
|
1465
|
-
],
|
|
1466
|
-
"tagName": "nord-banner",
|
|
1620
|
+
"dependencies": [],
|
|
1621
|
+
"tagName": "nord-button-group",
|
|
1467
1622
|
"customElement": true
|
|
1468
1623
|
}
|
|
1469
1624
|
],
|
|
@@ -1472,16 +1627,16 @@
|
|
|
1472
1627
|
"kind": "js",
|
|
1473
1628
|
"name": "default",
|
|
1474
1629
|
"declaration": {
|
|
1475
|
-
"name": "
|
|
1476
|
-
"module": "src/
|
|
1630
|
+
"name": "ButtonGroup",
|
|
1631
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1477
1632
|
}
|
|
1478
1633
|
},
|
|
1479
1634
|
{
|
|
1480
1635
|
"kind": "custom-element-definition",
|
|
1481
|
-
"name": "nord-
|
|
1636
|
+
"name": "nord-button-group",
|
|
1482
1637
|
"declaration": {
|
|
1483
|
-
"name": "
|
|
1484
|
-
"module": "src/
|
|
1638
|
+
"name": "ButtonGroup",
|
|
1639
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1485
1640
|
}
|
|
1486
1641
|
}
|
|
1487
1642
|
]
|
|
@@ -1990,202 +2145,47 @@
|
|
|
1990
2145
|
},
|
|
1991
2146
|
{
|
|
1992
2147
|
"kind": "javascript-module",
|
|
1993
|
-
"path": "src/
|
|
2148
|
+
"path": "src/checkbox/Checkbox.ts",
|
|
1994
2149
|
"declarations": [
|
|
1995
2150
|
{
|
|
1996
2151
|
"kind": "class",
|
|
1997
|
-
"description": "
|
|
1998
|
-
"name": "
|
|
2152
|
+
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
2153
|
+
"name": "Checkbox",
|
|
1999
2154
|
"cssProperties": [
|
|
2000
2155
|
{
|
|
2001
|
-
"description": "Controls the
|
|
2002
|
-
"name": "--n-
|
|
2003
|
-
"default": "var(--n-
|
|
2004
|
-
},
|
|
2005
|
-
{
|
|
2006
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
2007
|
-
"name": "--n-button-group-box-shadow",
|
|
2008
|
-
"default": "var(--n-box-shadow)"
|
|
2156
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
2157
|
+
"name": "--n-label-color",
|
|
2158
|
+
"default": "var(--n-color-text)"
|
|
2009
2159
|
}
|
|
2010
2160
|
],
|
|
2011
2161
|
"slots": [
|
|
2012
2162
|
{
|
|
2013
|
-
"description": "
|
|
2014
|
-
"name": ""
|
|
2163
|
+
"description": "Use when a label requires more than plain text.",
|
|
2164
|
+
"name": "label"
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
2168
|
+
"name": "hint"
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"description": "Optional slot that holds error text for the input.",
|
|
2172
|
+
"name": "error"
|
|
2015
2173
|
}
|
|
2016
2174
|
],
|
|
2017
2175
|
"members": [
|
|
2018
2176
|
{
|
|
2019
2177
|
"kind": "field",
|
|
2020
|
-
"name": "
|
|
2021
|
-
"privacy": "
|
|
2022
|
-
"
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
"privacy": "private",
|
|
2028
|
-
"default": "new DirectionController(this)"
|
|
2178
|
+
"name": "formValue",
|
|
2179
|
+
"privacy": "protected",
|
|
2180
|
+
"readonly": true,
|
|
2181
|
+
"inheritedFrom": {
|
|
2182
|
+
"name": "FormAssociatedMixin",
|
|
2183
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2184
|
+
}
|
|
2029
2185
|
},
|
|
2030
2186
|
{
|
|
2031
2187
|
"kind": "field",
|
|
2032
|
-
"name": "
|
|
2033
|
-
"type": {
|
|
2034
|
-
"text": "\"default\" | \"spaced\""
|
|
2035
|
-
},
|
|
2036
|
-
"default": "\"default\"",
|
|
2037
|
-
"description": "The style variant of the button group.",
|
|
2038
|
-
"attribute": "variant",
|
|
2039
|
-
"reflects": true
|
|
2040
|
-
},
|
|
2041
|
-
{
|
|
2042
|
-
"kind": "field",
|
|
2043
|
-
"name": "direction",
|
|
2044
|
-
"type": {
|
|
2045
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
2046
|
-
},
|
|
2047
|
-
"default": "\"horizontal\"",
|
|
2048
|
-
"description": "The direction of the button group.",
|
|
2049
|
-
"attribute": "direction",
|
|
2050
|
-
"reflects": true
|
|
2051
|
-
},
|
|
2052
|
-
{
|
|
2053
|
-
"kind": "field",
|
|
2054
|
-
"name": "wrap",
|
|
2055
|
-
"type": {
|
|
2056
|
-
"text": "boolean"
|
|
2057
|
-
},
|
|
2058
|
-
"default": "false",
|
|
2059
|
-
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
2060
|
-
"attribute": "wrap",
|
|
2061
|
-
"reflects": true
|
|
2062
|
-
},
|
|
2063
|
-
{
|
|
2064
|
-
"kind": "field",
|
|
2065
|
-
"name": "role",
|
|
2066
|
-
"type": {
|
|
2067
|
-
"text": "string"
|
|
2068
|
-
},
|
|
2069
|
-
"default": "\"group\"",
|
|
2070
|
-
"description": "The appropriate role for the containing element.",
|
|
2071
|
-
"attribute": "role",
|
|
2072
|
-
"reflects": true
|
|
2073
|
-
}
|
|
2074
|
-
],
|
|
2075
|
-
"attributes": [
|
|
2076
|
-
{
|
|
2077
|
-
"name": "variant",
|
|
2078
|
-
"type": {
|
|
2079
|
-
"text": "\"default\" | \"spaced\""
|
|
2080
|
-
},
|
|
2081
|
-
"default": "\"default\"",
|
|
2082
|
-
"description": "The style variant of the button group.",
|
|
2083
|
-
"fieldName": "variant"
|
|
2084
|
-
},
|
|
2085
|
-
{
|
|
2086
|
-
"name": "direction",
|
|
2087
|
-
"type": {
|
|
2088
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
2089
|
-
},
|
|
2090
|
-
"default": "\"horizontal\"",
|
|
2091
|
-
"description": "The direction of the button group.",
|
|
2092
|
-
"fieldName": "direction"
|
|
2093
|
-
},
|
|
2094
|
-
{
|
|
2095
|
-
"name": "wrap",
|
|
2096
|
-
"type": {
|
|
2097
|
-
"text": "boolean"
|
|
2098
|
-
},
|
|
2099
|
-
"default": "false",
|
|
2100
|
-
"description": "Defines whether the buttons are forced in a single line\nor can be flowed into multiple lines (only applied when variant is set to `spaced`).",
|
|
2101
|
-
"fieldName": "wrap"
|
|
2102
|
-
},
|
|
2103
|
-
{
|
|
2104
|
-
"name": "role",
|
|
2105
|
-
"type": {
|
|
2106
|
-
"text": "string"
|
|
2107
|
-
},
|
|
2108
|
-
"default": "\"group\"",
|
|
2109
|
-
"description": "The appropriate role for the containing element.",
|
|
2110
|
-
"fieldName": "role"
|
|
2111
|
-
}
|
|
2112
|
-
],
|
|
2113
|
-
"superclass": {
|
|
2114
|
-
"name": "LitElement",
|
|
2115
|
-
"package": "lit"
|
|
2116
|
-
},
|
|
2117
|
-
"localization": [],
|
|
2118
|
-
"status": "ready",
|
|
2119
|
-
"category": "structure",
|
|
2120
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to group together buttons, or dropdowns, of a similar nature or purpose.\n- Use the appropriate `role` attribute on the button group to provide additional semantics.\n- Use an `aria-labelledby` attribute referencing another element to best explain the contents of the button group.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t add components other than buttons, dropdowns and in some instances visually hidden components to the button group.\n- Don’t skip the addition of an appropriate label if the added `role` attribute value calls for it.\n- Don’t use for building grid based layouts.\n\n</div>\n\n---\n\n## Content guidelines\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| --------- | -------------------------------------------------------------------------------------------------------- |\n| `default` | The default variant renders a group of segmented buttons to emphasize that they’re thematically-related. |\n| `spaced` | The spaced variant renders a gap between the buttons to space them out evenly. |\n",
|
|
2121
|
-
"examples": [],
|
|
2122
|
-
"dependencies": [],
|
|
2123
|
-
"tagName": "nord-button-group",
|
|
2124
|
-
"customElement": true
|
|
2125
|
-
}
|
|
2126
|
-
],
|
|
2127
|
-
"exports": [
|
|
2128
|
-
{
|
|
2129
|
-
"kind": "js",
|
|
2130
|
-
"name": "default",
|
|
2131
|
-
"declaration": {
|
|
2132
|
-
"name": "ButtonGroup",
|
|
2133
|
-
"module": "src/button-group/ButtonGroup.ts"
|
|
2134
|
-
}
|
|
2135
|
-
},
|
|
2136
|
-
{
|
|
2137
|
-
"kind": "custom-element-definition",
|
|
2138
|
-
"name": "nord-button-group",
|
|
2139
|
-
"declaration": {
|
|
2140
|
-
"name": "ButtonGroup",
|
|
2141
|
-
"module": "src/button-group/ButtonGroup.ts"
|
|
2142
|
-
}
|
|
2143
|
-
}
|
|
2144
|
-
]
|
|
2145
|
-
},
|
|
2146
|
-
{
|
|
2147
|
-
"kind": "javascript-module",
|
|
2148
|
-
"path": "src/checkbox/Checkbox.ts",
|
|
2149
|
-
"declarations": [
|
|
2150
|
-
{
|
|
2151
|
-
"kind": "class",
|
|
2152
|
-
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
2153
|
-
"name": "Checkbox",
|
|
2154
|
-
"cssProperties": [
|
|
2155
|
-
{
|
|
2156
|
-
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
2157
|
-
"name": "--n-label-color",
|
|
2158
|
-
"default": "var(--n-color-text)"
|
|
2159
|
-
}
|
|
2160
|
-
],
|
|
2161
|
-
"slots": [
|
|
2162
|
-
{
|
|
2163
|
-
"description": "Use when a label requires more than plain text.",
|
|
2164
|
-
"name": "label"
|
|
2165
|
-
},
|
|
2166
|
-
{
|
|
2167
|
-
"description": "Optional slot that holds hint text for the input.",
|
|
2168
|
-
"name": "hint"
|
|
2169
|
-
},
|
|
2170
|
-
{
|
|
2171
|
-
"description": "Optional slot that holds error text for the input.",
|
|
2172
|
-
"name": "error"
|
|
2173
|
-
}
|
|
2174
|
-
],
|
|
2175
|
-
"members": [
|
|
2176
|
-
{
|
|
2177
|
-
"kind": "field",
|
|
2178
|
-
"name": "formValue",
|
|
2179
|
-
"privacy": "protected",
|
|
2180
|
-
"readonly": true,
|
|
2181
|
-
"inheritedFrom": {
|
|
2182
|
-
"name": "FormAssociatedMixin",
|
|
2183
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2184
|
-
}
|
|
2185
|
-
},
|
|
2186
|
-
{
|
|
2187
|
-
"kind": "field",
|
|
2188
|
-
"name": "indeterminate",
|
|
2188
|
+
"name": "indeterminate",
|
|
2189
2189
|
"type": {
|
|
2190
2190
|
"text": "boolean"
|
|
2191
2191
|
},
|
|
@@ -10873,6 +10873,63 @@
|
|
|
10873
10873
|
}
|
|
10874
10874
|
]
|
|
10875
10875
|
},
|
|
10876
|
+
{
|
|
10877
|
+
"kind": "javascript-module",
|
|
10878
|
+
"path": "src/notification-group/NotificationGroup.ts",
|
|
10879
|
+
"declarations": [
|
|
10880
|
+
{
|
|
10881
|
+
"kind": "class",
|
|
10882
|
+
"description": "Notification group is used to position and style a group of notifications.",
|
|
10883
|
+
"name": "NotificationGroup",
|
|
10884
|
+
"slots": [
|
|
10885
|
+
{
|
|
10886
|
+
"description": "Default slot in which to place notifications.",
|
|
10887
|
+
"name": ""
|
|
10888
|
+
}
|
|
10889
|
+
],
|
|
10890
|
+
"members": [],
|
|
10891
|
+
"events": [
|
|
10892
|
+
{
|
|
10893
|
+
"type": {
|
|
10894
|
+
"text": "NordEvent"
|
|
10895
|
+
},
|
|
10896
|
+
"description": "Fired when a notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
10897
|
+
"name": "dismiss"
|
|
10898
|
+
}
|
|
10899
|
+
],
|
|
10900
|
+
"superclass": {
|
|
10901
|
+
"name": "LitElement",
|
|
10902
|
+
"package": "lit"
|
|
10903
|
+
},
|
|
10904
|
+
"localization": [],
|
|
10905
|
+
"status": "ready",
|
|
10906
|
+
"category": "feedback",
|
|
10907
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Notification](/components/notification/) so that notifications get styled and positioned correctly.\n- Add as close to the start of your main content area as possible.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than notification components\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
10908
|
+
"examples": [],
|
|
10909
|
+
"dependencies": [],
|
|
10910
|
+
"tagName": "nord-notification-group",
|
|
10911
|
+
"customElement": true
|
|
10912
|
+
}
|
|
10913
|
+
],
|
|
10914
|
+
"exports": [
|
|
10915
|
+
{
|
|
10916
|
+
"kind": "js",
|
|
10917
|
+
"name": "default",
|
|
10918
|
+
"declaration": {
|
|
10919
|
+
"name": "NotificationGroup",
|
|
10920
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10921
|
+
}
|
|
10922
|
+
},
|
|
10923
|
+
{
|
|
10924
|
+
"kind": "custom-element-definition",
|
|
10925
|
+
"name": "nord-notification-group",
|
|
10926
|
+
"declaration": {
|
|
10927
|
+
"name": "NotificationGroup",
|
|
10928
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10929
|
+
}
|
|
10930
|
+
}
|
|
10931
|
+
]
|
|
10932
|
+
},
|
|
10876
10933
|
{
|
|
10877
10934
|
"kind": "javascript-module",
|
|
10878
10935
|
"path": "src/popout/Popout.ts",
|
|
@@ -11218,92 +11275,35 @@
|
|
|
11218
11275
|
},
|
|
11219
11276
|
{
|
|
11220
11277
|
"kind": "javascript-module",
|
|
11221
|
-
"path": "src/
|
|
11278
|
+
"path": "src/progress-bar/ProgressBar.ts",
|
|
11222
11279
|
"declarations": [
|
|
11223
11280
|
{
|
|
11224
11281
|
"kind": "class",
|
|
11225
|
-
"description": "
|
|
11226
|
-
"name": "
|
|
11227
|
-
"
|
|
11282
|
+
"description": "Progress Bar is used to visually represent the completion\nof a task or process. It shows how much of the task has\nbeen completed and how much is still left.",
|
|
11283
|
+
"name": "ProgressBar",
|
|
11284
|
+
"cssProperties": [
|
|
11228
11285
|
{
|
|
11229
|
-
"description": "
|
|
11230
|
-
"name": ""
|
|
11286
|
+
"description": "Controls the thickness of the progress bar, using our [spacing tokens](/tokens/#space).",
|
|
11287
|
+
"name": "--n-progress-size",
|
|
11288
|
+
"default": "var(--n-space-s)"
|
|
11289
|
+
},
|
|
11290
|
+
{
|
|
11291
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
11292
|
+
"name": "--n-progress-border-radius",
|
|
11293
|
+
"default": "var(--n-border-radius-s)"
|
|
11294
|
+
},
|
|
11295
|
+
{
|
|
11296
|
+
"description": "Controls the color of the progress bar, using [color tokens](/tokens/#color).",
|
|
11297
|
+
"name": "--n-progress-color",
|
|
11298
|
+
"default": "var(--n-color-accent)"
|
|
11231
11299
|
}
|
|
11232
11300
|
],
|
|
11233
|
-
"members": [
|
|
11234
|
-
"events": [
|
|
11301
|
+
"members": [
|
|
11235
11302
|
{
|
|
11303
|
+
"kind": "field",
|
|
11304
|
+
"name": "value",
|
|
11236
11305
|
"type": {
|
|
11237
|
-
"text": "
|
|
11238
|
-
},
|
|
11239
|
-
"description": "Fired when a notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
11240
|
-
"name": "dismiss"
|
|
11241
|
-
}
|
|
11242
|
-
],
|
|
11243
|
-
"superclass": {
|
|
11244
|
-
"name": "LitElement",
|
|
11245
|
-
"package": "lit"
|
|
11246
|
-
},
|
|
11247
|
-
"localization": [],
|
|
11248
|
-
"status": "ready",
|
|
11249
|
-
"category": "feedback",
|
|
11250
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Notification](/components/notification/) so that notifications get styled and positioned correctly.\n- Add as close to the start of your main content area as possible.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than notification components\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
11251
|
-
"examples": [],
|
|
11252
|
-
"dependencies": [],
|
|
11253
|
-
"tagName": "nord-notification-group",
|
|
11254
|
-
"customElement": true
|
|
11255
|
-
}
|
|
11256
|
-
],
|
|
11257
|
-
"exports": [
|
|
11258
|
-
{
|
|
11259
|
-
"kind": "js",
|
|
11260
|
-
"name": "default",
|
|
11261
|
-
"declaration": {
|
|
11262
|
-
"name": "NotificationGroup",
|
|
11263
|
-
"module": "src/notification-group/NotificationGroup.ts"
|
|
11264
|
-
}
|
|
11265
|
-
},
|
|
11266
|
-
{
|
|
11267
|
-
"kind": "custom-element-definition",
|
|
11268
|
-
"name": "nord-notification-group",
|
|
11269
|
-
"declaration": {
|
|
11270
|
-
"name": "NotificationGroup",
|
|
11271
|
-
"module": "src/notification-group/NotificationGroup.ts"
|
|
11272
|
-
}
|
|
11273
|
-
}
|
|
11274
|
-
]
|
|
11275
|
-
},
|
|
11276
|
-
{
|
|
11277
|
-
"kind": "javascript-module",
|
|
11278
|
-
"path": "src/progress-bar/ProgressBar.ts",
|
|
11279
|
-
"declarations": [
|
|
11280
|
-
{
|
|
11281
|
-
"kind": "class",
|
|
11282
|
-
"description": "Progress Bar is used to visually represent the completion\nof a task or process. It shows how much of the task has\nbeen completed and how much is still left.",
|
|
11283
|
-
"name": "ProgressBar",
|
|
11284
|
-
"cssProperties": [
|
|
11285
|
-
{
|
|
11286
|
-
"description": "Controls the thickness of the progress bar, using our [spacing tokens](/tokens/#space).",
|
|
11287
|
-
"name": "--n-progress-size",
|
|
11288
|
-
"default": "var(--n-space-s)"
|
|
11289
|
-
},
|
|
11290
|
-
{
|
|
11291
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
11292
|
-
"name": "--n-progress-border-radius",
|
|
11293
|
-
"default": "var(--n-border-radius-s)"
|
|
11294
|
-
},
|
|
11295
|
-
{
|
|
11296
|
-
"description": "Controls the color of the progress bar, using [color tokens](/tokens/#color).",
|
|
11297
|
-
"name": "--n-progress-color",
|
|
11298
|
-
"default": "var(--n-color-accent)"
|
|
11299
|
-
}
|
|
11300
|
-
],
|
|
11301
|
-
"members": [
|
|
11302
|
-
{
|
|
11303
|
-
"kind": "field",
|
|
11304
|
-
"name": "value",
|
|
11305
|
-
"type": {
|
|
11306
|
-
"text": "number | undefined"
|
|
11306
|
+
"text": "number | undefined"
|
|
11307
11307
|
},
|
|
11308
11308
|
"description": "Specifies how much of the task has been completed. Must be a valid floating\npoint number between 0 and max, or between 0 and 100 if max is omitted. If\nthere is no value, the progress bar is indeterminate; this indicates that\nan activity is ongoing with no indication of how long it’s expected to take.",
|
|
11309
11309
|
"attribute": "value",
|
|
@@ -13740,86 +13740,6 @@
|
|
|
13740
13740
|
}
|
|
13741
13741
|
]
|
|
13742
13742
|
},
|
|
13743
|
-
{
|
|
13744
|
-
"kind": "javascript-module",
|
|
13745
|
-
"path": "src/skeleton/Skeleton.ts",
|
|
13746
|
-
"declarations": [
|
|
13747
|
-
{
|
|
13748
|
-
"kind": "class",
|
|
13749
|
-
"description": "Skeletons are used to provide a low fidelity representation of content\nbefore it appears in a view. This improves the perceived loading time\nfor our users.",
|
|
13750
|
-
"name": "Skeleton",
|
|
13751
|
-
"cssProperties": [
|
|
13752
|
-
{
|
|
13753
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
13754
|
-
"name": "--n-skeleton-border-radius",
|
|
13755
|
-
"default": "var(--n-border-radius)"
|
|
13756
|
-
},
|
|
13757
|
-
{
|
|
13758
|
-
"description": "Controls the main color of the skeleton, using our [color tokens](/tokens/#color).",
|
|
13759
|
-
"name": "--n-skeleton-color",
|
|
13760
|
-
"default": "var(--n-color-border)"
|
|
13761
|
-
},
|
|
13762
|
-
{
|
|
13763
|
-
"description": "Controls the sheen color of the skeleton, using our [color tokens](/tokens/#color).",
|
|
13764
|
-
"name": "--n-skeleton-sheen-color",
|
|
13765
|
-
"default": "var(--n-color-border-strong)"
|
|
13766
|
-
}
|
|
13767
|
-
],
|
|
13768
|
-
"members": [
|
|
13769
|
-
{
|
|
13770
|
-
"kind": "field",
|
|
13771
|
-
"name": "effect",
|
|
13772
|
-
"type": {
|
|
13773
|
-
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
13774
|
-
},
|
|
13775
|
-
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
13776
|
-
"attribute": "effect",
|
|
13777
|
-
"reflects": true
|
|
13778
|
-
}
|
|
13779
|
-
],
|
|
13780
|
-
"attributes": [
|
|
13781
|
-
{
|
|
13782
|
-
"name": "effect",
|
|
13783
|
-
"type": {
|
|
13784
|
-
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
13785
|
-
},
|
|
13786
|
-
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
13787
|
-
"fieldName": "effect"
|
|
13788
|
-
}
|
|
13789
|
-
],
|
|
13790
|
-
"superclass": {
|
|
13791
|
-
"name": "LitElement",
|
|
13792
|
-
"package": "lit"
|
|
13793
|
-
},
|
|
13794
|
-
"localization": [],
|
|
13795
|
-
"status": "ready",
|
|
13796
|
-
"category": "feedback",
|
|
13797
|
-
"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 skeleton component for dynamic content only.\n- Use to give the user an indication of what the page layout will be like once loaded.\n- Mimick the actual layout using multiple Skeleton components.\n- Use `aria-busy=\"true\"` to indicate which area on the screen is currently loading and remove it or set it to `false` once loaded.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use Skeleton component for static content.\n- Don’t show placeholder content after Skeleton disappears that will change when the page fully loads.\n\n</div>\n",
|
|
13798
|
-
"examples": [],
|
|
13799
|
-
"dependencies": [],
|
|
13800
|
-
"tagName": "nord-skeleton",
|
|
13801
|
-
"customElement": true
|
|
13802
|
-
}
|
|
13803
|
-
],
|
|
13804
|
-
"exports": [
|
|
13805
|
-
{
|
|
13806
|
-
"kind": "js",
|
|
13807
|
-
"name": "default",
|
|
13808
|
-
"declaration": {
|
|
13809
|
-
"name": "Skeleton",
|
|
13810
|
-
"module": "src/skeleton/Skeleton.ts"
|
|
13811
|
-
}
|
|
13812
|
-
},
|
|
13813
|
-
{
|
|
13814
|
-
"kind": "custom-element-definition",
|
|
13815
|
-
"name": "nord-skeleton",
|
|
13816
|
-
"declaration": {
|
|
13817
|
-
"name": "Skeleton",
|
|
13818
|
-
"module": "src/skeleton/Skeleton.ts"
|
|
13819
|
-
}
|
|
13820
|
-
}
|
|
13821
|
-
]
|
|
13822
|
-
},
|
|
13823
13743
|
{
|
|
13824
13744
|
"kind": "javascript-module",
|
|
13825
13745
|
"path": "src/select/Select.ts",
|
|
@@ -14628,77 +14548,49 @@
|
|
|
14628
14548
|
},
|
|
14629
14549
|
{
|
|
14630
14550
|
"kind": "javascript-module",
|
|
14631
|
-
"path": "src/
|
|
14551
|
+
"path": "src/skeleton/Skeleton.ts",
|
|
14632
14552
|
"declarations": [
|
|
14633
14553
|
{
|
|
14634
14554
|
"kind": "class",
|
|
14635
|
-
"description": "
|
|
14636
|
-
"name": "
|
|
14555
|
+
"description": "Skeletons are used to provide a low fidelity representation of content\nbefore it appears in a view. This improves the perceived loading time\nfor our users.",
|
|
14556
|
+
"name": "Skeleton",
|
|
14637
14557
|
"cssProperties": [
|
|
14638
14558
|
{
|
|
14639
|
-
"description": "Controls
|
|
14640
|
-
"name": "--n-
|
|
14641
|
-
"default": "var(--n-
|
|
14642
|
-
}
|
|
14643
|
-
],
|
|
14644
|
-
"members": [
|
|
14645
|
-
{
|
|
14646
|
-
"kind": "field",
|
|
14647
|
-
"name": "size",
|
|
14648
|
-
"type": {
|
|
14649
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
14650
|
-
},
|
|
14651
|
-
"default": "\"m\"",
|
|
14652
|
-
"description": "The size of the spinner.",
|
|
14653
|
-
"attribute": "size",
|
|
14654
|
-
"reflects": true
|
|
14559
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
14560
|
+
"name": "--n-skeleton-border-radius",
|
|
14561
|
+
"default": "var(--n-border-radius)"
|
|
14655
14562
|
},
|
|
14656
14563
|
{
|
|
14657
|
-
"
|
|
14658
|
-
"name": "color",
|
|
14659
|
-
"
|
|
14660
|
-
"text": "string | undefined"
|
|
14661
|
-
},
|
|
14662
|
-
"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.",
|
|
14663
|
-
"attribute": "color",
|
|
14664
|
-
"reflects": true
|
|
14564
|
+
"description": "Controls the main color of the skeleton, using our [color tokens](/tokens/#color).",
|
|
14565
|
+
"name": "--n-skeleton-color",
|
|
14566
|
+
"default": "var(--n-color-border)"
|
|
14665
14567
|
},
|
|
14568
|
+
{
|
|
14569
|
+
"description": "Controls the sheen color of the skeleton, using our [color tokens](/tokens/#color).",
|
|
14570
|
+
"name": "--n-skeleton-sheen-color",
|
|
14571
|
+
"default": "var(--n-color-border-strong)"
|
|
14572
|
+
}
|
|
14573
|
+
],
|
|
14574
|
+
"members": [
|
|
14666
14575
|
{
|
|
14667
14576
|
"kind": "field",
|
|
14668
|
-
"name": "
|
|
14577
|
+
"name": "effect",
|
|
14669
14578
|
"type": {
|
|
14670
|
-
"text": "
|
|
14579
|
+
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
14671
14580
|
},
|
|
14672
|
-
"description": "
|
|
14673
|
-
"attribute": "
|
|
14581
|
+
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
14582
|
+
"attribute": "effect",
|
|
14674
14583
|
"reflects": true
|
|
14675
14584
|
}
|
|
14676
14585
|
],
|
|
14677
14586
|
"attributes": [
|
|
14678
14587
|
{
|
|
14679
|
-
"name": "
|
|
14680
|
-
"type": {
|
|
14681
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
14682
|
-
},
|
|
14683
|
-
"default": "\"m\"",
|
|
14684
|
-
"description": "The size of the spinner.",
|
|
14685
|
-
"fieldName": "size"
|
|
14686
|
-
},
|
|
14687
|
-
{
|
|
14688
|
-
"name": "color",
|
|
14689
|
-
"type": {
|
|
14690
|
-
"text": "string | undefined"
|
|
14691
|
-
},
|
|
14692
|
-
"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.",
|
|
14693
|
-
"fieldName": "color"
|
|
14694
|
-
},
|
|
14695
|
-
{
|
|
14696
|
-
"name": "label",
|
|
14588
|
+
"name": "effect",
|
|
14697
14589
|
"type": {
|
|
14698
|
-
"text": "
|
|
14590
|
+
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
14699
14591
|
},
|
|
14700
|
-
"description": "
|
|
14701
|
-
"fieldName": "
|
|
14592
|
+
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
14593
|
+
"fieldName": "effect"
|
|
14702
14594
|
}
|
|
14703
14595
|
],
|
|
14704
14596
|
"superclass": {
|
|
@@ -14708,10 +14600,10 @@
|
|
|
14708
14600
|
"localization": [],
|
|
14709
14601
|
"status": "ready",
|
|
14710
14602
|
"category": "feedback",
|
|
14711
|
-
"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
|
|
14603
|
+
"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 skeleton component for dynamic content only.\n- Use to give the user an indication of what the page layout will be like once loaded.\n- Mimick the actual layout using multiple Skeleton components.\n- Use `aria-busy=\"true\"` to indicate which area on the screen is currently loading and remove it or set it to `false` once loaded.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use Skeleton component for static content.\n- Don’t show placeholder content after Skeleton disappears that will change when the page fully loads.\n\n</div>\n",
|
|
14712
14604
|
"examples": [],
|
|
14713
14605
|
"dependencies": [],
|
|
14714
|
-
"tagName": "nord-
|
|
14606
|
+
"tagName": "nord-skeleton",
|
|
14715
14607
|
"customElement": true
|
|
14716
14608
|
}
|
|
14717
14609
|
],
|
|
@@ -14720,16 +14612,16 @@
|
|
|
14720
14612
|
"kind": "js",
|
|
14721
14613
|
"name": "default",
|
|
14722
14614
|
"declaration": {
|
|
14723
|
-
"name": "
|
|
14724
|
-
"module": "src/
|
|
14615
|
+
"name": "Skeleton",
|
|
14616
|
+
"module": "src/skeleton/Skeleton.ts"
|
|
14725
14617
|
}
|
|
14726
14618
|
},
|
|
14727
14619
|
{
|
|
14728
14620
|
"kind": "custom-element-definition",
|
|
14729
|
-
"name": "nord-
|
|
14621
|
+
"name": "nord-skeleton",
|
|
14730
14622
|
"declaration": {
|
|
14731
|
-
"name": "
|
|
14732
|
-
"module": "src/
|
|
14623
|
+
"name": "Skeleton",
|
|
14624
|
+
"module": "src/skeleton/Skeleton.ts"
|
|
14733
14625
|
}
|
|
14734
14626
|
}
|
|
14735
14627
|
]
|
|
@@ -14987,39 +14879,147 @@
|
|
|
14987
14879
|
},
|
|
14988
14880
|
{
|
|
14989
14881
|
"kind": "javascript-module",
|
|
14990
|
-
"path": "src/
|
|
14882
|
+
"path": "src/spinner/Spinner.ts",
|
|
14991
14883
|
"declarations": [
|
|
14992
14884
|
{
|
|
14993
14885
|
"kind": "class",
|
|
14994
|
-
"description": "
|
|
14995
|
-
"name": "
|
|
14886
|
+
"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.",
|
|
14887
|
+
"name": "Spinner",
|
|
14996
14888
|
"cssProperties": [
|
|
14997
14889
|
{
|
|
14998
|
-
"description": "Controls the
|
|
14999
|
-
"name": "--n-
|
|
15000
|
-
"default": "
|
|
15001
|
-
}
|
|
15002
|
-
],
|
|
15003
|
-
"slots": [
|
|
15004
|
-
{
|
|
15005
|
-
"description": "The element which contains the content to be revealed.",
|
|
15006
|
-
"name": ""
|
|
15007
|
-
},
|
|
15008
|
-
{
|
|
15009
|
-
"description": "The element which contains all tabs to reveal tabbed content.",
|
|
15010
|
-
"name": "tab"
|
|
14890
|
+
"description": "Controls the color the spinner.",
|
|
14891
|
+
"name": "--n-spinner-color",
|
|
14892
|
+
"default": "var(--n-color-accent)"
|
|
15011
14893
|
}
|
|
15012
14894
|
],
|
|
15013
14895
|
"members": [
|
|
15014
14896
|
{
|
|
15015
14897
|
"kind": "field",
|
|
15016
|
-
"name": "
|
|
15017
|
-
"
|
|
15018
|
-
|
|
15019
|
-
|
|
15020
|
-
|
|
15021
|
-
"
|
|
15022
|
-
"
|
|
14898
|
+
"name": "size",
|
|
14899
|
+
"type": {
|
|
14900
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
14901
|
+
},
|
|
14902
|
+
"default": "\"m\"",
|
|
14903
|
+
"description": "The size of the spinner.",
|
|
14904
|
+
"attribute": "size",
|
|
14905
|
+
"reflects": true
|
|
14906
|
+
},
|
|
14907
|
+
{
|
|
14908
|
+
"kind": "field",
|
|
14909
|
+
"name": "color",
|
|
14910
|
+
"type": {
|
|
14911
|
+
"text": "string | undefined"
|
|
14912
|
+
},
|
|
14913
|
+
"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.",
|
|
14914
|
+
"attribute": "color",
|
|
14915
|
+
"reflects": true
|
|
14916
|
+
},
|
|
14917
|
+
{
|
|
14918
|
+
"kind": "field",
|
|
14919
|
+
"name": "label",
|
|
14920
|
+
"type": {
|
|
14921
|
+
"text": "string | undefined"
|
|
14922
|
+
},
|
|
14923
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
14924
|
+
"attribute": "label",
|
|
14925
|
+
"reflects": true
|
|
14926
|
+
}
|
|
14927
|
+
],
|
|
14928
|
+
"attributes": [
|
|
14929
|
+
{
|
|
14930
|
+
"name": "size",
|
|
14931
|
+
"type": {
|
|
14932
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
14933
|
+
},
|
|
14934
|
+
"default": "\"m\"",
|
|
14935
|
+
"description": "The size of the spinner.",
|
|
14936
|
+
"fieldName": "size"
|
|
14937
|
+
},
|
|
14938
|
+
{
|
|
14939
|
+
"name": "color",
|
|
14940
|
+
"type": {
|
|
14941
|
+
"text": "string | undefined"
|
|
14942
|
+
},
|
|
14943
|
+
"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.",
|
|
14944
|
+
"fieldName": "color"
|
|
14945
|
+
},
|
|
14946
|
+
{
|
|
14947
|
+
"name": "label",
|
|
14948
|
+
"type": {
|
|
14949
|
+
"text": "string | undefined"
|
|
14950
|
+
},
|
|
14951
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
14952
|
+
"fieldName": "label"
|
|
14953
|
+
}
|
|
14954
|
+
],
|
|
14955
|
+
"superclass": {
|
|
14956
|
+
"name": "LitElement",
|
|
14957
|
+
"package": "lit"
|
|
14958
|
+
},
|
|
14959
|
+
"localization": [],
|
|
14960
|
+
"status": "ready",
|
|
14961
|
+
"category": "feedback",
|
|
14962
|
+
"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",
|
|
14963
|
+
"examples": [],
|
|
14964
|
+
"dependencies": [],
|
|
14965
|
+
"tagName": "nord-spinner",
|
|
14966
|
+
"customElement": true
|
|
14967
|
+
}
|
|
14968
|
+
],
|
|
14969
|
+
"exports": [
|
|
14970
|
+
{
|
|
14971
|
+
"kind": "js",
|
|
14972
|
+
"name": "default",
|
|
14973
|
+
"declaration": {
|
|
14974
|
+
"name": "Spinner",
|
|
14975
|
+
"module": "src/spinner/Spinner.ts"
|
|
14976
|
+
}
|
|
14977
|
+
},
|
|
14978
|
+
{
|
|
14979
|
+
"kind": "custom-element-definition",
|
|
14980
|
+
"name": "nord-spinner",
|
|
14981
|
+
"declaration": {
|
|
14982
|
+
"name": "Spinner",
|
|
14983
|
+
"module": "src/spinner/Spinner.ts"
|
|
14984
|
+
}
|
|
14985
|
+
}
|
|
14986
|
+
]
|
|
14987
|
+
},
|
|
14988
|
+
{
|
|
14989
|
+
"kind": "javascript-module",
|
|
14990
|
+
"path": "src/tab-group/TabGroup.ts",
|
|
14991
|
+
"declarations": [
|
|
14992
|
+
{
|
|
14993
|
+
"kind": "class",
|
|
14994
|
+
"description": "Tab Group allows multiple panels to be contained within a single window,\nusing tabs as a navigational element.",
|
|
14995
|
+
"name": "TabGroup",
|
|
14996
|
+
"cssProperties": [
|
|
14997
|
+
{
|
|
14998
|
+
"description": "Controls the padding around the tab group (including the tab list), using our [spacing tokens](/tokens/#space).",
|
|
14999
|
+
"name": "--n-tab-group-padding",
|
|
15000
|
+
"default": "0"
|
|
15001
|
+
}
|
|
15002
|
+
],
|
|
15003
|
+
"slots": [
|
|
15004
|
+
{
|
|
15005
|
+
"description": "The element which contains the content to be revealed.",
|
|
15006
|
+
"name": ""
|
|
15007
|
+
},
|
|
15008
|
+
{
|
|
15009
|
+
"description": "The element which contains all tabs to reveal tabbed content.",
|
|
15010
|
+
"name": "tab"
|
|
15011
|
+
}
|
|
15012
|
+
],
|
|
15013
|
+
"members": [
|
|
15014
|
+
{
|
|
15015
|
+
"kind": "field",
|
|
15016
|
+
"name": "direction",
|
|
15017
|
+
"privacy": "private",
|
|
15018
|
+
"default": "new DirectionController(this)"
|
|
15019
|
+
},
|
|
15020
|
+
{
|
|
15021
|
+
"kind": "field",
|
|
15022
|
+
"name": "observer",
|
|
15023
15023
|
"type": {
|
|
15024
15024
|
"text": "MutationObserver | undefined"
|
|
15025
15025
|
},
|
|
@@ -15231,54 +15231,6 @@
|
|
|
15231
15231
|
}
|
|
15232
15232
|
]
|
|
15233
15233
|
},
|
|
15234
|
-
{
|
|
15235
|
-
"kind": "javascript-module",
|
|
15236
|
-
"path": "src/tab-panel/TabPanel.ts",
|
|
15237
|
-
"declarations": [
|
|
15238
|
-
{
|
|
15239
|
-
"kind": "class",
|
|
15240
|
-
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15241
|
-
"name": "TabPanel",
|
|
15242
|
-
"slots": [
|
|
15243
|
-
{
|
|
15244
|
-
"description": "The tab panel content.",
|
|
15245
|
-
"name": ""
|
|
15246
|
-
}
|
|
15247
|
-
],
|
|
15248
|
-
"members": [],
|
|
15249
|
-
"superclass": {
|
|
15250
|
-
"name": "LitElement",
|
|
15251
|
-
"package": "lit"
|
|
15252
|
-
},
|
|
15253
|
-
"localization": [],
|
|
15254
|
-
"status": "ready",
|
|
15255
|
-
"category": "navigation",
|
|
15256
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab panel component within the tab group component.\n- Use both non-interactive and interactive elements within the contents of the tab panel.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use the tab panel component outside of the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the related tab component to select the tab but prevent the order of the tabs being affected.\n",
|
|
15257
|
-
"examples": [],
|
|
15258
|
-
"dependencies": [],
|
|
15259
|
-
"tagName": "nord-tab-panel",
|
|
15260
|
-
"customElement": true
|
|
15261
|
-
}
|
|
15262
|
-
],
|
|
15263
|
-
"exports": [
|
|
15264
|
-
{
|
|
15265
|
-
"kind": "js",
|
|
15266
|
-
"name": "default",
|
|
15267
|
-
"declaration": {
|
|
15268
|
-
"name": "TabPanel",
|
|
15269
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
15270
|
-
}
|
|
15271
|
-
},
|
|
15272
|
-
{
|
|
15273
|
-
"kind": "custom-element-definition",
|
|
15274
|
-
"name": "nord-tab-panel",
|
|
15275
|
-
"declaration": {
|
|
15276
|
-
"name": "TabPanel",
|
|
15277
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
15278
|
-
}
|
|
15279
|
-
}
|
|
15280
|
-
]
|
|
15281
|
-
},
|
|
15282
15234
|
{
|
|
15283
15235
|
"kind": "javascript-module",
|
|
15284
15236
|
"path": "src/table/Table.ts",
|
|
@@ -15425,6 +15377,54 @@
|
|
|
15425
15377
|
}
|
|
15426
15378
|
]
|
|
15427
15379
|
},
|
|
15380
|
+
{
|
|
15381
|
+
"kind": "javascript-module",
|
|
15382
|
+
"path": "src/tab-panel/TabPanel.ts",
|
|
15383
|
+
"declarations": [
|
|
15384
|
+
{
|
|
15385
|
+
"kind": "class",
|
|
15386
|
+
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15387
|
+
"name": "TabPanel",
|
|
15388
|
+
"slots": [
|
|
15389
|
+
{
|
|
15390
|
+
"description": "The tab panel content.",
|
|
15391
|
+
"name": ""
|
|
15392
|
+
}
|
|
15393
|
+
],
|
|
15394
|
+
"members": [],
|
|
15395
|
+
"superclass": {
|
|
15396
|
+
"name": "LitElement",
|
|
15397
|
+
"package": "lit"
|
|
15398
|
+
},
|
|
15399
|
+
"localization": [],
|
|
15400
|
+
"status": "ready",
|
|
15401
|
+
"category": "navigation",
|
|
15402
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab panel component within the tab group component.\n- Use both non-interactive and interactive elements within the contents of the tab panel.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use the tab panel component outside of the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the related tab component to select the tab but prevent the order of the tabs being affected.\n",
|
|
15403
|
+
"examples": [],
|
|
15404
|
+
"dependencies": [],
|
|
15405
|
+
"tagName": "nord-tab-panel",
|
|
15406
|
+
"customElement": true
|
|
15407
|
+
}
|
|
15408
|
+
],
|
|
15409
|
+
"exports": [
|
|
15410
|
+
{
|
|
15411
|
+
"kind": "js",
|
|
15412
|
+
"name": "default",
|
|
15413
|
+
"declaration": {
|
|
15414
|
+
"name": "TabPanel",
|
|
15415
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15416
|
+
}
|
|
15417
|
+
},
|
|
15418
|
+
{
|
|
15419
|
+
"kind": "custom-element-definition",
|
|
15420
|
+
"name": "nord-tab-panel",
|
|
15421
|
+
"declaration": {
|
|
15422
|
+
"name": "TabPanel",
|
|
15423
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15424
|
+
}
|
|
15425
|
+
}
|
|
15426
|
+
]
|
|
15427
|
+
},
|
|
15428
15428
|
{
|
|
15429
15429
|
"kind": "javascript-module",
|
|
15430
15430
|
"path": "src/tag/Tag.ts",
|
|
@@ -17252,231 +17252,392 @@
|
|
|
17252
17252
|
},
|
|
17253
17253
|
{
|
|
17254
17254
|
"kind": "javascript-module",
|
|
17255
|
-
"path": "src/
|
|
17255
|
+
"path": "src/toast-group/ToastGroup.ts",
|
|
17256
17256
|
"declarations": [
|
|
17257
17257
|
{
|
|
17258
17258
|
"kind": "class",
|
|
17259
|
-
"description": "
|
|
17260
|
-
"name": "
|
|
17261
|
-
"cssProperties": [
|
|
17262
|
-
{
|
|
17263
|
-
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
17264
|
-
"name": "--n-label-color",
|
|
17265
|
-
"default": "var(--n-color-text)"
|
|
17266
|
-
}
|
|
17267
|
-
],
|
|
17259
|
+
"description": "Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.",
|
|
17260
|
+
"name": "ToastGroup",
|
|
17268
17261
|
"slots": [
|
|
17269
17262
|
{
|
|
17270
|
-
"description": "
|
|
17271
|
-
"name": "
|
|
17272
|
-
},
|
|
17273
|
-
{
|
|
17274
|
-
"description": "Optional slot that holds hint text for the input.",
|
|
17275
|
-
"name": "hint"
|
|
17276
|
-
},
|
|
17277
|
-
{
|
|
17278
|
-
"description": "Optional slot that holds error text for the input.",
|
|
17279
|
-
"name": "error"
|
|
17263
|
+
"description": "Default slot in which to place toasts.",
|
|
17264
|
+
"name": ""
|
|
17280
17265
|
}
|
|
17281
17266
|
],
|
|
17282
17267
|
"members": [
|
|
17283
17268
|
{
|
|
17284
|
-
"kind": "
|
|
17285
|
-
"name": "
|
|
17286
|
-
"
|
|
17287
|
-
|
|
17288
|
-
|
|
17289
|
-
|
|
17290
|
-
|
|
17291
|
-
|
|
17292
|
-
|
|
17293
|
-
|
|
17294
|
-
|
|
17295
|
-
|
|
17269
|
+
"kind": "method",
|
|
17270
|
+
"name": "addToast",
|
|
17271
|
+
"parameters": [
|
|
17272
|
+
{
|
|
17273
|
+
"name": "text",
|
|
17274
|
+
"type": {
|
|
17275
|
+
"text": "string"
|
|
17276
|
+
},
|
|
17277
|
+
"description": "The text/message of the toast."
|
|
17278
|
+
},
|
|
17279
|
+
{
|
|
17280
|
+
"name": "options",
|
|
17281
|
+
"default": "{}",
|
|
17282
|
+
"type": {
|
|
17283
|
+
"text": "ToastOptions"
|
|
17284
|
+
},
|
|
17285
|
+
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
17286
|
+
}
|
|
17287
|
+
],
|
|
17288
|
+
"description": "Convenience method for creating and adding a toast to the group.",
|
|
17289
|
+
"return": {
|
|
17290
|
+
"type": {
|
|
17291
|
+
"text": "Toast"
|
|
17292
|
+
}
|
|
17293
|
+
}
|
|
17294
|
+
}
|
|
17295
|
+
],
|
|
17296
|
+
"events": [
|
|
17297
|
+
{
|
|
17296
17298
|
"type": {
|
|
17297
|
-
"text": "
|
|
17299
|
+
"text": "NordEvent"
|
|
17298
17300
|
},
|
|
17299
|
-
"
|
|
17300
|
-
"
|
|
17301
|
-
|
|
17301
|
+
"description": "Fired when a toast is dismissed (via user action or auto-dismiss), and its exit animation has completed. This event should be used to remove the dismissed toast from the DOM.",
|
|
17302
|
+
"name": "dismiss"
|
|
17303
|
+
}
|
|
17304
|
+
],
|
|
17305
|
+
"superclass": {
|
|
17306
|
+
"name": "LitElement",
|
|
17307
|
+
"package": "lit"
|
|
17308
|
+
},
|
|
17309
|
+
"localization": [],
|
|
17310
|
+
"status": "ready",
|
|
17311
|
+
"category": "feedback",
|
|
17312
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Toast](/components/toast/) so that toasts get styled and announced to screen readers correctly.\n- Add as close to the bottom of the document as possible, ideally near the body closing tag, to maintain correct stacking order.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than toast components\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and understandable by the user:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n",
|
|
17313
|
+
"examples": [],
|
|
17314
|
+
"dependencies": [
|
|
17315
|
+
"toast"
|
|
17316
|
+
],
|
|
17317
|
+
"tagName": "nord-toast-group",
|
|
17318
|
+
"customElement": true
|
|
17319
|
+
}
|
|
17320
|
+
],
|
|
17321
|
+
"exports": [
|
|
17322
|
+
{
|
|
17323
|
+
"kind": "js",
|
|
17324
|
+
"name": "default",
|
|
17325
|
+
"declaration": {
|
|
17326
|
+
"name": "ToastGroup",
|
|
17327
|
+
"module": "src/toast-group/ToastGroup.ts"
|
|
17328
|
+
}
|
|
17329
|
+
},
|
|
17330
|
+
{
|
|
17331
|
+
"kind": "custom-element-definition",
|
|
17332
|
+
"name": "nord-toast-group",
|
|
17333
|
+
"declaration": {
|
|
17334
|
+
"name": "ToastGroup",
|
|
17335
|
+
"module": "src/toast-group/ToastGroup.ts"
|
|
17336
|
+
}
|
|
17337
|
+
}
|
|
17338
|
+
]
|
|
17339
|
+
},
|
|
17340
|
+
{
|
|
17341
|
+
"kind": "javascript-module",
|
|
17342
|
+
"path": "src/tooltip/Tooltip.ts",
|
|
17343
|
+
"declarations": [
|
|
17344
|
+
{
|
|
17345
|
+
"kind": "class",
|
|
17346
|
+
"description": "Tooltips are floating containers for displaying additional information\nfor the currently focused element. A tooltip can be useful when you want\nto e.g. give a hint about an existing Command Menu shortcut.",
|
|
17347
|
+
"name": "Tooltip",
|
|
17348
|
+
"cssProperties": [
|
|
17349
|
+
{
|
|
17350
|
+
"description": "Controls the maximum inline size, or width, of the tooltip.",
|
|
17351
|
+
"name": "--n-tooltip-max-size",
|
|
17352
|
+
"default": "50ch"
|
|
17353
|
+
}
|
|
17354
|
+
],
|
|
17355
|
+
"slots": [
|
|
17356
|
+
{
|
|
17357
|
+
"description": "The tooltip content",
|
|
17358
|
+
"name": ""
|
|
17359
|
+
},
|
|
17360
|
+
{
|
|
17361
|
+
"description": "Optional slot that holds shortcut keys to access the subject",
|
|
17362
|
+
"name": "shortcut"
|
|
17363
|
+
}
|
|
17364
|
+
],
|
|
17365
|
+
"members": [
|
|
17366
|
+
{
|
|
17367
|
+
"kind": "field",
|
|
17368
|
+
"name": "lastOpened",
|
|
17369
|
+
"type": {
|
|
17370
|
+
"text": "Tooltip | undefined"
|
|
17371
|
+
},
|
|
17372
|
+
"privacy": "private",
|
|
17373
|
+
"static": true
|
|
17374
|
+
},
|
|
17375
|
+
{
|
|
17376
|
+
"kind": "field",
|
|
17377
|
+
"name": "shortcutSlot",
|
|
17378
|
+
"privacy": "private",
|
|
17379
|
+
"default": "new SlotController(this, \"shortcut\")"
|
|
17380
|
+
},
|
|
17381
|
+
{
|
|
17382
|
+
"kind": "field",
|
|
17383
|
+
"name": "events",
|
|
17384
|
+
"privacy": "private",
|
|
17385
|
+
"default": "new EventController(this)"
|
|
17386
|
+
},
|
|
17387
|
+
{
|
|
17388
|
+
"kind": "field",
|
|
17389
|
+
"name": "currentElement",
|
|
17390
|
+
"type": {
|
|
17391
|
+
"text": "FocusableElement | undefined"
|
|
17392
|
+
},
|
|
17393
|
+
"privacy": "private"
|
|
17394
|
+
},
|
|
17395
|
+
{
|
|
17396
|
+
"kind": "field",
|
|
17397
|
+
"name": "timeoutId",
|
|
17398
|
+
"type": {
|
|
17399
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
17400
|
+
},
|
|
17401
|
+
"privacy": "private"
|
|
17402
|
+
},
|
|
17403
|
+
{
|
|
17404
|
+
"kind": "field",
|
|
17405
|
+
"name": "proxy",
|
|
17406
|
+
"type": {
|
|
17407
|
+
"text": "HTMLSpanElement | undefined"
|
|
17408
|
+
},
|
|
17409
|
+
"privacy": "private",
|
|
17410
|
+
"description": "the proxy element is for cases where the targetElement is a web component,\nand the WC has a focusable child in its shadow root e.g. a button component.\nin this case, when the tooltip is shown, we inject the proxy into targetElement's shadow root\nand wire up aria-describedby from the focusable element to the proxy.\nwhen the tooltip is hidden, we remove the proxy and remove the aria-describedby relationship."
|
|
17411
|
+
},
|
|
17412
|
+
{
|
|
17413
|
+
"kind": "field",
|
|
17414
|
+
"name": "state",
|
|
17415
|
+
"type": {
|
|
17416
|
+
"text": "TooltipStates"
|
|
17417
|
+
},
|
|
17418
|
+
"privacy": "private",
|
|
17419
|
+
"default": "\"hidden\"",
|
|
17420
|
+
"description": "The current state of the tooltip, dependent on the state machine"
|
|
17421
|
+
},
|
|
17422
|
+
{
|
|
17423
|
+
"kind": "field",
|
|
17424
|
+
"name": "coords",
|
|
17425
|
+
"type": {
|
|
17426
|
+
"text": "[number, number]"
|
|
17427
|
+
},
|
|
17428
|
+
"privacy": "private",
|
|
17429
|
+
"default": "[0, 0]"
|
|
17430
|
+
},
|
|
17431
|
+
{
|
|
17432
|
+
"kind": "field",
|
|
17433
|
+
"name": "position",
|
|
17434
|
+
"type": {
|
|
17435
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
17436
|
+
},
|
|
17437
|
+
"default": "\"block-start\"",
|
|
17438
|
+
"description": "Control the position of the tooltip component.\nWhen set to \"none\", the tooltip will be shown above\nbut accommodate for browser boundaries.",
|
|
17439
|
+
"attribute": "position",
|
|
17302
17440
|
"reflects": true
|
|
17303
17441
|
},
|
|
17304
17442
|
{
|
|
17305
17443
|
"kind": "field",
|
|
17306
|
-
"name": "
|
|
17444
|
+
"name": "role",
|
|
17307
17445
|
"type": {
|
|
17308
|
-
"text": "
|
|
17446
|
+
"text": "string"
|
|
17309
17447
|
},
|
|
17310
|
-
"default": "
|
|
17311
|
-
"description": "
|
|
17312
|
-
"attribute": "
|
|
17448
|
+
"default": "\"tooltip\"",
|
|
17449
|
+
"description": "The tooltip role, set on the component by default.",
|
|
17450
|
+
"attribute": "role",
|
|
17313
17451
|
"reflects": true
|
|
17314
17452
|
},
|
|
17315
17453
|
{
|
|
17316
17454
|
"kind": "field",
|
|
17317
|
-
"name": "
|
|
17455
|
+
"name": "id",
|
|
17318
17456
|
"type": {
|
|
17319
|
-
"text": "
|
|
17457
|
+
"text": "string"
|
|
17320
17458
|
},
|
|
17321
|
-
"default": "\"
|
|
17322
|
-
"description": "The
|
|
17323
|
-
"attribute": "
|
|
17459
|
+
"default": "\"\"",
|
|
17460
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
17461
|
+
"attribute": "id",
|
|
17462
|
+
"reflects": true
|
|
17463
|
+
},
|
|
17464
|
+
{
|
|
17465
|
+
"kind": "field",
|
|
17466
|
+
"name": "delay",
|
|
17467
|
+
"type": {
|
|
17468
|
+
"text": "number"
|
|
17469
|
+
},
|
|
17470
|
+
"default": "500",
|
|
17471
|
+
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
17472
|
+
"attribute": "delay",
|
|
17324
17473
|
"reflects": true
|
|
17325
17474
|
},
|
|
17326
17475
|
{
|
|
17327
17476
|
"kind": "method",
|
|
17328
|
-
"name": "
|
|
17329
|
-
"privacy": "protected"
|
|
17477
|
+
"name": "handleIdChange",
|
|
17478
|
+
"privacy": "protected"
|
|
17479
|
+
},
|
|
17480
|
+
{
|
|
17481
|
+
"kind": "method",
|
|
17482
|
+
"name": "handleStateChange",
|
|
17483
|
+
"privacy": "private",
|
|
17330
17484
|
"parameters": [
|
|
17331
17485
|
{
|
|
17332
|
-
"name": "
|
|
17486
|
+
"name": "prevState",
|
|
17333
17487
|
"type": {
|
|
17334
|
-
"text": "
|
|
17488
|
+
"text": "TooltipStates"
|
|
17335
17489
|
}
|
|
17336
17490
|
}
|
|
17337
|
-
]
|
|
17338
|
-
"return": {
|
|
17339
|
-
"type": {
|
|
17340
|
-
"text": "void"
|
|
17341
|
-
}
|
|
17342
|
-
},
|
|
17343
|
-
"inheritedFrom": {
|
|
17344
|
-
"name": "FormAssociatedMixin",
|
|
17345
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17346
|
-
}
|
|
17491
|
+
]
|
|
17347
17492
|
},
|
|
17348
17493
|
{
|
|
17349
17494
|
"kind": "field",
|
|
17350
|
-
"name": "
|
|
17351
|
-
"privacy": "
|
|
17352
|
-
"
|
|
17353
|
-
"inheritedFrom": {
|
|
17354
|
-
"name": "FormAssociatedMixin",
|
|
17355
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17356
|
-
}
|
|
17495
|
+
"name": "updatePosition",
|
|
17496
|
+
"privacy": "private",
|
|
17497
|
+
"description": "Setting and updating the position of the tooltip"
|
|
17357
17498
|
},
|
|
17358
17499
|
{
|
|
17359
17500
|
"kind": "field",
|
|
17360
|
-
"name": "
|
|
17361
|
-
"privacy": "
|
|
17362
|
-
"default": "new SlotController(this, \"error\")",
|
|
17363
|
-
"inheritedFrom": {
|
|
17364
|
-
"name": "FormAssociatedMixin",
|
|
17365
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17366
|
-
}
|
|
17501
|
+
"name": "hideTooltip",
|
|
17502
|
+
"privacy": "private"
|
|
17367
17503
|
},
|
|
17368
17504
|
{
|
|
17369
17505
|
"kind": "field",
|
|
17370
|
-
"name": "
|
|
17371
|
-
"privacy": "
|
|
17372
|
-
"default": "new SlotController(this, \"hint\")",
|
|
17373
|
-
"inheritedFrom": {
|
|
17374
|
-
"name": "FormAssociatedMixin",
|
|
17375
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17376
|
-
}
|
|
17506
|
+
"name": "reposition",
|
|
17507
|
+
"privacy": "private"
|
|
17377
17508
|
},
|
|
17378
17509
|
{
|
|
17379
17510
|
"kind": "field",
|
|
17380
|
-
"name": "
|
|
17381
|
-
"privacy": "
|
|
17382
|
-
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
17383
|
-
"inheritedFrom": {
|
|
17384
|
-
"name": "FormAssociatedMixin",
|
|
17385
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17386
|
-
}
|
|
17511
|
+
"name": "handleShow",
|
|
17512
|
+
"privacy": "private"
|
|
17387
17513
|
},
|
|
17388
17514
|
{
|
|
17389
17515
|
"kind": "field",
|
|
17390
|
-
"name": "
|
|
17391
|
-
"
|
|
17392
|
-
"text": "string"
|
|
17393
|
-
},
|
|
17394
|
-
"privacy": "protected",
|
|
17395
|
-
"default": "\"input\"",
|
|
17396
|
-
"inheritedFrom": {
|
|
17397
|
-
"name": "FormAssociatedMixin",
|
|
17398
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17399
|
-
}
|
|
17516
|
+
"name": "handleHide",
|
|
17517
|
+
"privacy": "private"
|
|
17400
17518
|
},
|
|
17401
17519
|
{
|
|
17402
17520
|
"kind": "field",
|
|
17403
|
-
"name": "
|
|
17521
|
+
"name": "hideOnEscape",
|
|
17522
|
+
"privacy": "private"
|
|
17523
|
+
},
|
|
17524
|
+
{
|
|
17525
|
+
"kind": "field",
|
|
17526
|
+
"name": "addDescribedBy",
|
|
17527
|
+
"privacy": "private"
|
|
17528
|
+
},
|
|
17529
|
+
{
|
|
17530
|
+
"kind": "field",
|
|
17531
|
+
"name": "removeDescribedBy",
|
|
17532
|
+
"privacy": "private"
|
|
17533
|
+
}
|
|
17534
|
+
],
|
|
17535
|
+
"attributes": [
|
|
17536
|
+
{
|
|
17537
|
+
"name": "position",
|
|
17404
17538
|
"type": {
|
|
17405
|
-
"text": "
|
|
17539
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
17406
17540
|
},
|
|
17407
|
-
"
|
|
17408
|
-
"
|
|
17409
|
-
"
|
|
17410
|
-
"name": "FormAssociatedMixin",
|
|
17411
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17412
|
-
}
|
|
17541
|
+
"default": "\"block-start\"",
|
|
17542
|
+
"description": "Control the position of the tooltip component.\nWhen set to \"none\", the tooltip will be shown above\nbut accommodate for browser boundaries.",
|
|
17543
|
+
"fieldName": "position"
|
|
17413
17544
|
},
|
|
17414
17545
|
{
|
|
17415
|
-
"
|
|
17416
|
-
"name": "hintId",
|
|
17546
|
+
"name": "role",
|
|
17417
17547
|
"type": {
|
|
17418
17548
|
"text": "string"
|
|
17419
17549
|
},
|
|
17420
|
-
"
|
|
17421
|
-
"
|
|
17422
|
-
"
|
|
17423
|
-
"name": "FormAssociatedMixin",
|
|
17424
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17425
|
-
}
|
|
17550
|
+
"default": "\"tooltip\"",
|
|
17551
|
+
"description": "The tooltip role, set on the component by default.",
|
|
17552
|
+
"fieldName": "role"
|
|
17426
17553
|
},
|
|
17427
17554
|
{
|
|
17428
|
-
"
|
|
17429
|
-
"name": "label",
|
|
17555
|
+
"name": "id",
|
|
17430
17556
|
"type": {
|
|
17431
17557
|
"text": "string"
|
|
17432
17558
|
},
|
|
17433
17559
|
"default": "\"\"",
|
|
17434
|
-
"description": "
|
|
17435
|
-
"
|
|
17436
|
-
"reflects": true,
|
|
17437
|
-
"inheritedFrom": {
|
|
17438
|
-
"name": "FormAssociatedMixin",
|
|
17439
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17440
|
-
}
|
|
17560
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
17561
|
+
"fieldName": "id"
|
|
17441
17562
|
},
|
|
17442
17563
|
{
|
|
17443
|
-
"
|
|
17444
|
-
"name": "hint",
|
|
17564
|
+
"name": "delay",
|
|
17445
17565
|
"type": {
|
|
17446
|
-
"text": "
|
|
17566
|
+
"text": "number"
|
|
17447
17567
|
},
|
|
17448
|
-
"
|
|
17449
|
-
"
|
|
17450
|
-
"
|
|
17451
|
-
|
|
17452
|
-
|
|
17453
|
-
|
|
17454
|
-
|
|
17568
|
+
"default": "500",
|
|
17569
|
+
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
17570
|
+
"fieldName": "delay"
|
|
17571
|
+
}
|
|
17572
|
+
],
|
|
17573
|
+
"superclass": {
|
|
17574
|
+
"name": "LitElement",
|
|
17575
|
+
"package": "lit"
|
|
17576
|
+
},
|
|
17577
|
+
"localization": [],
|
|
17578
|
+
"status": "ready",
|
|
17579
|
+
"category": "overlay",
|
|
17580
|
+
"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",
|
|
17581
|
+
"examples": [],
|
|
17582
|
+
"dependencies": [],
|
|
17583
|
+
"tagName": "nord-tooltip",
|
|
17584
|
+
"customElement": true
|
|
17585
|
+
}
|
|
17586
|
+
],
|
|
17587
|
+
"exports": [
|
|
17588
|
+
{
|
|
17589
|
+
"kind": "js",
|
|
17590
|
+
"name": "default",
|
|
17591
|
+
"declaration": {
|
|
17592
|
+
"name": "Tooltip",
|
|
17593
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
17594
|
+
}
|
|
17595
|
+
},
|
|
17596
|
+
{
|
|
17597
|
+
"kind": "custom-element-definition",
|
|
17598
|
+
"name": "nord-tooltip",
|
|
17599
|
+
"declaration": {
|
|
17600
|
+
"name": "Tooltip",
|
|
17601
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
17602
|
+
}
|
|
17603
|
+
}
|
|
17604
|
+
]
|
|
17605
|
+
},
|
|
17606
|
+
{
|
|
17607
|
+
"kind": "javascript-module",
|
|
17608
|
+
"path": "src/toggle/Toggle.ts",
|
|
17609
|
+
"declarations": [
|
|
17610
|
+
{
|
|
17611
|
+
"kind": "class",
|
|
17612
|
+
"description": "Toggle switch gives control over a feature or option that can be\nturned on or off. If a physical switch would work for the action, a\ntoggle is probably the best component to use.",
|
|
17613
|
+
"name": "Toggle",
|
|
17614
|
+
"cssProperties": [
|
|
17615
|
+
{
|
|
17616
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
17617
|
+
"name": "--n-label-color",
|
|
17618
|
+
"default": "var(--n-color-text)"
|
|
17619
|
+
}
|
|
17620
|
+
],
|
|
17621
|
+
"slots": [
|
|
17622
|
+
{
|
|
17623
|
+
"description": "Use when a label requires more than plain text.",
|
|
17624
|
+
"name": "label"
|
|
17455
17625
|
},
|
|
17456
17626
|
{
|
|
17457
|
-
"
|
|
17458
|
-
"name": "
|
|
17459
|
-
"type": {
|
|
17460
|
-
"text": "boolean"
|
|
17461
|
-
},
|
|
17462
|
-
"default": "false",
|
|
17463
|
-
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
17464
|
-
"attribute": "hide-label",
|
|
17465
|
-
"reflects": true,
|
|
17466
|
-
"inheritedFrom": {
|
|
17467
|
-
"name": "FormAssociatedMixin",
|
|
17468
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17469
|
-
}
|
|
17627
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
17628
|
+
"name": "hint"
|
|
17470
17629
|
},
|
|
17630
|
+
{
|
|
17631
|
+
"description": "Optional slot that holds error text for the input.",
|
|
17632
|
+
"name": "error"
|
|
17633
|
+
}
|
|
17634
|
+
],
|
|
17635
|
+
"members": [
|
|
17471
17636
|
{
|
|
17472
17637
|
"kind": "field",
|
|
17473
|
-
"name": "
|
|
17474
|
-
"
|
|
17475
|
-
|
|
17476
|
-
},
|
|
17477
|
-
"description": "Placeholder text to display within the input.",
|
|
17478
|
-
"attribute": "placeholder",
|
|
17479
|
-
"reflects": true,
|
|
17638
|
+
"name": "formValue",
|
|
17639
|
+
"privacy": "protected",
|
|
17640
|
+
"readonly": true,
|
|
17480
17641
|
"inheritedFrom": {
|
|
17481
17642
|
"name": "FormAssociatedMixin",
|
|
17482
17643
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -17484,51 +17645,40 @@
|
|
|
17484
17645
|
},
|
|
17485
17646
|
{
|
|
17486
17647
|
"kind": "field",
|
|
17487
|
-
"name": "
|
|
17648
|
+
"name": "checked",
|
|
17488
17649
|
"type": {
|
|
17489
|
-
"text": "
|
|
17650
|
+
"text": "boolean"
|
|
17490
17651
|
},
|
|
17491
|
-
"
|
|
17492
|
-
"
|
|
17493
|
-
"
|
|
17494
|
-
"
|
|
17495
|
-
"name": "FormAssociatedMixin",
|
|
17496
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17497
|
-
}
|
|
17652
|
+
"default": "false",
|
|
17653
|
+
"description": "Controls whether the toggle is checked or not.",
|
|
17654
|
+
"attribute": "checked",
|
|
17655
|
+
"reflects": true
|
|
17498
17656
|
},
|
|
17499
17657
|
{
|
|
17500
17658
|
"kind": "field",
|
|
17501
|
-
"name": "
|
|
17659
|
+
"name": "reverse",
|
|
17502
17660
|
"type": {
|
|
17503
17661
|
"text": "boolean"
|
|
17504
17662
|
},
|
|
17505
17663
|
"default": "false",
|
|
17506
|
-
"description": "
|
|
17507
|
-
"attribute": "
|
|
17508
|
-
"reflects": true
|
|
17509
|
-
"inheritedFrom": {
|
|
17510
|
-
"name": "FormAssociatedMixin",
|
|
17511
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17512
|
-
}
|
|
17664
|
+
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
17665
|
+
"attribute": "reverse",
|
|
17666
|
+
"reflects": true
|
|
17513
17667
|
},
|
|
17514
17668
|
{
|
|
17515
17669
|
"kind": "field",
|
|
17516
|
-
"name": "
|
|
17670
|
+
"name": "size",
|
|
17517
17671
|
"type": {
|
|
17518
|
-
"text": "
|
|
17672
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
17519
17673
|
},
|
|
17520
|
-
"default": "
|
|
17521
|
-
"description": "
|
|
17522
|
-
"attribute": "
|
|
17523
|
-
"reflects": true
|
|
17524
|
-
"inheritedFrom": {
|
|
17525
|
-
"name": "FormAssociatedMixin",
|
|
17526
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17527
|
-
}
|
|
17674
|
+
"default": "\"m\"",
|
|
17675
|
+
"description": "The size of the toggle switch.",
|
|
17676
|
+
"attribute": "size",
|
|
17677
|
+
"reflects": true
|
|
17528
17678
|
},
|
|
17529
17679
|
{
|
|
17530
17680
|
"kind": "method",
|
|
17531
|
-
"name": "
|
|
17681
|
+
"name": "handleChange",
|
|
17532
17682
|
"privacy": "protected",
|
|
17533
17683
|
"parameters": [
|
|
17534
17684
|
{
|
|
@@ -17538,51 +17688,31 @@
|
|
|
17538
17688
|
}
|
|
17539
17689
|
}
|
|
17540
17690
|
],
|
|
17541
|
-
"
|
|
17542
|
-
"
|
|
17543
|
-
|
|
17544
|
-
}
|
|
17545
|
-
},
|
|
17546
|
-
{
|
|
17547
|
-
"kind": "method",
|
|
17548
|
-
"name": "renderLabel",
|
|
17549
|
-
"privacy": "protected",
|
|
17550
|
-
"parameters": [
|
|
17551
|
-
{
|
|
17552
|
-
"name": "additionalContent",
|
|
17553
|
-
"optional": true,
|
|
17554
|
-
"type": {
|
|
17555
|
-
"text": "TemplateResult"
|
|
17556
|
-
}
|
|
17691
|
+
"return": {
|
|
17692
|
+
"type": {
|
|
17693
|
+
"text": "void"
|
|
17557
17694
|
}
|
|
17558
|
-
|
|
17559
|
-
"inheritedFrom": {
|
|
17560
|
-
"name": "FormAssociatedMixin",
|
|
17561
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17562
|
-
}
|
|
17563
|
-
},
|
|
17564
|
-
{
|
|
17565
|
-
"kind": "method",
|
|
17566
|
-
"name": "renderError",
|
|
17567
|
-
"privacy": "protected",
|
|
17695
|
+
},
|
|
17568
17696
|
"inheritedFrom": {
|
|
17569
17697
|
"name": "FormAssociatedMixin",
|
|
17570
17698
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17571
17699
|
}
|
|
17572
17700
|
},
|
|
17573
17701
|
{
|
|
17574
|
-
"kind": "
|
|
17575
|
-
"name": "
|
|
17702
|
+
"kind": "field",
|
|
17703
|
+
"name": "labelSlot",
|
|
17576
17704
|
"privacy": "protected",
|
|
17705
|
+
"default": "new SlotController(this, \"label\")",
|
|
17577
17706
|
"inheritedFrom": {
|
|
17578
17707
|
"name": "FormAssociatedMixin",
|
|
17579
17708
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17580
17709
|
}
|
|
17581
17710
|
},
|
|
17582
17711
|
{
|
|
17583
|
-
"kind": "
|
|
17584
|
-
"name": "
|
|
17712
|
+
"kind": "field",
|
|
17713
|
+
"name": "errorSlot",
|
|
17585
17714
|
"privacy": "protected",
|
|
17715
|
+
"default": "new SlotController(this, \"error\")",
|
|
17586
17716
|
"inheritedFrom": {
|
|
17587
17717
|
"name": "FormAssociatedMixin",
|
|
17588
17718
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -17590,9 +17720,9 @@
|
|
|
17590
17720
|
},
|
|
17591
17721
|
{
|
|
17592
17722
|
"kind": "field",
|
|
17593
|
-
"name": "
|
|
17723
|
+
"name": "hintSlot",
|
|
17594
17724
|
"privacy": "protected",
|
|
17595
|
-
"
|
|
17725
|
+
"default": "new SlotController(this, \"hint\")",
|
|
17596
17726
|
"inheritedFrom": {
|
|
17597
17727
|
"name": "FormAssociatedMixin",
|
|
17598
17728
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -17600,9 +17730,9 @@
|
|
|
17600
17730
|
},
|
|
17601
17731
|
{
|
|
17602
17732
|
"kind": "field",
|
|
17603
|
-
"name": "
|
|
17733
|
+
"name": "formData",
|
|
17604
17734
|
"privacy": "protected",
|
|
17605
|
-
"
|
|
17735
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
17606
17736
|
"inheritedFrom": {
|
|
17607
17737
|
"name": "FormAssociatedMixin",
|
|
17608
17738
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -17610,688 +17740,534 @@
|
|
|
17610
17740
|
},
|
|
17611
17741
|
{
|
|
17612
17742
|
"kind": "field",
|
|
17613
|
-
"name": "
|
|
17614
|
-
"type": {
|
|
17615
|
-
"text": "boolean"
|
|
17616
|
-
},
|
|
17617
|
-
"default": "false",
|
|
17618
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
17619
|
-
"attribute": "disabled",
|
|
17620
|
-
"reflects": true,
|
|
17621
|
-
"inheritedFrom": {
|
|
17622
|
-
"name": "InputMixin",
|
|
17623
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17624
|
-
}
|
|
17625
|
-
},
|
|
17626
|
-
{
|
|
17627
|
-
"kind": "field",
|
|
17628
|
-
"name": "name",
|
|
17629
|
-
"type": {
|
|
17630
|
-
"text": "string | undefined"
|
|
17631
|
-
},
|
|
17632
|
-
"description": "The name of the form component.",
|
|
17633
|
-
"attribute": "name",
|
|
17634
|
-
"reflects": true,
|
|
17635
|
-
"inheritedFrom": {
|
|
17636
|
-
"name": "InputMixin",
|
|
17637
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17638
|
-
}
|
|
17639
|
-
},
|
|
17640
|
-
{
|
|
17641
|
-
"kind": "field",
|
|
17642
|
-
"name": "value",
|
|
17743
|
+
"name": "inputId",
|
|
17643
17744
|
"type": {
|
|
17644
17745
|
"text": "string"
|
|
17645
17746
|
},
|
|
17646
|
-
"
|
|
17647
|
-
"
|
|
17648
|
-
"attribute": "value",
|
|
17649
|
-
"inheritedFrom": {
|
|
17650
|
-
"name": "InputMixin",
|
|
17651
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17652
|
-
}
|
|
17653
|
-
},
|
|
17654
|
-
{
|
|
17655
|
-
"kind": "field",
|
|
17656
|
-
"name": "formAncestor",
|
|
17657
|
-
"type": {
|
|
17658
|
-
"text": "HTMLFormElement | null"
|
|
17659
|
-
},
|
|
17660
|
-
"privacy": "private",
|
|
17661
|
-
"default": "null",
|
|
17747
|
+
"privacy": "protected",
|
|
17748
|
+
"default": "\"input\"",
|
|
17662
17749
|
"inheritedFrom": {
|
|
17663
|
-
"name": "
|
|
17664
|
-
"module": "src/common/mixins/
|
|
17750
|
+
"name": "FormAssociatedMixin",
|
|
17751
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17665
17752
|
}
|
|
17666
17753
|
},
|
|
17667
17754
|
{
|
|
17668
17755
|
"kind": "field",
|
|
17669
|
-
"name": "
|
|
17756
|
+
"name": "errorId",
|
|
17670
17757
|
"type": {
|
|
17671
|
-
"text": "string
|
|
17758
|
+
"text": "string"
|
|
17672
17759
|
},
|
|
17673
17760
|
"privacy": "protected",
|
|
17761
|
+
"default": "\"error\"",
|
|
17674
17762
|
"inheritedFrom": {
|
|
17675
|
-
"name": "
|
|
17676
|
-
"module": "src/common/mixins/
|
|
17763
|
+
"name": "FormAssociatedMixin",
|
|
17764
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17677
17765
|
}
|
|
17678
17766
|
},
|
|
17679
17767
|
{
|
|
17680
17768
|
"kind": "field",
|
|
17681
|
-
"name": "
|
|
17769
|
+
"name": "hintId",
|
|
17682
17770
|
"type": {
|
|
17683
|
-
"text": "
|
|
17771
|
+
"text": "string"
|
|
17684
17772
|
},
|
|
17685
|
-
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
17686
|
-
"attribute": "form",
|
|
17687
|
-
"inheritedFrom": {
|
|
17688
|
-
"name": "InputMixin",
|
|
17689
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17690
|
-
}
|
|
17691
|
-
},
|
|
17692
|
-
{
|
|
17693
|
-
"kind": "field",
|
|
17694
|
-
"name": "focusableRef",
|
|
17695
17773
|
"privacy": "protected",
|
|
17774
|
+
"default": "\"hint\"",
|
|
17696
17775
|
"inheritedFrom": {
|
|
17697
|
-
"name": "
|
|
17698
|
-
"module": "src/common/mixins/
|
|
17699
|
-
}
|
|
17700
|
-
},
|
|
17701
|
-
{
|
|
17702
|
-
"kind": "method",
|
|
17703
|
-
"name": "focus",
|
|
17704
|
-
"parameters": [
|
|
17705
|
-
{
|
|
17706
|
-
"name": "options",
|
|
17707
|
-
"optional": true,
|
|
17708
|
-
"type": {
|
|
17709
|
-
"text": "FocusOptions"
|
|
17710
|
-
},
|
|
17711
|
-
"description": "An object which controls aspects of the focusing process."
|
|
17712
|
-
}
|
|
17713
|
-
],
|
|
17714
|
-
"description": "Programmatically move focus to the component.",
|
|
17715
|
-
"inheritedFrom": {
|
|
17716
|
-
"name": "FocusableMixin",
|
|
17717
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
17718
|
-
}
|
|
17719
|
-
},
|
|
17720
|
-
{
|
|
17721
|
-
"kind": "method",
|
|
17722
|
-
"name": "blur",
|
|
17723
|
-
"description": "Programmatically remove focus from the component.",
|
|
17724
|
-
"inheritedFrom": {
|
|
17725
|
-
"name": "FocusableMixin",
|
|
17726
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
17727
|
-
}
|
|
17728
|
-
},
|
|
17729
|
-
{
|
|
17730
|
-
"kind": "method",
|
|
17731
|
-
"name": "click",
|
|
17732
|
-
"description": "Programmatically simulates a click on the component.",
|
|
17733
|
-
"inheritedFrom": {
|
|
17734
|
-
"name": "FocusableMixin",
|
|
17735
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
17776
|
+
"name": "FormAssociatedMixin",
|
|
17777
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17736
17778
|
}
|
|
17737
|
-
}
|
|
17738
|
-
],
|
|
17739
|
-
"attributes": [
|
|
17740
|
-
{
|
|
17741
|
-
"name": "checked",
|
|
17742
|
-
"type": {
|
|
17743
|
-
"text": "boolean"
|
|
17744
|
-
},
|
|
17745
|
-
"default": "false",
|
|
17746
|
-
"description": "Controls whether the toggle is checked or not.",
|
|
17747
|
-
"fieldName": "checked"
|
|
17748
|
-
},
|
|
17749
|
-
{
|
|
17750
|
-
"name": "reverse",
|
|
17751
|
-
"type": {
|
|
17752
|
-
"text": "boolean"
|
|
17753
|
-
},
|
|
17754
|
-
"default": "false",
|
|
17755
|
-
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
17756
|
-
"fieldName": "reverse"
|
|
17757
|
-
},
|
|
17758
|
-
{
|
|
17759
|
-
"name": "size",
|
|
17760
|
-
"type": {
|
|
17761
|
-
"text": "\"s\" | \"m\" | \"l\""
|
|
17762
|
-
},
|
|
17763
|
-
"default": "\"m\"",
|
|
17764
|
-
"description": "The size of the toggle switch.",
|
|
17765
|
-
"fieldName": "size"
|
|
17766
17779
|
},
|
|
17767
17780
|
{
|
|
17781
|
+
"kind": "field",
|
|
17768
17782
|
"name": "label",
|
|
17769
17783
|
"type": {
|
|
17770
17784
|
"text": "string"
|
|
17771
17785
|
},
|
|
17772
17786
|
"default": "\"\"",
|
|
17773
17787
|
"description": "Label for the input.",
|
|
17774
|
-
"
|
|
17788
|
+
"attribute": "label",
|
|
17789
|
+
"reflects": true,
|
|
17775
17790
|
"inheritedFrom": {
|
|
17776
17791
|
"name": "FormAssociatedMixin",
|
|
17777
17792
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17778
17793
|
}
|
|
17779
17794
|
},
|
|
17780
17795
|
{
|
|
17796
|
+
"kind": "field",
|
|
17781
17797
|
"name": "hint",
|
|
17782
17798
|
"type": {
|
|
17783
17799
|
"text": "string | undefined"
|
|
17784
17800
|
},
|
|
17785
17801
|
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
17786
|
-
"
|
|
17802
|
+
"attribute": "hint",
|
|
17803
|
+
"reflects": true,
|
|
17787
17804
|
"inheritedFrom": {
|
|
17788
17805
|
"name": "FormAssociatedMixin",
|
|
17789
17806
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17790
17807
|
}
|
|
17791
17808
|
},
|
|
17792
17809
|
{
|
|
17793
|
-
"
|
|
17810
|
+
"kind": "field",
|
|
17811
|
+
"name": "hideLabel",
|
|
17794
17812
|
"type": {
|
|
17795
17813
|
"text": "boolean"
|
|
17796
17814
|
},
|
|
17797
17815
|
"default": "false",
|
|
17798
17816
|
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
17799
|
-
"
|
|
17817
|
+
"attribute": "hide-label",
|
|
17818
|
+
"reflects": true,
|
|
17800
17819
|
"inheritedFrom": {
|
|
17801
17820
|
"name": "FormAssociatedMixin",
|
|
17802
17821
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17803
17822
|
}
|
|
17804
17823
|
},
|
|
17805
17824
|
{
|
|
17825
|
+
"kind": "field",
|
|
17806
17826
|
"name": "placeholder",
|
|
17807
17827
|
"type": {
|
|
17808
17828
|
"text": "string | undefined"
|
|
17809
17829
|
},
|
|
17810
17830
|
"description": "Placeholder text to display within the input.",
|
|
17811
|
-
"
|
|
17831
|
+
"attribute": "placeholder",
|
|
17832
|
+
"reflects": true,
|
|
17812
17833
|
"inheritedFrom": {
|
|
17813
17834
|
"name": "FormAssociatedMixin",
|
|
17814
17835
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17815
17836
|
}
|
|
17816
17837
|
},
|
|
17817
17838
|
{
|
|
17839
|
+
"kind": "field",
|
|
17818
17840
|
"name": "error",
|
|
17819
17841
|
"type": {
|
|
17820
17842
|
"text": "string | undefined"
|
|
17821
17843
|
},
|
|
17822
17844
|
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
17823
|
-
"
|
|
17845
|
+
"attribute": "error",
|
|
17846
|
+
"reflects": true,
|
|
17824
17847
|
"inheritedFrom": {
|
|
17825
17848
|
"name": "FormAssociatedMixin",
|
|
17826
17849
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17827
17850
|
}
|
|
17828
17851
|
},
|
|
17829
17852
|
{
|
|
17853
|
+
"kind": "field",
|
|
17830
17854
|
"name": "required",
|
|
17831
17855
|
"type": {
|
|
17832
17856
|
"text": "boolean"
|
|
17833
17857
|
},
|
|
17834
17858
|
"default": "false",
|
|
17835
17859
|
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
17836
|
-
"
|
|
17860
|
+
"attribute": "required",
|
|
17861
|
+
"reflects": true,
|
|
17837
17862
|
"inheritedFrom": {
|
|
17838
17863
|
"name": "FormAssociatedMixin",
|
|
17839
17864
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17840
17865
|
}
|
|
17841
17866
|
},
|
|
17842
17867
|
{
|
|
17843
|
-
"
|
|
17868
|
+
"kind": "field",
|
|
17869
|
+
"name": "hideRequired",
|
|
17844
17870
|
"type": {
|
|
17845
17871
|
"text": "boolean"
|
|
17846
17872
|
},
|
|
17847
17873
|
"default": "false",
|
|
17848
17874
|
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
17849
|
-
"
|
|
17850
|
-
"
|
|
17851
|
-
"name": "FormAssociatedMixin",
|
|
17852
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17853
|
-
}
|
|
17854
|
-
},
|
|
17855
|
-
{
|
|
17856
|
-
"name": "disabled",
|
|
17857
|
-
"type": {
|
|
17858
|
-
"text": "boolean"
|
|
17859
|
-
},
|
|
17860
|
-
"default": "false",
|
|
17861
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
17862
|
-
"fieldName": "disabled",
|
|
17863
|
-
"inheritedFrom": {
|
|
17864
|
-
"name": "InputMixin",
|
|
17865
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17866
|
-
}
|
|
17867
|
-
},
|
|
17868
|
-
{
|
|
17869
|
-
"name": "name",
|
|
17870
|
-
"type": {
|
|
17871
|
-
"text": "string | undefined"
|
|
17872
|
-
},
|
|
17873
|
-
"description": "The name of the form component.",
|
|
17874
|
-
"fieldName": "name",
|
|
17875
|
-
"inheritedFrom": {
|
|
17876
|
-
"name": "InputMixin",
|
|
17877
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17878
|
-
}
|
|
17879
|
-
},
|
|
17880
|
-
{
|
|
17881
|
-
"name": "value",
|
|
17882
|
-
"type": {
|
|
17883
|
-
"text": "string"
|
|
17884
|
-
},
|
|
17885
|
-
"default": "\"\"",
|
|
17886
|
-
"description": "The value of the form component.",
|
|
17887
|
-
"fieldName": "value",
|
|
17888
|
-
"inheritedFrom": {
|
|
17889
|
-
"name": "InputMixin",
|
|
17890
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17891
|
-
}
|
|
17892
|
-
},
|
|
17893
|
-
{
|
|
17894
|
-
"name": "form",
|
|
17895
|
-
"type": {
|
|
17896
|
-
"text": "HTMLFormElement | null"
|
|
17897
|
-
},
|
|
17898
|
-
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
17899
|
-
"fieldName": "form",
|
|
17900
|
-
"inheritedFrom": {
|
|
17901
|
-
"name": "InputMixin",
|
|
17902
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17903
|
-
}
|
|
17904
|
-
}
|
|
17905
|
-
],
|
|
17906
|
-
"mixins": [
|
|
17907
|
-
{
|
|
17908
|
-
"name": "FormAssociatedMixin",
|
|
17909
|
-
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
17910
|
-
},
|
|
17911
|
-
{
|
|
17912
|
-
"name": "InputMixin",
|
|
17913
|
-
"module": "/src/common/mixins/InputMixin.js"
|
|
17914
|
-
},
|
|
17915
|
-
{
|
|
17916
|
-
"name": "FocusableMixin",
|
|
17917
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
17918
|
-
}
|
|
17919
|
-
],
|
|
17920
|
-
"superclass": {
|
|
17921
|
-
"name": "LitElement",
|
|
17922
|
-
"package": "lit"
|
|
17923
|
-
},
|
|
17924
|
-
"localization": [],
|
|
17925
|
-
"status": "ready",
|
|
17926
|
-
"category": "form",
|
|
17927
|
-
"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 toggles when your intent is to turn something on or off instantly.\n- Use for any feature or option that can be turned on or off.\n- If a physical switch would work for the action, the toggle is probably the best component to use.\n- Use for making it possible to choose one or more options from a limited number of options.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Toggles should never require users to click a button to apply or save the setting.\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another toggle when another one is clicked. Only exception is when a toggle is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nToggle labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing toggle 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\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n",
|
|
17928
|
-
"examples": [],
|
|
17929
|
-
"dependencies": [],
|
|
17930
|
-
"tagName": "nord-toggle",
|
|
17931
|
-
"customElement": true,
|
|
17932
|
-
"events": [
|
|
17933
|
-
{
|
|
17934
|
-
"name": "input",
|
|
17935
|
-
"type": {
|
|
17936
|
-
"text": "NordEvent"
|
|
17937
|
-
},
|
|
17938
|
-
"description": "Fired as the user types into the input.",
|
|
17875
|
+
"attribute": "hide-required",
|
|
17876
|
+
"reflects": true,
|
|
17939
17877
|
"inheritedFrom": {
|
|
17940
17878
|
"name": "FormAssociatedMixin",
|
|
17941
17879
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17942
17880
|
}
|
|
17943
17881
|
},
|
|
17944
|
-
{
|
|
17945
|
-
"name": "change",
|
|
17946
|
-
"type": {
|
|
17947
|
-
"text": "NordEvent"
|
|
17948
|
-
},
|
|
17949
|
-
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
17950
|
-
"inheritedFrom": {
|
|
17951
|
-
"name": "FormAssociatedMixin",
|
|
17952
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17953
|
-
}
|
|
17954
|
-
}
|
|
17955
|
-
]
|
|
17956
|
-
}
|
|
17957
|
-
],
|
|
17958
|
-
"exports": [
|
|
17959
|
-
{
|
|
17960
|
-
"kind": "js",
|
|
17961
|
-
"name": "default",
|
|
17962
|
-
"declaration": {
|
|
17963
|
-
"name": "Toggle",
|
|
17964
|
-
"module": "src/toggle/Toggle.ts"
|
|
17965
|
-
}
|
|
17966
|
-
},
|
|
17967
|
-
{
|
|
17968
|
-
"kind": "custom-element-definition",
|
|
17969
|
-
"name": "nord-toggle",
|
|
17970
|
-
"declaration": {
|
|
17971
|
-
"name": "Toggle",
|
|
17972
|
-
"module": "src/toggle/Toggle.ts"
|
|
17973
|
-
}
|
|
17974
|
-
}
|
|
17975
|
-
]
|
|
17976
|
-
},
|
|
17977
|
-
{
|
|
17978
|
-
"kind": "javascript-module",
|
|
17979
|
-
"path": "src/toast-group/ToastGroup.ts",
|
|
17980
|
-
"declarations": [
|
|
17981
|
-
{
|
|
17982
|
-
"kind": "class",
|
|
17983
|
-
"description": "Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.",
|
|
17984
|
-
"name": "ToastGroup",
|
|
17985
|
-
"slots": [
|
|
17986
|
-
{
|
|
17987
|
-
"description": "Default slot in which to place toasts.",
|
|
17988
|
-
"name": ""
|
|
17989
|
-
}
|
|
17990
|
-
],
|
|
17991
|
-
"members": [
|
|
17992
17882
|
{
|
|
17993
17883
|
"kind": "method",
|
|
17994
|
-
"name": "
|
|
17884
|
+
"name": "handleInput",
|
|
17885
|
+
"privacy": "protected",
|
|
17995
17886
|
"parameters": [
|
|
17996
17887
|
{
|
|
17997
|
-
"name": "
|
|
17998
|
-
"type": {
|
|
17999
|
-
"text": "string"
|
|
18000
|
-
},
|
|
18001
|
-
"description": "The text/message of the toast."
|
|
18002
|
-
},
|
|
18003
|
-
{
|
|
18004
|
-
"name": "options",
|
|
18005
|
-
"default": "{}",
|
|
17888
|
+
"name": "e",
|
|
18006
17889
|
"type": {
|
|
18007
|
-
"text": "
|
|
18008
|
-
}
|
|
18009
|
-
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
17890
|
+
"text": "Event"
|
|
17891
|
+
}
|
|
18010
17892
|
}
|
|
18011
17893
|
],
|
|
18012
|
-
"
|
|
18013
|
-
|
|
18014
|
-
"
|
|
18015
|
-
"text": "Toast"
|
|
18016
|
-
}
|
|
17894
|
+
"inheritedFrom": {
|
|
17895
|
+
"name": "FormAssociatedMixin",
|
|
17896
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18017
17897
|
}
|
|
18018
|
-
}
|
|
18019
|
-
],
|
|
18020
|
-
"events": [
|
|
18021
|
-
{
|
|
18022
|
-
"type": {
|
|
18023
|
-
"text": "NordEvent"
|
|
18024
|
-
},
|
|
18025
|
-
"description": "Fired when a toast is dismissed (via user action or auto-dismiss), and its exit animation has completed. This event should be used to remove the dismissed toast from the DOM.",
|
|
18026
|
-
"name": "dismiss"
|
|
18027
|
-
}
|
|
18028
|
-
],
|
|
18029
|
-
"superclass": {
|
|
18030
|
-
"name": "LitElement",
|
|
18031
|
-
"package": "lit"
|
|
18032
|
-
},
|
|
18033
|
-
"localization": [],
|
|
18034
|
-
"status": "ready",
|
|
18035
|
-
"category": "feedback",
|
|
18036
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Toast](/components/toast/) so that toasts get styled and announced to screen readers correctly.\n- Add as close to the bottom of the document as possible, ideally near the body closing tag, to maintain correct stacking order.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than toast components\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and understandable by the user:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n",
|
|
18037
|
-
"examples": [],
|
|
18038
|
-
"dependencies": [
|
|
18039
|
-
"toast"
|
|
18040
|
-
],
|
|
18041
|
-
"tagName": "nord-toast-group",
|
|
18042
|
-
"customElement": true
|
|
18043
|
-
}
|
|
18044
|
-
],
|
|
18045
|
-
"exports": [
|
|
18046
|
-
{
|
|
18047
|
-
"kind": "js",
|
|
18048
|
-
"name": "default",
|
|
18049
|
-
"declaration": {
|
|
18050
|
-
"name": "ToastGroup",
|
|
18051
|
-
"module": "src/toast-group/ToastGroup.ts"
|
|
18052
|
-
}
|
|
18053
|
-
},
|
|
18054
|
-
{
|
|
18055
|
-
"kind": "custom-element-definition",
|
|
18056
|
-
"name": "nord-toast-group",
|
|
18057
|
-
"declaration": {
|
|
18058
|
-
"name": "ToastGroup",
|
|
18059
|
-
"module": "src/toast-group/ToastGroup.ts"
|
|
18060
|
-
}
|
|
18061
|
-
}
|
|
18062
|
-
]
|
|
18063
|
-
},
|
|
18064
|
-
{
|
|
18065
|
-
"kind": "javascript-module",
|
|
18066
|
-
"path": "src/tooltip/Tooltip.ts",
|
|
18067
|
-
"declarations": [
|
|
18068
|
-
{
|
|
18069
|
-
"kind": "class",
|
|
18070
|
-
"description": "Tooltips are floating containers for displaying additional information\nfor the currently focused element. A tooltip can be useful when you want\nto e.g. give a hint about an existing Command Menu shortcut.",
|
|
18071
|
-
"name": "Tooltip",
|
|
18072
|
-
"cssProperties": [
|
|
17898
|
+
},
|
|
18073
17899
|
{
|
|
18074
|
-
"
|
|
18075
|
-
"name": "
|
|
18076
|
-
"
|
|
18077
|
-
|
|
18078
|
-
|
|
18079
|
-
|
|
17900
|
+
"kind": "method",
|
|
17901
|
+
"name": "renderLabel",
|
|
17902
|
+
"privacy": "protected",
|
|
17903
|
+
"parameters": [
|
|
17904
|
+
{
|
|
17905
|
+
"name": "additionalContent",
|
|
17906
|
+
"optional": true,
|
|
17907
|
+
"type": {
|
|
17908
|
+
"text": "TemplateResult"
|
|
17909
|
+
}
|
|
17910
|
+
}
|
|
17911
|
+
],
|
|
17912
|
+
"inheritedFrom": {
|
|
17913
|
+
"name": "FormAssociatedMixin",
|
|
17914
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17915
|
+
}
|
|
17916
|
+
},
|
|
18080
17917
|
{
|
|
18081
|
-
"
|
|
18082
|
-
"name": ""
|
|
17918
|
+
"kind": "method",
|
|
17919
|
+
"name": "renderError",
|
|
17920
|
+
"privacy": "protected",
|
|
17921
|
+
"inheritedFrom": {
|
|
17922
|
+
"name": "FormAssociatedMixin",
|
|
17923
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17924
|
+
}
|
|
18083
17925
|
},
|
|
18084
17926
|
{
|
|
18085
|
-
"
|
|
18086
|
-
"name": "
|
|
18087
|
-
|
|
18088
|
-
|
|
18089
|
-
|
|
17927
|
+
"kind": "method",
|
|
17928
|
+
"name": "getDescribedBy",
|
|
17929
|
+
"privacy": "protected",
|
|
17930
|
+
"inheritedFrom": {
|
|
17931
|
+
"name": "FormAssociatedMixin",
|
|
17932
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17933
|
+
}
|
|
17934
|
+
},
|
|
18090
17935
|
{
|
|
18091
|
-
"kind": "
|
|
18092
|
-
"name": "
|
|
18093
|
-
"
|
|
18094
|
-
|
|
18095
|
-
|
|
18096
|
-
|
|
18097
|
-
|
|
17936
|
+
"kind": "method",
|
|
17937
|
+
"name": "getInvalid",
|
|
17938
|
+
"privacy": "protected",
|
|
17939
|
+
"inheritedFrom": {
|
|
17940
|
+
"name": "FormAssociatedMixin",
|
|
17941
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17942
|
+
}
|
|
18098
17943
|
},
|
|
18099
17944
|
{
|
|
18100
17945
|
"kind": "field",
|
|
18101
|
-
"name": "
|
|
18102
|
-
"privacy": "
|
|
18103
|
-
"
|
|
17946
|
+
"name": "hasHint",
|
|
17947
|
+
"privacy": "protected",
|
|
17948
|
+
"readonly": true,
|
|
17949
|
+
"inheritedFrom": {
|
|
17950
|
+
"name": "FormAssociatedMixin",
|
|
17951
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17952
|
+
}
|
|
18104
17953
|
},
|
|
18105
17954
|
{
|
|
18106
17955
|
"kind": "field",
|
|
18107
|
-
"name": "
|
|
18108
|
-
"privacy": "
|
|
18109
|
-
"
|
|
17956
|
+
"name": "hasError",
|
|
17957
|
+
"privacy": "protected",
|
|
17958
|
+
"readonly": true,
|
|
17959
|
+
"inheritedFrom": {
|
|
17960
|
+
"name": "FormAssociatedMixin",
|
|
17961
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17962
|
+
}
|
|
18110
17963
|
},
|
|
18111
17964
|
{
|
|
18112
17965
|
"kind": "field",
|
|
18113
|
-
"name": "
|
|
17966
|
+
"name": "disabled",
|
|
18114
17967
|
"type": {
|
|
18115
|
-
"text": "
|
|
17968
|
+
"text": "boolean"
|
|
18116
17969
|
},
|
|
18117
|
-
"
|
|
17970
|
+
"default": "false",
|
|
17971
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
17972
|
+
"attribute": "disabled",
|
|
17973
|
+
"reflects": true,
|
|
17974
|
+
"inheritedFrom": {
|
|
17975
|
+
"name": "InputMixin",
|
|
17976
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
17977
|
+
}
|
|
18118
17978
|
},
|
|
18119
17979
|
{
|
|
18120
17980
|
"kind": "field",
|
|
18121
|
-
"name": "
|
|
17981
|
+
"name": "name",
|
|
18122
17982
|
"type": {
|
|
18123
|
-
"text": "
|
|
17983
|
+
"text": "string | undefined"
|
|
18124
17984
|
},
|
|
18125
|
-
"
|
|
17985
|
+
"description": "The name of the form component.",
|
|
17986
|
+
"attribute": "name",
|
|
17987
|
+
"reflects": true,
|
|
17988
|
+
"inheritedFrom": {
|
|
17989
|
+
"name": "InputMixin",
|
|
17990
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
17991
|
+
}
|
|
18126
17992
|
},
|
|
18127
17993
|
{
|
|
18128
17994
|
"kind": "field",
|
|
18129
|
-
"name": "
|
|
17995
|
+
"name": "value",
|
|
18130
17996
|
"type": {
|
|
18131
|
-
"text": "
|
|
17997
|
+
"text": "string"
|
|
18132
17998
|
},
|
|
18133
|
-
"
|
|
18134
|
-
"description": "
|
|
17999
|
+
"default": "\"\"",
|
|
18000
|
+
"description": "The value of the form component.",
|
|
18001
|
+
"attribute": "value",
|
|
18002
|
+
"inheritedFrom": {
|
|
18003
|
+
"name": "InputMixin",
|
|
18004
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18005
|
+
}
|
|
18135
18006
|
},
|
|
18136
18007
|
{
|
|
18137
18008
|
"kind": "field",
|
|
18138
|
-
"name": "
|
|
18009
|
+
"name": "formAncestor",
|
|
18139
18010
|
"type": {
|
|
18140
|
-
"text": "
|
|
18011
|
+
"text": "HTMLFormElement | null"
|
|
18141
18012
|
},
|
|
18142
18013
|
"privacy": "private",
|
|
18143
|
-
"default": "
|
|
18144
|
-
"
|
|
18014
|
+
"default": "null",
|
|
18015
|
+
"inheritedFrom": {
|
|
18016
|
+
"name": "InputMixin",
|
|
18017
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18018
|
+
}
|
|
18145
18019
|
},
|
|
18146
18020
|
{
|
|
18147
18021
|
"kind": "field",
|
|
18148
|
-
"name": "
|
|
18022
|
+
"name": "_formId",
|
|
18149
18023
|
"type": {
|
|
18150
|
-
"text": "
|
|
18024
|
+
"text": "string | undefined"
|
|
18151
18025
|
},
|
|
18152
|
-
"privacy": "
|
|
18153
|
-
"
|
|
18026
|
+
"privacy": "protected",
|
|
18027
|
+
"inheritedFrom": {
|
|
18028
|
+
"name": "InputMixin",
|
|
18029
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18030
|
+
}
|
|
18154
18031
|
},
|
|
18155
18032
|
{
|
|
18156
18033
|
"kind": "field",
|
|
18157
|
-
"name": "
|
|
18034
|
+
"name": "form",
|
|
18158
18035
|
"type": {
|
|
18159
|
-
"text": "
|
|
18036
|
+
"text": "HTMLFormElement | null"
|
|
18160
18037
|
},
|
|
18161
|
-
"
|
|
18162
|
-
"
|
|
18163
|
-
"
|
|
18164
|
-
|
|
18038
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
18039
|
+
"attribute": "form",
|
|
18040
|
+
"inheritedFrom": {
|
|
18041
|
+
"name": "InputMixin",
|
|
18042
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18043
|
+
}
|
|
18165
18044
|
},
|
|
18166
18045
|
{
|
|
18167
18046
|
"kind": "field",
|
|
18168
|
-
"name": "
|
|
18169
|
-
"
|
|
18170
|
-
|
|
18171
|
-
|
|
18172
|
-
|
|
18173
|
-
|
|
18174
|
-
"attribute": "role",
|
|
18175
|
-
"reflects": true
|
|
18047
|
+
"name": "focusableRef",
|
|
18048
|
+
"privacy": "protected",
|
|
18049
|
+
"inheritedFrom": {
|
|
18050
|
+
"name": "FocusableMixin",
|
|
18051
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18052
|
+
}
|
|
18176
18053
|
},
|
|
18177
18054
|
{
|
|
18178
|
-
"kind": "
|
|
18179
|
-
"name": "
|
|
18180
|
-
"
|
|
18181
|
-
|
|
18182
|
-
|
|
18183
|
-
|
|
18184
|
-
|
|
18185
|
-
|
|
18186
|
-
|
|
18055
|
+
"kind": "method",
|
|
18056
|
+
"name": "focus",
|
|
18057
|
+
"parameters": [
|
|
18058
|
+
{
|
|
18059
|
+
"name": "options",
|
|
18060
|
+
"optional": true,
|
|
18061
|
+
"type": {
|
|
18062
|
+
"text": "FocusOptions"
|
|
18063
|
+
},
|
|
18064
|
+
"description": "An object which controls aspects of the focusing process."
|
|
18065
|
+
}
|
|
18066
|
+
],
|
|
18067
|
+
"description": "Programmatically move focus to the component.",
|
|
18068
|
+
"inheritedFrom": {
|
|
18069
|
+
"name": "FocusableMixin",
|
|
18070
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18071
|
+
}
|
|
18187
18072
|
},
|
|
18188
18073
|
{
|
|
18189
|
-
"kind": "
|
|
18190
|
-
"name": "
|
|
18074
|
+
"kind": "method",
|
|
18075
|
+
"name": "blur",
|
|
18076
|
+
"description": "Programmatically remove focus from the component.",
|
|
18077
|
+
"inheritedFrom": {
|
|
18078
|
+
"name": "FocusableMixin",
|
|
18079
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18080
|
+
}
|
|
18081
|
+
},
|
|
18082
|
+
{
|
|
18083
|
+
"kind": "method",
|
|
18084
|
+
"name": "click",
|
|
18085
|
+
"description": "Programmatically simulates a click on the component.",
|
|
18086
|
+
"inheritedFrom": {
|
|
18087
|
+
"name": "FocusableMixin",
|
|
18088
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18089
|
+
}
|
|
18090
|
+
}
|
|
18091
|
+
],
|
|
18092
|
+
"attributes": [
|
|
18093
|
+
{
|
|
18094
|
+
"name": "checked",
|
|
18191
18095
|
"type": {
|
|
18192
|
-
"text": "
|
|
18096
|
+
"text": "boolean"
|
|
18193
18097
|
},
|
|
18194
|
-
"default": "
|
|
18195
|
-
"description": "
|
|
18196
|
-
"
|
|
18197
|
-
"reflects": true
|
|
18098
|
+
"default": "false",
|
|
18099
|
+
"description": "Controls whether the toggle is checked or not.",
|
|
18100
|
+
"fieldName": "checked"
|
|
18198
18101
|
},
|
|
18199
18102
|
{
|
|
18200
|
-
"
|
|
18201
|
-
"
|
|
18202
|
-
|
|
18103
|
+
"name": "reverse",
|
|
18104
|
+
"type": {
|
|
18105
|
+
"text": "boolean"
|
|
18106
|
+
},
|
|
18107
|
+
"default": "false",
|
|
18108
|
+
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
18109
|
+
"fieldName": "reverse"
|
|
18203
18110
|
},
|
|
18204
18111
|
{
|
|
18205
|
-
"
|
|
18206
|
-
"
|
|
18207
|
-
|
|
18208
|
-
|
|
18209
|
-
|
|
18210
|
-
|
|
18211
|
-
|
|
18212
|
-
"text": "TooltipStates"
|
|
18213
|
-
}
|
|
18214
|
-
}
|
|
18215
|
-
]
|
|
18112
|
+
"name": "size",
|
|
18113
|
+
"type": {
|
|
18114
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
18115
|
+
},
|
|
18116
|
+
"default": "\"m\"",
|
|
18117
|
+
"description": "The size of the toggle switch.",
|
|
18118
|
+
"fieldName": "size"
|
|
18216
18119
|
},
|
|
18217
18120
|
{
|
|
18218
|
-
"
|
|
18219
|
-
"
|
|
18220
|
-
|
|
18221
|
-
|
|
18121
|
+
"name": "label",
|
|
18122
|
+
"type": {
|
|
18123
|
+
"text": "string"
|
|
18124
|
+
},
|
|
18125
|
+
"default": "\"\"",
|
|
18126
|
+
"description": "Label for the input.",
|
|
18127
|
+
"fieldName": "label",
|
|
18128
|
+
"inheritedFrom": {
|
|
18129
|
+
"name": "FormAssociatedMixin",
|
|
18130
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18131
|
+
}
|
|
18222
18132
|
},
|
|
18223
18133
|
{
|
|
18224
|
-
"
|
|
18225
|
-
"
|
|
18226
|
-
|
|
18134
|
+
"name": "hint",
|
|
18135
|
+
"type": {
|
|
18136
|
+
"text": "string | undefined"
|
|
18137
|
+
},
|
|
18138
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
18139
|
+
"fieldName": "hint",
|
|
18140
|
+
"inheritedFrom": {
|
|
18141
|
+
"name": "FormAssociatedMixin",
|
|
18142
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18143
|
+
}
|
|
18227
18144
|
},
|
|
18228
18145
|
{
|
|
18229
|
-
"
|
|
18230
|
-
"
|
|
18231
|
-
|
|
18146
|
+
"name": "hide-label",
|
|
18147
|
+
"type": {
|
|
18148
|
+
"text": "boolean"
|
|
18149
|
+
},
|
|
18150
|
+
"default": "false",
|
|
18151
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
18152
|
+
"fieldName": "hideLabel",
|
|
18153
|
+
"inheritedFrom": {
|
|
18154
|
+
"name": "FormAssociatedMixin",
|
|
18155
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18156
|
+
}
|
|
18232
18157
|
},
|
|
18233
18158
|
{
|
|
18234
|
-
"
|
|
18235
|
-
"
|
|
18236
|
-
|
|
18159
|
+
"name": "placeholder",
|
|
18160
|
+
"type": {
|
|
18161
|
+
"text": "string | undefined"
|
|
18162
|
+
},
|
|
18163
|
+
"description": "Placeholder text to display within the input.",
|
|
18164
|
+
"fieldName": "placeholder",
|
|
18165
|
+
"inheritedFrom": {
|
|
18166
|
+
"name": "FormAssociatedMixin",
|
|
18167
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18168
|
+
}
|
|
18237
18169
|
},
|
|
18238
18170
|
{
|
|
18239
|
-
"
|
|
18240
|
-
"
|
|
18241
|
-
|
|
18171
|
+
"name": "error",
|
|
18172
|
+
"type": {
|
|
18173
|
+
"text": "string | undefined"
|
|
18174
|
+
},
|
|
18175
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
18176
|
+
"fieldName": "error",
|
|
18177
|
+
"inheritedFrom": {
|
|
18178
|
+
"name": "FormAssociatedMixin",
|
|
18179
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18180
|
+
}
|
|
18242
18181
|
},
|
|
18243
18182
|
{
|
|
18244
|
-
"
|
|
18245
|
-
"
|
|
18246
|
-
|
|
18183
|
+
"name": "required",
|
|
18184
|
+
"type": {
|
|
18185
|
+
"text": "boolean"
|
|
18186
|
+
},
|
|
18187
|
+
"default": "false",
|
|
18188
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
18189
|
+
"fieldName": "required",
|
|
18190
|
+
"inheritedFrom": {
|
|
18191
|
+
"name": "FormAssociatedMixin",
|
|
18192
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18193
|
+
}
|
|
18247
18194
|
},
|
|
18248
18195
|
{
|
|
18249
|
-
"
|
|
18250
|
-
"
|
|
18251
|
-
|
|
18196
|
+
"name": "hide-required",
|
|
18197
|
+
"type": {
|
|
18198
|
+
"text": "boolean"
|
|
18199
|
+
},
|
|
18200
|
+
"default": "false",
|
|
18201
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
18202
|
+
"fieldName": "hideRequired",
|
|
18203
|
+
"inheritedFrom": {
|
|
18204
|
+
"name": "FormAssociatedMixin",
|
|
18205
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18206
|
+
}
|
|
18252
18207
|
},
|
|
18253
18208
|
{
|
|
18254
|
-
"
|
|
18255
|
-
"name": "removeDescribedBy",
|
|
18256
|
-
"privacy": "private"
|
|
18257
|
-
}
|
|
18258
|
-
],
|
|
18259
|
-
"attributes": [
|
|
18260
|
-
{
|
|
18261
|
-
"name": "position",
|
|
18209
|
+
"name": "disabled",
|
|
18262
18210
|
"type": {
|
|
18263
|
-
"text": "
|
|
18211
|
+
"text": "boolean"
|
|
18264
18212
|
},
|
|
18265
|
-
"default": "
|
|
18266
|
-
"description": "
|
|
18267
|
-
"fieldName": "
|
|
18213
|
+
"default": "false",
|
|
18214
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
18215
|
+
"fieldName": "disabled",
|
|
18216
|
+
"inheritedFrom": {
|
|
18217
|
+
"name": "InputMixin",
|
|
18218
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18219
|
+
}
|
|
18268
18220
|
},
|
|
18269
18221
|
{
|
|
18270
|
-
"name": "
|
|
18222
|
+
"name": "name",
|
|
18271
18223
|
"type": {
|
|
18272
|
-
"text": "string"
|
|
18224
|
+
"text": "string | undefined"
|
|
18273
18225
|
},
|
|
18274
|
-
"
|
|
18275
|
-
"
|
|
18276
|
-
"
|
|
18226
|
+
"description": "The name of the form component.",
|
|
18227
|
+
"fieldName": "name",
|
|
18228
|
+
"inheritedFrom": {
|
|
18229
|
+
"name": "InputMixin",
|
|
18230
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18231
|
+
}
|
|
18277
18232
|
},
|
|
18278
18233
|
{
|
|
18279
|
-
"name": "
|
|
18234
|
+
"name": "value",
|
|
18280
18235
|
"type": {
|
|
18281
18236
|
"text": "string"
|
|
18282
18237
|
},
|
|
18283
18238
|
"default": "\"\"",
|
|
18284
|
-
"description": "The
|
|
18285
|
-
"fieldName": "
|
|
18239
|
+
"description": "The value of the form component.",
|
|
18240
|
+
"fieldName": "value",
|
|
18241
|
+
"inheritedFrom": {
|
|
18242
|
+
"name": "InputMixin",
|
|
18243
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18244
|
+
}
|
|
18286
18245
|
},
|
|
18287
18246
|
{
|
|
18288
|
-
"name": "
|
|
18247
|
+
"name": "form",
|
|
18289
18248
|
"type": {
|
|
18290
|
-
"text": "
|
|
18249
|
+
"text": "HTMLFormElement | null"
|
|
18291
18250
|
},
|
|
18292
|
-
"
|
|
18293
|
-
"
|
|
18294
|
-
"
|
|
18251
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
18252
|
+
"fieldName": "form",
|
|
18253
|
+
"inheritedFrom": {
|
|
18254
|
+
"name": "InputMixin",
|
|
18255
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18256
|
+
}
|
|
18257
|
+
}
|
|
18258
|
+
],
|
|
18259
|
+
"mixins": [
|
|
18260
|
+
{
|
|
18261
|
+
"name": "FormAssociatedMixin",
|
|
18262
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
18263
|
+
},
|
|
18264
|
+
{
|
|
18265
|
+
"name": "InputMixin",
|
|
18266
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
18267
|
+
},
|
|
18268
|
+
{
|
|
18269
|
+
"name": "FocusableMixin",
|
|
18270
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
18295
18271
|
}
|
|
18296
18272
|
],
|
|
18297
18273
|
"superclass": {
|
|
@@ -18300,12 +18276,36 @@
|
|
|
18300
18276
|
},
|
|
18301
18277
|
"localization": [],
|
|
18302
18278
|
"status": "ready",
|
|
18303
|
-
"category": "
|
|
18304
|
-
"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
|
|
18279
|
+
"category": "form",
|
|
18280
|
+
"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 toggles when your intent is to turn something on or off instantly.\n- Use for any feature or option that can be turned on or off.\n- If a physical switch would work for the action, the toggle is probably the best component to use.\n- Use for making it possible to choose one or more options from a limited number of options.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Toggles should never require users to click a button to apply or save the setting.\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another toggle when another one is clicked. Only exception is when a toggle is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nToggle labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing toggle 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\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n",
|
|
18305
18281
|
"examples": [],
|
|
18306
18282
|
"dependencies": [],
|
|
18307
|
-
"tagName": "nord-
|
|
18308
|
-
"customElement": true
|
|
18283
|
+
"tagName": "nord-toggle",
|
|
18284
|
+
"customElement": true,
|
|
18285
|
+
"events": [
|
|
18286
|
+
{
|
|
18287
|
+
"name": "input",
|
|
18288
|
+
"type": {
|
|
18289
|
+
"text": "NordEvent"
|
|
18290
|
+
},
|
|
18291
|
+
"description": "Fired as the user types into the input.",
|
|
18292
|
+
"inheritedFrom": {
|
|
18293
|
+
"name": "FormAssociatedMixin",
|
|
18294
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18295
|
+
}
|
|
18296
|
+
},
|
|
18297
|
+
{
|
|
18298
|
+
"name": "change",
|
|
18299
|
+
"type": {
|
|
18300
|
+
"text": "NordEvent"
|
|
18301
|
+
},
|
|
18302
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
18303
|
+
"inheritedFrom": {
|
|
18304
|
+
"name": "FormAssociatedMixin",
|
|
18305
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18306
|
+
}
|
|
18307
|
+
}
|
|
18308
|
+
]
|
|
18309
18309
|
}
|
|
18310
18310
|
],
|
|
18311
18311
|
"exports": [
|
|
@@ -18313,36 +18313,32 @@
|
|
|
18313
18313
|
"kind": "js",
|
|
18314
18314
|
"name": "default",
|
|
18315
18315
|
"declaration": {
|
|
18316
|
-
"name": "
|
|
18317
|
-
"module": "src/
|
|
18316
|
+
"name": "Toggle",
|
|
18317
|
+
"module": "src/toggle/Toggle.ts"
|
|
18318
18318
|
}
|
|
18319
18319
|
},
|
|
18320
18320
|
{
|
|
18321
18321
|
"kind": "custom-element-definition",
|
|
18322
|
-
"name": "nord-
|
|
18322
|
+
"name": "nord-toggle",
|
|
18323
18323
|
"declaration": {
|
|
18324
|
-
"name": "
|
|
18325
|
-
"module": "src/
|
|
18324
|
+
"name": "Toggle",
|
|
18325
|
+
"module": "src/toggle/Toggle.ts"
|
|
18326
18326
|
}
|
|
18327
18327
|
}
|
|
18328
18328
|
]
|
|
18329
18329
|
},
|
|
18330
18330
|
{
|
|
18331
18331
|
"kind": "javascript-module",
|
|
18332
|
-
"path": "src/
|
|
18332
|
+
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
18333
18333
|
"declarations": [
|
|
18334
18334
|
{
|
|
18335
18335
|
"kind": "class",
|
|
18336
|
-
"description": "
|
|
18337
|
-
"name": "
|
|
18336
|
+
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
18337
|
+
"name": "VisuallyHidden",
|
|
18338
18338
|
"slots": [
|
|
18339
18339
|
{
|
|
18340
|
-
"description": "
|
|
18340
|
+
"description": "The visually hidden content.",
|
|
18341
18341
|
"name": ""
|
|
18342
|
-
},
|
|
18343
|
-
{
|
|
18344
|
-
"description": "Optional slot for menus, buttons, toggles, etc.",
|
|
18345
|
-
"name": "end"
|
|
18346
18342
|
}
|
|
18347
18343
|
],
|
|
18348
18344
|
"members": [],
|
|
@@ -18352,11 +18348,11 @@
|
|
|
18352
18348
|
},
|
|
18353
18349
|
"localization": [],
|
|
18354
18350
|
"status": "ready",
|
|
18355
|
-
"category": "
|
|
18356
|
-
"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-
|
|
18351
|
+
"category": "text",
|
|
18352
|
+
"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",
|
|
18357
18353
|
"examples": [],
|
|
18358
18354
|
"dependencies": [],
|
|
18359
|
-
"tagName": "nord-
|
|
18355
|
+
"tagName": "nord-visually-hidden",
|
|
18360
18356
|
"customElement": true
|
|
18361
18357
|
}
|
|
18362
18358
|
],
|
|
@@ -18365,32 +18361,36 @@
|
|
|
18365
18361
|
"kind": "js",
|
|
18366
18362
|
"name": "default",
|
|
18367
18363
|
"declaration": {
|
|
18368
|
-
"name": "
|
|
18369
|
-
"module": "src/
|
|
18364
|
+
"name": "VisuallyHidden",
|
|
18365
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
18370
18366
|
}
|
|
18371
18367
|
},
|
|
18372
18368
|
{
|
|
18373
18369
|
"kind": "custom-element-definition",
|
|
18374
|
-
"name": "nord-
|
|
18370
|
+
"name": "nord-visually-hidden",
|
|
18375
18371
|
"declaration": {
|
|
18376
|
-
"name": "
|
|
18377
|
-
"module": "src/
|
|
18372
|
+
"name": "VisuallyHidden",
|
|
18373
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
18378
18374
|
}
|
|
18379
18375
|
}
|
|
18380
18376
|
]
|
|
18381
18377
|
},
|
|
18382
18378
|
{
|
|
18383
18379
|
"kind": "javascript-module",
|
|
18384
|
-
"path": "src/
|
|
18380
|
+
"path": "src/top-bar/TopBar.ts",
|
|
18385
18381
|
"declarations": [
|
|
18386
18382
|
{
|
|
18387
18383
|
"kind": "class",
|
|
18388
|
-
"description": "
|
|
18389
|
-
"name": "
|
|
18384
|
+
"description": "Top bar is a header component that is always visible at the top of the interface. Top bar allows functionality such as search and contextual menus to be placed at the top of the interface.",
|
|
18385
|
+
"name": "TopBar",
|
|
18390
18386
|
"slots": [
|
|
18391
18387
|
{
|
|
18392
|
-
"description": "
|
|
18388
|
+
"description": "Used for the main content of the top bar. We recommend placing your application’s global search functionality into this slot.",
|
|
18393
18389
|
"name": ""
|
|
18390
|
+
},
|
|
18391
|
+
{
|
|
18392
|
+
"description": "Optional slot for menus, buttons, toggles, etc.",
|
|
18393
|
+
"name": "end"
|
|
18394
18394
|
}
|
|
18395
18395
|
],
|
|
18396
18396
|
"members": [],
|
|
@@ -18400,11 +18400,11 @@
|
|
|
18400
18400
|
},
|
|
18401
18401
|
"localization": [],
|
|
18402
18402
|
"status": "ready",
|
|
18403
|
-
"category": "
|
|
18404
|
-
"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-
|
|
18403
|
+
"category": "structure",
|
|
18404
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Applications that utilize the top bar can allow users to customize the color of the top bar to match their preference. [View an example](/components/top-bar/?example=color).\n- If your application allows it, include search to help users find resources and navigate.\n- Include a user menu in the end slot of the top bar.\n- Use the [layout component](/components/layout/?example=top-bar) to provide structure for the top bar component. We’ve also created [an example which shows full theming capabilities](/components/layout/?example=theming).\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for global navigation. Use the [navigation component](/components/navigation/) instead.\n- Don’t allow the user to set a top bar color that doesn’t provide enough contrast with the content.\n- Don’t allow the user to freely pick a hex code as the top bar color. Instead, offer a choice from a predefined palette of colors which provides sufficient contrast with the content. [View an example](/components/top-bar/?example=color).\n\n</div>\n\n---\n\n## Theming\n\nPlease see the [Top Bar theming](/themes/#top-bar-theming) section in our theming documentation for detailed guidelines.\n\n<nord-button variant=\"primary\" href=\"/themes/#top-bar-theming\">Theming Guidelines</nord-button>\n",
|
|
18405
18405
|
"examples": [],
|
|
18406
18406
|
"dependencies": [],
|
|
18407
|
-
"tagName": "nord-
|
|
18407
|
+
"tagName": "nord-top-bar",
|
|
18408
18408
|
"customElement": true
|
|
18409
18409
|
}
|
|
18410
18410
|
],
|
|
@@ -18413,16 +18413,16 @@
|
|
|
18413
18413
|
"kind": "js",
|
|
18414
18414
|
"name": "default",
|
|
18415
18415
|
"declaration": {
|
|
18416
|
-
"name": "
|
|
18417
|
-
"module": "src/
|
|
18416
|
+
"name": "TopBar",
|
|
18417
|
+
"module": "src/top-bar/TopBar.ts"
|
|
18418
18418
|
}
|
|
18419
18419
|
},
|
|
18420
18420
|
{
|
|
18421
18421
|
"kind": "custom-element-definition",
|
|
18422
|
-
"name": "nord-
|
|
18422
|
+
"name": "nord-top-bar",
|
|
18423
18423
|
"declaration": {
|
|
18424
|
-
"name": "
|
|
18425
|
-
"module": "src/
|
|
18424
|
+
"name": "TopBar",
|
|
18425
|
+
"module": "src/top-bar/TopBar.ts"
|
|
18426
18426
|
}
|
|
18427
18427
|
}
|
|
18428
18428
|
]
|