@nordhealth/components 3.22.0-alpha.0 → 4.0.0-alpha.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 +1251 -1251
- package/lib/Calendar-Cuumq57y.js.map +1 -1
- package/lib/bundle.js +96 -2
- package/lib/bundle.js.map +1 -1
- package/package.json +5 -5
package/custom-elements.json
CHANGED
|
@@ -673,123 +673,6 @@
|
|
|
673
673
|
}
|
|
674
674
|
]
|
|
675
675
|
},
|
|
676
|
-
{
|
|
677
|
-
"kind": "javascript-module",
|
|
678
|
-
"path": "src/badge/Badge.ts",
|
|
679
|
-
"declarations": [
|
|
680
|
-
{
|
|
681
|
-
"kind": "class",
|
|
682
|
-
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
683
|
-
"name": "Badge",
|
|
684
|
-
"slots": [
|
|
685
|
-
{
|
|
686
|
-
"description": "The badge content.",
|
|
687
|
-
"name": ""
|
|
688
|
-
},
|
|
689
|
-
{
|
|
690
|
-
"description": "Used to place an icon at the start of badge.",
|
|
691
|
-
"name": "icon"
|
|
692
|
-
}
|
|
693
|
-
],
|
|
694
|
-
"members": [
|
|
695
|
-
{
|
|
696
|
-
"kind": "field",
|
|
697
|
-
"name": "type",
|
|
698
|
-
"type": {
|
|
699
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
700
|
-
},
|
|
701
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
702
|
-
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
703
|
-
"default": "\"neutral\"",
|
|
704
|
-
"attribute": "type",
|
|
705
|
-
"reflects": true
|
|
706
|
-
},
|
|
707
|
-
{
|
|
708
|
-
"kind": "field",
|
|
709
|
-
"name": "variant",
|
|
710
|
-
"type": {
|
|
711
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
712
|
-
},
|
|
713
|
-
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
714
|
-
"default": "\"neutral\"",
|
|
715
|
-
"attribute": "variant",
|
|
716
|
-
"reflects": true
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
"kind": "field",
|
|
720
|
-
"name": "strong",
|
|
721
|
-
"type": {
|
|
722
|
-
"text": "boolean"
|
|
723
|
-
},
|
|
724
|
-
"default": "false",
|
|
725
|
-
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
726
|
-
"attribute": "strong",
|
|
727
|
-
"reflects": true
|
|
728
|
-
}
|
|
729
|
-
],
|
|
730
|
-
"attributes": [
|
|
731
|
-
{
|
|
732
|
-
"name": "type",
|
|
733
|
-
"type": {
|
|
734
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
735
|
-
},
|
|
736
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
737
|
-
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
738
|
-
"default": "\"neutral\"",
|
|
739
|
-
"fieldName": "type"
|
|
740
|
-
},
|
|
741
|
-
{
|
|
742
|
-
"name": "variant",
|
|
743
|
-
"type": {
|
|
744
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
745
|
-
},
|
|
746
|
-
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
747
|
-
"default": "\"neutral\"",
|
|
748
|
-
"fieldName": "variant"
|
|
749
|
-
},
|
|
750
|
-
{
|
|
751
|
-
"name": "strong",
|
|
752
|
-
"type": {
|
|
753
|
-
"text": "boolean"
|
|
754
|
-
},
|
|
755
|
-
"default": "false",
|
|
756
|
-
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
757
|
-
"fieldName": "strong"
|
|
758
|
-
}
|
|
759
|
-
],
|
|
760
|
-
"superclass": {
|
|
761
|
-
"name": "LitElement",
|
|
762
|
-
"package": "lit"
|
|
763
|
-
},
|
|
764
|
-
"localization": [],
|
|
765
|
-
"status": "ready",
|
|
766
|
-
"category": "text",
|
|
767
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s easy to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n- Don't use badges for labeling, categorizing, or organizing objects. Use the [tag component](/components/tag/) instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
768
|
-
"examples": [],
|
|
769
|
-
"dependencies": [],
|
|
770
|
-
"tagName": "nord-badge",
|
|
771
|
-
"customElement": true
|
|
772
|
-
}
|
|
773
|
-
],
|
|
774
|
-
"exports": [
|
|
775
|
-
{
|
|
776
|
-
"kind": "js",
|
|
777
|
-
"name": "default",
|
|
778
|
-
"declaration": {
|
|
779
|
-
"name": "Badge",
|
|
780
|
-
"module": "src/badge/Badge.ts"
|
|
781
|
-
}
|
|
782
|
-
},
|
|
783
|
-
{
|
|
784
|
-
"kind": "custom-element-definition",
|
|
785
|
-
"name": "nord-badge",
|
|
786
|
-
"declaration": {
|
|
787
|
-
"name": "Badge",
|
|
788
|
-
"module": "src/badge/Badge.ts"
|
|
789
|
-
}
|
|
790
|
-
}
|
|
791
|
-
]
|
|
792
|
-
},
|
|
793
676
|
{
|
|
794
677
|
"kind": "javascript-module",
|
|
795
678
|
"path": "src/button/Button.ts",
|
|
@@ -1373,7 +1256,7 @@
|
|
|
1373
1256
|
"localization": [],
|
|
1374
1257
|
"status": "ready",
|
|
1375
1258
|
"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-
|
|
1259
|
+
"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
1260
|
"examples": [],
|
|
1378
1261
|
"dependencies": [
|
|
1379
1262
|
"spinner"
|
|
@@ -1990,124 +1873,92 @@
|
|
|
1990
1873
|
},
|
|
1991
1874
|
{
|
|
1992
1875
|
"kind": "javascript-module",
|
|
1993
|
-
"path": "src/
|
|
1876
|
+
"path": "src/card/Card.ts",
|
|
1994
1877
|
"declarations": [
|
|
1995
1878
|
{
|
|
1996
1879
|
"kind": "class",
|
|
1997
|
-
"description": "
|
|
1998
|
-
"name": "
|
|
1880
|
+
"description": "Cards are shadowed surfaces that display content and actions on a\nsingle topic. They should be easy to scan for relevant and\nactionable information.",
|
|
1881
|
+
"name": "Card",
|
|
1999
1882
|
"cssProperties": [
|
|
2000
1883
|
{
|
|
2001
|
-
"description": "Controls
|
|
2002
|
-
"name": "--n-
|
|
2003
|
-
"default": "var(--n-border-radius
|
|
1884
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1885
|
+
"name": "--n-card-border-radius",
|
|
1886
|
+
"default": "var(--n-border-radius)"
|
|
2004
1887
|
},
|
|
2005
1888
|
{
|
|
2006
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).
|
|
2007
|
-
"name": "--n-
|
|
2008
|
-
"default": "var(--n-box-shadow)"
|
|
1889
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1890
|
+
"name": "--n-card-box-shadow",
|
|
1891
|
+
"default": "var(--n-box-shadow-popout)"
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"description": "Controls the padding on all sides of the card.",
|
|
1895
|
+
"name": "--n-card-padding",
|
|
1896
|
+
"default": "var(--n-space-m)"
|
|
1897
|
+
},
|
|
1898
|
+
{
|
|
1899
|
+
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
1900
|
+
"name": "--n-card-slot-padding",
|
|
1901
|
+
"default": "var(--n-space-m)"
|
|
2009
1902
|
}
|
|
2010
1903
|
],
|
|
2011
1904
|
"slots": [
|
|
2012
1905
|
{
|
|
2013
|
-
"description": "The
|
|
1906
|
+
"description": "The card content.",
|
|
2014
1907
|
"name": ""
|
|
1908
|
+
},
|
|
1909
|
+
{
|
|
1910
|
+
"description": "Optional slot that holds a header for the card.",
|
|
1911
|
+
"name": "header"
|
|
1912
|
+
},
|
|
1913
|
+
{
|
|
1914
|
+
"description": "Optional slot that positions content at the end of the header. Useful for actions or additional info.",
|
|
1915
|
+
"name": "header-end"
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"description": "Optional slot that holds footer content for the card.",
|
|
1919
|
+
"name": "footer"
|
|
2015
1920
|
}
|
|
2016
1921
|
],
|
|
2017
1922
|
"members": [
|
|
2018
1923
|
{
|
|
2019
1924
|
"kind": "field",
|
|
2020
|
-
"name": "
|
|
1925
|
+
"name": "headerSlot",
|
|
2021
1926
|
"privacy": "private",
|
|
2022
|
-
"default": "new SlotController(this)"
|
|
1927
|
+
"default": "new SlotController(this, \"header\")"
|
|
2023
1928
|
},
|
|
2024
1929
|
{
|
|
2025
1930
|
"kind": "field",
|
|
2026
|
-
"name": "
|
|
1931
|
+
"name": "headerEndSlot",
|
|
2027
1932
|
"privacy": "private",
|
|
2028
|
-
"default": "new
|
|
2029
|
-
},
|
|
2030
|
-
{
|
|
2031
|
-
"kind": "field",
|
|
2032
|
-
"name": "variant",
|
|
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
|
|
1933
|
+
"default": "new SlotController(this, \"header-end\")"
|
|
2051
1934
|
},
|
|
2052
1935
|
{
|
|
2053
1936
|
"kind": "field",
|
|
2054
|
-
"name": "
|
|
2055
|
-
"
|
|
2056
|
-
|
|
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
|
|
1937
|
+
"name": "footerSlot",
|
|
1938
|
+
"privacy": "private",
|
|
1939
|
+
"default": "new SlotController(this, \"footer\")"
|
|
2062
1940
|
},
|
|
2063
1941
|
{
|
|
2064
1942
|
"kind": "field",
|
|
2065
|
-
"name": "
|
|
1943
|
+
"name": "padding",
|
|
2066
1944
|
"type": {
|
|
2067
|
-
"text": "
|
|
1945
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
2068
1946
|
},
|
|
2069
|
-
"default": "\"
|
|
2070
|
-
"description": "
|
|
2071
|
-
"attribute": "
|
|
1947
|
+
"default": "\"m\"",
|
|
1948
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1949
|
+
"attribute": "padding",
|
|
2072
1950
|
"reflects": true
|
|
2073
1951
|
}
|
|
2074
1952
|
],
|
|
2075
1953
|
"attributes": [
|
|
2076
1954
|
{
|
|
2077
|
-
"name": "
|
|
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",
|
|
1955
|
+
"name": "padding",
|
|
2105
1956
|
"type": {
|
|
2106
|
-
"text": "
|
|
1957
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
2107
1958
|
},
|
|
2108
|
-
"default": "\"
|
|
2109
|
-
"description": "
|
|
2110
|
-
"fieldName": "
|
|
1959
|
+
"default": "\"m\"",
|
|
1960
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1961
|
+
"fieldName": "padding"
|
|
2111
1962
|
}
|
|
2112
1963
|
],
|
|
2113
1964
|
"superclass": {
|
|
@@ -2117,10 +1968,10 @@
|
|
|
2117
1968
|
"localization": [],
|
|
2118
1969
|
"status": "ready",
|
|
2119
1970
|
"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
|
|
1971
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n- Include a header when placing a [Table](/components/table) component inside the card.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place cards within cards. Consider using the [divider](/components/divider/) component to break up sections instead.\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n",
|
|
2121
1972
|
"examples": [],
|
|
2122
1973
|
"dependencies": [],
|
|
2123
|
-
"tagName": "nord-
|
|
1974
|
+
"tagName": "nord-card",
|
|
2124
1975
|
"customElement": true
|
|
2125
1976
|
}
|
|
2126
1977
|
],
|
|
@@ -2129,16 +1980,16 @@
|
|
|
2129
1980
|
"kind": "js",
|
|
2130
1981
|
"name": "default",
|
|
2131
1982
|
"declaration": {
|
|
2132
|
-
"name": "
|
|
2133
|
-
"module": "src/
|
|
1983
|
+
"name": "Card",
|
|
1984
|
+
"module": "src/card/Card.ts"
|
|
2134
1985
|
}
|
|
2135
1986
|
},
|
|
2136
1987
|
{
|
|
2137
1988
|
"kind": "custom-element-definition",
|
|
2138
|
-
"name": "nord-
|
|
1989
|
+
"name": "nord-card",
|
|
2139
1990
|
"declaration": {
|
|
2140
|
-
"name": "
|
|
2141
|
-
"module": "src/
|
|
1991
|
+
"name": "Card",
|
|
1992
|
+
"module": "src/card/Card.ts"
|
|
2142
1993
|
}
|
|
2143
1994
|
}
|
|
2144
1995
|
]
|
|
@@ -2883,92 +2734,241 @@
|
|
|
2883
2734
|
},
|
|
2884
2735
|
{
|
|
2885
2736
|
"kind": "javascript-module",
|
|
2886
|
-
"path": "src/
|
|
2737
|
+
"path": "src/badge/Badge.ts",
|
|
2887
2738
|
"declarations": [
|
|
2888
2739
|
{
|
|
2889
2740
|
"kind": "class",
|
|
2890
|
-
"description": "
|
|
2891
|
-
"name": "
|
|
2892
|
-
"
|
|
2741
|
+
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
2742
|
+
"name": "Badge",
|
|
2743
|
+
"slots": [
|
|
2893
2744
|
{
|
|
2894
|
-
"description": "
|
|
2895
|
-
"name": "
|
|
2896
|
-
"default": "var(--n-border-radius)"
|
|
2745
|
+
"description": "The badge content.",
|
|
2746
|
+
"name": ""
|
|
2897
2747
|
},
|
|
2898
2748
|
{
|
|
2899
|
-
"description": "
|
|
2900
|
-
"name": "
|
|
2901
|
-
|
|
2749
|
+
"description": "Used to place an icon at the start of badge.",
|
|
2750
|
+
"name": "icon"
|
|
2751
|
+
}
|
|
2752
|
+
],
|
|
2753
|
+
"members": [
|
|
2754
|
+
{
|
|
2755
|
+
"kind": "field",
|
|
2756
|
+
"name": "type",
|
|
2757
|
+
"type": {
|
|
2758
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
2759
|
+
},
|
|
2760
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
2761
|
+
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
2762
|
+
"default": "\"neutral\"",
|
|
2763
|
+
"attribute": "type",
|
|
2764
|
+
"reflects": true
|
|
2902
2765
|
},
|
|
2903
2766
|
{
|
|
2904
|
-
"
|
|
2905
|
-
"name": "
|
|
2906
|
-
"
|
|
2767
|
+
"kind": "field",
|
|
2768
|
+
"name": "variant",
|
|
2769
|
+
"type": {
|
|
2770
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
2771
|
+
},
|
|
2772
|
+
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
2773
|
+
"default": "\"neutral\"",
|
|
2774
|
+
"attribute": "variant",
|
|
2775
|
+
"reflects": true
|
|
2907
2776
|
},
|
|
2908
2777
|
{
|
|
2909
|
-
"
|
|
2910
|
-
"name": "
|
|
2911
|
-
"
|
|
2778
|
+
"kind": "field",
|
|
2779
|
+
"name": "strong",
|
|
2780
|
+
"type": {
|
|
2781
|
+
"text": "boolean"
|
|
2782
|
+
},
|
|
2783
|
+
"default": "false",
|
|
2784
|
+
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
2785
|
+
"attribute": "strong",
|
|
2786
|
+
"reflects": true
|
|
2912
2787
|
}
|
|
2913
2788
|
],
|
|
2914
|
-
"
|
|
2789
|
+
"attributes": [
|
|
2915
2790
|
{
|
|
2916
|
-
"
|
|
2917
|
-
"
|
|
2791
|
+
"name": "type",
|
|
2792
|
+
"type": {
|
|
2793
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
2794
|
+
},
|
|
2795
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
2796
|
+
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
2797
|
+
"default": "\"neutral\"",
|
|
2798
|
+
"fieldName": "type"
|
|
2918
2799
|
},
|
|
2919
2800
|
{
|
|
2920
|
-
"
|
|
2921
|
-
"
|
|
2801
|
+
"name": "variant",
|
|
2802
|
+
"type": {
|
|
2803
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
2804
|
+
},
|
|
2805
|
+
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
2806
|
+
"default": "\"neutral\"",
|
|
2807
|
+
"fieldName": "variant"
|
|
2922
2808
|
},
|
|
2923
2809
|
{
|
|
2924
|
-
"
|
|
2925
|
-
"
|
|
2810
|
+
"name": "strong",
|
|
2811
|
+
"type": {
|
|
2812
|
+
"text": "boolean"
|
|
2813
|
+
},
|
|
2814
|
+
"default": "false",
|
|
2815
|
+
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
2816
|
+
"fieldName": "strong"
|
|
2817
|
+
}
|
|
2818
|
+
],
|
|
2819
|
+
"superclass": {
|
|
2820
|
+
"name": "LitElement",
|
|
2821
|
+
"package": "lit"
|
|
2822
|
+
},
|
|
2823
|
+
"localization": [],
|
|
2824
|
+
"status": "ready",
|
|
2825
|
+
"category": "text",
|
|
2826
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s easy to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n- Don't use badges for labeling, categorizing, or organizing objects. Use the [tag component](/components/tag/) instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
2827
|
+
"examples": [],
|
|
2828
|
+
"dependencies": [],
|
|
2829
|
+
"tagName": "nord-badge",
|
|
2830
|
+
"customElement": true
|
|
2831
|
+
}
|
|
2832
|
+
],
|
|
2833
|
+
"exports": [
|
|
2834
|
+
{
|
|
2835
|
+
"kind": "js",
|
|
2836
|
+
"name": "default",
|
|
2837
|
+
"declaration": {
|
|
2838
|
+
"name": "Badge",
|
|
2839
|
+
"module": "src/badge/Badge.ts"
|
|
2840
|
+
}
|
|
2841
|
+
},
|
|
2842
|
+
{
|
|
2843
|
+
"kind": "custom-element-definition",
|
|
2844
|
+
"name": "nord-badge",
|
|
2845
|
+
"declaration": {
|
|
2846
|
+
"name": "Badge",
|
|
2847
|
+
"module": "src/badge/Badge.ts"
|
|
2848
|
+
}
|
|
2849
|
+
}
|
|
2850
|
+
]
|
|
2851
|
+
},
|
|
2852
|
+
{
|
|
2853
|
+
"kind": "javascript-module",
|
|
2854
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
2855
|
+
"declarations": [
|
|
2856
|
+
{
|
|
2857
|
+
"kind": "class",
|
|
2858
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
2859
|
+
"name": "ButtonGroup",
|
|
2860
|
+
"cssProperties": [
|
|
2861
|
+
{
|
|
2862
|
+
"description": "Controls the rounded corners of the button group, using [border radius tokens](/tokens/#border-radius). Only relevant for the default variant.",
|
|
2863
|
+
"name": "--n-button-group-border-radius",
|
|
2864
|
+
"default": "var(--n-border-radius-s)"
|
|
2926
2865
|
},
|
|
2927
2866
|
{
|
|
2928
|
-
"description": "
|
|
2929
|
-
"name": "
|
|
2867
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow). Only relevant for the default variant.",
|
|
2868
|
+
"name": "--n-button-group-box-shadow",
|
|
2869
|
+
"default": "var(--n-box-shadow)"
|
|
2870
|
+
}
|
|
2871
|
+
],
|
|
2872
|
+
"slots": [
|
|
2873
|
+
{
|
|
2874
|
+
"description": "The button group content",
|
|
2875
|
+
"name": ""
|
|
2930
2876
|
}
|
|
2931
2877
|
],
|
|
2932
2878
|
"members": [
|
|
2933
2879
|
{
|
|
2934
2880
|
"kind": "field",
|
|
2935
|
-
"name": "
|
|
2881
|
+
"name": "defaultSlot",
|
|
2936
2882
|
"privacy": "private",
|
|
2937
|
-
"default": "new SlotController(this
|
|
2883
|
+
"default": "new SlotController(this)"
|
|
2938
2884
|
},
|
|
2939
2885
|
{
|
|
2940
2886
|
"kind": "field",
|
|
2941
|
-
"name": "
|
|
2887
|
+
"name": "dirController",
|
|
2942
2888
|
"privacy": "private",
|
|
2943
|
-
"default": "new
|
|
2889
|
+
"default": "new DirectionController(this)"
|
|
2944
2890
|
},
|
|
2945
2891
|
{
|
|
2946
2892
|
"kind": "field",
|
|
2947
|
-
"name": "
|
|
2948
|
-
"
|
|
2949
|
-
|
|
2893
|
+
"name": "variant",
|
|
2894
|
+
"type": {
|
|
2895
|
+
"text": "\"default\" | \"spaced\""
|
|
2896
|
+
},
|
|
2897
|
+
"default": "\"default\"",
|
|
2898
|
+
"description": "The style variant of the button group.",
|
|
2899
|
+
"attribute": "variant",
|
|
2900
|
+
"reflects": true
|
|
2950
2901
|
},
|
|
2951
2902
|
{
|
|
2952
2903
|
"kind": "field",
|
|
2953
|
-
"name": "
|
|
2904
|
+
"name": "direction",
|
|
2954
2905
|
"type": {
|
|
2955
|
-
"text": "\"
|
|
2906
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
2956
2907
|
},
|
|
2957
|
-
"default": "\"
|
|
2958
|
-
"description": "
|
|
2959
|
-
"attribute": "
|
|
2908
|
+
"default": "\"horizontal\"",
|
|
2909
|
+
"description": "The direction of the button group.",
|
|
2910
|
+
"attribute": "direction",
|
|
2911
|
+
"reflects": true
|
|
2912
|
+
},
|
|
2913
|
+
{
|
|
2914
|
+
"kind": "field",
|
|
2915
|
+
"name": "wrap",
|
|
2916
|
+
"type": {
|
|
2917
|
+
"text": "boolean"
|
|
2918
|
+
},
|
|
2919
|
+
"default": "false",
|
|
2920
|
+
"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`).",
|
|
2921
|
+
"attribute": "wrap",
|
|
2922
|
+
"reflects": true
|
|
2923
|
+
},
|
|
2924
|
+
{
|
|
2925
|
+
"kind": "field",
|
|
2926
|
+
"name": "role",
|
|
2927
|
+
"type": {
|
|
2928
|
+
"text": "string"
|
|
2929
|
+
},
|
|
2930
|
+
"default": "\"group\"",
|
|
2931
|
+
"description": "The appropriate role for the containing element.",
|
|
2932
|
+
"attribute": "role",
|
|
2960
2933
|
"reflects": true
|
|
2961
2934
|
}
|
|
2962
2935
|
],
|
|
2963
2936
|
"attributes": [
|
|
2964
2937
|
{
|
|
2965
|
-
"name": "
|
|
2938
|
+
"name": "variant",
|
|
2966
2939
|
"type": {
|
|
2967
|
-
"text": "\"
|
|
2940
|
+
"text": "\"default\" | \"spaced\""
|
|
2968
2941
|
},
|
|
2969
|
-
"default": "\"
|
|
2970
|
-
"description": "
|
|
2971
|
-
"fieldName": "
|
|
2942
|
+
"default": "\"default\"",
|
|
2943
|
+
"description": "The style variant of the button group.",
|
|
2944
|
+
"fieldName": "variant"
|
|
2945
|
+
},
|
|
2946
|
+
{
|
|
2947
|
+
"name": "direction",
|
|
2948
|
+
"type": {
|
|
2949
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
2950
|
+
},
|
|
2951
|
+
"default": "\"horizontal\"",
|
|
2952
|
+
"description": "The direction of the button group.",
|
|
2953
|
+
"fieldName": "direction"
|
|
2954
|
+
},
|
|
2955
|
+
{
|
|
2956
|
+
"name": "wrap",
|
|
2957
|
+
"type": {
|
|
2958
|
+
"text": "boolean"
|
|
2959
|
+
},
|
|
2960
|
+
"default": "false",
|
|
2961
|
+
"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`).",
|
|
2962
|
+
"fieldName": "wrap"
|
|
2963
|
+
},
|
|
2964
|
+
{
|
|
2965
|
+
"name": "role",
|
|
2966
|
+
"type": {
|
|
2967
|
+
"text": "string"
|
|
2968
|
+
},
|
|
2969
|
+
"default": "\"group\"",
|
|
2970
|
+
"description": "The appropriate role for the containing element.",
|
|
2971
|
+
"fieldName": "role"
|
|
2972
2972
|
}
|
|
2973
2973
|
],
|
|
2974
2974
|
"superclass": {
|
|
@@ -2978,10 +2978,10 @@
|
|
|
2978
2978
|
"localization": [],
|
|
2979
2979
|
"status": "ready",
|
|
2980
2980
|
"category": "structure",
|
|
2981
|
-
"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
|
|
2981
|
+
"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",
|
|
2982
2982
|
"examples": [],
|
|
2983
2983
|
"dependencies": [],
|
|
2984
|
-
"tagName": "nord-
|
|
2984
|
+
"tagName": "nord-button-group",
|
|
2985
2985
|
"customElement": true
|
|
2986
2986
|
}
|
|
2987
2987
|
],
|
|
@@ -2990,16 +2990,16 @@
|
|
|
2990
2990
|
"kind": "js",
|
|
2991
2991
|
"name": "default",
|
|
2992
2992
|
"declaration": {
|
|
2993
|
-
"name": "
|
|
2994
|
-
"module": "src/
|
|
2993
|
+
"name": "ButtonGroup",
|
|
2994
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
2995
2995
|
}
|
|
2996
2996
|
},
|
|
2997
2997
|
{
|
|
2998
2998
|
"kind": "custom-element-definition",
|
|
2999
|
-
"name": "nord-
|
|
2999
|
+
"name": "nord-button-group",
|
|
3000
3000
|
"declaration": {
|
|
3001
|
-
"name": "
|
|
3002
|
-
"module": "src/
|
|
3001
|
+
"name": "ButtonGroup",
|
|
3002
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
3003
3003
|
}
|
|
3004
3004
|
}
|
|
3005
3005
|
]
|
|
@@ -10875,12 +10875,69 @@
|
|
|
10875
10875
|
},
|
|
10876
10876
|
{
|
|
10877
10877
|
"kind": "javascript-module",
|
|
10878
|
-
"path": "src/
|
|
10878
|
+
"path": "src/notification-group/NotificationGroup.ts",
|
|
10879
10879
|
"declarations": [
|
|
10880
10880
|
{
|
|
10881
10881
|
"kind": "class",
|
|
10882
|
-
"description": "
|
|
10883
|
-
"name": "
|
|
10882
|
+
"description": "Notification group is used to position and style a group of notifications.",
|
|
10883
|
+
"name": "NotificationGroup",
|
|
10884
|
+
"slots": [
|
|
10885
|
+
{
|
|
10886
|
+
"description": "Default slot in which to place notifications.",
|
|
10887
|
+
"name": ""
|
|
10888
|
+
}
|
|
10889
|
+
],
|
|
10890
|
+
"members": [],
|
|
10891
|
+
"events": [
|
|
10892
|
+
{
|
|
10893
|
+
"type": {
|
|
10894
|
+
"text": "NordEvent"
|
|
10895
|
+
},
|
|
10896
|
+
"description": "Fired when a notification is dismissed, and its exit animation has completed. This event should be used to remove the dismissed notification from the DOM.",
|
|
10897
|
+
"name": "dismiss"
|
|
10898
|
+
}
|
|
10899
|
+
],
|
|
10900
|
+
"superclass": {
|
|
10901
|
+
"name": "LitElement",
|
|
10902
|
+
"package": "lit"
|
|
10903
|
+
},
|
|
10904
|
+
"localization": [],
|
|
10905
|
+
"status": "ready",
|
|
10906
|
+
"category": "feedback",
|
|
10907
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Notification](/components/notification/) so that notifications get styled and positioned correctly.\n- Add as close to the start of your main content area as possible.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than notification components\n\n</div>\n\n---\n\n## Content guidelines\n\nNotification content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the notification content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAction link labels in notifications should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing action link labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Start consultation</div>\n<div class=\"n-usage n-usage-dont\">Start Consultation</div>\n\nAvoid unnecessary words and articles in action link labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n",
|
|
10908
|
+
"examples": [],
|
|
10909
|
+
"dependencies": [],
|
|
10910
|
+
"tagName": "nord-notification-group",
|
|
10911
|
+
"customElement": true
|
|
10912
|
+
}
|
|
10913
|
+
],
|
|
10914
|
+
"exports": [
|
|
10915
|
+
{
|
|
10916
|
+
"kind": "js",
|
|
10917
|
+
"name": "default",
|
|
10918
|
+
"declaration": {
|
|
10919
|
+
"name": "NotificationGroup",
|
|
10920
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10921
|
+
}
|
|
10922
|
+
},
|
|
10923
|
+
{
|
|
10924
|
+
"kind": "custom-element-definition",
|
|
10925
|
+
"name": "nord-notification-group",
|
|
10926
|
+
"declaration": {
|
|
10927
|
+
"name": "NotificationGroup",
|
|
10928
|
+
"module": "src/notification-group/NotificationGroup.ts"
|
|
10929
|
+
}
|
|
10930
|
+
}
|
|
10931
|
+
]
|
|
10932
|
+
},
|
|
10933
|
+
{
|
|
10934
|
+
"kind": "javascript-module",
|
|
10935
|
+
"path": "src/popout/Popout.ts",
|
|
10936
|
+
"declarations": [
|
|
10937
|
+
{
|
|
10938
|
+
"kind": "class",
|
|
10939
|
+
"description": "Popouts are small overlays that open on demand. They let users access additional content and actions without cluttering the page.",
|
|
10940
|
+
"name": "Popout",
|
|
10884
10941
|
"slots": [
|
|
10885
10942
|
{
|
|
10886
10943
|
"description": "The popout content.",
|
|
@@ -11216,63 +11273,6 @@
|
|
|
11216
11273
|
}
|
|
11217
11274
|
]
|
|
11218
11275
|
},
|
|
11219
|
-
{
|
|
11220
|
-
"kind": "javascript-module",
|
|
11221
|
-
"path": "src/notification-group/NotificationGroup.ts",
|
|
11222
|
-
"declarations": [
|
|
11223
|
-
{
|
|
11224
|
-
"kind": "class",
|
|
11225
|
-
"description": "Notification group is used to position and style a group of notifications.",
|
|
11226
|
-
"name": "NotificationGroup",
|
|
11227
|
-
"slots": [
|
|
11228
|
-
{
|
|
11229
|
-
"description": "Default slot in which to place notifications.",
|
|
11230
|
-
"name": ""
|
|
11231
|
-
}
|
|
11232
|
-
],
|
|
11233
|
-
"members": [],
|
|
11234
|
-
"events": [
|
|
11235
|
-
{
|
|
11236
|
-
"type": {
|
|
11237
|
-
"text": "NordEvent"
|
|
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
11276
|
{
|
|
11277
11277
|
"kind": "javascript-module",
|
|
11278
11278
|
"path": "src/progress-bar/ProgressBar.ts",
|
|
@@ -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",
|
|
@@ -14736,59 +14656,139 @@
|
|
|
14736
14656
|
},
|
|
14737
14657
|
{
|
|
14738
14658
|
"kind": "javascript-module",
|
|
14739
|
-
"path": "src/
|
|
14659
|
+
"path": "src/skeleton/Skeleton.ts",
|
|
14740
14660
|
"declarations": [
|
|
14741
14661
|
{
|
|
14742
14662
|
"kind": "class",
|
|
14743
|
-
"description": "
|
|
14744
|
-
"name": "
|
|
14663
|
+
"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.",
|
|
14664
|
+
"name": "Skeleton",
|
|
14745
14665
|
"cssProperties": [
|
|
14746
14666
|
{
|
|
14747
|
-
"description": "Controls the
|
|
14748
|
-
"name": "--n-
|
|
14749
|
-
"default": "var(--n-
|
|
14750
|
-
}
|
|
14751
|
-
],
|
|
14752
|
-
"slots": [
|
|
14667
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
14668
|
+
"name": "--n-skeleton-border-radius",
|
|
14669
|
+
"default": "var(--n-border-radius)"
|
|
14670
|
+
},
|
|
14753
14671
|
{
|
|
14754
|
-
"description": "
|
|
14755
|
-
"name": ""
|
|
14672
|
+
"description": "Controls the main color of the skeleton, using our [color tokens](/tokens/#color).",
|
|
14673
|
+
"name": "--n-skeleton-color",
|
|
14674
|
+
"default": "var(--n-color-border)"
|
|
14675
|
+
},
|
|
14676
|
+
{
|
|
14677
|
+
"description": "Controls the sheen color of the skeleton, using our [color tokens](/tokens/#color).",
|
|
14678
|
+
"name": "--n-skeleton-sheen-color",
|
|
14679
|
+
"default": "var(--n-color-border-strong)"
|
|
14756
14680
|
}
|
|
14757
14681
|
],
|
|
14758
14682
|
"members": [
|
|
14759
14683
|
{
|
|
14760
14684
|
"kind": "field",
|
|
14761
|
-
"name": "
|
|
14762
|
-
"type": {
|
|
14763
|
-
"text": "\"none\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
14764
|
-
},
|
|
14765
|
-
"default": "\"m\"",
|
|
14766
|
-
"description": "The space injected between components.",
|
|
14767
|
-
"attribute": "gap",
|
|
14768
|
-
"reflects": true
|
|
14769
|
-
},
|
|
14770
|
-
{
|
|
14771
|
-
"kind": "field",
|
|
14772
|
-
"name": "direction",
|
|
14685
|
+
"name": "effect",
|
|
14773
14686
|
"type": {
|
|
14774
|
-
"text": "\"
|
|
14687
|
+
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
14775
14688
|
},
|
|
14776
|
-
"
|
|
14777
|
-
"
|
|
14778
|
-
"attribute": "direction",
|
|
14689
|
+
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
14690
|
+
"attribute": "effect",
|
|
14779
14691
|
"reflects": true
|
|
14780
|
-
}
|
|
14692
|
+
}
|
|
14693
|
+
],
|
|
14694
|
+
"attributes": [
|
|
14781
14695
|
{
|
|
14782
|
-
"
|
|
14783
|
-
"name": "alignItems",
|
|
14696
|
+
"name": "effect",
|
|
14784
14697
|
"type": {
|
|
14785
|
-
"text": "
|
|
14698
|
+
"text": "\"pulse\" | \"sheen\" | undefined"
|
|
14786
14699
|
},
|
|
14787
|
-
"
|
|
14788
|
-
"
|
|
14789
|
-
|
|
14790
|
-
|
|
14791
|
-
|
|
14700
|
+
"description": "Determines which animation effect the skeleton will use.\nThe default is no animation.",
|
|
14701
|
+
"fieldName": "effect"
|
|
14702
|
+
}
|
|
14703
|
+
],
|
|
14704
|
+
"superclass": {
|
|
14705
|
+
"name": "LitElement",
|
|
14706
|
+
"package": "lit"
|
|
14707
|
+
},
|
|
14708
|
+
"localization": [],
|
|
14709
|
+
"status": "ready",
|
|
14710
|
+
"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 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
|
+
"examples": [],
|
|
14713
|
+
"dependencies": [],
|
|
14714
|
+
"tagName": "nord-skeleton",
|
|
14715
|
+
"customElement": true
|
|
14716
|
+
}
|
|
14717
|
+
],
|
|
14718
|
+
"exports": [
|
|
14719
|
+
{
|
|
14720
|
+
"kind": "js",
|
|
14721
|
+
"name": "default",
|
|
14722
|
+
"declaration": {
|
|
14723
|
+
"name": "Skeleton",
|
|
14724
|
+
"module": "src/skeleton/Skeleton.ts"
|
|
14725
|
+
}
|
|
14726
|
+
},
|
|
14727
|
+
{
|
|
14728
|
+
"kind": "custom-element-definition",
|
|
14729
|
+
"name": "nord-skeleton",
|
|
14730
|
+
"declaration": {
|
|
14731
|
+
"name": "Skeleton",
|
|
14732
|
+
"module": "src/skeleton/Skeleton.ts"
|
|
14733
|
+
}
|
|
14734
|
+
}
|
|
14735
|
+
]
|
|
14736
|
+
},
|
|
14737
|
+
{
|
|
14738
|
+
"kind": "javascript-module",
|
|
14739
|
+
"path": "src/stack/Stack.ts",
|
|
14740
|
+
"declarations": [
|
|
14741
|
+
{
|
|
14742
|
+
"kind": "class",
|
|
14743
|
+
"description": "Stack component manages layout of immediate children along the\nvertical or horizontal axis with optional spacing between each child.",
|
|
14744
|
+
"name": "Stack",
|
|
14745
|
+
"cssProperties": [
|
|
14746
|
+
{
|
|
14747
|
+
"description": "Controls the spacing between items, using our [spacing tokens](/tokens/#space).",
|
|
14748
|
+
"name": "--n-stack-gap",
|
|
14749
|
+
"default": "var(--n-space-m)"
|
|
14750
|
+
}
|
|
14751
|
+
],
|
|
14752
|
+
"slots": [
|
|
14753
|
+
{
|
|
14754
|
+
"description": "The stack content.",
|
|
14755
|
+
"name": ""
|
|
14756
|
+
}
|
|
14757
|
+
],
|
|
14758
|
+
"members": [
|
|
14759
|
+
{
|
|
14760
|
+
"kind": "field",
|
|
14761
|
+
"name": "gap",
|
|
14762
|
+
"type": {
|
|
14763
|
+
"text": "\"none\" | \"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
14764
|
+
},
|
|
14765
|
+
"default": "\"m\"",
|
|
14766
|
+
"description": "The space injected between components.",
|
|
14767
|
+
"attribute": "gap",
|
|
14768
|
+
"reflects": true
|
|
14769
|
+
},
|
|
14770
|
+
{
|
|
14771
|
+
"kind": "field",
|
|
14772
|
+
"name": "direction",
|
|
14773
|
+
"type": {
|
|
14774
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
14775
|
+
},
|
|
14776
|
+
"default": "\"vertical\"",
|
|
14777
|
+
"description": "The direction of the stack.",
|
|
14778
|
+
"attribute": "direction",
|
|
14779
|
+
"reflects": true
|
|
14780
|
+
},
|
|
14781
|
+
{
|
|
14782
|
+
"kind": "field",
|
|
14783
|
+
"name": "alignItems",
|
|
14784
|
+
"type": {
|
|
14785
|
+
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"baseline\"\n | \"stretch\" | undefined"
|
|
14786
|
+
},
|
|
14787
|
+
"default": "\"stretch\"",
|
|
14788
|
+
"description": "How to align the child items inside the stack.",
|
|
14789
|
+
"attribute": "align-items",
|
|
14790
|
+
"reflects": true
|
|
14791
|
+
},
|
|
14792
14792
|
{
|
|
14793
14793
|
"kind": "field",
|
|
14794
14794
|
"name": "wrap",
|
|
@@ -17252,355 +17252,490 @@
|
|
|
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": "
|
|
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",
|
|
17261
|
+
"slots": [
|
|
17262
|
+
{
|
|
17263
|
+
"description": "Default slot in which to place toasts.",
|
|
17264
|
+
"name": ""
|
|
17265
|
+
}
|
|
17266
|
+
],
|
|
17267
|
+
"members": [
|
|
17268
|
+
{
|
|
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
|
+
{
|
|
17298
|
+
"type": {
|
|
17299
|
+
"text": "NordEvent"
|
|
17300
|
+
},
|
|
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",
|
|
17261
17348
|
"cssProperties": [
|
|
17262
17349
|
{
|
|
17263
|
-
"description": "Controls the
|
|
17264
|
-
"name": "--n-
|
|
17265
|
-
"default": "
|
|
17350
|
+
"description": "Controls the maximum inline size, or width, of the tooltip.",
|
|
17351
|
+
"name": "--n-tooltip-max-size",
|
|
17352
|
+
"default": "50ch"
|
|
17266
17353
|
}
|
|
17267
17354
|
],
|
|
17268
17355
|
"slots": [
|
|
17269
17356
|
{
|
|
17270
|
-
"description": "
|
|
17271
|
-
"name": "
|
|
17272
|
-
},
|
|
17273
|
-
{
|
|
17274
|
-
"description": "Optional slot that holds hint text for the input.",
|
|
17275
|
-
"name": "hint"
|
|
17357
|
+
"description": "The tooltip content",
|
|
17358
|
+
"name": ""
|
|
17276
17359
|
},
|
|
17277
17360
|
{
|
|
17278
|
-
"description": "Optional slot that holds
|
|
17279
|
-
"name": "
|
|
17361
|
+
"description": "Optional slot that holds shortcut keys to access the subject",
|
|
17362
|
+
"name": "shortcut"
|
|
17280
17363
|
}
|
|
17281
17364
|
],
|
|
17282
17365
|
"members": [
|
|
17283
17366
|
{
|
|
17284
17367
|
"kind": "field",
|
|
17285
|
-
"name": "
|
|
17286
|
-
"
|
|
17287
|
-
|
|
17288
|
-
|
|
17289
|
-
|
|
17290
|
-
|
|
17291
|
-
}
|
|
17368
|
+
"name": "lastOpened",
|
|
17369
|
+
"type": {
|
|
17370
|
+
"text": "Tooltip | undefined"
|
|
17371
|
+
},
|
|
17372
|
+
"privacy": "private",
|
|
17373
|
+
"static": true
|
|
17292
17374
|
},
|
|
17293
17375
|
{
|
|
17294
17376
|
"kind": "field",
|
|
17295
|
-
"name": "
|
|
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",
|
|
17296
17390
|
"type": {
|
|
17297
|
-
"text": "
|
|
17391
|
+
"text": "FocusableElement | undefined"
|
|
17298
17392
|
},
|
|
17299
|
-
"
|
|
17300
|
-
"description": "Controls whether the toggle is checked or not.",
|
|
17301
|
-
"attribute": "checked",
|
|
17302
|
-
"reflects": true
|
|
17393
|
+
"privacy": "private"
|
|
17303
17394
|
},
|
|
17304
17395
|
{
|
|
17305
17396
|
"kind": "field",
|
|
17306
|
-
"name": "
|
|
17397
|
+
"name": "timeoutId",
|
|
17307
17398
|
"type": {
|
|
17308
|
-
"text": "
|
|
17399
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
17309
17400
|
},
|
|
17310
|
-
"
|
|
17311
|
-
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
17312
|
-
"attribute": "reverse",
|
|
17313
|
-
"reflects": true
|
|
17401
|
+
"privacy": "private"
|
|
17314
17402
|
},
|
|
17315
17403
|
{
|
|
17316
17404
|
"kind": "field",
|
|
17317
|
-
"name": "
|
|
17405
|
+
"name": "proxy",
|
|
17318
17406
|
"type": {
|
|
17319
|
-
"text": "
|
|
17407
|
+
"text": "HTMLSpanElement | undefined"
|
|
17320
17408
|
},
|
|
17321
|
-
"
|
|
17322
|
-
"description": "
|
|
17323
|
-
"attribute": "size",
|
|
17324
|
-
"reflects": true
|
|
17325
|
-
},
|
|
17326
|
-
{
|
|
17327
|
-
"kind": "method",
|
|
17328
|
-
"name": "handleChange",
|
|
17329
|
-
"privacy": "protected",
|
|
17330
|
-
"parameters": [
|
|
17331
|
-
{
|
|
17332
|
-
"name": "e",
|
|
17333
|
-
"type": {
|
|
17334
|
-
"text": "Event"
|
|
17335
|
-
}
|
|
17336
|
-
}
|
|
17337
|
-
],
|
|
17338
|
-
"return": {
|
|
17339
|
-
"type": {
|
|
17340
|
-
"text": "void"
|
|
17341
|
-
}
|
|
17342
|
-
},
|
|
17343
|
-
"inheritedFrom": {
|
|
17344
|
-
"name": "FormAssociatedMixin",
|
|
17345
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17346
|
-
}
|
|
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."
|
|
17347
17411
|
},
|
|
17348
17412
|
{
|
|
17349
17413
|
"kind": "field",
|
|
17350
|
-
"name": "
|
|
17351
|
-
"
|
|
17352
|
-
|
|
17353
|
-
|
|
17354
|
-
|
|
17355
|
-
|
|
17356
|
-
|
|
17357
|
-
},
|
|
17358
|
-
{
|
|
17359
|
-
"kind": "field",
|
|
17360
|
-
"name": "errorSlot",
|
|
17361
|
-
"privacy": "protected",
|
|
17362
|
-
"default": "new SlotController(this, \"error\")",
|
|
17363
|
-
"inheritedFrom": {
|
|
17364
|
-
"name": "FormAssociatedMixin",
|
|
17365
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17366
|
-
}
|
|
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"
|
|
17367
17421
|
},
|
|
17368
17422
|
{
|
|
17369
17423
|
"kind": "field",
|
|
17370
|
-
"name": "
|
|
17371
|
-
"
|
|
17372
|
-
|
|
17373
|
-
|
|
17374
|
-
|
|
17375
|
-
|
|
17376
|
-
}
|
|
17424
|
+
"name": "coords",
|
|
17425
|
+
"type": {
|
|
17426
|
+
"text": "[number, number]"
|
|
17427
|
+
},
|
|
17428
|
+
"privacy": "private",
|
|
17429
|
+
"default": "[0, 0]"
|
|
17377
17430
|
},
|
|
17378
17431
|
{
|
|
17379
17432
|
"kind": "field",
|
|
17380
|
-
"name": "
|
|
17381
|
-
"
|
|
17382
|
-
|
|
17383
|
-
|
|
17384
|
-
|
|
17385
|
-
|
|
17386
|
-
|
|
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",
|
|
17440
|
+
"reflects": true
|
|
17387
17441
|
},
|
|
17388
17442
|
{
|
|
17389
17443
|
"kind": "field",
|
|
17390
|
-
"name": "
|
|
17444
|
+
"name": "role",
|
|
17391
17445
|
"type": {
|
|
17392
17446
|
"text": "string"
|
|
17393
17447
|
},
|
|
17394
|
-
"
|
|
17395
|
-
"
|
|
17396
|
-
"
|
|
17397
|
-
|
|
17398
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17399
|
-
}
|
|
17448
|
+
"default": "\"tooltip\"",
|
|
17449
|
+
"description": "The tooltip role, set on the component by default.",
|
|
17450
|
+
"attribute": "role",
|
|
17451
|
+
"reflects": true
|
|
17400
17452
|
},
|
|
17401
17453
|
{
|
|
17402
17454
|
"kind": "field",
|
|
17403
|
-
"name": "
|
|
17455
|
+
"name": "id",
|
|
17404
17456
|
"type": {
|
|
17405
17457
|
"text": "string"
|
|
17406
17458
|
},
|
|
17407
|
-
"
|
|
17408
|
-
"
|
|
17409
|
-
"
|
|
17410
|
-
|
|
17411
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17412
|
-
}
|
|
17459
|
+
"default": "\"\"",
|
|
17460
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
17461
|
+
"attribute": "id",
|
|
17462
|
+
"reflects": true
|
|
17413
17463
|
},
|
|
17414
17464
|
{
|
|
17415
17465
|
"kind": "field",
|
|
17416
|
-
"name": "
|
|
17466
|
+
"name": "delay",
|
|
17417
17467
|
"type": {
|
|
17418
|
-
"text": "
|
|
17468
|
+
"text": "number"
|
|
17419
17469
|
},
|
|
17420
|
-
"
|
|
17421
|
-
"
|
|
17422
|
-
"
|
|
17423
|
-
|
|
17424
|
-
|
|
17425
|
-
|
|
17470
|
+
"default": "500",
|
|
17471
|
+
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
17472
|
+
"attribute": "delay",
|
|
17473
|
+
"reflects": true
|
|
17474
|
+
},
|
|
17475
|
+
{
|
|
17476
|
+
"kind": "method",
|
|
17477
|
+
"name": "handleIdChange",
|
|
17478
|
+
"privacy": "protected"
|
|
17479
|
+
},
|
|
17480
|
+
{
|
|
17481
|
+
"kind": "method",
|
|
17482
|
+
"name": "handleStateChange",
|
|
17483
|
+
"privacy": "private",
|
|
17484
|
+
"parameters": [
|
|
17485
|
+
{
|
|
17486
|
+
"name": "prevState",
|
|
17487
|
+
"type": {
|
|
17488
|
+
"text": "TooltipStates"
|
|
17489
|
+
}
|
|
17490
|
+
}
|
|
17491
|
+
]
|
|
17426
17492
|
},
|
|
17427
17493
|
{
|
|
17428
17494
|
"kind": "field",
|
|
17429
|
-
"name": "
|
|
17430
|
-
"
|
|
17431
|
-
|
|
17432
|
-
},
|
|
17433
|
-
"default": "\"\"",
|
|
17434
|
-
"description": "Label for the input.",
|
|
17435
|
-
"attribute": "label",
|
|
17436
|
-
"reflects": true,
|
|
17437
|
-
"inheritedFrom": {
|
|
17438
|
-
"name": "FormAssociatedMixin",
|
|
17439
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17440
|
-
}
|
|
17495
|
+
"name": "updatePosition",
|
|
17496
|
+
"privacy": "private",
|
|
17497
|
+
"description": "Setting and updating the position of the tooltip"
|
|
17441
17498
|
},
|
|
17442
17499
|
{
|
|
17443
17500
|
"kind": "field",
|
|
17444
|
-
"name": "
|
|
17445
|
-
"
|
|
17446
|
-
"text": "string | undefined"
|
|
17447
|
-
},
|
|
17448
|
-
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
17449
|
-
"attribute": "hint",
|
|
17450
|
-
"reflects": true,
|
|
17451
|
-
"inheritedFrom": {
|
|
17452
|
-
"name": "FormAssociatedMixin",
|
|
17453
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17454
|
-
}
|
|
17501
|
+
"name": "hideTooltip",
|
|
17502
|
+
"privacy": "private"
|
|
17455
17503
|
},
|
|
17456
17504
|
{
|
|
17457
17505
|
"kind": "field",
|
|
17458
|
-
"name": "
|
|
17459
|
-
"
|
|
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
|
-
}
|
|
17506
|
+
"name": "reposition",
|
|
17507
|
+
"privacy": "private"
|
|
17470
17508
|
},
|
|
17471
17509
|
{
|
|
17472
17510
|
"kind": "field",
|
|
17473
|
-
"name": "
|
|
17474
|
-
"
|
|
17475
|
-
"text": "string | undefined"
|
|
17476
|
-
},
|
|
17477
|
-
"description": "Placeholder text to display within the input.",
|
|
17478
|
-
"attribute": "placeholder",
|
|
17479
|
-
"reflects": true,
|
|
17480
|
-
"inheritedFrom": {
|
|
17481
|
-
"name": "FormAssociatedMixin",
|
|
17482
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17483
|
-
}
|
|
17511
|
+
"name": "handleShow",
|
|
17512
|
+
"privacy": "private"
|
|
17484
17513
|
},
|
|
17485
17514
|
{
|
|
17486
17515
|
"kind": "field",
|
|
17487
|
-
"name": "
|
|
17488
|
-
"
|
|
17489
|
-
"text": "string | undefined"
|
|
17490
|
-
},
|
|
17491
|
-
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
17492
|
-
"attribute": "error",
|
|
17493
|
-
"reflects": true,
|
|
17494
|
-
"inheritedFrom": {
|
|
17495
|
-
"name": "FormAssociatedMixin",
|
|
17496
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17497
|
-
}
|
|
17516
|
+
"name": "handleHide",
|
|
17517
|
+
"privacy": "private"
|
|
17498
17518
|
},
|
|
17499
17519
|
{
|
|
17500
17520
|
"kind": "field",
|
|
17501
|
-
"name": "
|
|
17502
|
-
"
|
|
17503
|
-
"text": "boolean"
|
|
17504
|
-
},
|
|
17505
|
-
"default": "false",
|
|
17506
|
-
"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.",
|
|
17507
|
-
"attribute": "required",
|
|
17508
|
-
"reflects": true,
|
|
17509
|
-
"inheritedFrom": {
|
|
17510
|
-
"name": "FormAssociatedMixin",
|
|
17511
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17512
|
-
}
|
|
17521
|
+
"name": "hideOnEscape",
|
|
17522
|
+
"privacy": "private"
|
|
17513
17523
|
},
|
|
17514
17524
|
{
|
|
17515
17525
|
"kind": "field",
|
|
17516
|
-
"name": "
|
|
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",
|
|
17517
17538
|
"type": {
|
|
17518
|
-
"text": "
|
|
17539
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
17519
17540
|
},
|
|
17520
|
-
"default": "
|
|
17521
|
-
"description": "
|
|
17522
|
-
"
|
|
17523
|
-
"reflects": true,
|
|
17524
|
-
"inheritedFrom": {
|
|
17525
|
-
"name": "FormAssociatedMixin",
|
|
17526
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17527
|
-
}
|
|
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"
|
|
17528
17544
|
},
|
|
17529
17545
|
{
|
|
17530
|
-
"
|
|
17531
|
-
"
|
|
17532
|
-
|
|
17533
|
-
|
|
17534
|
-
|
|
17535
|
-
|
|
17536
|
-
|
|
17537
|
-
"text": "Event"
|
|
17538
|
-
}
|
|
17539
|
-
}
|
|
17540
|
-
],
|
|
17541
|
-
"inheritedFrom": {
|
|
17542
|
-
"name": "FormAssociatedMixin",
|
|
17543
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17544
|
-
}
|
|
17546
|
+
"name": "role",
|
|
17547
|
+
"type": {
|
|
17548
|
+
"text": "string"
|
|
17549
|
+
},
|
|
17550
|
+
"default": "\"tooltip\"",
|
|
17551
|
+
"description": "The tooltip role, set on the component by default.",
|
|
17552
|
+
"fieldName": "role"
|
|
17545
17553
|
},
|
|
17546
17554
|
{
|
|
17547
|
-
"
|
|
17548
|
-
"
|
|
17549
|
-
|
|
17550
|
-
|
|
17551
|
-
|
|
17552
|
-
|
|
17553
|
-
|
|
17554
|
-
"type": {
|
|
17555
|
-
"text": "TemplateResult"
|
|
17556
|
-
}
|
|
17557
|
-
}
|
|
17558
|
-
],
|
|
17559
|
-
"inheritedFrom": {
|
|
17560
|
-
"name": "FormAssociatedMixin",
|
|
17561
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17562
|
-
}
|
|
17555
|
+
"name": "id",
|
|
17556
|
+
"type": {
|
|
17557
|
+
"text": "string"
|
|
17558
|
+
},
|
|
17559
|
+
"default": "\"\"",
|
|
17560
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
17561
|
+
"fieldName": "id"
|
|
17563
17562
|
},
|
|
17564
17563
|
{
|
|
17565
|
-
"
|
|
17566
|
-
"
|
|
17567
|
-
|
|
17568
|
-
|
|
17569
|
-
|
|
17570
|
-
|
|
17571
|
-
|
|
17572
|
-
}
|
|
17564
|
+
"name": "delay",
|
|
17565
|
+
"type": {
|
|
17566
|
+
"text": "number"
|
|
17567
|
+
},
|
|
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/top-bar/TopBar.ts",
|
|
17609
|
+
"declarations": [
|
|
17610
|
+
{
|
|
17611
|
+
"kind": "class",
|
|
17612
|
+
"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.",
|
|
17613
|
+
"name": "TopBar",
|
|
17614
|
+
"slots": [
|
|
17573
17615
|
{
|
|
17574
|
-
"
|
|
17575
|
-
"name": "
|
|
17576
|
-
"privacy": "protected",
|
|
17577
|
-
"inheritedFrom": {
|
|
17578
|
-
"name": "FormAssociatedMixin",
|
|
17579
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17580
|
-
}
|
|
17616
|
+
"description": "Used for the main content of the top bar. We recommend placing your application’s global search functionality into this slot.",
|
|
17617
|
+
"name": ""
|
|
17581
17618
|
},
|
|
17582
17619
|
{
|
|
17583
|
-
"
|
|
17584
|
-
"name": "
|
|
17585
|
-
|
|
17586
|
-
|
|
17587
|
-
|
|
17588
|
-
|
|
17589
|
-
|
|
17620
|
+
"description": "Optional slot for menus, buttons, toggles, etc.",
|
|
17621
|
+
"name": "end"
|
|
17622
|
+
}
|
|
17623
|
+
],
|
|
17624
|
+
"members": [],
|
|
17625
|
+
"superclass": {
|
|
17626
|
+
"name": "LitElement",
|
|
17627
|
+
"package": "lit"
|
|
17628
|
+
},
|
|
17629
|
+
"localization": [],
|
|
17630
|
+
"status": "ready",
|
|
17631
|
+
"category": "structure",
|
|
17632
|
+
"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",
|
|
17633
|
+
"examples": [],
|
|
17634
|
+
"dependencies": [],
|
|
17635
|
+
"tagName": "nord-top-bar",
|
|
17636
|
+
"customElement": true
|
|
17637
|
+
}
|
|
17638
|
+
],
|
|
17639
|
+
"exports": [
|
|
17640
|
+
{
|
|
17641
|
+
"kind": "js",
|
|
17642
|
+
"name": "default",
|
|
17643
|
+
"declaration": {
|
|
17644
|
+
"name": "TopBar",
|
|
17645
|
+
"module": "src/top-bar/TopBar.ts"
|
|
17646
|
+
}
|
|
17647
|
+
},
|
|
17648
|
+
{
|
|
17649
|
+
"kind": "custom-element-definition",
|
|
17650
|
+
"name": "nord-top-bar",
|
|
17651
|
+
"declaration": {
|
|
17652
|
+
"name": "TopBar",
|
|
17653
|
+
"module": "src/top-bar/TopBar.ts"
|
|
17654
|
+
}
|
|
17655
|
+
}
|
|
17656
|
+
]
|
|
17657
|
+
},
|
|
17658
|
+
{
|
|
17659
|
+
"kind": "javascript-module",
|
|
17660
|
+
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
17661
|
+
"declarations": [
|
|
17662
|
+
{
|
|
17663
|
+
"kind": "class",
|
|
17664
|
+
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
17665
|
+
"name": "VisuallyHidden",
|
|
17666
|
+
"slots": [
|
|
17667
|
+
{
|
|
17668
|
+
"description": "The visually hidden content.",
|
|
17669
|
+
"name": ""
|
|
17670
|
+
}
|
|
17671
|
+
],
|
|
17672
|
+
"members": [],
|
|
17673
|
+
"superclass": {
|
|
17674
|
+
"name": "LitElement",
|
|
17675
|
+
"package": "lit"
|
|
17676
|
+
},
|
|
17677
|
+
"localization": [],
|
|
17678
|
+
"status": "ready",
|
|
17679
|
+
"category": "text",
|
|
17680
|
+
"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",
|
|
17681
|
+
"examples": [],
|
|
17682
|
+
"dependencies": [],
|
|
17683
|
+
"tagName": "nord-visually-hidden",
|
|
17684
|
+
"customElement": true
|
|
17685
|
+
}
|
|
17686
|
+
],
|
|
17687
|
+
"exports": [
|
|
17688
|
+
{
|
|
17689
|
+
"kind": "js",
|
|
17690
|
+
"name": "default",
|
|
17691
|
+
"declaration": {
|
|
17692
|
+
"name": "VisuallyHidden",
|
|
17693
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
17694
|
+
}
|
|
17695
|
+
},
|
|
17696
|
+
{
|
|
17697
|
+
"kind": "custom-element-definition",
|
|
17698
|
+
"name": "nord-visually-hidden",
|
|
17699
|
+
"declaration": {
|
|
17700
|
+
"name": "VisuallyHidden",
|
|
17701
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
17702
|
+
}
|
|
17703
|
+
}
|
|
17704
|
+
]
|
|
17705
|
+
},
|
|
17706
|
+
{
|
|
17707
|
+
"kind": "javascript-module",
|
|
17708
|
+
"path": "src/toggle/Toggle.ts",
|
|
17709
|
+
"declarations": [
|
|
17710
|
+
{
|
|
17711
|
+
"kind": "class",
|
|
17712
|
+
"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.",
|
|
17713
|
+
"name": "Toggle",
|
|
17714
|
+
"cssProperties": [
|
|
17715
|
+
{
|
|
17716
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
17717
|
+
"name": "--n-label-color",
|
|
17718
|
+
"default": "var(--n-color-text)"
|
|
17719
|
+
}
|
|
17720
|
+
],
|
|
17721
|
+
"slots": [
|
|
17722
|
+
{
|
|
17723
|
+
"description": "Use when a label requires more than plain text.",
|
|
17724
|
+
"name": "label"
|
|
17590
17725
|
},
|
|
17591
17726
|
{
|
|
17592
|
-
"
|
|
17593
|
-
"name": "
|
|
17594
|
-
"privacy": "protected",
|
|
17595
|
-
"readonly": true,
|
|
17596
|
-
"inheritedFrom": {
|
|
17597
|
-
"name": "FormAssociatedMixin",
|
|
17598
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17599
|
-
}
|
|
17727
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
17728
|
+
"name": "hint"
|
|
17600
17729
|
},
|
|
17730
|
+
{
|
|
17731
|
+
"description": "Optional slot that holds error text for the input.",
|
|
17732
|
+
"name": "error"
|
|
17733
|
+
}
|
|
17734
|
+
],
|
|
17735
|
+
"members": [
|
|
17601
17736
|
{
|
|
17602
17737
|
"kind": "field",
|
|
17603
|
-
"name": "
|
|
17738
|
+
"name": "formValue",
|
|
17604
17739
|
"privacy": "protected",
|
|
17605
17740
|
"readonly": true,
|
|
17606
17741
|
"inheritedFrom": {
|
|
@@ -17610,802 +17745,667 @@
|
|
|
17610
17745
|
},
|
|
17611
17746
|
{
|
|
17612
17747
|
"kind": "field",
|
|
17613
|
-
"name": "
|
|
17748
|
+
"name": "checked",
|
|
17614
17749
|
"type": {
|
|
17615
17750
|
"text": "boolean"
|
|
17616
17751
|
},
|
|
17617
17752
|
"default": "false",
|
|
17618
|
-
"description": "
|
|
17619
|
-
"attribute": "
|
|
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",
|
|
17643
|
-
"type": {
|
|
17644
|
-
"text": "string"
|
|
17645
|
-
},
|
|
17646
|
-
"default": "\"\"",
|
|
17647
|
-
"description": "The value of the form component.",
|
|
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",
|
|
17662
|
-
"inheritedFrom": {
|
|
17663
|
-
"name": "InputMixin",
|
|
17664
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17665
|
-
}
|
|
17753
|
+
"description": "Controls whether the toggle is checked or not.",
|
|
17754
|
+
"attribute": "checked",
|
|
17755
|
+
"reflects": true
|
|
17666
17756
|
},
|
|
17667
17757
|
{
|
|
17668
17758
|
"kind": "field",
|
|
17669
|
-
"name": "
|
|
17759
|
+
"name": "reverse",
|
|
17670
17760
|
"type": {
|
|
17671
|
-
"text": "
|
|
17761
|
+
"text": "boolean"
|
|
17672
17762
|
},
|
|
17673
|
-
"
|
|
17674
|
-
"
|
|
17675
|
-
|
|
17676
|
-
|
|
17677
|
-
}
|
|
17763
|
+
"default": "false",
|
|
17764
|
+
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
17765
|
+
"attribute": "reverse",
|
|
17766
|
+
"reflects": true
|
|
17678
17767
|
},
|
|
17679
17768
|
{
|
|
17680
17769
|
"kind": "field",
|
|
17681
|
-
"name": "
|
|
17770
|
+
"name": "size",
|
|
17682
17771
|
"type": {
|
|
17683
|
-
"text": "
|
|
17772
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
17684
17773
|
},
|
|
17685
|
-
"
|
|
17686
|
-
"
|
|
17687
|
-
"
|
|
17688
|
-
|
|
17689
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
17690
|
-
}
|
|
17691
|
-
},
|
|
17692
|
-
{
|
|
17693
|
-
"kind": "field",
|
|
17694
|
-
"name": "focusableRef",
|
|
17695
|
-
"privacy": "protected",
|
|
17696
|
-
"inheritedFrom": {
|
|
17697
|
-
"name": "FocusableMixin",
|
|
17698
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
17699
|
-
}
|
|
17774
|
+
"default": "\"m\"",
|
|
17775
|
+
"description": "The size of the toggle switch.",
|
|
17776
|
+
"attribute": "size",
|
|
17777
|
+
"reflects": true
|
|
17700
17778
|
},
|
|
17701
17779
|
{
|
|
17702
17780
|
"kind": "method",
|
|
17703
|
-
"name": "
|
|
17781
|
+
"name": "handleChange",
|
|
17782
|
+
"privacy": "protected",
|
|
17704
17783
|
"parameters": [
|
|
17705
17784
|
{
|
|
17706
|
-
"name": "
|
|
17707
|
-
"optional": true,
|
|
17785
|
+
"name": "e",
|
|
17708
17786
|
"type": {
|
|
17709
|
-
"text": "
|
|
17710
|
-
}
|
|
17711
|
-
"description": "An object which controls aspects of the focusing process."
|
|
17787
|
+
"text": "Event"
|
|
17788
|
+
}
|
|
17712
17789
|
}
|
|
17713
17790
|
],
|
|
17714
|
-
"
|
|
17791
|
+
"return": {
|
|
17792
|
+
"type": {
|
|
17793
|
+
"text": "void"
|
|
17794
|
+
}
|
|
17795
|
+
},
|
|
17715
17796
|
"inheritedFrom": {
|
|
17716
|
-
"name": "
|
|
17717
|
-
"module": "src/common/mixins/
|
|
17797
|
+
"name": "FormAssociatedMixin",
|
|
17798
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17718
17799
|
}
|
|
17719
17800
|
},
|
|
17720
17801
|
{
|
|
17721
|
-
"kind": "
|
|
17722
|
-
"name": "
|
|
17723
|
-
"
|
|
17802
|
+
"kind": "field",
|
|
17803
|
+
"name": "labelSlot",
|
|
17804
|
+
"privacy": "protected",
|
|
17805
|
+
"default": "new SlotController(this, \"label\")",
|
|
17724
17806
|
"inheritedFrom": {
|
|
17725
|
-
"name": "
|
|
17726
|
-
"module": "src/common/mixins/
|
|
17807
|
+
"name": "FormAssociatedMixin",
|
|
17808
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17727
17809
|
}
|
|
17728
17810
|
},
|
|
17729
17811
|
{
|
|
17730
|
-
"kind": "
|
|
17731
|
-
"name": "
|
|
17732
|
-
"
|
|
17812
|
+
"kind": "field",
|
|
17813
|
+
"name": "errorSlot",
|
|
17814
|
+
"privacy": "protected",
|
|
17815
|
+
"default": "new SlotController(this, \"error\")",
|
|
17733
17816
|
"inheritedFrom": {
|
|
17734
|
-
"name": "
|
|
17735
|
-
"module": "src/common/mixins/
|
|
17817
|
+
"name": "FormAssociatedMixin",
|
|
17818
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17736
17819
|
}
|
|
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
17820
|
},
|
|
17767
17821
|
{
|
|
17768
|
-
"
|
|
17769
|
-
"
|
|
17770
|
-
|
|
17771
|
-
|
|
17772
|
-
"default": "\"\"",
|
|
17773
|
-
"description": "Label for the input.",
|
|
17774
|
-
"fieldName": "label",
|
|
17822
|
+
"kind": "field",
|
|
17823
|
+
"name": "hintSlot",
|
|
17824
|
+
"privacy": "protected",
|
|
17825
|
+
"default": "new SlotController(this, \"hint\")",
|
|
17775
17826
|
"inheritedFrom": {
|
|
17776
17827
|
"name": "FormAssociatedMixin",
|
|
17777
17828
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17778
17829
|
}
|
|
17779
17830
|
},
|
|
17780
17831
|
{
|
|
17781
|
-
"
|
|
17782
|
-
"
|
|
17783
|
-
|
|
17784
|
-
},
|
|
17785
|
-
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
17786
|
-
"fieldName": "hint",
|
|
17832
|
+
"kind": "field",
|
|
17833
|
+
"name": "formData",
|
|
17834
|
+
"privacy": "protected",
|
|
17835
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
17787
17836
|
"inheritedFrom": {
|
|
17788
17837
|
"name": "FormAssociatedMixin",
|
|
17789
17838
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17790
17839
|
}
|
|
17791
17840
|
},
|
|
17792
17841
|
{
|
|
17793
|
-
"
|
|
17842
|
+
"kind": "field",
|
|
17843
|
+
"name": "inputId",
|
|
17794
17844
|
"type": {
|
|
17795
|
-
"text": "
|
|
17845
|
+
"text": "string"
|
|
17796
17846
|
},
|
|
17797
|
-
"
|
|
17798
|
-
"
|
|
17799
|
-
"fieldName": "hideLabel",
|
|
17847
|
+
"privacy": "protected",
|
|
17848
|
+
"default": "\"input\"",
|
|
17800
17849
|
"inheritedFrom": {
|
|
17801
17850
|
"name": "FormAssociatedMixin",
|
|
17802
17851
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17803
17852
|
}
|
|
17804
17853
|
},
|
|
17805
17854
|
{
|
|
17806
|
-
"
|
|
17855
|
+
"kind": "field",
|
|
17856
|
+
"name": "errorId",
|
|
17807
17857
|
"type": {
|
|
17808
|
-
"text": "string
|
|
17858
|
+
"text": "string"
|
|
17809
17859
|
},
|
|
17810
|
-
"
|
|
17811
|
-
"
|
|
17860
|
+
"privacy": "protected",
|
|
17861
|
+
"default": "\"error\"",
|
|
17812
17862
|
"inheritedFrom": {
|
|
17813
17863
|
"name": "FormAssociatedMixin",
|
|
17814
17864
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17815
17865
|
}
|
|
17816
17866
|
},
|
|
17817
17867
|
{
|
|
17818
|
-
"
|
|
17868
|
+
"kind": "field",
|
|
17869
|
+
"name": "hintId",
|
|
17819
17870
|
"type": {
|
|
17820
|
-
"text": "string
|
|
17871
|
+
"text": "string"
|
|
17821
17872
|
},
|
|
17822
|
-
"
|
|
17823
|
-
"
|
|
17873
|
+
"privacy": "protected",
|
|
17874
|
+
"default": "\"hint\"",
|
|
17824
17875
|
"inheritedFrom": {
|
|
17825
17876
|
"name": "FormAssociatedMixin",
|
|
17826
17877
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17827
17878
|
}
|
|
17828
17879
|
},
|
|
17829
17880
|
{
|
|
17830
|
-
"
|
|
17881
|
+
"kind": "field",
|
|
17882
|
+
"name": "label",
|
|
17831
17883
|
"type": {
|
|
17832
|
-
"text": "
|
|
17884
|
+
"text": "string"
|
|
17833
17885
|
},
|
|
17834
|
-
"default": "
|
|
17835
|
-
"description": "
|
|
17836
|
-
"
|
|
17886
|
+
"default": "\"\"",
|
|
17887
|
+
"description": "Label for the input.",
|
|
17888
|
+
"attribute": "label",
|
|
17889
|
+
"reflects": true,
|
|
17837
17890
|
"inheritedFrom": {
|
|
17838
17891
|
"name": "FormAssociatedMixin",
|
|
17839
17892
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17840
17893
|
}
|
|
17841
17894
|
},
|
|
17842
17895
|
{
|
|
17843
|
-
"
|
|
17896
|
+
"kind": "field",
|
|
17897
|
+
"name": "hint",
|
|
17844
17898
|
"type": {
|
|
17845
|
-
"text": "
|
|
17899
|
+
"text": "string | undefined"
|
|
17846
17900
|
},
|
|
17847
|
-
"
|
|
17848
|
-
"
|
|
17849
|
-
"
|
|
17901
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
17902
|
+
"attribute": "hint",
|
|
17903
|
+
"reflects": true,
|
|
17850
17904
|
"inheritedFrom": {
|
|
17851
17905
|
"name": "FormAssociatedMixin",
|
|
17852
17906
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17853
17907
|
}
|
|
17854
17908
|
},
|
|
17855
17909
|
{
|
|
17856
|
-
"
|
|
17910
|
+
"kind": "field",
|
|
17911
|
+
"name": "hideLabel",
|
|
17857
17912
|
"type": {
|
|
17858
17913
|
"text": "boolean"
|
|
17859
17914
|
},
|
|
17860
17915
|
"default": "false",
|
|
17861
|
-
"description": "
|
|
17862
|
-
"
|
|
17916
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
17917
|
+
"attribute": "hide-label",
|
|
17918
|
+
"reflects": true,
|
|
17863
17919
|
"inheritedFrom": {
|
|
17864
|
-
"name": "
|
|
17865
|
-
"module": "src/common/mixins/
|
|
17920
|
+
"name": "FormAssociatedMixin",
|
|
17921
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17866
17922
|
}
|
|
17867
17923
|
},
|
|
17868
17924
|
{
|
|
17869
|
-
"
|
|
17925
|
+
"kind": "field",
|
|
17926
|
+
"name": "placeholder",
|
|
17870
17927
|
"type": {
|
|
17871
17928
|
"text": "string | undefined"
|
|
17872
17929
|
},
|
|
17873
|
-
"description": "
|
|
17874
|
-
"
|
|
17930
|
+
"description": "Placeholder text to display within the input.",
|
|
17931
|
+
"attribute": "placeholder",
|
|
17932
|
+
"reflects": true,
|
|
17875
17933
|
"inheritedFrom": {
|
|
17876
|
-
"name": "
|
|
17877
|
-
"module": "src/common/mixins/
|
|
17934
|
+
"name": "FormAssociatedMixin",
|
|
17935
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17878
17936
|
}
|
|
17879
17937
|
},
|
|
17880
17938
|
{
|
|
17881
|
-
"
|
|
17939
|
+
"kind": "field",
|
|
17940
|
+
"name": "error",
|
|
17882
17941
|
"type": {
|
|
17883
|
-
"text": "string"
|
|
17942
|
+
"text": "string | undefined"
|
|
17884
17943
|
},
|
|
17885
|
-
"
|
|
17886
|
-
"
|
|
17887
|
-
"
|
|
17944
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
17945
|
+
"attribute": "error",
|
|
17946
|
+
"reflects": true,
|
|
17888
17947
|
"inheritedFrom": {
|
|
17889
|
-
"name": "
|
|
17890
|
-
"module": "src/common/mixins/
|
|
17948
|
+
"name": "FormAssociatedMixin",
|
|
17949
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17891
17950
|
}
|
|
17892
17951
|
},
|
|
17893
17952
|
{
|
|
17894
|
-
"
|
|
17953
|
+
"kind": "field",
|
|
17954
|
+
"name": "required",
|
|
17895
17955
|
"type": {
|
|
17896
|
-
"text": "
|
|
17956
|
+
"text": "boolean"
|
|
17897
17957
|
},
|
|
17898
|
-
"
|
|
17899
|
-
"
|
|
17958
|
+
"default": "false",
|
|
17959
|
+
"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.",
|
|
17960
|
+
"attribute": "required",
|
|
17961
|
+
"reflects": true,
|
|
17900
17962
|
"inheritedFrom": {
|
|
17901
|
-
"name": "
|
|
17902
|
-
"module": "src/common/mixins/
|
|
17963
|
+
"name": "FormAssociatedMixin",
|
|
17964
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17903
17965
|
}
|
|
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
17966
|
},
|
|
17915
17967
|
{
|
|
17916
|
-
"
|
|
17917
|
-
"
|
|
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",
|
|
17968
|
+
"kind": "field",
|
|
17969
|
+
"name": "hideRequired",
|
|
17935
17970
|
"type": {
|
|
17936
|
-
"text": "
|
|
17971
|
+
"text": "boolean"
|
|
17937
17972
|
},
|
|
17938
|
-
"
|
|
17973
|
+
"default": "false",
|
|
17974
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
17975
|
+
"attribute": "hide-required",
|
|
17976
|
+
"reflects": true,
|
|
17939
17977
|
"inheritedFrom": {
|
|
17940
17978
|
"name": "FormAssociatedMixin",
|
|
17941
17979
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17942
17980
|
}
|
|
17943
17981
|
},
|
|
17944
17982
|
{
|
|
17945
|
-
"
|
|
17946
|
-
"
|
|
17947
|
-
|
|
17948
|
-
|
|
17949
|
-
|
|
17983
|
+
"kind": "method",
|
|
17984
|
+
"name": "handleInput",
|
|
17985
|
+
"privacy": "protected",
|
|
17986
|
+
"parameters": [
|
|
17987
|
+
{
|
|
17988
|
+
"name": "e",
|
|
17989
|
+
"type": {
|
|
17990
|
+
"text": "Event"
|
|
17991
|
+
}
|
|
17992
|
+
}
|
|
17993
|
+
],
|
|
17950
17994
|
"inheritedFrom": {
|
|
17951
17995
|
"name": "FormAssociatedMixin",
|
|
17952
17996
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17953
17997
|
}
|
|
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": [
|
|
17998
|
+
},
|
|
17992
17999
|
{
|
|
17993
18000
|
"kind": "method",
|
|
17994
|
-
"name": "
|
|
18001
|
+
"name": "renderLabel",
|
|
18002
|
+
"privacy": "protected",
|
|
17995
18003
|
"parameters": [
|
|
17996
18004
|
{
|
|
17997
|
-
"name": "
|
|
17998
|
-
"
|
|
17999
|
-
"text": "string"
|
|
18000
|
-
},
|
|
18001
|
-
"description": "The text/message of the toast."
|
|
18002
|
-
},
|
|
18003
|
-
{
|
|
18004
|
-
"name": "options",
|
|
18005
|
-
"default": "{}",
|
|
18005
|
+
"name": "additionalContent",
|
|
18006
|
+
"optional": true,
|
|
18006
18007
|
"type": {
|
|
18007
|
-
"text": "
|
|
18008
|
-
}
|
|
18009
|
-
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
18008
|
+
"text": "TemplateResult"
|
|
18009
|
+
}
|
|
18010
18010
|
}
|
|
18011
18011
|
],
|
|
18012
|
-
"
|
|
18013
|
-
|
|
18014
|
-
"
|
|
18015
|
-
"text": "Toast"
|
|
18016
|
-
}
|
|
18012
|
+
"inheritedFrom": {
|
|
18013
|
+
"name": "FormAssociatedMixin",
|
|
18014
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18017
18015
|
}
|
|
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": [
|
|
18016
|
+
},
|
|
18073
18017
|
{
|
|
18074
|
-
"
|
|
18075
|
-
"name": "
|
|
18076
|
-
"
|
|
18077
|
-
|
|
18078
|
-
|
|
18079
|
-
|
|
18018
|
+
"kind": "method",
|
|
18019
|
+
"name": "renderError",
|
|
18020
|
+
"privacy": "protected",
|
|
18021
|
+
"inheritedFrom": {
|
|
18022
|
+
"name": "FormAssociatedMixin",
|
|
18023
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18024
|
+
}
|
|
18025
|
+
},
|
|
18080
18026
|
{
|
|
18081
|
-
"
|
|
18082
|
-
"name": ""
|
|
18027
|
+
"kind": "method",
|
|
18028
|
+
"name": "getDescribedBy",
|
|
18029
|
+
"privacy": "protected",
|
|
18030
|
+
"inheritedFrom": {
|
|
18031
|
+
"name": "FormAssociatedMixin",
|
|
18032
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18033
|
+
}
|
|
18083
18034
|
},
|
|
18084
18035
|
{
|
|
18085
|
-
"
|
|
18086
|
-
"name": "
|
|
18087
|
-
|
|
18088
|
-
|
|
18089
|
-
|
|
18090
|
-
|
|
18091
|
-
|
|
18092
|
-
"name": "lastOpened",
|
|
18093
|
-
"type": {
|
|
18094
|
-
"text": "Tooltip | undefined"
|
|
18095
|
-
},
|
|
18096
|
-
"privacy": "private",
|
|
18097
|
-
"static": true
|
|
18036
|
+
"kind": "method",
|
|
18037
|
+
"name": "getInvalid",
|
|
18038
|
+
"privacy": "protected",
|
|
18039
|
+
"inheritedFrom": {
|
|
18040
|
+
"name": "FormAssociatedMixin",
|
|
18041
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18042
|
+
}
|
|
18098
18043
|
},
|
|
18099
18044
|
{
|
|
18100
18045
|
"kind": "field",
|
|
18101
|
-
"name": "
|
|
18102
|
-
"privacy": "
|
|
18103
|
-
"
|
|
18046
|
+
"name": "hasHint",
|
|
18047
|
+
"privacy": "protected",
|
|
18048
|
+
"readonly": true,
|
|
18049
|
+
"inheritedFrom": {
|
|
18050
|
+
"name": "FormAssociatedMixin",
|
|
18051
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18052
|
+
}
|
|
18104
18053
|
},
|
|
18105
18054
|
{
|
|
18106
18055
|
"kind": "field",
|
|
18107
|
-
"name": "
|
|
18108
|
-
"privacy": "
|
|
18109
|
-
"
|
|
18056
|
+
"name": "hasError",
|
|
18057
|
+
"privacy": "protected",
|
|
18058
|
+
"readonly": true,
|
|
18059
|
+
"inheritedFrom": {
|
|
18060
|
+
"name": "FormAssociatedMixin",
|
|
18061
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18062
|
+
}
|
|
18110
18063
|
},
|
|
18111
18064
|
{
|
|
18112
18065
|
"kind": "field",
|
|
18113
|
-
"name": "
|
|
18066
|
+
"name": "disabled",
|
|
18114
18067
|
"type": {
|
|
18115
|
-
"text": "
|
|
18068
|
+
"text": "boolean"
|
|
18116
18069
|
},
|
|
18117
|
-
"
|
|
18070
|
+
"default": "false",
|
|
18071
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
18072
|
+
"attribute": "disabled",
|
|
18073
|
+
"reflects": true,
|
|
18074
|
+
"inheritedFrom": {
|
|
18075
|
+
"name": "InputMixin",
|
|
18076
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18077
|
+
}
|
|
18118
18078
|
},
|
|
18119
18079
|
{
|
|
18120
18080
|
"kind": "field",
|
|
18121
|
-
"name": "
|
|
18081
|
+
"name": "name",
|
|
18122
18082
|
"type": {
|
|
18123
|
-
"text": "
|
|
18083
|
+
"text": "string | undefined"
|
|
18124
18084
|
},
|
|
18125
|
-
"
|
|
18085
|
+
"description": "The name of the form component.",
|
|
18086
|
+
"attribute": "name",
|
|
18087
|
+
"reflects": true,
|
|
18088
|
+
"inheritedFrom": {
|
|
18089
|
+
"name": "InputMixin",
|
|
18090
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18091
|
+
}
|
|
18126
18092
|
},
|
|
18127
18093
|
{
|
|
18128
18094
|
"kind": "field",
|
|
18129
|
-
"name": "
|
|
18095
|
+
"name": "value",
|
|
18130
18096
|
"type": {
|
|
18131
|
-
"text": "
|
|
18097
|
+
"text": "string"
|
|
18132
18098
|
},
|
|
18133
|
-
"
|
|
18134
|
-
"description": "
|
|
18099
|
+
"default": "\"\"",
|
|
18100
|
+
"description": "The value of the form component.",
|
|
18101
|
+
"attribute": "value",
|
|
18102
|
+
"inheritedFrom": {
|
|
18103
|
+
"name": "InputMixin",
|
|
18104
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18105
|
+
}
|
|
18135
18106
|
},
|
|
18136
18107
|
{
|
|
18137
18108
|
"kind": "field",
|
|
18138
|
-
"name": "
|
|
18109
|
+
"name": "formAncestor",
|
|
18139
18110
|
"type": {
|
|
18140
|
-
"text": "
|
|
18111
|
+
"text": "HTMLFormElement | null"
|
|
18141
18112
|
},
|
|
18142
18113
|
"privacy": "private",
|
|
18143
|
-
"default": "
|
|
18144
|
-
"
|
|
18114
|
+
"default": "null",
|
|
18115
|
+
"inheritedFrom": {
|
|
18116
|
+
"name": "InputMixin",
|
|
18117
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18118
|
+
}
|
|
18145
18119
|
},
|
|
18146
18120
|
{
|
|
18147
18121
|
"kind": "field",
|
|
18148
|
-
"name": "
|
|
18122
|
+
"name": "_formId",
|
|
18149
18123
|
"type": {
|
|
18150
|
-
"text": "
|
|
18124
|
+
"text": "string | undefined"
|
|
18151
18125
|
},
|
|
18152
|
-
"privacy": "
|
|
18153
|
-
"
|
|
18126
|
+
"privacy": "protected",
|
|
18127
|
+
"inheritedFrom": {
|
|
18128
|
+
"name": "InputMixin",
|
|
18129
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18130
|
+
}
|
|
18154
18131
|
},
|
|
18155
18132
|
{
|
|
18156
18133
|
"kind": "field",
|
|
18157
|
-
"name": "
|
|
18134
|
+
"name": "form",
|
|
18158
18135
|
"type": {
|
|
18159
|
-
"text": "
|
|
18136
|
+
"text": "HTMLFormElement | null"
|
|
18160
18137
|
},
|
|
18161
|
-
"
|
|
18162
|
-
"
|
|
18163
|
-
"
|
|
18164
|
-
|
|
18138
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
18139
|
+
"attribute": "form",
|
|
18140
|
+
"inheritedFrom": {
|
|
18141
|
+
"name": "InputMixin",
|
|
18142
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18143
|
+
}
|
|
18165
18144
|
},
|
|
18166
18145
|
{
|
|
18167
18146
|
"kind": "field",
|
|
18168
|
-
"name": "
|
|
18169
|
-
"
|
|
18170
|
-
|
|
18171
|
-
|
|
18172
|
-
|
|
18173
|
-
|
|
18174
|
-
"attribute": "role",
|
|
18175
|
-
"reflects": true
|
|
18147
|
+
"name": "focusableRef",
|
|
18148
|
+
"privacy": "protected",
|
|
18149
|
+
"inheritedFrom": {
|
|
18150
|
+
"name": "FocusableMixin",
|
|
18151
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18152
|
+
}
|
|
18176
18153
|
},
|
|
18177
18154
|
{
|
|
18178
|
-
"kind": "
|
|
18179
|
-
"name": "
|
|
18180
|
-
"
|
|
18181
|
-
|
|
18182
|
-
|
|
18183
|
-
|
|
18184
|
-
|
|
18185
|
-
|
|
18186
|
-
|
|
18155
|
+
"kind": "method",
|
|
18156
|
+
"name": "focus",
|
|
18157
|
+
"parameters": [
|
|
18158
|
+
{
|
|
18159
|
+
"name": "options",
|
|
18160
|
+
"optional": true,
|
|
18161
|
+
"type": {
|
|
18162
|
+
"text": "FocusOptions"
|
|
18163
|
+
},
|
|
18164
|
+
"description": "An object which controls aspects of the focusing process."
|
|
18165
|
+
}
|
|
18166
|
+
],
|
|
18167
|
+
"description": "Programmatically move focus to the component.",
|
|
18168
|
+
"inheritedFrom": {
|
|
18169
|
+
"name": "FocusableMixin",
|
|
18170
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18171
|
+
}
|
|
18187
18172
|
},
|
|
18188
18173
|
{
|
|
18189
|
-
"kind": "
|
|
18190
|
-
"name": "
|
|
18174
|
+
"kind": "method",
|
|
18175
|
+
"name": "blur",
|
|
18176
|
+
"description": "Programmatically remove focus from the component.",
|
|
18177
|
+
"inheritedFrom": {
|
|
18178
|
+
"name": "FocusableMixin",
|
|
18179
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18180
|
+
}
|
|
18181
|
+
},
|
|
18182
|
+
{
|
|
18183
|
+
"kind": "method",
|
|
18184
|
+
"name": "click",
|
|
18185
|
+
"description": "Programmatically simulates a click on the component.",
|
|
18186
|
+
"inheritedFrom": {
|
|
18187
|
+
"name": "FocusableMixin",
|
|
18188
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18189
|
+
}
|
|
18190
|
+
}
|
|
18191
|
+
],
|
|
18192
|
+
"attributes": [
|
|
18193
|
+
{
|
|
18194
|
+
"name": "checked",
|
|
18191
18195
|
"type": {
|
|
18192
|
-
"text": "
|
|
18196
|
+
"text": "boolean"
|
|
18193
18197
|
},
|
|
18194
|
-
"default": "
|
|
18195
|
-
"description": "
|
|
18196
|
-
"
|
|
18197
|
-
"reflects": true
|
|
18198
|
+
"default": "false",
|
|
18199
|
+
"description": "Controls whether the toggle is checked or not.",
|
|
18200
|
+
"fieldName": "checked"
|
|
18198
18201
|
},
|
|
18199
18202
|
{
|
|
18200
|
-
"
|
|
18201
|
-
"
|
|
18202
|
-
|
|
18203
|
+
"name": "reverse",
|
|
18204
|
+
"type": {
|
|
18205
|
+
"text": "boolean"
|
|
18206
|
+
},
|
|
18207
|
+
"default": "false",
|
|
18208
|
+
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
18209
|
+
"fieldName": "reverse"
|
|
18203
18210
|
},
|
|
18204
18211
|
{
|
|
18205
|
-
"
|
|
18206
|
-
"
|
|
18207
|
-
|
|
18208
|
-
|
|
18209
|
-
|
|
18210
|
-
|
|
18211
|
-
|
|
18212
|
-
"text": "TooltipStates"
|
|
18213
|
-
}
|
|
18214
|
-
}
|
|
18215
|
-
]
|
|
18212
|
+
"name": "size",
|
|
18213
|
+
"type": {
|
|
18214
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
18215
|
+
},
|
|
18216
|
+
"default": "\"m\"",
|
|
18217
|
+
"description": "The size of the toggle switch.",
|
|
18218
|
+
"fieldName": "size"
|
|
18216
18219
|
},
|
|
18217
18220
|
{
|
|
18218
|
-
"
|
|
18219
|
-
"
|
|
18220
|
-
|
|
18221
|
-
|
|
18221
|
+
"name": "label",
|
|
18222
|
+
"type": {
|
|
18223
|
+
"text": "string"
|
|
18224
|
+
},
|
|
18225
|
+
"default": "\"\"",
|
|
18226
|
+
"description": "Label for the input.",
|
|
18227
|
+
"fieldName": "label",
|
|
18228
|
+
"inheritedFrom": {
|
|
18229
|
+
"name": "FormAssociatedMixin",
|
|
18230
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18231
|
+
}
|
|
18222
18232
|
},
|
|
18223
18233
|
{
|
|
18224
|
-
"
|
|
18225
|
-
"
|
|
18226
|
-
|
|
18234
|
+
"name": "hint",
|
|
18235
|
+
"type": {
|
|
18236
|
+
"text": "string | undefined"
|
|
18237
|
+
},
|
|
18238
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
18239
|
+
"fieldName": "hint",
|
|
18240
|
+
"inheritedFrom": {
|
|
18241
|
+
"name": "FormAssociatedMixin",
|
|
18242
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18243
|
+
}
|
|
18227
18244
|
},
|
|
18228
18245
|
{
|
|
18229
|
-
"
|
|
18230
|
-
"
|
|
18231
|
-
|
|
18246
|
+
"name": "hide-label",
|
|
18247
|
+
"type": {
|
|
18248
|
+
"text": "boolean"
|
|
18249
|
+
},
|
|
18250
|
+
"default": "false",
|
|
18251
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
18252
|
+
"fieldName": "hideLabel",
|
|
18253
|
+
"inheritedFrom": {
|
|
18254
|
+
"name": "FormAssociatedMixin",
|
|
18255
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18256
|
+
}
|
|
18232
18257
|
},
|
|
18233
18258
|
{
|
|
18234
|
-
"
|
|
18235
|
-
"
|
|
18236
|
-
|
|
18259
|
+
"name": "placeholder",
|
|
18260
|
+
"type": {
|
|
18261
|
+
"text": "string | undefined"
|
|
18262
|
+
},
|
|
18263
|
+
"description": "Placeholder text to display within the input.",
|
|
18264
|
+
"fieldName": "placeholder",
|
|
18265
|
+
"inheritedFrom": {
|
|
18266
|
+
"name": "FormAssociatedMixin",
|
|
18267
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18268
|
+
}
|
|
18237
18269
|
},
|
|
18238
18270
|
{
|
|
18239
|
-
"
|
|
18240
|
-
"
|
|
18241
|
-
|
|
18271
|
+
"name": "error",
|
|
18272
|
+
"type": {
|
|
18273
|
+
"text": "string | undefined"
|
|
18274
|
+
},
|
|
18275
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
18276
|
+
"fieldName": "error",
|
|
18277
|
+
"inheritedFrom": {
|
|
18278
|
+
"name": "FormAssociatedMixin",
|
|
18279
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18280
|
+
}
|
|
18242
18281
|
},
|
|
18243
18282
|
{
|
|
18244
|
-
"
|
|
18245
|
-
"
|
|
18246
|
-
|
|
18283
|
+
"name": "required",
|
|
18284
|
+
"type": {
|
|
18285
|
+
"text": "boolean"
|
|
18286
|
+
},
|
|
18287
|
+
"default": "false",
|
|
18288
|
+
"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.",
|
|
18289
|
+
"fieldName": "required",
|
|
18290
|
+
"inheritedFrom": {
|
|
18291
|
+
"name": "FormAssociatedMixin",
|
|
18292
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18293
|
+
}
|
|
18247
18294
|
},
|
|
18248
18295
|
{
|
|
18249
|
-
"
|
|
18250
|
-
"
|
|
18251
|
-
|
|
18296
|
+
"name": "hide-required",
|
|
18297
|
+
"type": {
|
|
18298
|
+
"text": "boolean"
|
|
18299
|
+
},
|
|
18300
|
+
"default": "false",
|
|
18301
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
18302
|
+
"fieldName": "hideRequired",
|
|
18303
|
+
"inheritedFrom": {
|
|
18304
|
+
"name": "FormAssociatedMixin",
|
|
18305
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18306
|
+
}
|
|
18252
18307
|
},
|
|
18253
18308
|
{
|
|
18254
|
-
"
|
|
18255
|
-
"name": "removeDescribedBy",
|
|
18256
|
-
"privacy": "private"
|
|
18257
|
-
}
|
|
18258
|
-
],
|
|
18259
|
-
"attributes": [
|
|
18260
|
-
{
|
|
18261
|
-
"name": "position",
|
|
18309
|
+
"name": "disabled",
|
|
18262
18310
|
"type": {
|
|
18263
|
-
"text": "
|
|
18311
|
+
"text": "boolean"
|
|
18264
18312
|
},
|
|
18265
|
-
"default": "
|
|
18266
|
-
"description": "
|
|
18267
|
-
"fieldName": "
|
|
18313
|
+
"default": "false",
|
|
18314
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
18315
|
+
"fieldName": "disabled",
|
|
18316
|
+
"inheritedFrom": {
|
|
18317
|
+
"name": "InputMixin",
|
|
18318
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18319
|
+
}
|
|
18268
18320
|
},
|
|
18269
18321
|
{
|
|
18270
|
-
"name": "
|
|
18322
|
+
"name": "name",
|
|
18271
18323
|
"type": {
|
|
18272
|
-
"text": "string"
|
|
18324
|
+
"text": "string | undefined"
|
|
18273
18325
|
},
|
|
18274
|
-
"
|
|
18275
|
-
"
|
|
18276
|
-
"
|
|
18326
|
+
"description": "The name of the form component.",
|
|
18327
|
+
"fieldName": "name",
|
|
18328
|
+
"inheritedFrom": {
|
|
18329
|
+
"name": "InputMixin",
|
|
18330
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18331
|
+
}
|
|
18277
18332
|
},
|
|
18278
18333
|
{
|
|
18279
|
-
"name": "
|
|
18334
|
+
"name": "value",
|
|
18280
18335
|
"type": {
|
|
18281
18336
|
"text": "string"
|
|
18282
18337
|
},
|
|
18283
18338
|
"default": "\"\"",
|
|
18284
|
-
"description": "The
|
|
18285
|
-
"fieldName": "
|
|
18339
|
+
"description": "The value of the form component.",
|
|
18340
|
+
"fieldName": "value",
|
|
18341
|
+
"inheritedFrom": {
|
|
18342
|
+
"name": "InputMixin",
|
|
18343
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18344
|
+
}
|
|
18286
18345
|
},
|
|
18287
18346
|
{
|
|
18288
|
-
"name": "
|
|
18347
|
+
"name": "form",
|
|
18289
18348
|
"type": {
|
|
18290
|
-
"text": "
|
|
18349
|
+
"text": "HTMLFormElement | null"
|
|
18291
18350
|
},
|
|
18292
|
-
"
|
|
18293
|
-
"
|
|
18294
|
-
"
|
|
18351
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
18352
|
+
"fieldName": "form",
|
|
18353
|
+
"inheritedFrom": {
|
|
18354
|
+
"name": "InputMixin",
|
|
18355
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18356
|
+
}
|
|
18295
18357
|
}
|
|
18296
18358
|
],
|
|
18297
|
-
"
|
|
18298
|
-
"name": "LitElement",
|
|
18299
|
-
"package": "lit"
|
|
18300
|
-
},
|
|
18301
|
-
"localization": [],
|
|
18302
|
-
"status": "ready",
|
|
18303
|
-
"category": "overlay",
|
|
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 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",
|
|
18305
|
-
"examples": [],
|
|
18306
|
-
"dependencies": [],
|
|
18307
|
-
"tagName": "nord-tooltip",
|
|
18308
|
-
"customElement": true
|
|
18309
|
-
}
|
|
18310
|
-
],
|
|
18311
|
-
"exports": [
|
|
18312
|
-
{
|
|
18313
|
-
"kind": "js",
|
|
18314
|
-
"name": "default",
|
|
18315
|
-
"declaration": {
|
|
18316
|
-
"name": "Tooltip",
|
|
18317
|
-
"module": "src/tooltip/Tooltip.ts"
|
|
18318
|
-
}
|
|
18319
|
-
},
|
|
18320
|
-
{
|
|
18321
|
-
"kind": "custom-element-definition",
|
|
18322
|
-
"name": "nord-tooltip",
|
|
18323
|
-
"declaration": {
|
|
18324
|
-
"name": "Tooltip",
|
|
18325
|
-
"module": "src/tooltip/Tooltip.ts"
|
|
18326
|
-
}
|
|
18327
|
-
}
|
|
18328
|
-
]
|
|
18329
|
-
},
|
|
18330
|
-
{
|
|
18331
|
-
"kind": "javascript-module",
|
|
18332
|
-
"path": "src/top-bar/TopBar.ts",
|
|
18333
|
-
"declarations": [
|
|
18334
|
-
{
|
|
18335
|
-
"kind": "class",
|
|
18336
|
-
"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.",
|
|
18337
|
-
"name": "TopBar",
|
|
18338
|
-
"slots": [
|
|
18359
|
+
"mixins": [
|
|
18339
18360
|
{
|
|
18340
|
-
"
|
|
18341
|
-
"
|
|
18361
|
+
"name": "FormAssociatedMixin",
|
|
18362
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
18342
18363
|
},
|
|
18343
18364
|
{
|
|
18344
|
-
"
|
|
18345
|
-
"
|
|
18365
|
+
"name": "InputMixin",
|
|
18366
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
18367
|
+
},
|
|
18368
|
+
{
|
|
18369
|
+
"name": "FocusableMixin",
|
|
18370
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
18346
18371
|
}
|
|
18347
18372
|
],
|
|
18348
|
-
"members": [],
|
|
18349
18373
|
"superclass": {
|
|
18350
18374
|
"name": "LitElement",
|
|
18351
18375
|
"package": "lit"
|
|
18352
18376
|
},
|
|
18353
18377
|
"localization": [],
|
|
18354
18378
|
"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-
|
|
18379
|
+
"category": "form",
|
|
18380
|
+
"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",
|
|
18357
18381
|
"examples": [],
|
|
18358
18382
|
"dependencies": [],
|
|
18359
|
-
"tagName": "nord-
|
|
18360
|
-
"customElement": true
|
|
18361
|
-
|
|
18362
|
-
],
|
|
18363
|
-
"exports": [
|
|
18364
|
-
{
|
|
18365
|
-
"kind": "js",
|
|
18366
|
-
"name": "default",
|
|
18367
|
-
"declaration": {
|
|
18368
|
-
"name": "TopBar",
|
|
18369
|
-
"module": "src/top-bar/TopBar.ts"
|
|
18370
|
-
}
|
|
18371
|
-
},
|
|
18372
|
-
{
|
|
18373
|
-
"kind": "custom-element-definition",
|
|
18374
|
-
"name": "nord-top-bar",
|
|
18375
|
-
"declaration": {
|
|
18376
|
-
"name": "TopBar",
|
|
18377
|
-
"module": "src/top-bar/TopBar.ts"
|
|
18378
|
-
}
|
|
18379
|
-
}
|
|
18380
|
-
]
|
|
18381
|
-
},
|
|
18382
|
-
{
|
|
18383
|
-
"kind": "javascript-module",
|
|
18384
|
-
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
18385
|
-
"declarations": [
|
|
18386
|
-
{
|
|
18387
|
-
"kind": "class",
|
|
18388
|
-
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
18389
|
-
"name": "VisuallyHidden",
|
|
18390
|
-
"slots": [
|
|
18383
|
+
"tagName": "nord-toggle",
|
|
18384
|
+
"customElement": true,
|
|
18385
|
+
"events": [
|
|
18391
18386
|
{
|
|
18392
|
-
"
|
|
18393
|
-
"
|
|
18387
|
+
"name": "input",
|
|
18388
|
+
"type": {
|
|
18389
|
+
"text": "NordEvent"
|
|
18390
|
+
},
|
|
18391
|
+
"description": "Fired as the user types into the input.",
|
|
18392
|
+
"inheritedFrom": {
|
|
18393
|
+
"name": "FormAssociatedMixin",
|
|
18394
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18395
|
+
}
|
|
18396
|
+
},
|
|
18397
|
+
{
|
|
18398
|
+
"name": "change",
|
|
18399
|
+
"type": {
|
|
18400
|
+
"text": "NordEvent"
|
|
18401
|
+
},
|
|
18402
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
18403
|
+
"inheritedFrom": {
|
|
18404
|
+
"name": "FormAssociatedMixin",
|
|
18405
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18406
|
+
}
|
|
18394
18407
|
}
|
|
18395
|
-
]
|
|
18396
|
-
"members": [],
|
|
18397
|
-
"superclass": {
|
|
18398
|
-
"name": "LitElement",
|
|
18399
|
-
"package": "lit"
|
|
18400
|
-
},
|
|
18401
|
-
"localization": [],
|
|
18402
|
-
"status": "ready",
|
|
18403
|
-
"category": "text",
|
|
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- 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",
|
|
18405
|
-
"examples": [],
|
|
18406
|
-
"dependencies": [],
|
|
18407
|
-
"tagName": "nord-visually-hidden",
|
|
18408
|
-
"customElement": true
|
|
18408
|
+
]
|
|
18409
18409
|
}
|
|
18410
18410
|
],
|
|
18411
18411
|
"exports": [
|
|
@@ -18413,16 +18413,16 @@
|
|
|
18413
18413
|
"kind": "js",
|
|
18414
18414
|
"name": "default",
|
|
18415
18415
|
"declaration": {
|
|
18416
|
-
"name": "
|
|
18417
|
-
"module": "src/
|
|
18416
|
+
"name": "Toggle",
|
|
18417
|
+
"module": "src/toggle/Toggle.ts"
|
|
18418
18418
|
}
|
|
18419
18419
|
},
|
|
18420
18420
|
{
|
|
18421
18421
|
"kind": "custom-element-definition",
|
|
18422
|
-
"name": "nord-
|
|
18422
|
+
"name": "nord-toggle",
|
|
18423
18423
|
"declaration": {
|
|
18424
|
-
"name": "
|
|
18425
|
-
"module": "src/
|
|
18424
|
+
"name": "Toggle",
|
|
18425
|
+
"module": "src/toggle/Toggle.ts"
|
|
18426
18426
|
}
|
|
18427
18427
|
}
|
|
18428
18428
|
]
|