@nordhealth/components 2.17.1 → 3.1.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/README.md +14 -1
- package/custom-elements.json +1321 -873
- package/lib/Avatar.js +1 -1
- package/lib/Avatar.js.map +1 -1
- package/lib/Badge.js +1 -1
- package/lib/Badge.js.map +1 -1
- package/lib/Banner.js +1 -1
- package/lib/Banner.js.map +1 -1
- package/lib/Button.js +1 -1
- package/lib/Button.js.map +1 -1
- package/lib/ButtonGroup.js +1 -1
- package/lib/ButtonGroup.js.map +1 -1
- package/lib/Calendar-62409139.js +2 -0
- package/lib/{Calendar-70103fd4.js.map → Calendar-62409139.js.map} +1 -1
- package/lib/Calendar.js +1 -1
- package/lib/CommandMenu.js +1 -1
- package/lib/CommandMenu.js.map +1 -1
- package/lib/CommandMenuAction.js +1 -1
- package/lib/CommandMenuAction.js.map +1 -1
- package/lib/DatePicker.js +1 -1
- package/lib/DatePicker.js.map +1 -1
- package/lib/{DirectionController-8b298382.js → DirectionController-f35f5476.js} +2 -2
- package/lib/{DirectionController-8b298382.js.map → DirectionController-f35f5476.js.map} +1 -1
- package/lib/Divider.js.map +1 -1
- package/lib/Drawer.js +1 -1
- package/lib/Drawer.js.map +1 -1
- package/lib/Dropdown.js +1 -1
- package/lib/Dropdown.js.map +1 -1
- package/lib/DropdownGroup.js +1 -1
- package/lib/DropdownGroup.js.map +1 -1
- package/lib/DropdownItem-a9bf32f4.js +2 -0
- package/lib/DropdownItem-a9bf32f4.js.map +1 -0
- package/lib/DropdownItem.js +1 -1
- package/lib/DropdownItem.js.map +1 -1
- package/lib/EventController-d99ebeef.js.map +1 -1
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Icon.js.map +1 -1
- package/lib/IconManager.js +1 -1
- package/lib/Input.js +1 -1
- package/lib/Input.js.map +1 -1
- package/lib/Layout.js +1 -1
- package/lib/Layout.js.map +1 -1
- package/lib/LocalizeController.js +1 -1
- package/lib/LocalizeController.js.map +1 -1
- package/lib/Message.js +2 -0
- package/lib/Message.js.map +1 -0
- package/lib/Modal.js +1 -1
- package/lib/Modal.js.map +1 -1
- package/lib/ModalController.js.map +1 -1
- package/lib/NavGroup.js +1 -1
- package/lib/NavGroup.js.map +1 -1
- package/lib/NavItem.js +1 -1
- package/lib/NavItem.js.map +1 -1
- package/lib/NavToggle-d34fed72.js +2 -0
- package/lib/NavToggle-d34fed72.js.map +1 -0
- package/lib/NavToggle.js +1 -1
- package/lib/NavToggle.js.map +1 -1
- package/lib/Navigation.js +1 -1
- package/lib/Navigation.js.map +1 -1
- package/lib/Notification.js +1 -1
- package/lib/Notification.js.map +1 -1
- package/lib/NotificationGroup.js +1 -1
- package/lib/NotificationGroup.js.map +1 -1
- package/lib/NotificationMixin-c06bb631.js.map +1 -1
- package/lib/{Popout-9f0393b2.js → Popout-c6ee2d7a.js} +2 -2
- package/lib/Popout-c6ee2d7a.js.map +1 -0
- package/lib/Popout.js +1 -1
- package/lib/ProgressBar.js +1 -1
- package/lib/ProgressBar.js.map +1 -1
- package/lib/Qrcode.js.map +1 -1
- package/lib/Radio.js.map +1 -1
- package/lib/Range.js +1 -1
- package/lib/ScrollbarController-773c79f4.js.map +1 -1
- package/lib/Select.js.map +1 -1
- package/lib/SelectEvent.js.map +1 -1
- package/lib/Stack.js +1 -1
- package/lib/Stack.js.map +1 -1
- package/lib/{Sticky-69666e8c.js → Sticky-acc92284.js} +2 -2
- package/lib/Sticky-acc92284.js.map +1 -0
- package/lib/Tab.js +1 -1
- package/lib/Tab.js.map +1 -1
- package/lib/TabGroup.js +1 -1
- package/lib/TabGroup.js.map +1 -1
- package/lib/TextField-8b226327.js +2 -0
- package/lib/{TextField-d617d0ad.js.map → TextField-8b226327.js.map} +1 -1
- package/lib/Textarea.js +1 -1
- package/lib/Textarea.js.map +1 -1
- package/lib/Toast.js.map +1 -1
- package/lib/Toggle.js +1 -1
- package/lib/Toggle.js.map +1 -1
- package/lib/Tooltip.js +1 -1
- package/lib/Tooltip.js.map +1 -1
- package/lib/TopBar.js +2 -0
- package/lib/TopBar.js.map +1 -0
- package/lib/bundle.js +16 -15
- package/lib/bundle.js.map +1 -1
- package/lib/en-us.js +1 -1
- package/lib/en-us.js.map +1 -1
- package/lib/fi-fi.js +1 -1
- package/lib/fi-fi.js.map +1 -1
- package/lib/index.js +1 -1
- package/lib/localization.js +1 -1
- package/lib/localization.js.map +1 -1
- package/lib/localization8.js +2 -0
- package/lib/localization8.js.map +1 -0
- package/lib/positioning-a572d126.js +2 -0
- package/lib/positioning-a572d126.js.map +1 -0
- package/lib/query-assigned-elements-15485e3d.js.map +1 -1
- package/lib/src/avatar/Avatar.d.ts +2 -1
- package/lib/src/badge/Badge.d.ts +12 -3
- package/lib/src/button/Button.d.ts +2 -3
- package/lib/src/button-group/ButtonGroup.d.ts +2 -4
- package/lib/src/calendar/Calendar.d.ts +1 -1
- package/lib/src/command-menu/CommandMenu.d.ts +1 -4
- package/lib/src/command-menu/KeyboardController.d.ts +1 -1
- package/lib/src/command-menu/localization.d.ts +1 -0
- package/lib/src/common/controllers/DirectionController.d.ts +1 -1
- package/lib/src/common/controllers/EventController.d.ts +6 -5
- package/lib/src/common/controllers/FormDataController.d.ts +1 -1
- package/lib/src/common/controllers/LightDismissController.d.ts +1 -1
- package/lib/src/common/controllers/LightDomController.d.ts +1 -1
- package/lib/src/common/controllers/LightSlotController.d.ts +1 -1
- package/lib/src/common/controllers/PortalController.d.ts +1 -1
- package/lib/src/common/controllers/ResizeController.d.ts +13 -0
- package/lib/src/common/controllers/ShortcutController.d.ts +1 -1
- package/lib/src/common/controllers/SwipeController.d.ts +2 -2
- package/lib/src/common/decorators/observe.d.ts +1 -1
- package/lib/src/common/fsm.d.ts +4 -4
- package/lib/src/common/mixins/AutocompleteMixin.d.ts +2 -2
- package/lib/src/common/mixins/DraftComponentMixin.d.ts +1 -1
- package/lib/src/common/mixins/FloatingComponentMixin.d.ts +1 -1
- package/lib/src/common/mixins/FocusableMixin.d.ts +1 -1
- package/lib/src/common/mixins/FormAssociatedMixin.d.ts +1 -1
- package/lib/src/common/mixins/InputMixin.d.ts +1 -1
- package/lib/src/common/mixins/NotificationMixin.d.ts +1 -1
- package/lib/src/common/mixins/ReadonlyMixin.d.ts +1 -1
- package/lib/src/common/mixins/SizeMixin.d.ts +1 -1
- package/lib/src/common/positioning.d.ts +3 -3
- package/lib/src/common/ref.d.ts +1 -1
- package/lib/src/date-picker/DatePicker.d.ts +0 -6
- package/lib/src/date-picker/date-adapter.d.ts +3 -3
- package/lib/src/drawer/Drawer.d.ts +2 -4
- package/lib/src/dropdown/Dropdown.d.ts +6 -0
- package/lib/src/dropdown/Dropdown.test.d.ts +1 -0
- package/lib/src/icon/Icon.d.ts +1 -0
- package/lib/src/icon/IconManager.d.ts +1 -1
- package/lib/src/index.d.ts +2 -0
- package/lib/src/input/Input.d.ts +2 -0
- package/lib/src/layout/Layout.d.ts +6 -14
- package/lib/src/layout/Layout.test.d.ts +1 -0
- package/lib/src/localization/LocalizeController.d.ts +3 -3
- package/lib/src/localization/en-us.d.ts +4 -0
- package/lib/src/localization/translation.d.ts +7 -3
- package/lib/src/message/Message.d.ts +42 -0
- package/lib/src/message/Message.test.d.ts +2 -0
- package/lib/src/message/localization.d.ts +4 -0
- package/lib/src/modal/ModalController.d.ts +1 -1
- package/lib/src/nav-group/NavGroup.d.ts +1 -1
- package/lib/src/nav-group/NavGroup.test.d.ts +1 -0
- package/lib/src/nav-item/NavItem.d.ts +2 -2
- package/lib/src/nav-toggle/NavToggle.d.ts +1 -1
- package/lib/src/navigation/Navigation.d.ts +5 -0
- package/lib/src/select/Select.d.ts +1 -0
- package/lib/src/stack/Stack.d.ts +0 -5
- package/lib/src/toast-group/ToastGroup.d.ts +1 -1
- package/lib/src/top-bar/TopBar.d.ts +20 -0
- package/lib/src/top-bar/TopBar.test.d.ts +9 -0
- package/lib/translation.js +1 -1
- package/lib/translation.js.map +1 -1
- package/package.json +43 -39
- package/lib/Calendar-70103fd4.js +0 -2
- package/lib/Popout-9f0393b2.js.map +0 -1
- package/lib/Sticky-69666e8c.js.map +0 -1
- package/lib/TextField-d617d0ad.js +0 -2
- package/lib/positioning-cc75c800.js +0 -2
- package/lib/positioning-cc75c800.js.map +0 -1
package/custom-elements.json
CHANGED
|
@@ -167,6 +167,14 @@
|
|
|
167
167
|
"module": "\"./header/Header.js\""
|
|
168
168
|
}
|
|
169
169
|
},
|
|
170
|
+
{
|
|
171
|
+
"kind": "js",
|
|
172
|
+
"name": "Message",
|
|
173
|
+
"declaration": {
|
|
174
|
+
"name": "default",
|
|
175
|
+
"module": "\"./message/Message.js\""
|
|
176
|
+
}
|
|
177
|
+
},
|
|
170
178
|
{
|
|
171
179
|
"kind": "js",
|
|
172
180
|
"name": "NavGroup",
|
|
@@ -414,6 +422,14 @@
|
|
|
414
422
|
"name": "default",
|
|
415
423
|
"module": "\"./notification-group/NotificationGroup.js\""
|
|
416
424
|
}
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
"kind": "js",
|
|
428
|
+
"name": "TopBar",
|
|
429
|
+
"declaration": {
|
|
430
|
+
"name": "default",
|
|
431
|
+
"module": "\"./top-bar/TopBar.js\""
|
|
432
|
+
}
|
|
417
433
|
}
|
|
418
434
|
]
|
|
419
435
|
},
|
|
@@ -435,6 +451,11 @@
|
|
|
435
451
|
"description": "Controls the size of the avatar, using [icon sizing tokens](/tokens/#size).",
|
|
436
452
|
"name": "--n-avatar-size",
|
|
437
453
|
"default": "var(--n-size-icon-l)"
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"description": "Controls the box shadow for the avatar.",
|
|
457
|
+
"name": "--n-avatar-box-shadow",
|
|
458
|
+
"default": "none"
|
|
438
459
|
}
|
|
439
460
|
],
|
|
440
461
|
"members": [
|
|
@@ -619,6 +640,10 @@
|
|
|
619
640
|
{
|
|
620
641
|
"description": "The badge content.",
|
|
621
642
|
"name": ""
|
|
643
|
+
},
|
|
644
|
+
{
|
|
645
|
+
"description": "Used to place an icon at the start of badge.",
|
|
646
|
+
"name": "icon"
|
|
622
647
|
}
|
|
623
648
|
],
|
|
624
649
|
"members": [
|
|
@@ -628,248 +653,59 @@
|
|
|
628
653
|
"type": {
|
|
629
654
|
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
630
655
|
},
|
|
631
|
-
"default": "\"neutral\"",
|
|
632
656
|
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
657
|
+
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
633
658
|
"attribute": "type",
|
|
634
659
|
"reflects": true
|
|
635
660
|
},
|
|
636
661
|
{
|
|
637
662
|
"kind": "field",
|
|
638
|
-
"name": "
|
|
639
|
-
"type": {
|
|
640
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
641
|
-
},
|
|
642
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
643
|
-
"attribute": "progress"
|
|
644
|
-
}
|
|
645
|
-
],
|
|
646
|
-
"attributes": [
|
|
647
|
-
{
|
|
648
|
-
"name": "type",
|
|
649
|
-
"type": {
|
|
650
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
651
|
-
},
|
|
652
|
-
"default": "\"neutral\"",
|
|
653
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
654
|
-
"fieldName": "type"
|
|
655
|
-
},
|
|
656
|
-
{
|
|
657
|
-
"name": "progress",
|
|
663
|
+
"name": "variant",
|
|
658
664
|
"type": {
|
|
659
|
-
"text": "\"
|
|
665
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
660
666
|
},
|
|
661
|
-
"description": "The
|
|
662
|
-
"
|
|
663
|
-
|
|
664
|
-
],
|
|
665
|
-
"superclass": {
|
|
666
|
-
"name": "LitElement",
|
|
667
|
-
"package": "lit"
|
|
668
|
-
},
|
|
669
|
-
"localization": [],
|
|
670
|
-
"status": "ready",
|
|
671
|
-
"category": "text",
|
|
672
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s clear to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
673
|
-
"examples": [],
|
|
674
|
-
"dependencies": [
|
|
675
|
-
"icon"
|
|
676
|
-
],
|
|
677
|
-
"tagName": "nord-badge",
|
|
678
|
-
"customElement": true
|
|
679
|
-
}
|
|
680
|
-
],
|
|
681
|
-
"exports": [
|
|
682
|
-
{
|
|
683
|
-
"kind": "js",
|
|
684
|
-
"name": "default",
|
|
685
|
-
"declaration": {
|
|
686
|
-
"name": "Badge",
|
|
687
|
-
"module": "src/badge/Badge.ts"
|
|
688
|
-
}
|
|
689
|
-
},
|
|
690
|
-
{
|
|
691
|
-
"kind": "custom-element-definition",
|
|
692
|
-
"name": "nord-badge",
|
|
693
|
-
"declaration": {
|
|
694
|
-
"name": "Badge",
|
|
695
|
-
"module": "src/badge/Badge.ts"
|
|
696
|
-
}
|
|
697
|
-
}
|
|
698
|
-
]
|
|
699
|
-
},
|
|
700
|
-
{
|
|
701
|
-
"kind": "javascript-module",
|
|
702
|
-
"path": "src/banner/Banner.ts",
|
|
703
|
-
"declarations": [
|
|
704
|
-
{
|
|
705
|
-
"kind": "class",
|
|
706
|
-
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
707
|
-
"name": "Banner",
|
|
708
|
-
"cssProperties": [
|
|
709
|
-
{
|
|
710
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
711
|
-
"name": "--n-banner-border-radius",
|
|
712
|
-
"default": "var(--n-border-radius)"
|
|
667
|
+
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
668
|
+
"attribute": "variant",
|
|
669
|
+
"reflects": true
|
|
713
670
|
},
|
|
714
|
-
{
|
|
715
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
716
|
-
"name": "--n-banner-box-shadow",
|
|
717
|
-
"default": "var(--n-box-shadow-card)"
|
|
718
|
-
}
|
|
719
|
-
],
|
|
720
|
-
"slots": [
|
|
721
|
-
{
|
|
722
|
-
"description": "default slot",
|
|
723
|
-
"name": ""
|
|
724
|
-
}
|
|
725
|
-
],
|
|
726
|
-
"members": [
|
|
727
671
|
{
|
|
728
672
|
"kind": "field",
|
|
729
|
-
"name": "
|
|
673
|
+
"name": "strong",
|
|
730
674
|
"type": {
|
|
731
|
-
"text": "
|
|
675
|
+
"text": "boolean"
|
|
732
676
|
},
|
|
733
|
-
"default": "
|
|
734
|
-
"description": "
|
|
735
|
-
"attribute": "
|
|
677
|
+
"default": "false",
|
|
678
|
+
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
679
|
+
"attribute": "strong",
|
|
736
680
|
"reflects": true
|
|
737
681
|
}
|
|
738
682
|
],
|
|
739
683
|
"attributes": [
|
|
740
684
|
{
|
|
741
|
-
"name": "
|
|
742
|
-
"type": {
|
|
743
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
744
|
-
},
|
|
745
|
-
"default": "\"info\"",
|
|
746
|
-
"description": "The style variant of the banner.",
|
|
747
|
-
"fieldName": "variant"
|
|
748
|
-
}
|
|
749
|
-
],
|
|
750
|
-
"superclass": {
|
|
751
|
-
"name": "LitElement",
|
|
752
|
-
"package": "lit"
|
|
753
|
-
},
|
|
754
|
-
"localization": [],
|
|
755
|
-
"status": "ready",
|
|
756
|
-
"category": "feedback",
|
|
757
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
758
|
-
"examples": [],
|
|
759
|
-
"dependencies": [
|
|
760
|
-
"icon"
|
|
761
|
-
],
|
|
762
|
-
"tagName": "nord-banner",
|
|
763
|
-
"customElement": true
|
|
764
|
-
}
|
|
765
|
-
],
|
|
766
|
-
"exports": [
|
|
767
|
-
{
|
|
768
|
-
"kind": "js",
|
|
769
|
-
"name": "default",
|
|
770
|
-
"declaration": {
|
|
771
|
-
"name": "Banner",
|
|
772
|
-
"module": "src/banner/Banner.ts"
|
|
773
|
-
}
|
|
774
|
-
},
|
|
775
|
-
{
|
|
776
|
-
"kind": "custom-element-definition",
|
|
777
|
-
"name": "nord-banner",
|
|
778
|
-
"declaration": {
|
|
779
|
-
"name": "Banner",
|
|
780
|
-
"module": "src/banner/Banner.ts"
|
|
781
|
-
}
|
|
782
|
-
}
|
|
783
|
-
]
|
|
784
|
-
},
|
|
785
|
-
{
|
|
786
|
-
"kind": "javascript-module",
|
|
787
|
-
"path": "src/button-group/ButtonGroup.ts",
|
|
788
|
-
"declarations": [
|
|
789
|
-
{
|
|
790
|
-
"kind": "class",
|
|
791
|
-
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
792
|
-
"name": "ButtonGroup",
|
|
793
|
-
"cssProperties": [
|
|
794
|
-
{
|
|
795
|
-
"description": "Controls the rounded corners of the button, using [border radius tokens](/tokens/#border-radius).",
|
|
796
|
-
"name": "--n-button-group-border-radius",
|
|
797
|
-
"default": "var(--n-border-radius-s)"
|
|
798
|
-
},
|
|
799
|
-
{
|
|
800
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
801
|
-
"name": "--n-button-group-box-shadow",
|
|
802
|
-
"default": "var(--n-box-shadow)"
|
|
803
|
-
}
|
|
804
|
-
],
|
|
805
|
-
"slots": [
|
|
806
|
-
{
|
|
807
|
-
"description": "The button group content",
|
|
808
|
-
"name": ""
|
|
809
|
-
}
|
|
810
|
-
],
|
|
811
|
-
"members": [
|
|
812
|
-
{
|
|
813
|
-
"kind": "field",
|
|
814
|
-
"name": "direction",
|
|
685
|
+
"name": "type",
|
|
815
686
|
"type": {
|
|
816
|
-
"text": "\"
|
|
687
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
817
688
|
},
|
|
818
|
-
"
|
|
819
|
-
"
|
|
820
|
-
"
|
|
821
|
-
"reflects": true
|
|
689
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
690
|
+
"deprecated": "Use `variant` instead. If you previously used `\"progress\"`, use `\"info\"` instead.",
|
|
691
|
+
"fieldName": "type"
|
|
822
692
|
},
|
|
823
693
|
{
|
|
824
|
-
"
|
|
825
|
-
"name": "role",
|
|
694
|
+
"name": "variant",
|
|
826
695
|
"type": {
|
|
827
|
-
"text": "
|
|
696
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"neutral\" | \"info\" | undefined"
|
|
828
697
|
},
|
|
829
|
-
"
|
|
830
|
-
"
|
|
831
|
-
"attribute": "role",
|
|
832
|
-
"reflects": true
|
|
698
|
+
"description": "The style variant of the badge.\nDetermines the background color of the badge.",
|
|
699
|
+
"fieldName": "variant"
|
|
833
700
|
},
|
|
834
701
|
{
|
|
835
|
-
"
|
|
836
|
-
"name": "_warningLogged",
|
|
702
|
+
"name": "strong",
|
|
837
703
|
"type": {
|
|
838
704
|
"text": "boolean"
|
|
839
705
|
},
|
|
840
|
-
"privacy": "private",
|
|
841
|
-
"static": true,
|
|
842
706
|
"default": "false",
|
|
843
|
-
"
|
|
844
|
-
|
|
845
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
846
|
-
}
|
|
847
|
-
}
|
|
848
|
-
],
|
|
849
|
-
"attributes": [
|
|
850
|
-
{
|
|
851
|
-
"name": "direction",
|
|
852
|
-
"type": {
|
|
853
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
854
|
-
},
|
|
855
|
-
"default": "\"horizontal\"",
|
|
856
|
-
"description": "The direction of the button group.",
|
|
857
|
-
"fieldName": "direction"
|
|
858
|
-
},
|
|
859
|
-
{
|
|
860
|
-
"name": "role",
|
|
861
|
-
"type": {
|
|
862
|
-
"text": "string"
|
|
863
|
-
},
|
|
864
|
-
"default": "\"group\"",
|
|
865
|
-
"description": "The appropriate role for the containing element.",
|
|
866
|
-
"fieldName": "role"
|
|
867
|
-
}
|
|
868
|
-
],
|
|
869
|
-
"mixins": [
|
|
870
|
-
{
|
|
871
|
-
"name": "DraftComponentMixin",
|
|
872
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
707
|
+
"description": "Strong badges are a secondary style for badges.\nThey provide more visual prominence and emphasize them.",
|
|
708
|
+
"fieldName": "strong"
|
|
873
709
|
}
|
|
874
710
|
],
|
|
875
711
|
"superclass": {
|
|
@@ -877,12 +713,12 @@
|
|
|
877
713
|
"package": "lit"
|
|
878
714
|
},
|
|
879
715
|
"localization": [],
|
|
880
|
-
"status": "
|
|
881
|
-
"category": "
|
|
882
|
-
"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
|
|
716
|
+
"status": "ready",
|
|
717
|
+
"category": "text",
|
|
718
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use established variants and color patterns so that users can clearly identify the importance level.\n- Use to show a status update on a piece of information or action.\n- Use to mark something as a “draft” or “new”.\n- Use when you want to highlight something that has been added recently.\n- Always position badge so that it’s clear to understand what object it’s related to.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t make badges clickable. Instead use button component’s small variant.\n- Don’t use alternatives to existing badge variants.\n\n</div>\n\n---\n\n## Content guidelines\n\nBadge labels should use a single word to describe the status of an object. Only use two words if you need to describe a complex state:\n\n<div class=\"n-usage n-usage-do\">Complete</div>\n<div class=\"n-usage n-usage-dont\">Action completed</div>\n\nWhen writing badge labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Partially refunded</div>\n<div class=\"n-usage n-usage-dont\">Partially Refunded</div>\n\nAvoid unnecessary words and articles in badge labels, such as “is”, “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Pending</div>\n<div class=\"n-usage n-usage-dont\">Item is pending</div>\n\nAlways describe the status in the past tense:\n\n<div class=\"n-usage n-usage-do\">Refunded</div>\n<div class=\"n-usage n-usage-dont\">Refund</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `neutral` | The default style variant. |\n| `info` | Used to convey general information that isn’t critical. |\n| `success` | Used to convey success states. For example, you might want to show a badge that tells the user a payment was successful. |\n| `highlight` | Used to highlight specific items in the interface, like notifications. |\n| `danger` | Used to communicate problems that have to be resolved so that user can continue forward. Should always be used for highlighting errors. |\n| `warning` | Used to display information that needs a user’s attention attention and may require further steps. |\n| `progress` | Used to convey something that’s in progress. |\n",
|
|
883
719
|
"examples": [],
|
|
884
720
|
"dependencies": [],
|
|
885
|
-
"tagName": "nord-
|
|
721
|
+
"tagName": "nord-badge",
|
|
886
722
|
"customElement": true
|
|
887
723
|
}
|
|
888
724
|
],
|
|
@@ -891,16 +727,16 @@
|
|
|
891
727
|
"kind": "js",
|
|
892
728
|
"name": "default",
|
|
893
729
|
"declaration": {
|
|
894
|
-
"name": "
|
|
895
|
-
"module": "src/
|
|
730
|
+
"name": "Badge",
|
|
731
|
+
"module": "src/badge/Badge.ts"
|
|
896
732
|
}
|
|
897
733
|
},
|
|
898
734
|
{
|
|
899
735
|
"kind": "custom-element-definition",
|
|
900
|
-
"name": "nord-
|
|
736
|
+
"name": "nord-badge",
|
|
901
737
|
"declaration": {
|
|
902
|
-
"name": "
|
|
903
|
-
"module": "src/
|
|
738
|
+
"name": "Badge",
|
|
739
|
+
"module": "src/badge/Badge.ts"
|
|
904
740
|
}
|
|
905
741
|
}
|
|
906
742
|
]
|
|
@@ -973,6 +809,11 @@
|
|
|
973
809
|
"description": "Controls the minimum block size, or height, of the button using our [spacing tokens](/tokens/#space).",
|
|
974
810
|
"name": "--n-button-min-block-size",
|
|
975
811
|
"default": "var(--n-space-xl)"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"description": "Controls the color of toggle icon that gets rendered when the button is used as a [Dropdown](/components/dropdown/) toggle.",
|
|
815
|
+
"name": "--n-button-toggle-icon-color",
|
|
816
|
+
"default": "var(--n-color-icon)"
|
|
976
817
|
}
|
|
977
818
|
],
|
|
978
819
|
"slots": [
|
|
@@ -1017,10 +858,10 @@
|
|
|
1017
858
|
"kind": "field",
|
|
1018
859
|
"name": "variant",
|
|
1019
860
|
"type": {
|
|
1020
|
-
"text": "\"default\" | \"primary\" | \"dashed\" | \"plain\" | \"danger\"
|
|
861
|
+
"text": "\"default\" | \"primary\" | \"dashed\" | \"plain\" | \"danger\""
|
|
1021
862
|
},
|
|
1022
863
|
"default": "\"default\"",
|
|
1023
|
-
"description": "The style variant of the button
|
|
864
|
+
"description": "The style variant of the button.",
|
|
1024
865
|
"attribute": "variant",
|
|
1025
866
|
"reflects": true
|
|
1026
867
|
},
|
|
@@ -1226,6 +1067,7 @@
|
|
|
1226
1067
|
"kind": "field",
|
|
1227
1068
|
"name": "form",
|
|
1228
1069
|
"description": "Gets the form, if any, associated with the form element.",
|
|
1070
|
+
"readonly": true,
|
|
1229
1071
|
"inheritedFrom": {
|
|
1230
1072
|
"name": "InputMixin",
|
|
1231
1073
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -1282,10 +1124,10 @@
|
|
|
1282
1124
|
{
|
|
1283
1125
|
"name": "variant",
|
|
1284
1126
|
"type": {
|
|
1285
|
-
"text": "\"default\" | \"primary\" | \"dashed\" | \"plain\" | \"danger\"
|
|
1127
|
+
"text": "\"default\" | \"primary\" | \"dashed\" | \"plain\" | \"danger\""
|
|
1286
1128
|
},
|
|
1287
1129
|
"default": "\"default\"",
|
|
1288
|
-
"description": "The style variant of the button
|
|
1130
|
+
"description": "The style variant of the button.",
|
|
1289
1131
|
"fieldName": "variant"
|
|
1290
1132
|
},
|
|
1291
1133
|
{
|
|
@@ -1420,7 +1262,7 @@
|
|
|
1420
1262
|
"localization": [],
|
|
1421
1263
|
"status": "ready",
|
|
1422
1264
|
"category": "action",
|
|
1423
|
-
"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
|
|
1265
|
+
"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-width: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-width: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-width: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-width: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",
|
|
1424
1266
|
"examples": [],
|
|
1425
1267
|
"dependencies": [
|
|
1426
1268
|
"spinner"
|
|
@@ -1450,12 +1292,200 @@
|
|
|
1450
1292
|
},
|
|
1451
1293
|
{
|
|
1452
1294
|
"kind": "javascript-module",
|
|
1453
|
-
"path": "src/
|
|
1295
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
1454
1296
|
"declarations": [
|
|
1455
1297
|
{
|
|
1456
1298
|
"kind": "class",
|
|
1457
|
-
"description": "
|
|
1458
|
-
"name": "
|
|
1299
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
1300
|
+
"name": "ButtonGroup",
|
|
1301
|
+
"cssProperties": [
|
|
1302
|
+
{
|
|
1303
|
+
"description": "Controls the rounded corners of the button, using [border radius tokens](/tokens/#border-radius).",
|
|
1304
|
+
"name": "--n-button-group-border-radius",
|
|
1305
|
+
"default": "var(--n-border-radius-s)"
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1309
|
+
"name": "--n-button-group-box-shadow",
|
|
1310
|
+
"default": "var(--n-box-shadow)"
|
|
1311
|
+
}
|
|
1312
|
+
],
|
|
1313
|
+
"slots": [
|
|
1314
|
+
{
|
|
1315
|
+
"description": "The button group content",
|
|
1316
|
+
"name": ""
|
|
1317
|
+
}
|
|
1318
|
+
],
|
|
1319
|
+
"members": [
|
|
1320
|
+
{
|
|
1321
|
+
"kind": "field",
|
|
1322
|
+
"name": "direction",
|
|
1323
|
+
"type": {
|
|
1324
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1325
|
+
},
|
|
1326
|
+
"default": "\"horizontal\"",
|
|
1327
|
+
"description": "The direction of the button group.",
|
|
1328
|
+
"attribute": "direction",
|
|
1329
|
+
"reflects": true
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"kind": "field",
|
|
1333
|
+
"name": "role",
|
|
1334
|
+
"type": {
|
|
1335
|
+
"text": "string"
|
|
1336
|
+
},
|
|
1337
|
+
"default": "\"group\"",
|
|
1338
|
+
"description": "The appropriate role for the containing element.",
|
|
1339
|
+
"attribute": "role",
|
|
1340
|
+
"reflects": true
|
|
1341
|
+
}
|
|
1342
|
+
],
|
|
1343
|
+
"attributes": [
|
|
1344
|
+
{
|
|
1345
|
+
"name": "direction",
|
|
1346
|
+
"type": {
|
|
1347
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1348
|
+
},
|
|
1349
|
+
"default": "\"horizontal\"",
|
|
1350
|
+
"description": "The direction of the button group.",
|
|
1351
|
+
"fieldName": "direction"
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"name": "role",
|
|
1355
|
+
"type": {
|
|
1356
|
+
"text": "string"
|
|
1357
|
+
},
|
|
1358
|
+
"default": "\"group\"",
|
|
1359
|
+
"description": "The appropriate role for the containing element.",
|
|
1360
|
+
"fieldName": "role"
|
|
1361
|
+
}
|
|
1362
|
+
],
|
|
1363
|
+
"superclass": {
|
|
1364
|
+
"name": "LitElement",
|
|
1365
|
+
"package": "lit"
|
|
1366
|
+
},
|
|
1367
|
+
"localization": [],
|
|
1368
|
+
"status": "new",
|
|
1369
|
+
"category": "structure",
|
|
1370
|
+
"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",
|
|
1371
|
+
"examples": [],
|
|
1372
|
+
"dependencies": [],
|
|
1373
|
+
"tagName": "nord-button-group",
|
|
1374
|
+
"customElement": true
|
|
1375
|
+
}
|
|
1376
|
+
],
|
|
1377
|
+
"exports": [
|
|
1378
|
+
{
|
|
1379
|
+
"kind": "js",
|
|
1380
|
+
"name": "default",
|
|
1381
|
+
"declaration": {
|
|
1382
|
+
"name": "ButtonGroup",
|
|
1383
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1384
|
+
}
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
"kind": "custom-element-definition",
|
|
1388
|
+
"name": "nord-button-group",
|
|
1389
|
+
"declaration": {
|
|
1390
|
+
"name": "ButtonGroup",
|
|
1391
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1392
|
+
}
|
|
1393
|
+
}
|
|
1394
|
+
]
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"kind": "javascript-module",
|
|
1398
|
+
"path": "src/banner/Banner.ts",
|
|
1399
|
+
"declarations": [
|
|
1400
|
+
{
|
|
1401
|
+
"kind": "class",
|
|
1402
|
+
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
1403
|
+
"name": "Banner",
|
|
1404
|
+
"cssProperties": [
|
|
1405
|
+
{
|
|
1406
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1407
|
+
"name": "--n-banner-border-radius",
|
|
1408
|
+
"default": "var(--n-border-radius)"
|
|
1409
|
+
},
|
|
1410
|
+
{
|
|
1411
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1412
|
+
"name": "--n-banner-box-shadow",
|
|
1413
|
+
"default": "var(--n-box-shadow-card)"
|
|
1414
|
+
}
|
|
1415
|
+
],
|
|
1416
|
+
"slots": [
|
|
1417
|
+
{
|
|
1418
|
+
"description": "default slot",
|
|
1419
|
+
"name": ""
|
|
1420
|
+
}
|
|
1421
|
+
],
|
|
1422
|
+
"members": [
|
|
1423
|
+
{
|
|
1424
|
+
"kind": "field",
|
|
1425
|
+
"name": "variant",
|
|
1426
|
+
"type": {
|
|
1427
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1428
|
+
},
|
|
1429
|
+
"default": "\"info\"",
|
|
1430
|
+
"description": "The style variant of the banner.",
|
|
1431
|
+
"attribute": "variant",
|
|
1432
|
+
"reflects": true
|
|
1433
|
+
}
|
|
1434
|
+
],
|
|
1435
|
+
"attributes": [
|
|
1436
|
+
{
|
|
1437
|
+
"name": "variant",
|
|
1438
|
+
"type": {
|
|
1439
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1440
|
+
},
|
|
1441
|
+
"default": "\"info\"",
|
|
1442
|
+
"description": "The style variant of the banner.",
|
|
1443
|
+
"fieldName": "variant"
|
|
1444
|
+
}
|
|
1445
|
+
],
|
|
1446
|
+
"superclass": {
|
|
1447
|
+
"name": "LitElement",
|
|
1448
|
+
"package": "lit"
|
|
1449
|
+
},
|
|
1450
|
+
"localization": [],
|
|
1451
|
+
"status": "ready",
|
|
1452
|
+
"category": "feedback",
|
|
1453
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
1454
|
+
"examples": [],
|
|
1455
|
+
"dependencies": [
|
|
1456
|
+
"icon"
|
|
1457
|
+
],
|
|
1458
|
+
"tagName": "nord-banner",
|
|
1459
|
+
"customElement": true
|
|
1460
|
+
}
|
|
1461
|
+
],
|
|
1462
|
+
"exports": [
|
|
1463
|
+
{
|
|
1464
|
+
"kind": "js",
|
|
1465
|
+
"name": "default",
|
|
1466
|
+
"declaration": {
|
|
1467
|
+
"name": "Banner",
|
|
1468
|
+
"module": "src/banner/Banner.ts"
|
|
1469
|
+
}
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
"kind": "custom-element-definition",
|
|
1473
|
+
"name": "nord-banner",
|
|
1474
|
+
"declaration": {
|
|
1475
|
+
"name": "Banner",
|
|
1476
|
+
"module": "src/banner/Banner.ts"
|
|
1477
|
+
}
|
|
1478
|
+
}
|
|
1479
|
+
]
|
|
1480
|
+
},
|
|
1481
|
+
{
|
|
1482
|
+
"kind": "javascript-module",
|
|
1483
|
+
"path": "src/calendar/Calendar.ts",
|
|
1484
|
+
"declarations": [
|
|
1485
|
+
{
|
|
1486
|
+
"kind": "class",
|
|
1487
|
+
"description": "Calendar allows user to pick a date. It comes with built-in\nfunctionality that allows you to set a minimum and a maximum allowed date.\nPlease note that the date must be passed in ISO-8601 format.",
|
|
1488
|
+
"name": "Calendar",
|
|
1459
1489
|
"cssProperties": [
|
|
1460
1490
|
{
|
|
1461
1491
|
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
@@ -2101,6 +2131,7 @@
|
|
|
2101
2131
|
"kind": "field",
|
|
2102
2132
|
"name": "formValue",
|
|
2103
2133
|
"privacy": "protected",
|
|
2134
|
+
"readonly": true,
|
|
2104
2135
|
"inheritedFrom": {
|
|
2105
2136
|
"name": "FormAssociatedMixin",
|
|
2106
2137
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -2403,6 +2434,7 @@
|
|
|
2403
2434
|
"kind": "field",
|
|
2404
2435
|
"name": "hasHint",
|
|
2405
2436
|
"privacy": "protected",
|
|
2437
|
+
"readonly": true,
|
|
2406
2438
|
"inheritedFrom": {
|
|
2407
2439
|
"name": "FormAssociatedMixin",
|
|
2408
2440
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -2412,6 +2444,7 @@
|
|
|
2412
2444
|
"kind": "field",
|
|
2413
2445
|
"name": "hasError",
|
|
2414
2446
|
"privacy": "protected",
|
|
2447
|
+
"readonly": true,
|
|
2415
2448
|
"inheritedFrom": {
|
|
2416
2449
|
"name": "FormAssociatedMixin",
|
|
2417
2450
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -2463,6 +2496,7 @@
|
|
|
2463
2496
|
"kind": "field",
|
|
2464
2497
|
"name": "form",
|
|
2465
2498
|
"description": "Gets the form, if any, associated with the form element.",
|
|
2499
|
+
"readonly": true,
|
|
2466
2500
|
"inheritedFrom": {
|
|
2467
2501
|
"name": "InputMixin",
|
|
2468
2502
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -2829,16 +2863,6 @@
|
|
|
2829
2863
|
"description": "Show or hide the command menu.",
|
|
2830
2864
|
"attribute": "open"
|
|
2831
2865
|
},
|
|
2832
|
-
{
|
|
2833
|
-
"kind": "field",
|
|
2834
|
-
"name": "placeholder",
|
|
2835
|
-
"type": {
|
|
2836
|
-
"text": "string"
|
|
2837
|
-
},
|
|
2838
|
-
"default": "\"Type a command or search...\"",
|
|
2839
|
-
"description": "Hint text to display in the Command Menu search field.",
|
|
2840
|
-
"attribute": "placeholder"
|
|
2841
|
-
},
|
|
2842
2866
|
{
|
|
2843
2867
|
"kind": "field",
|
|
2844
2868
|
"name": "commands",
|
|
@@ -2898,7 +2922,8 @@
|
|
|
2898
2922
|
"type": {
|
|
2899
2923
|
"text": "ICommandMenuAction"
|
|
2900
2924
|
},
|
|
2901
|
-
"privacy": "private"
|
|
2925
|
+
"privacy": "private",
|
|
2926
|
+
"readonly": true
|
|
2902
2927
|
},
|
|
2903
2928
|
{
|
|
2904
2929
|
"kind": "method",
|
|
@@ -3096,15 +3121,6 @@
|
|
|
3096
3121
|
"default": "false",
|
|
3097
3122
|
"description": "Show or hide the command menu.",
|
|
3098
3123
|
"fieldName": "open"
|
|
3099
|
-
},
|
|
3100
|
-
{
|
|
3101
|
-
"name": "placeholder",
|
|
3102
|
-
"type": {
|
|
3103
|
-
"text": "string"
|
|
3104
|
-
},
|
|
3105
|
-
"default": "\"Type a command or search...\"",
|
|
3106
|
-
"description": "Hint text to display in the Command Menu search field.",
|
|
3107
|
-
"fieldName": "placeholder"
|
|
3108
3124
|
}
|
|
3109
3125
|
],
|
|
3110
3126
|
"superclass": {
|
|
@@ -3143,6 +3159,10 @@
|
|
|
3143
3159
|
{
|
|
3144
3160
|
"name": "tip",
|
|
3145
3161
|
"description": "A hint tip that describes some approaches to find a command when there are no matching results."
|
|
3162
|
+
},
|
|
3163
|
+
{
|
|
3164
|
+
"name": "placeholder",
|
|
3165
|
+
"description": "Hint text to display in the Command Menu search field."
|
|
3146
3166
|
}
|
|
3147
3167
|
],
|
|
3148
3168
|
"status": "ready",
|
|
@@ -3383,7 +3403,7 @@
|
|
|
3383
3403
|
"type": {
|
|
3384
3404
|
"text": "object"
|
|
3385
3405
|
},
|
|
3386
|
-
"default": "{\n instructions: \"Press 'Enter' to confirm your input or 'Escape' to cancel\",\n inputLabel: \"Type the name of a command to run.\",\n footerArrowKeys: \"Navigate\",\n footerEnterKey: \"Select\",\n footerEscapeKey: \"Esc to dismiss\",\n footerBackspaceKey: \"Move to parent\",\n noResults: (searchTerm: string) => `No results for “${searchTerm}”`,\n tip: \"Search tips: some search terms require an exact match. Try typing the entire command name, or use a different word or phrase.\",\n}"
|
|
3406
|
+
"default": "{\n instructions: \"Press 'Enter' to confirm your input or 'Escape' to cancel\",\n inputLabel: \"Type the name of a command to run.\",\n footerArrowKeys: \"Navigate\",\n footerEnterKey: \"Select\",\n footerEscapeKey: \"Esc to dismiss\",\n footerBackspaceKey: \"Move to parent\",\n noResults: (searchTerm: string) => `No results for “${searchTerm}”`,\n tip: \"Search tips: some search terms require an exact match. Try typing the entire command name, or use a different word or phrase.\",\n placeholder: \"Type a command or search…\",\n}"
|
|
3387
3407
|
}
|
|
3388
3408
|
],
|
|
3389
3409
|
"exports": [
|
|
@@ -4854,17 +4874,6 @@
|
|
|
4854
4874
|
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
4855
4875
|
"attribute": "max"
|
|
4856
4876
|
},
|
|
4857
|
-
{
|
|
4858
|
-
"kind": "field",
|
|
4859
|
-
"name": "direction",
|
|
4860
|
-
"type": {
|
|
4861
|
-
"text": "\"left\" | \"right\""
|
|
4862
|
-
},
|
|
4863
|
-
"default": "\"right\"",
|
|
4864
|
-
"description": "This is deprecated, the popout will now adjust automatically based on available space.\nForces the opening direction of the calendar modal to be always left or right.",
|
|
4865
|
-
"deprecated": "true",
|
|
4866
|
-
"attribute": "direction"
|
|
4867
|
-
},
|
|
4868
4877
|
{
|
|
4869
4878
|
"kind": "field",
|
|
4870
4879
|
"name": "firstDayOfWeek",
|
|
@@ -5050,6 +5059,7 @@
|
|
|
5050
5059
|
"kind": "field",
|
|
5051
5060
|
"name": "formValue",
|
|
5052
5061
|
"privacy": "protected",
|
|
5062
|
+
"readonly": true,
|
|
5053
5063
|
"inheritedFrom": {
|
|
5054
5064
|
"name": "FormAssociatedMixin",
|
|
5055
5065
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -5272,6 +5282,7 @@
|
|
|
5272
5282
|
"kind": "field",
|
|
5273
5283
|
"name": "hasHint",
|
|
5274
5284
|
"privacy": "protected",
|
|
5285
|
+
"readonly": true,
|
|
5275
5286
|
"inheritedFrom": {
|
|
5276
5287
|
"name": "FormAssociatedMixin",
|
|
5277
5288
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -5281,6 +5292,7 @@
|
|
|
5281
5292
|
"kind": "field",
|
|
5282
5293
|
"name": "hasError",
|
|
5283
5294
|
"privacy": "protected",
|
|
5295
|
+
"readonly": true,
|
|
5284
5296
|
"inheritedFrom": {
|
|
5285
5297
|
"name": "FormAssociatedMixin",
|
|
5286
5298
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -5333,6 +5345,7 @@
|
|
|
5333
5345
|
"kind": "field",
|
|
5334
5346
|
"name": "form",
|
|
5335
5347
|
"description": "Gets the form, if any, associated with the form element.",
|
|
5348
|
+
"readonly": true,
|
|
5336
5349
|
"inheritedFrom": {
|
|
5337
5350
|
"name": "InputMixin",
|
|
5338
5351
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -5450,16 +5463,6 @@
|
|
|
5450
5463
|
"description": "Maximum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the min property.",
|
|
5451
5464
|
"fieldName": "max"
|
|
5452
5465
|
},
|
|
5453
|
-
{
|
|
5454
|
-
"name": "direction",
|
|
5455
|
-
"type": {
|
|
5456
|
-
"text": "\"left\" | \"right\""
|
|
5457
|
-
},
|
|
5458
|
-
"default": "\"right\"",
|
|
5459
|
-
"description": "This is deprecated, the popout will now adjust automatically based on available space.\nForces the opening direction of the calendar modal to be always left or right.",
|
|
5460
|
-
"deprecated": "true",
|
|
5461
|
-
"fieldName": "direction"
|
|
5462
|
-
},
|
|
5463
5466
|
{
|
|
5464
5467
|
"name": "first-day-of-week",
|
|
5465
5468
|
"type": {
|
|
@@ -5873,20 +5876,6 @@
|
|
|
5873
5876
|
"description": "Controls the padding of the drawer component.",
|
|
5874
5877
|
"attribute": "padding",
|
|
5875
5878
|
"reflects": true
|
|
5876
|
-
},
|
|
5877
|
-
{
|
|
5878
|
-
"kind": "field",
|
|
5879
|
-
"name": "_warningLogged",
|
|
5880
|
-
"type": {
|
|
5881
|
-
"text": "boolean"
|
|
5882
|
-
},
|
|
5883
|
-
"privacy": "private",
|
|
5884
|
-
"static": true,
|
|
5885
|
-
"default": "false",
|
|
5886
|
-
"inheritedFrom": {
|
|
5887
|
-
"name": "DraftComponentMixin",
|
|
5888
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
5889
|
-
}
|
|
5890
5879
|
}
|
|
5891
5880
|
],
|
|
5892
5881
|
"attributes": [
|
|
@@ -5900,18 +5889,12 @@
|
|
|
5900
5889
|
"fieldName": "padding"
|
|
5901
5890
|
}
|
|
5902
5891
|
],
|
|
5903
|
-
"mixins": [
|
|
5904
|
-
{
|
|
5905
|
-
"name": "DraftComponentMixin",
|
|
5906
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
5907
|
-
}
|
|
5908
|
-
],
|
|
5909
5892
|
"superclass": {
|
|
5910
5893
|
"name": "LitElement",
|
|
5911
5894
|
"package": "lit"
|
|
5912
5895
|
},
|
|
5913
5896
|
"localization": [],
|
|
5914
|
-
"status": "
|
|
5897
|
+
"status": "new",
|
|
5915
5898
|
"category": "structure",
|
|
5916
5899
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for displaying contextual actions or information. For example, when clicking on a table row.\n- Use when you don’t want to block users from completing their task in the main view of an application.\n- Always include a header that summarizes the actions and information in the drawer.\n- Should be closeable through actions like “Done” and “Close”.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t put cards inside the drawer. Consider using the [divider](/components/divider/) component to break up sections instead.\n- Don’t reset the drawer’s state when closed if used for settings or filters. Settings should persist.\n- Don’t open from within another drawer. Only one drawer can be open at a time.\n- Don’t use for presenting a small amount of content or an actions menu, use the [popout](/components/popout/) or [dropdown](/components/dropdown/) component instead.\n\n</div>\n\n---\n\n## Additional considerations\n\n- You can customize the width of the component using `--n-layout-drawer-inline-size` CSS Custom Property that is offered on [Layout component](/components/layout/).\n",
|
|
5917
5900
|
"examples": [],
|
|
@@ -5962,18 +5945,46 @@
|
|
|
5962
5945
|
{
|
|
5963
5946
|
"description": "Used to place the toggle for dropdown.",
|
|
5964
5947
|
"name": "toggle"
|
|
5948
|
+
},
|
|
5949
|
+
{
|
|
5950
|
+
"description": "Optional slot that holds a header for the dropdown.",
|
|
5951
|
+
"name": "header"
|
|
5952
|
+
},
|
|
5953
|
+
{
|
|
5954
|
+
"description": "Optional slot that positions content at the end of the header. Useful for actions or additional info.",
|
|
5955
|
+
"name": "header-end"
|
|
5965
5956
|
}
|
|
5966
5957
|
],
|
|
5967
5958
|
"members": [
|
|
5968
5959
|
{
|
|
5969
5960
|
"kind": "field",
|
|
5970
|
-
"name": "
|
|
5971
|
-
"
|
|
5972
|
-
|
|
5973
|
-
|
|
5974
|
-
|
|
5975
|
-
|
|
5976
|
-
|
|
5961
|
+
"name": "headerSlot",
|
|
5962
|
+
"privacy": "private",
|
|
5963
|
+
"default": "new SlotController(this, \"header\")"
|
|
5964
|
+
},
|
|
5965
|
+
{
|
|
5966
|
+
"kind": "field",
|
|
5967
|
+
"name": "headerEndSlot",
|
|
5968
|
+
"privacy": "private",
|
|
5969
|
+
"default": "new SlotController(this, \"header-end\")"
|
|
5970
|
+
},
|
|
5971
|
+
{
|
|
5972
|
+
"kind": "field",
|
|
5973
|
+
"name": "list",
|
|
5974
|
+
"type": {
|
|
5975
|
+
"text": "HTMLElement"
|
|
5976
|
+
},
|
|
5977
|
+
"privacy": "private"
|
|
5978
|
+
},
|
|
5979
|
+
{
|
|
5980
|
+
"kind": "field",
|
|
5981
|
+
"name": "popout",
|
|
5982
|
+
"type": {
|
|
5983
|
+
"text": "Popout"
|
|
5984
|
+
},
|
|
5985
|
+
"privacy": "private"
|
|
5986
|
+
},
|
|
5987
|
+
{
|
|
5977
5988
|
"kind": "field",
|
|
5978
5989
|
"name": "expand",
|
|
5979
5990
|
"type": {
|
|
@@ -6018,6 +6029,11 @@
|
|
|
6018
6029
|
"name": "handleClose",
|
|
6019
6030
|
"privacy": "private"
|
|
6020
6031
|
},
|
|
6032
|
+
{
|
|
6033
|
+
"kind": "method",
|
|
6034
|
+
"name": "handleOpenChange",
|
|
6035
|
+
"privacy": "protected"
|
|
6036
|
+
},
|
|
6021
6037
|
{
|
|
6022
6038
|
"kind": "method",
|
|
6023
6039
|
"name": "hide",
|
|
@@ -6525,12 +6541,14 @@
|
|
|
6525
6541
|
{
|
|
6526
6542
|
"kind": "field",
|
|
6527
6543
|
"name": "hasHint",
|
|
6528
|
-
"privacy": "protected"
|
|
6544
|
+
"privacy": "protected",
|
|
6545
|
+
"readonly": true
|
|
6529
6546
|
},
|
|
6530
6547
|
{
|
|
6531
6548
|
"kind": "field",
|
|
6532
6549
|
"name": "hasError",
|
|
6533
|
-
"privacy": "protected"
|
|
6550
|
+
"privacy": "protected",
|
|
6551
|
+
"readonly": true
|
|
6534
6552
|
}
|
|
6535
6553
|
],
|
|
6536
6554
|
"attributes": [
|
|
@@ -7066,14 +7084,30 @@
|
|
|
7066
7084
|
{
|
|
7067
7085
|
"kind": "field",
|
|
7068
7086
|
"name": "startSlot",
|
|
7069
|
-
"
|
|
7070
|
-
|
|
7087
|
+
"type": {
|
|
7088
|
+
"text": "HTMLSlotElement"
|
|
7089
|
+
},
|
|
7090
|
+
"privacy": "private"
|
|
7071
7091
|
},
|
|
7072
7092
|
{
|
|
7073
7093
|
"kind": "field",
|
|
7074
7094
|
"name": "endSlot",
|
|
7095
|
+
"type": {
|
|
7096
|
+
"text": "HTMLSlotElement"
|
|
7097
|
+
},
|
|
7098
|
+
"privacy": "private"
|
|
7099
|
+
},
|
|
7100
|
+
{
|
|
7101
|
+
"kind": "field",
|
|
7102
|
+
"name": "startObserver",
|
|
7075
7103
|
"privacy": "private",
|
|
7076
|
-
"default": "new
|
|
7104
|
+
"default": "new ResizeController(this, () => this.startSlot)"
|
|
7105
|
+
},
|
|
7106
|
+
{
|
|
7107
|
+
"kind": "field",
|
|
7108
|
+
"name": "endObserver",
|
|
7109
|
+
"privacy": "private",
|
|
7110
|
+
"default": "new ResizeController(this, () => this.endSlot)"
|
|
7077
7111
|
},
|
|
7078
7112
|
{
|
|
7079
7113
|
"kind": "field",
|
|
@@ -7191,6 +7225,7 @@
|
|
|
7191
7225
|
"kind": "field",
|
|
7192
7226
|
"name": "formValue",
|
|
7193
7227
|
"privacy": "protected",
|
|
7228
|
+
"readonly": true,
|
|
7194
7229
|
"inheritedFrom": {
|
|
7195
7230
|
"name": "FormAssociatedMixin",
|
|
7196
7231
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -7413,6 +7448,7 @@
|
|
|
7413
7448
|
"kind": "field",
|
|
7414
7449
|
"name": "hasHint",
|
|
7415
7450
|
"privacy": "protected",
|
|
7451
|
+
"readonly": true,
|
|
7416
7452
|
"inheritedFrom": {
|
|
7417
7453
|
"name": "FormAssociatedMixin",
|
|
7418
7454
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -7422,6 +7458,7 @@
|
|
|
7422
7458
|
"kind": "field",
|
|
7423
7459
|
"name": "hasError",
|
|
7424
7460
|
"privacy": "protected",
|
|
7461
|
+
"readonly": true,
|
|
7425
7462
|
"inheritedFrom": {
|
|
7426
7463
|
"name": "FormAssociatedMixin",
|
|
7427
7464
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -7502,6 +7539,7 @@
|
|
|
7502
7539
|
"kind": "field",
|
|
7503
7540
|
"name": "form",
|
|
7504
7541
|
"description": "Gets the form, if any, associated with the form element.",
|
|
7542
|
+
"readonly": true,
|
|
7505
7543
|
"inheritedFrom": {
|
|
7506
7544
|
"name": "InputMixin",
|
|
7507
7545
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -7870,6 +7908,10 @@
|
|
|
7870
7908
|
"description": "Used to place content inside the navigation sidebar.",
|
|
7871
7909
|
"name": "nav"
|
|
7872
7910
|
},
|
|
7911
|
+
{
|
|
7912
|
+
"description": "Used to place the [Top Bar](../top-bar/) component.",
|
|
7913
|
+
"name": "top-bar"
|
|
7914
|
+
},
|
|
7873
7915
|
{
|
|
7874
7916
|
"description": "Used to place content inside the header section.",
|
|
7875
7917
|
"name": "header"
|
|
@@ -7892,12 +7934,6 @@
|
|
|
7892
7934
|
},
|
|
7893
7935
|
"privacy": "private"
|
|
7894
7936
|
},
|
|
7895
|
-
{
|
|
7896
|
-
"kind": "field",
|
|
7897
|
-
"name": "resizeObserver",
|
|
7898
|
-
"privacy": "private",
|
|
7899
|
-
"default": "new ResizeObserver(entries => {\n this.headerSize = Math.round(entries[0].borderBoxSize[0].blockSize)\n })"
|
|
7900
|
-
},
|
|
7901
7937
|
{
|
|
7902
7938
|
"kind": "field",
|
|
7903
7939
|
"name": "navSlot",
|
|
@@ -7910,6 +7946,18 @@
|
|
|
7910
7946
|
"privacy": "private",
|
|
7911
7947
|
"default": "new SlotController(this, \"drawer\")"
|
|
7912
7948
|
},
|
|
7949
|
+
{
|
|
7950
|
+
"kind": "field",
|
|
7951
|
+
"name": "topBarSlot",
|
|
7952
|
+
"privacy": "private",
|
|
7953
|
+
"default": "new SlotController(this, \"top-bar\")"
|
|
7954
|
+
},
|
|
7955
|
+
{
|
|
7956
|
+
"kind": "field",
|
|
7957
|
+
"name": "headerSlot",
|
|
7958
|
+
"privacy": "private",
|
|
7959
|
+
"default": "new SlotController(this, \"header\")"
|
|
7960
|
+
},
|
|
7913
7961
|
{
|
|
7914
7962
|
"kind": "field",
|
|
7915
7963
|
"name": "direction",
|
|
@@ -7928,14 +7976,6 @@
|
|
|
7928
7976
|
"privacy": "private",
|
|
7929
7977
|
"default": "new LightDismissController(this, {\n isOpen: () => this.navState === \"opened\" && !this.wideScreen,\n onDismiss: () => this.navTransition(\"close\"),\n isDismissible: node => node !== this.navEl,\n })"
|
|
7930
7978
|
},
|
|
7931
|
-
{
|
|
7932
|
-
"kind": "field",
|
|
7933
|
-
"name": "stickyElement",
|
|
7934
|
-
"type": {
|
|
7935
|
-
"text": "HTMLDivElement"
|
|
7936
|
-
},
|
|
7937
|
-
"privacy": "private"
|
|
7938
|
-
},
|
|
7939
7979
|
{
|
|
7940
7980
|
"kind": "field",
|
|
7941
7981
|
"name": "navEl",
|
|
@@ -7971,15 +8011,6 @@
|
|
|
7971
8011
|
"name": "wideScreen",
|
|
7972
8012
|
"privacy": "private"
|
|
7973
8013
|
},
|
|
7974
|
-
{
|
|
7975
|
-
"kind": "field",
|
|
7976
|
-
"name": "headerSize",
|
|
7977
|
-
"type": {
|
|
7978
|
-
"text": "number"
|
|
7979
|
-
},
|
|
7980
|
-
"privacy": "private",
|
|
7981
|
-
"default": "0"
|
|
7982
|
-
},
|
|
7983
8014
|
{
|
|
7984
8015
|
"kind": "field",
|
|
7985
8016
|
"name": "navOpen",
|
|
@@ -7990,16 +8021,6 @@
|
|
|
7990
8021
|
"attribute": "nav-open",
|
|
7991
8022
|
"reflects": true
|
|
7992
8023
|
},
|
|
7993
|
-
{
|
|
7994
|
-
"kind": "field",
|
|
7995
|
-
"name": "navToggle",
|
|
7996
|
-
"type": {
|
|
7997
|
-
"text": "string | undefined"
|
|
7998
|
-
},
|
|
7999
|
-
"description": "ID reference of element used to toggle the navigation.\nThis is deprecated, the layout component will now render its own nav toggle to simplify usage.",
|
|
8000
|
-
"deprecated": "true",
|
|
8001
|
-
"attribute": "nav-toggle"
|
|
8002
|
-
},
|
|
8003
8024
|
{
|
|
8004
8025
|
"kind": "field",
|
|
8005
8026
|
"name": "padding",
|
|
@@ -8028,13 +8049,19 @@
|
|
|
8028
8049
|
"type": {
|
|
8029
8050
|
"text": "boolean"
|
|
8030
8051
|
},
|
|
8031
|
-
"description": "A getter whose values reflects whether the layout component considers the viewport to be narrow or not.\nA narrow viewport is considered to be less than 768px wide."
|
|
8052
|
+
"description": "A getter whose values reflects whether the layout component considers the viewport to be narrow or not.\nA narrow viewport is considered to be less than 768px wide.",
|
|
8053
|
+
"readonly": true
|
|
8032
8054
|
},
|
|
8033
8055
|
{
|
|
8034
8056
|
"kind": "method",
|
|
8035
8057
|
"name": "renderNavToggle",
|
|
8036
8058
|
"privacy": "private"
|
|
8037
8059
|
},
|
|
8060
|
+
{
|
|
8061
|
+
"kind": "method",
|
|
8062
|
+
"name": "renderNavCollapse",
|
|
8063
|
+
"privacy": "private"
|
|
8064
|
+
},
|
|
8038
8065
|
{
|
|
8039
8066
|
"kind": "method",
|
|
8040
8067
|
"name": "handleNavWidthChange",
|
|
@@ -8150,19 +8177,6 @@
|
|
|
8150
8177
|
"name": "handleTransitionEnd",
|
|
8151
8178
|
"privacy": "private"
|
|
8152
8179
|
},
|
|
8153
|
-
{
|
|
8154
|
-
"kind": "method",
|
|
8155
|
-
"name": "isNavToggle",
|
|
8156
|
-
"privacy": "private",
|
|
8157
|
-
"parameters": [
|
|
8158
|
-
{
|
|
8159
|
-
"name": "node",
|
|
8160
|
-
"type": {
|
|
8161
|
-
"text": "EventTarget | null"
|
|
8162
|
-
}
|
|
8163
|
-
}
|
|
8164
|
-
]
|
|
8165
|
-
},
|
|
8166
8180
|
{
|
|
8167
8181
|
"kind": "method",
|
|
8168
8182
|
"name": "handleKeyboardResize",
|
|
@@ -8230,15 +8244,6 @@
|
|
|
8230
8244
|
"description": "Controls whether the navigation is hidden off-screen or not.\nDefaults to `true` for wide viewports, and `false` otherwise.",
|
|
8231
8245
|
"fieldName": "navOpen"
|
|
8232
8246
|
},
|
|
8233
|
-
{
|
|
8234
|
-
"name": "nav-toggle",
|
|
8235
|
-
"type": {
|
|
8236
|
-
"text": "string | undefined"
|
|
8237
|
-
},
|
|
8238
|
-
"description": "ID reference of element used to toggle the navigation.\nThis is deprecated, the layout component will now render its own nav toggle to simplify usage.",
|
|
8239
|
-
"deprecated": "true",
|
|
8240
|
-
"fieldName": "navToggle"
|
|
8241
|
-
},
|
|
8242
8247
|
{
|
|
8243
8248
|
"name": "padding",
|
|
8244
8249
|
"type": {
|
|
@@ -8265,9 +8270,10 @@
|
|
|
8265
8270
|
"localization": [],
|
|
8266
8271
|
"status": "ready",
|
|
8267
8272
|
"category": "structure",
|
|
8268
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- To visually group content in a layout section, use the Card component.\n- To lay out a set of smaller components, use the Stack component.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Never put layout component inside another HTML landmark.\n- Don’t use when you need a vertical or horizontal layout system. Use Stack component instead.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Layout component uses `<main>` element internally which is an HTML sectioning element which by default defines an ARIA landmark role. For that reason you should never put layout component inside another HTML landmark.\n",
|
|
8273
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- To visually group content in a layout section, use the Card component.\n- To lay out a set of smaller components, use the Stack component.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Never put layout component inside another HTML landmark.\n- Don’t use when you need a vertical or horizontal layout system. Use Stack component instead.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Layout component uses `<main>` element internally which is an HTML sectioning element which by default defines an ARIA landmark role. For that reason you should never put layout component inside another HTML landmark.\n\n---\n\n## Theming\n\nPlease see the [Accent color](/themes/#accent-color) and [Top Bar theming](/themes/#top-bar-theming) sections in our theming documentation for detailed guidelines.\n\n<nord-button variant=\"primary\" href=\"/themes/#accent-color\">Theming Guidelines</nord-button>\n",
|
|
8269
8274
|
"examples": [],
|
|
8270
8275
|
"dependencies": [
|
|
8276
|
+
"icon",
|
|
8271
8277
|
"nav-toggle"
|
|
8272
8278
|
],
|
|
8273
8279
|
"tagName": "nord-layout",
|
|
@@ -8321,12 +8327,14 @@
|
|
|
8321
8327
|
{
|
|
8322
8328
|
"kind": "field",
|
|
8323
8329
|
"name": "lang",
|
|
8324
|
-
"description": "The lang of the document or element, with element taking precedence"
|
|
8330
|
+
"description": "The lang of the document or element, with element taking precedence",
|
|
8331
|
+
"readonly": true
|
|
8325
8332
|
},
|
|
8326
8333
|
{
|
|
8327
8334
|
"kind": "field",
|
|
8328
8335
|
"name": "resolvedLang",
|
|
8329
|
-
"description": "The lang of the translation being applied.\nThis may not match the document/element lang, in case of fallback translation"
|
|
8336
|
+
"description": "The lang of the translation being applied.\nThis may not match the document/element lang, in case of fallback translation",
|
|
8337
|
+
"readonly": true
|
|
8330
8338
|
},
|
|
8331
8339
|
{
|
|
8332
8340
|
"kind": "method",
|
|
@@ -8388,7 +8396,7 @@
|
|
|
8388
8396
|
"type": {
|
|
8389
8397
|
"text": "object"
|
|
8390
8398
|
},
|
|
8391
|
-
"default": "{\n $lang: \"en-US\",\n $name: \"English\",\n $dir: \"ltr\" as \"ltr\" | \"rtl\",\n \"nord-command-menu\": commandMenuLocalization,\n \"nord-calendar\": calendarLocalization,\n \"nord-date-picker\": datePickerLocalization,\n \"nord-modal\": modalLocalization,\n \"nord-nav-toggle\": navToggleLocalization,\n \"nord-textarea\": textareaLocalization,\n \"nord-notification\": notificationLocalization,\n}"
|
|
8399
|
+
"default": "{\n $lang: \"en-US\",\n $name: \"English\",\n $dir: \"ltr\" as \"ltr\" | \"rtl\",\n \"nord-command-menu\": commandMenuLocalization,\n \"nord-calendar\": calendarLocalization,\n \"nord-date-picker\": datePickerLocalization,\n \"nord-modal\": modalLocalization,\n \"nord-nav-toggle\": navToggleLocalization,\n \"nord-textarea\": textareaLocalization,\n \"nord-notification\": notificationLocalization,\n \"nord-message\": messageLocalization,\n}"
|
|
8392
8400
|
}
|
|
8393
8401
|
],
|
|
8394
8402
|
"exports": [
|
|
@@ -8412,7 +8420,7 @@
|
|
|
8412
8420
|
"type": {
|
|
8413
8421
|
"text": "Translation"
|
|
8414
8422
|
},
|
|
8415
|
-
"default": "{\n $lang: \"fi\",\n $name: \"Suomi\",\n $dir: \"ltr\",\n\n \"nord-command-menu\": {\n instructions: \"Paina 'Enter' vahvistaaksesi valinnan tai 'Escape' peruuttaaksesi\",\n inputLabel: \"Kirjoita komento jonka haluat suorittaa.\",\n footerArrowKeys: \"Siirry\",\n footerEnterKey: \"Valitse\",\n footerEscapeKey: \"Esc sulje\",\n footerBackspaceKey: \"Siirry takaisin\",\n noResults: searchTerm => `Ei tuloksia haulle \"${searchTerm}\"`,\n tip: \"Vinkki: jotkin haut vaativat tarkan hakutermin. Koita kirjoittaa koko hakutermi kokonaisuudessaan, tai kokeile toista sanaa tai fraasia.\",\n },\n\n \"nord-calendar\": {\n prevMonthLabel: \"Edellinen kuukausi\",\n nextMonthLabel: \"Seuraava kuukausi\",\n monthSelectLabel: \"Kuukausi\",\n yearSelectLabel: \"Vuosi\",\n },\n\n \"nord-date-picker\": {\n modalHeading: \"Valitse päivämäärä\",\n closeLabel: \"Sulje ikkuna\",\n buttonLabel: \"Valitse päivämäärä\",\n selectedDateMessage: \"Valittu päivämäärä on\",\n },\n\n \"nord-modal\": {\n closeLabel: \"Sulje ikkuna\",\n },\n\n \"nord-nav-toggle\": {\n label: \"Näytä/Piilota valikko\",\n },\n\n \"nord-textarea\": {\n remainingCharacters: (remaining: number) => `${remaining} merkkiä jäljellä`,\n },\n\n \"nord-notification\": {\n dismissLabel: \"Sulje ilmoitus\",\n },\n}"
|
|
8423
|
+
"default": "{\n $lang: \"fi\",\n $name: \"Suomi\",\n $dir: \"ltr\",\n\n \"nord-command-menu\": {\n instructions: \"Paina 'Enter' vahvistaaksesi valinnan tai 'Escape' peruuttaaksesi\",\n inputLabel: \"Kirjoita komento jonka haluat suorittaa.\",\n footerArrowKeys: \"Siirry\",\n footerEnterKey: \"Valitse\",\n footerEscapeKey: \"Esc sulje\",\n footerBackspaceKey: \"Siirry takaisin\",\n noResults: searchTerm => `Ei tuloksia haulle \"${searchTerm}\"`,\n tip: \"Vinkki: jotkin haut vaativat tarkan hakutermin. Koita kirjoittaa koko hakutermi kokonaisuudessaan, tai kokeile toista sanaa tai fraasia.\",\n placeholder: \"Kirjoita komento tai hakusana…\",\n },\n\n \"nord-calendar\": {\n prevMonthLabel: \"Edellinen kuukausi\",\n nextMonthLabel: \"Seuraava kuukausi\",\n monthSelectLabel: \"Kuukausi\",\n yearSelectLabel: \"Vuosi\",\n },\n\n \"nord-date-picker\": {\n modalHeading: \"Valitse päivämäärä\",\n closeLabel: \"Sulje ikkuna\",\n buttonLabel: \"Valitse päivämäärä\",\n selectedDateMessage: \"Valittu päivämäärä on\",\n },\n\n \"nord-modal\": {\n closeLabel: \"Sulje ikkuna\",\n },\n\n \"nord-nav-toggle\": {\n label: \"Näytä/Piilota valikko\",\n },\n\n \"nord-textarea\": {\n remainingCharacters: (remaining: number) => `${remaining} merkkiä jäljellä`,\n },\n\n \"nord-notification\": {\n dismissLabel: \"Sulje ilmoitus\",\n },\n\n \"nord-message\": {\n unreadLabel: \"Lukematon\",\n },\n}"
|
|
8416
8424
|
}
|
|
8417
8425
|
],
|
|
8418
8426
|
"exports": [
|
|
@@ -8548,151 +8556,74 @@
|
|
|
8548
8556
|
},
|
|
8549
8557
|
{
|
|
8550
8558
|
"kind": "javascript-module",
|
|
8551
|
-
"path": "src/
|
|
8559
|
+
"path": "src/message/Message.ts",
|
|
8552
8560
|
"declarations": [
|
|
8553
8561
|
{
|
|
8554
8562
|
"kind": "class",
|
|
8555
|
-
"description": "
|
|
8556
|
-
"name": "
|
|
8563
|
+
"description": "Message represents a specific item within a collection,\nsuch as notifications, tasks or conversations. Message\ncan be placed directly inside a dropdown component.",
|
|
8564
|
+
"name": "Message",
|
|
8557
8565
|
"cssProperties": [
|
|
8558
8566
|
{
|
|
8559
|
-
"description": "Controls the
|
|
8560
|
-
"name": "--n-
|
|
8561
|
-
"default": "var(--n-
|
|
8562
|
-
},
|
|
8563
|
-
{
|
|
8564
|
-
"description": "Controls the padding above and below the modal, using our [spacing tokens](/tokens/#space).",
|
|
8565
|
-
"name": "--n-modal-padding-block",
|
|
8566
|
-
"default": "var(--n-space-m)"
|
|
8567
|
-
},
|
|
8568
|
-
{
|
|
8569
|
-
"description": "Controls the width of the modal.",
|
|
8570
|
-
"name": "--n-modal-max-inline-size",
|
|
8571
|
-
"default": "620px"
|
|
8567
|
+
"description": "Controls the border color of the message, using our [color tokens](/tokens/#color).",
|
|
8568
|
+
"name": "--n-message-border-color",
|
|
8569
|
+
"default": "var(--n-color-border)"
|
|
8572
8570
|
}
|
|
8573
8571
|
],
|
|
8574
8572
|
"slots": [
|
|
8575
8573
|
{
|
|
8576
|
-
"description": "
|
|
8574
|
+
"description": "The message content.",
|
|
8577
8575
|
"name": ""
|
|
8578
8576
|
},
|
|
8579
8577
|
{
|
|
8580
|
-
"description": "
|
|
8581
|
-
"name": "header"
|
|
8582
|
-
},
|
|
8583
|
-
{
|
|
8584
|
-
"description": "Slot which is typically used to hold call to action buttons, but can also be used to build custom footers.",
|
|
8578
|
+
"description": "Used to place content after the message. Typically used for a timestamp.",
|
|
8585
8579
|
"name": "footer"
|
|
8586
8580
|
}
|
|
8587
8581
|
],
|
|
8588
8582
|
"members": [
|
|
8589
|
-
{
|
|
8590
|
-
"kind": "field",
|
|
8591
|
-
"name": "modal",
|
|
8592
|
-
"type": {
|
|
8593
|
-
"text": "HTMLDivElement"
|
|
8594
|
-
},
|
|
8595
|
-
"privacy": "private"
|
|
8596
|
-
},
|
|
8597
|
-
{
|
|
8598
|
-
"kind": "field",
|
|
8599
|
-
"name": "backdrop",
|
|
8600
|
-
"type": {
|
|
8601
|
-
"text": "HTMLDivElement"
|
|
8602
|
-
},
|
|
8603
|
-
"privacy": "private"
|
|
8604
|
-
},
|
|
8605
|
-
{
|
|
8606
|
-
"kind": "field",
|
|
8607
|
-
"name": "headerSlot",
|
|
8608
|
-
"privacy": "private",
|
|
8609
|
-
"default": "new SlotController(this, \"header\")"
|
|
8610
|
-
},
|
|
8611
|
-
{
|
|
8612
|
-
"kind": "field",
|
|
8613
|
-
"name": "featureSlot",
|
|
8614
|
-
"privacy": "private",
|
|
8615
|
-
"default": "new SlotController(this, \"feature\")"
|
|
8616
|
-
},
|
|
8617
|
-
{
|
|
8618
|
-
"kind": "field",
|
|
8619
|
-
"name": "footerSlot",
|
|
8620
|
-
"privacy": "private",
|
|
8621
|
-
"default": "new SlotController(this, \"footer\")"
|
|
8622
|
-
},
|
|
8623
8583
|
{
|
|
8624
8584
|
"kind": "field",
|
|
8625
8585
|
"name": "localize",
|
|
8626
8586
|
"privacy": "private",
|
|
8627
|
-
"default": "new LocalizeController<\"nord-
|
|
8628
|
-
},
|
|
8629
|
-
{
|
|
8630
|
-
"kind": "field",
|
|
8631
|
-
"name": "modalController",
|
|
8632
|
-
"privacy": "private",
|
|
8633
|
-
"default": "new ModalController(this, {\n isOpen: () => this.open,\n onDismiss: () => this.handleDismiss(),\n dialog: () => this.modal,\n backdrop: () => this.backdrop,\n close: returnValue => this.close(returnValue),\n })"
|
|
8587
|
+
"default": "new LocalizeController<\"nord-message\">(this)"
|
|
8634
8588
|
},
|
|
8635
8589
|
{
|
|
8636
8590
|
"kind": "field",
|
|
8637
|
-
"name": "
|
|
8591
|
+
"name": "href",
|
|
8638
8592
|
"type": {
|
|
8639
|
-
"text": "
|
|
8593
|
+
"text": "string | undefined"
|
|
8640
8594
|
},
|
|
8641
|
-
"
|
|
8642
|
-
"
|
|
8643
|
-
"attribute": "open",
|
|
8595
|
+
"description": "The url the message should link to.",
|
|
8596
|
+
"attribute": "href",
|
|
8644
8597
|
"reflects": true
|
|
8645
8598
|
},
|
|
8646
8599
|
{
|
|
8647
8600
|
"kind": "field",
|
|
8648
|
-
"name": "
|
|
8601
|
+
"name": "highlight",
|
|
8649
8602
|
"type": {
|
|
8650
|
-
"text": "
|
|
8603
|
+
"text": "boolean | undefined"
|
|
8651
8604
|
},
|
|
8652
|
-
"
|
|
8653
|
-
"
|
|
8654
|
-
"attribute": "size",
|
|
8605
|
+
"description": "Highlight the message visually. This is meant for highlighting\na new message that just appeared. Highlight style should be removed\nafter the user has seen the message and there’s been a timeout of\ne.g. 30 seconds.",
|
|
8606
|
+
"attribute": "highlight",
|
|
8655
8607
|
"reflects": true
|
|
8656
8608
|
},
|
|
8657
8609
|
{
|
|
8658
8610
|
"kind": "field",
|
|
8659
|
-
"name": "
|
|
8660
|
-
"type": {
|
|
8661
|
-
"text": "string"
|
|
8662
|
-
},
|
|
8663
|
-
"default": "\"\"",
|
|
8664
|
-
"description": "The reason why the modal was closed. This typically indicates\nwhich button the user pressed to close the modal, though any value\ncan be supplied if the modal is programmatically closed."
|
|
8665
|
-
},
|
|
8666
|
-
{
|
|
8667
|
-
"kind": "field",
|
|
8668
|
-
"name": "scrollable",
|
|
8611
|
+
"name": "unread",
|
|
8669
8612
|
"type": {
|
|
8670
|
-
"text": "boolean"
|
|
8613
|
+
"text": "boolean | undefined"
|
|
8671
8614
|
},
|
|
8672
|
-
"
|
|
8673
|
-
"
|
|
8674
|
-
"attribute": "scrollable",
|
|
8615
|
+
"description": "Mark the message as unread. By default messages are read.",
|
|
8616
|
+
"attribute": "unread",
|
|
8675
8617
|
"reflects": true
|
|
8676
8618
|
},
|
|
8677
8619
|
{
|
|
8678
|
-
"kind": "
|
|
8679
|
-
"name": "
|
|
8680
|
-
"
|
|
8681
|
-
|
|
8682
|
-
|
|
8683
|
-
|
|
8684
|
-
|
|
8685
|
-
"parameters": [
|
|
8686
|
-
{
|
|
8687
|
-
"name": "returnValue",
|
|
8688
|
-
"optional": true,
|
|
8689
|
-
"type": {
|
|
8690
|
-
"text": "string"
|
|
8691
|
-
},
|
|
8692
|
-
"description": "An optional value to indicate why the modal was closed."
|
|
8693
|
-
}
|
|
8694
|
-
],
|
|
8695
|
-
"description": "Programmatically close the modal."
|
|
8620
|
+
"kind": "field",
|
|
8621
|
+
"name": "focusableRef",
|
|
8622
|
+
"privacy": "protected",
|
|
8623
|
+
"inheritedFrom": {
|
|
8624
|
+
"name": "FocusableMixin",
|
|
8625
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8626
|
+
}
|
|
8696
8627
|
},
|
|
8697
8628
|
{
|
|
8698
8629
|
"kind": "method",
|
|
@@ -8707,30 +8638,312 @@
|
|
|
8707
8638
|
"description": "An object which controls aspects of the focusing process."
|
|
8708
8639
|
}
|
|
8709
8640
|
],
|
|
8710
|
-
"description": "Programmatically focus the
|
|
8641
|
+
"description": "Programmatically move focus to the component.",
|
|
8642
|
+
"inheritedFrom": {
|
|
8643
|
+
"name": "FocusableMixin",
|
|
8644
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8645
|
+
}
|
|
8711
8646
|
},
|
|
8712
8647
|
{
|
|
8713
8648
|
"kind": "method",
|
|
8714
|
-
"name": "
|
|
8715
|
-
"
|
|
8716
|
-
"
|
|
8717
|
-
|
|
8718
|
-
|
|
8719
|
-
|
|
8720
|
-
"text": "boolean"
|
|
8721
|
-
}
|
|
8722
|
-
}
|
|
8723
|
-
]
|
|
8649
|
+
"name": "blur",
|
|
8650
|
+
"description": "Programmatically remove focus from the component.",
|
|
8651
|
+
"inheritedFrom": {
|
|
8652
|
+
"name": "FocusableMixin",
|
|
8653
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8654
|
+
}
|
|
8724
8655
|
},
|
|
8725
8656
|
{
|
|
8726
8657
|
"kind": "method",
|
|
8727
|
-
"name": "
|
|
8728
|
-
"
|
|
8658
|
+
"name": "click",
|
|
8659
|
+
"description": "Programmatically simulates a click on the component.",
|
|
8660
|
+
"inheritedFrom": {
|
|
8661
|
+
"name": "FocusableMixin",
|
|
8662
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8663
|
+
}
|
|
8729
8664
|
}
|
|
8730
8665
|
],
|
|
8731
|
-
"
|
|
8666
|
+
"attributes": [
|
|
8732
8667
|
{
|
|
8733
|
-
"name": "
|
|
8668
|
+
"name": "href",
|
|
8669
|
+
"type": {
|
|
8670
|
+
"text": "string | undefined"
|
|
8671
|
+
},
|
|
8672
|
+
"description": "The url the message should link to.",
|
|
8673
|
+
"fieldName": "href"
|
|
8674
|
+
},
|
|
8675
|
+
{
|
|
8676
|
+
"name": "highlight",
|
|
8677
|
+
"type": {
|
|
8678
|
+
"text": "boolean | undefined"
|
|
8679
|
+
},
|
|
8680
|
+
"description": "Highlight the message visually. This is meant for highlighting\na new message that just appeared. Highlight style should be removed\nafter the user has seen the message and there’s been a timeout of\ne.g. 30 seconds.",
|
|
8681
|
+
"fieldName": "highlight"
|
|
8682
|
+
},
|
|
8683
|
+
{
|
|
8684
|
+
"name": "unread",
|
|
8685
|
+
"type": {
|
|
8686
|
+
"text": "boolean | undefined"
|
|
8687
|
+
},
|
|
8688
|
+
"description": "Mark the message as unread. By default messages are read.",
|
|
8689
|
+
"fieldName": "unread"
|
|
8690
|
+
}
|
|
8691
|
+
],
|
|
8692
|
+
"mixins": [
|
|
8693
|
+
{
|
|
8694
|
+
"name": "FocusableMixin",
|
|
8695
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
8696
|
+
}
|
|
8697
|
+
],
|
|
8698
|
+
"superclass": {
|
|
8699
|
+
"name": "LitElement",
|
|
8700
|
+
"package": "lit"
|
|
8701
|
+
},
|
|
8702
|
+
"localization": [
|
|
8703
|
+
{
|
|
8704
|
+
"name": "unreadLabel",
|
|
8705
|
+
"description": "Label for the unread messages."
|
|
8706
|
+
}
|
|
8707
|
+
],
|
|
8708
|
+
"status": "draft",
|
|
8709
|
+
"category": "action",
|
|
8710
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Messages should always perform an action when clicked.\n- The click action should navigate to a new page or provide more detail about the message.\n- Mark unread messages as read on user interaction.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t slot other components inside a message.\n\n</div>\n\n---\n\n## Content guidelines\n\nMessage content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Patient arrived</div>\n\nWhen writing the message content, be concise. Keep content to 1 to 2 sentence:\n\n<div class=\"n-usage n-usage-do\">You’ve reached the limit of 30 users included in your plan. Upgrade to add more.</div>\n<div class=\"n-usage n-usage-dont\">You have reached the user limit. Your clinic can only have a maximum of 30 users. To add more users, remove users you no longer need or upgrade your plan to add more.</div>\n\nWhen writing the notification content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen Arrived To Clinic With Pixie Cat.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Ariel Salminen arrived to clinic with Pixie cat.</div>\n<div class=\"n-usage n-usage-dont\">Ariel Salminen arrived to clinic with Pixie cat</div>\n\nAvoid all caps for messages:\n\n<div class=\"n-usage n-usage-do\">Nina Williams arrived to clinic with Norfryd</div>\n<div class=\"n-usage n-usage-dont\">NINA WILLIAMS ARRIVED TO CLINIC WITH NORFRYD</div>\n",
|
|
8711
|
+
"examples": [],
|
|
8712
|
+
"dependencies": [
|
|
8713
|
+
"dropdown-item"
|
|
8714
|
+
],
|
|
8715
|
+
"tagName": "nord-message",
|
|
8716
|
+
"customElement": true
|
|
8717
|
+
}
|
|
8718
|
+
],
|
|
8719
|
+
"exports": [
|
|
8720
|
+
{
|
|
8721
|
+
"kind": "js",
|
|
8722
|
+
"name": "default",
|
|
8723
|
+
"declaration": {
|
|
8724
|
+
"name": "Message",
|
|
8725
|
+
"module": "src/message/Message.ts"
|
|
8726
|
+
}
|
|
8727
|
+
},
|
|
8728
|
+
{
|
|
8729
|
+
"kind": "custom-element-definition",
|
|
8730
|
+
"name": "nord-message",
|
|
8731
|
+
"declaration": {
|
|
8732
|
+
"name": "Message",
|
|
8733
|
+
"module": "src/message/Message.ts"
|
|
8734
|
+
}
|
|
8735
|
+
}
|
|
8736
|
+
]
|
|
8737
|
+
},
|
|
8738
|
+
{
|
|
8739
|
+
"kind": "javascript-module",
|
|
8740
|
+
"path": "src/message/localization.ts",
|
|
8741
|
+
"declarations": [
|
|
8742
|
+
{
|
|
8743
|
+
"kind": "variable",
|
|
8744
|
+
"name": "localization",
|
|
8745
|
+
"type": {
|
|
8746
|
+
"text": "object"
|
|
8747
|
+
},
|
|
8748
|
+
"default": "{\n unreadLabel: \"Unread\",\n}"
|
|
8749
|
+
}
|
|
8750
|
+
],
|
|
8751
|
+
"exports": [
|
|
8752
|
+
{
|
|
8753
|
+
"kind": "js",
|
|
8754
|
+
"name": "default",
|
|
8755
|
+
"declaration": {
|
|
8756
|
+
"name": "localization",
|
|
8757
|
+
"module": "src/message/localization.ts"
|
|
8758
|
+
}
|
|
8759
|
+
}
|
|
8760
|
+
]
|
|
8761
|
+
},
|
|
8762
|
+
{
|
|
8763
|
+
"kind": "javascript-module",
|
|
8764
|
+
"path": "src/modal/Modal.ts",
|
|
8765
|
+
"declarations": [
|
|
8766
|
+
{
|
|
8767
|
+
"kind": "class",
|
|
8768
|
+
"description": "Modal component is used to display content that temporarily blocks interactions\nwith the main view of an application. Modal should be used sparingly and\nonly when necessary.",
|
|
8769
|
+
"name": "Modal",
|
|
8770
|
+
"cssProperties": [
|
|
8771
|
+
{
|
|
8772
|
+
"description": "Controls the padding on the sides of the modal, using our [spacing tokens](/tokens/#space).",
|
|
8773
|
+
"name": "--n-modal-padding-inline",
|
|
8774
|
+
"default": "var(--n-space-m)"
|
|
8775
|
+
},
|
|
8776
|
+
{
|
|
8777
|
+
"description": "Controls the padding above and below the modal, using our [spacing tokens](/tokens/#space).",
|
|
8778
|
+
"name": "--n-modal-padding-block",
|
|
8779
|
+
"default": "var(--n-space-m)"
|
|
8780
|
+
},
|
|
8781
|
+
{
|
|
8782
|
+
"description": "Controls the width of the modal.",
|
|
8783
|
+
"name": "--n-modal-max-inline-size",
|
|
8784
|
+
"default": "620px"
|
|
8785
|
+
}
|
|
8786
|
+
],
|
|
8787
|
+
"slots": [
|
|
8788
|
+
{
|
|
8789
|
+
"description": "Default slot",
|
|
8790
|
+
"name": ""
|
|
8791
|
+
},
|
|
8792
|
+
{
|
|
8793
|
+
"description": "Slot which holds the header of the modal, positioned next to the close button.",
|
|
8794
|
+
"name": "header"
|
|
8795
|
+
},
|
|
8796
|
+
{
|
|
8797
|
+
"description": "Slot which is typically used to hold call to action buttons, but can also be used to build custom footers.",
|
|
8798
|
+
"name": "footer"
|
|
8799
|
+
}
|
|
8800
|
+
],
|
|
8801
|
+
"members": [
|
|
8802
|
+
{
|
|
8803
|
+
"kind": "field",
|
|
8804
|
+
"name": "modal",
|
|
8805
|
+
"type": {
|
|
8806
|
+
"text": "HTMLDivElement"
|
|
8807
|
+
},
|
|
8808
|
+
"privacy": "private"
|
|
8809
|
+
},
|
|
8810
|
+
{
|
|
8811
|
+
"kind": "field",
|
|
8812
|
+
"name": "backdrop",
|
|
8813
|
+
"type": {
|
|
8814
|
+
"text": "HTMLDivElement"
|
|
8815
|
+
},
|
|
8816
|
+
"privacy": "private"
|
|
8817
|
+
},
|
|
8818
|
+
{
|
|
8819
|
+
"kind": "field",
|
|
8820
|
+
"name": "headerSlot",
|
|
8821
|
+
"privacy": "private",
|
|
8822
|
+
"default": "new SlotController(this, \"header\")"
|
|
8823
|
+
},
|
|
8824
|
+
{
|
|
8825
|
+
"kind": "field",
|
|
8826
|
+
"name": "featureSlot",
|
|
8827
|
+
"privacy": "private",
|
|
8828
|
+
"default": "new SlotController(this, \"feature\")"
|
|
8829
|
+
},
|
|
8830
|
+
{
|
|
8831
|
+
"kind": "field",
|
|
8832
|
+
"name": "footerSlot",
|
|
8833
|
+
"privacy": "private",
|
|
8834
|
+
"default": "new SlotController(this, \"footer\")"
|
|
8835
|
+
},
|
|
8836
|
+
{
|
|
8837
|
+
"kind": "field",
|
|
8838
|
+
"name": "localize",
|
|
8839
|
+
"privacy": "private",
|
|
8840
|
+
"default": "new LocalizeController<\"nord-modal\">(this)"
|
|
8841
|
+
},
|
|
8842
|
+
{
|
|
8843
|
+
"kind": "field",
|
|
8844
|
+
"name": "modalController",
|
|
8845
|
+
"privacy": "private",
|
|
8846
|
+
"default": "new ModalController(this, {\n isOpen: () => this.open,\n onDismiss: () => this.handleDismiss(),\n dialog: () => this.modal,\n backdrop: () => this.backdrop,\n close: returnValue => this.close(returnValue),\n })"
|
|
8847
|
+
},
|
|
8848
|
+
{
|
|
8849
|
+
"kind": "field",
|
|
8850
|
+
"name": "open",
|
|
8851
|
+
"type": {
|
|
8852
|
+
"text": "boolean"
|
|
8853
|
+
},
|
|
8854
|
+
"default": "false",
|
|
8855
|
+
"description": "Controls whether the modal is open or not.",
|
|
8856
|
+
"attribute": "open",
|
|
8857
|
+
"reflects": true
|
|
8858
|
+
},
|
|
8859
|
+
{
|
|
8860
|
+
"kind": "field",
|
|
8861
|
+
"name": "size",
|
|
8862
|
+
"type": {
|
|
8863
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
8864
|
+
},
|
|
8865
|
+
"default": "\"m\"",
|
|
8866
|
+
"description": "Controls the max-width of the modal when open.",
|
|
8867
|
+
"attribute": "size",
|
|
8868
|
+
"reflects": true
|
|
8869
|
+
},
|
|
8870
|
+
{
|
|
8871
|
+
"kind": "field",
|
|
8872
|
+
"name": "returnValue",
|
|
8873
|
+
"type": {
|
|
8874
|
+
"text": "string"
|
|
8875
|
+
},
|
|
8876
|
+
"default": "\"\"",
|
|
8877
|
+
"description": "The reason why the modal was closed. This typically indicates\nwhich button the user pressed to close the modal, though any value\ncan be supplied if the modal is programmatically closed."
|
|
8878
|
+
},
|
|
8879
|
+
{
|
|
8880
|
+
"kind": "field",
|
|
8881
|
+
"name": "scrollable",
|
|
8882
|
+
"type": {
|
|
8883
|
+
"text": "boolean"
|
|
8884
|
+
},
|
|
8885
|
+
"default": "false",
|
|
8886
|
+
"description": "By default if a modal is too big for the browser window,\nthe entire modal will scroll. This setting changes that behavior\nso that the body of the modal scrolls instead, with the modal\nitself remaining fixed.",
|
|
8887
|
+
"attribute": "scrollable",
|
|
8888
|
+
"reflects": true
|
|
8889
|
+
},
|
|
8890
|
+
{
|
|
8891
|
+
"kind": "method",
|
|
8892
|
+
"name": "showModal",
|
|
8893
|
+
"description": "Show the modal, automatically moving focus to the modal or a child\nelement with an `autofocus` attribute."
|
|
8894
|
+
},
|
|
8895
|
+
{
|
|
8896
|
+
"kind": "method",
|
|
8897
|
+
"name": "close",
|
|
8898
|
+
"parameters": [
|
|
8899
|
+
{
|
|
8900
|
+
"name": "returnValue",
|
|
8901
|
+
"optional": true,
|
|
8902
|
+
"type": {
|
|
8903
|
+
"text": "string"
|
|
8904
|
+
},
|
|
8905
|
+
"description": "An optional value to indicate why the modal was closed."
|
|
8906
|
+
}
|
|
8907
|
+
],
|
|
8908
|
+
"description": "Programmatically close the modal."
|
|
8909
|
+
},
|
|
8910
|
+
{
|
|
8911
|
+
"kind": "method",
|
|
8912
|
+
"name": "focus",
|
|
8913
|
+
"parameters": [
|
|
8914
|
+
{
|
|
8915
|
+
"name": "options",
|
|
8916
|
+
"optional": true,
|
|
8917
|
+
"type": {
|
|
8918
|
+
"text": "FocusOptions"
|
|
8919
|
+
},
|
|
8920
|
+
"description": "An object which controls aspects of the focusing process."
|
|
8921
|
+
}
|
|
8922
|
+
],
|
|
8923
|
+
"description": "Programmatically focus the modal."
|
|
8924
|
+
},
|
|
8925
|
+
{
|
|
8926
|
+
"kind": "method",
|
|
8927
|
+
"name": "handleOpenUpdated",
|
|
8928
|
+
"privacy": "protected",
|
|
8929
|
+
"parameters": [
|
|
8930
|
+
{
|
|
8931
|
+
"name": "prev",
|
|
8932
|
+
"type": {
|
|
8933
|
+
"text": "boolean"
|
|
8934
|
+
}
|
|
8935
|
+
}
|
|
8936
|
+
]
|
|
8937
|
+
},
|
|
8938
|
+
{
|
|
8939
|
+
"kind": "method",
|
|
8940
|
+
"name": "handleDismiss",
|
|
8941
|
+
"privacy": "private"
|
|
8942
|
+
}
|
|
8943
|
+
],
|
|
8944
|
+
"events": [
|
|
8945
|
+
{
|
|
8946
|
+
"name": "close",
|
|
8734
8947
|
"type": {
|
|
8735
8948
|
"text": "NordEvent"
|
|
8736
8949
|
},
|
|
@@ -9168,6 +9381,11 @@
|
|
|
9168
9381
|
"name": "toggleOpen",
|
|
9169
9382
|
"privacy": "private"
|
|
9170
9383
|
},
|
|
9384
|
+
{
|
|
9385
|
+
"kind": "method",
|
|
9386
|
+
"name": "handleActiveChange",
|
|
9387
|
+
"privacy": "protected"
|
|
9388
|
+
},
|
|
9171
9389
|
{
|
|
9172
9390
|
"kind": "field",
|
|
9173
9391
|
"name": "focusableRef",
|
|
@@ -9222,6 +9440,12 @@
|
|
|
9222
9440
|
"text": "NordEvent"
|
|
9223
9441
|
},
|
|
9224
9442
|
"description": "Dispatched whenever a nav item's state changes between open and closed."
|
|
9443
|
+
},
|
|
9444
|
+
{
|
|
9445
|
+
"name": "activate",
|
|
9446
|
+
"type": {
|
|
9447
|
+
"text": "NordEvent"
|
|
9448
|
+
}
|
|
9225
9449
|
}
|
|
9226
9450
|
],
|
|
9227
9451
|
"attributes": [
|
|
@@ -9313,7 +9537,7 @@
|
|
|
9313
9537
|
"declarations": [
|
|
9314
9538
|
{
|
|
9315
9539
|
"kind": "class",
|
|
9316
|
-
"description": "Nav toggle is meant for hiding and showing the primary navigation.\nThis component is used internally in the Layout component, but can also be\nused separate to further customize the
|
|
9540
|
+
"description": "Nav toggle is meant for hiding and showing the primary navigation.\nThis component is used internally in the Layout component, but can also be\nused separate to further customize the behavior.",
|
|
9317
9541
|
"name": "NavToggle",
|
|
9318
9542
|
"members": [
|
|
9319
9543
|
{
|
|
@@ -9455,6 +9679,13 @@
|
|
|
9455
9679
|
"kind": "class",
|
|
9456
9680
|
"description": "Navigation is used to display the primary navigation in the sidebar\nof an application. Navigation includes a list of links that users\nuse to move between sections of the application.",
|
|
9457
9681
|
"name": "Navigation",
|
|
9682
|
+
"cssProperties": [
|
|
9683
|
+
{
|
|
9684
|
+
"description": "Controls the background color of the navigation element.",
|
|
9685
|
+
"name": "--n-navigation-background-color",
|
|
9686
|
+
"default": "var(--n-color-nav-surface)"
|
|
9687
|
+
}
|
|
9688
|
+
],
|
|
9458
9689
|
"slots": [
|
|
9459
9690
|
{
|
|
9460
9691
|
"description": "The main section of the sidebar, for holding nav components.",
|
|
@@ -9475,6 +9706,17 @@
|
|
|
9475
9706
|
"name": "headerSlot",
|
|
9476
9707
|
"privacy": "private",
|
|
9477
9708
|
"default": "new SlotController(this, \"header\")"
|
|
9709
|
+
},
|
|
9710
|
+
{
|
|
9711
|
+
"kind": "field",
|
|
9712
|
+
"name": "events",
|
|
9713
|
+
"privacy": "private",
|
|
9714
|
+
"default": "new EventController(this)"
|
|
9715
|
+
},
|
|
9716
|
+
{
|
|
9717
|
+
"kind": "field",
|
|
9718
|
+
"name": "handleActivate",
|
|
9719
|
+
"privacy": "private"
|
|
9478
9720
|
}
|
|
9479
9721
|
],
|
|
9480
9722
|
"superclass": {
|
|
@@ -9486,7 +9728,9 @@
|
|
|
9486
9728
|
"category": "navigation",
|
|
9487
9729
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for primary navigation items that perform an action when clicked. Each action should navigate to a URL or trigger another action like a modal overlay.\n- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place a `<nav>` element inside the navigation component, as it already contains one internally.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n",
|
|
9488
9730
|
"examples": [],
|
|
9489
|
-
"dependencies": [
|
|
9731
|
+
"dependencies": [
|
|
9732
|
+
"nav-item"
|
|
9733
|
+
],
|
|
9490
9734
|
"tagName": "nord-navigation",
|
|
9491
9735
|
"customElement": true
|
|
9492
9736
|
}
|
|
@@ -10543,6 +10787,7 @@
|
|
|
10543
10787
|
"kind": "field",
|
|
10544
10788
|
"name": "formValue",
|
|
10545
10789
|
"privacy": "protected",
|
|
10790
|
+
"readonly": true,
|
|
10546
10791
|
"inheritedFrom": {
|
|
10547
10792
|
"name": "FormAssociatedMixin",
|
|
10548
10793
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -10780,6 +11025,7 @@
|
|
|
10780
11025
|
"kind": "field",
|
|
10781
11026
|
"name": "hasHint",
|
|
10782
11027
|
"privacy": "protected",
|
|
11028
|
+
"readonly": true,
|
|
10783
11029
|
"inheritedFrom": {
|
|
10784
11030
|
"name": "FormAssociatedMixin",
|
|
10785
11031
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -10789,6 +11035,7 @@
|
|
|
10789
11035
|
"kind": "field",
|
|
10790
11036
|
"name": "hasError",
|
|
10791
11037
|
"privacy": "protected",
|
|
11038
|
+
"readonly": true,
|
|
10792
11039
|
"inheritedFrom": {
|
|
10793
11040
|
"name": "FormAssociatedMixin",
|
|
10794
11041
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -10840,6 +11087,7 @@
|
|
|
10840
11087
|
"kind": "field",
|
|
10841
11088
|
"name": "form",
|
|
10842
11089
|
"description": "Gets the form, if any, associated with the form element.",
|
|
11090
|
+
"readonly": true,
|
|
10843
11091
|
"inheritedFrom": {
|
|
10844
11092
|
"name": "InputMixin",
|
|
10845
11093
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -11253,6 +11501,7 @@
|
|
|
11253
11501
|
"kind": "field",
|
|
11254
11502
|
"name": "formValue",
|
|
11255
11503
|
"privacy": "protected",
|
|
11504
|
+
"readonly": true,
|
|
11256
11505
|
"inheritedFrom": {
|
|
11257
11506
|
"name": "FormAssociatedMixin",
|
|
11258
11507
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11458,6 +11707,7 @@
|
|
|
11458
11707
|
"kind": "field",
|
|
11459
11708
|
"name": "hasHint",
|
|
11460
11709
|
"privacy": "protected",
|
|
11710
|
+
"readonly": true,
|
|
11461
11711
|
"inheritedFrom": {
|
|
11462
11712
|
"name": "FormAssociatedMixin",
|
|
11463
11713
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11467,6 +11717,7 @@
|
|
|
11467
11717
|
"kind": "field",
|
|
11468
11718
|
"name": "hasError",
|
|
11469
11719
|
"privacy": "protected",
|
|
11720
|
+
"readonly": true,
|
|
11470
11721
|
"inheritedFrom": {
|
|
11471
11722
|
"name": "FormAssociatedMixin",
|
|
11472
11723
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11547,6 +11798,7 @@
|
|
|
11547
11798
|
"kind": "field",
|
|
11548
11799
|
"name": "form",
|
|
11549
11800
|
"description": "Gets the form, if any, associated with the form element.",
|
|
11801
|
+
"readonly": true,
|
|
11550
11802
|
"inheritedFrom": {
|
|
11551
11803
|
"name": "InputMixin",
|
|
11552
11804
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -11899,6 +12151,10 @@
|
|
|
11899
12151
|
{
|
|
11900
12152
|
"description": "Optional slot that holds error text for the input.",
|
|
11901
12153
|
"name": "error"
|
|
12154
|
+
},
|
|
12155
|
+
{
|
|
12156
|
+
"description": "Used to place an icon at the start of select.",
|
|
12157
|
+
"name": "icon"
|
|
11902
12158
|
}
|
|
11903
12159
|
],
|
|
11904
12160
|
"members": [
|
|
@@ -11906,6 +12162,7 @@
|
|
|
11906
12162
|
"kind": "field",
|
|
11907
12163
|
"name": "formValue",
|
|
11908
12164
|
"privacy": "protected",
|
|
12165
|
+
"readonly": true,
|
|
11909
12166
|
"inheritedFrom": {
|
|
11910
12167
|
"name": "FormAssociatedMixin",
|
|
11911
12168
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -11944,7 +12201,8 @@
|
|
|
11944
12201
|
{
|
|
11945
12202
|
"kind": "field",
|
|
11946
12203
|
"name": "options",
|
|
11947
|
-
"privacy": "private"
|
|
12204
|
+
"privacy": "private",
|
|
12205
|
+
"readonly": true
|
|
11948
12206
|
},
|
|
11949
12207
|
{
|
|
11950
12208
|
"kind": "method",
|
|
@@ -12236,6 +12494,7 @@
|
|
|
12236
12494
|
"kind": "field",
|
|
12237
12495
|
"name": "hasHint",
|
|
12238
12496
|
"privacy": "protected",
|
|
12497
|
+
"readonly": true,
|
|
12239
12498
|
"inheritedFrom": {
|
|
12240
12499
|
"name": "FormAssociatedMixin",
|
|
12241
12500
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12245,6 +12504,7 @@
|
|
|
12245
12504
|
"kind": "field",
|
|
12246
12505
|
"name": "hasError",
|
|
12247
12506
|
"privacy": "protected",
|
|
12507
|
+
"readonly": true,
|
|
12248
12508
|
"inheritedFrom": {
|
|
12249
12509
|
"name": "FormAssociatedMixin",
|
|
12250
12510
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -12310,6 +12570,7 @@
|
|
|
12310
12570
|
"kind": "field",
|
|
12311
12571
|
"name": "form",
|
|
12312
12572
|
"description": "Gets the form, if any, associated with the form element.",
|
|
12573
|
+
"readonly": true,
|
|
12313
12574
|
"inheritedFrom": {
|
|
12314
12575
|
"name": "InputMixin",
|
|
12315
12576
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -12673,16 +12934,117 @@
|
|
|
12673
12934
|
"kind": "js",
|
|
12674
12935
|
"name": "default",
|
|
12675
12936
|
"declaration": {
|
|
12676
|
-
"name": "Skeleton",
|
|
12677
|
-
"module": "src/skeleton/Skeleton.ts"
|
|
12937
|
+
"name": "Skeleton",
|
|
12938
|
+
"module": "src/skeleton/Skeleton.ts"
|
|
12939
|
+
}
|
|
12940
|
+
},
|
|
12941
|
+
{
|
|
12942
|
+
"kind": "custom-element-definition",
|
|
12943
|
+
"name": "nord-skeleton",
|
|
12944
|
+
"declaration": {
|
|
12945
|
+
"name": "Skeleton",
|
|
12946
|
+
"module": "src/skeleton/Skeleton.ts"
|
|
12947
|
+
}
|
|
12948
|
+
}
|
|
12949
|
+
]
|
|
12950
|
+
},
|
|
12951
|
+
{
|
|
12952
|
+
"kind": "javascript-module",
|
|
12953
|
+
"path": "src/spinner/Spinner.ts",
|
|
12954
|
+
"declarations": [
|
|
12955
|
+
{
|
|
12956
|
+
"kind": "class",
|
|
12957
|
+
"description": "Spinner component is used to indicate users that their action is being\nprocessed. You can customize the size and color of the spinner with the\nprovided properties.",
|
|
12958
|
+
"name": "Spinner",
|
|
12959
|
+
"members": [
|
|
12960
|
+
{
|
|
12961
|
+
"kind": "field",
|
|
12962
|
+
"name": "size",
|
|
12963
|
+
"type": {
|
|
12964
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
12965
|
+
},
|
|
12966
|
+
"default": "\"m\"",
|
|
12967
|
+
"description": "The size of the spinner.",
|
|
12968
|
+
"attribute": "size",
|
|
12969
|
+
"reflects": true
|
|
12970
|
+
},
|
|
12971
|
+
{
|
|
12972
|
+
"kind": "field",
|
|
12973
|
+
"name": "color",
|
|
12974
|
+
"type": {
|
|
12975
|
+
"text": "string | undefined"
|
|
12976
|
+
},
|
|
12977
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12978
|
+
"attribute": "color",
|
|
12979
|
+
"reflects": true
|
|
12980
|
+
},
|
|
12981
|
+
{
|
|
12982
|
+
"kind": "field",
|
|
12983
|
+
"name": "label",
|
|
12984
|
+
"type": {
|
|
12985
|
+
"text": "string | undefined"
|
|
12986
|
+
},
|
|
12987
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12988
|
+
"attribute": "label",
|
|
12989
|
+
"reflects": true
|
|
12990
|
+
}
|
|
12991
|
+
],
|
|
12992
|
+
"attributes": [
|
|
12993
|
+
{
|
|
12994
|
+
"name": "size",
|
|
12995
|
+
"type": {
|
|
12996
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
12997
|
+
},
|
|
12998
|
+
"default": "\"m\"",
|
|
12999
|
+
"description": "The size of the spinner.",
|
|
13000
|
+
"fieldName": "size"
|
|
13001
|
+
},
|
|
13002
|
+
{
|
|
13003
|
+
"name": "color",
|
|
13004
|
+
"type": {
|
|
13005
|
+
"text": "string | undefined"
|
|
13006
|
+
},
|
|
13007
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
13008
|
+
"fieldName": "color"
|
|
13009
|
+
},
|
|
13010
|
+
{
|
|
13011
|
+
"name": "label",
|
|
13012
|
+
"type": {
|
|
13013
|
+
"text": "string | undefined"
|
|
13014
|
+
},
|
|
13015
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
13016
|
+
"fieldName": "label"
|
|
13017
|
+
}
|
|
13018
|
+
],
|
|
13019
|
+
"superclass": {
|
|
13020
|
+
"name": "LitElement",
|
|
13021
|
+
"package": "lit"
|
|
13022
|
+
},
|
|
13023
|
+
"localization": [],
|
|
13024
|
+
"status": "ready",
|
|
13025
|
+
"category": "feedback",
|
|
13026
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for indicating users that their action is being processed.\n- Use the label property to provide an accessible label for the spinner. If no label is supplied, the spinner is hidden from assistive technology.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to show progress. Favor a progress bar instead.\n\n</div>\n",
|
|
13027
|
+
"examples": [],
|
|
13028
|
+
"dependencies": [],
|
|
13029
|
+
"tagName": "nord-spinner",
|
|
13030
|
+
"customElement": true
|
|
13031
|
+
}
|
|
13032
|
+
],
|
|
13033
|
+
"exports": [
|
|
13034
|
+
{
|
|
13035
|
+
"kind": "js",
|
|
13036
|
+
"name": "default",
|
|
13037
|
+
"declaration": {
|
|
13038
|
+
"name": "Spinner",
|
|
13039
|
+
"module": "src/spinner/Spinner.ts"
|
|
12678
13040
|
}
|
|
12679
13041
|
},
|
|
12680
13042
|
{
|
|
12681
13043
|
"kind": "custom-element-definition",
|
|
12682
|
-
"name": "nord-
|
|
13044
|
+
"name": "nord-spinner",
|
|
12683
13045
|
"declaration": {
|
|
12684
|
-
"name": "
|
|
12685
|
-
"module": "src/
|
|
13046
|
+
"name": "Spinner",
|
|
13047
|
+
"module": "src/spinner/Spinner.ts"
|
|
12686
13048
|
}
|
|
12687
13049
|
}
|
|
12688
13050
|
]
|
|
@@ -12742,18 +13104,6 @@
|
|
|
12742
13104
|
"attribute": "align-items",
|
|
12743
13105
|
"reflects": true
|
|
12744
13106
|
},
|
|
12745
|
-
{
|
|
12746
|
-
"kind": "field",
|
|
12747
|
-
"name": "responsive",
|
|
12748
|
-
"type": {
|
|
12749
|
-
"text": "boolean"
|
|
12750
|
-
},
|
|
12751
|
-
"default": "false",
|
|
12752
|
-
"description": "This property is deprecated and will be removed in a future version. We recommend using standard [CSS media queries](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries) over this property. Please see the [updated usage example](/components/stack/?example=using+responsive+media+query).",
|
|
12753
|
-
"deprecated": "true",
|
|
12754
|
-
"attribute": "responsive",
|
|
12755
|
-
"reflects": true
|
|
12756
|
-
},
|
|
12757
13107
|
{
|
|
12758
13108
|
"kind": "field",
|
|
12759
13109
|
"name": "wrap",
|
|
@@ -12804,16 +13154,6 @@
|
|
|
12804
13154
|
"description": "How to align the child items inside the stack.",
|
|
12805
13155
|
"fieldName": "alignItems"
|
|
12806
13156
|
},
|
|
12807
|
-
{
|
|
12808
|
-
"name": "responsive",
|
|
12809
|
-
"type": {
|
|
12810
|
-
"text": "boolean"
|
|
12811
|
-
},
|
|
12812
|
-
"default": "false",
|
|
12813
|
-
"description": "This property is deprecated and will be removed in a future version. We recommend using standard [CSS media queries](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries) over this property. Please see the [updated usage example](/components/stack/?example=using+responsive+media+query).",
|
|
12814
|
-
"deprecated": "true",
|
|
12815
|
-
"fieldName": "responsive"
|
|
12816
|
-
},
|
|
12817
13157
|
{
|
|
12818
13158
|
"name": "wrap",
|
|
12819
13159
|
"type": {
|
|
@@ -12865,107 +13205,6 @@
|
|
|
12865
13205
|
}
|
|
12866
13206
|
]
|
|
12867
13207
|
},
|
|
12868
|
-
{
|
|
12869
|
-
"kind": "javascript-module",
|
|
12870
|
-
"path": "src/spinner/Spinner.ts",
|
|
12871
|
-
"declarations": [
|
|
12872
|
-
{
|
|
12873
|
-
"kind": "class",
|
|
12874
|
-
"description": "Spinner component is used to indicate users that their action is being\nprocessed. You can customize the size and color of the spinner with the\nprovided properties.",
|
|
12875
|
-
"name": "Spinner",
|
|
12876
|
-
"members": [
|
|
12877
|
-
{
|
|
12878
|
-
"kind": "field",
|
|
12879
|
-
"name": "size",
|
|
12880
|
-
"type": {
|
|
12881
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
12882
|
-
},
|
|
12883
|
-
"default": "\"m\"",
|
|
12884
|
-
"description": "The size of the spinner.",
|
|
12885
|
-
"attribute": "size",
|
|
12886
|
-
"reflects": true
|
|
12887
|
-
},
|
|
12888
|
-
{
|
|
12889
|
-
"kind": "field",
|
|
12890
|
-
"name": "color",
|
|
12891
|
-
"type": {
|
|
12892
|
-
"text": "string | undefined"
|
|
12893
|
-
},
|
|
12894
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12895
|
-
"attribute": "color",
|
|
12896
|
-
"reflects": true
|
|
12897
|
-
},
|
|
12898
|
-
{
|
|
12899
|
-
"kind": "field",
|
|
12900
|
-
"name": "label",
|
|
12901
|
-
"type": {
|
|
12902
|
-
"text": "string | undefined"
|
|
12903
|
-
},
|
|
12904
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12905
|
-
"attribute": "label",
|
|
12906
|
-
"reflects": true
|
|
12907
|
-
}
|
|
12908
|
-
],
|
|
12909
|
-
"attributes": [
|
|
12910
|
-
{
|
|
12911
|
-
"name": "size",
|
|
12912
|
-
"type": {
|
|
12913
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
12914
|
-
},
|
|
12915
|
-
"default": "\"m\"",
|
|
12916
|
-
"description": "The size of the spinner.",
|
|
12917
|
-
"fieldName": "size"
|
|
12918
|
-
},
|
|
12919
|
-
{
|
|
12920
|
-
"name": "color",
|
|
12921
|
-
"type": {
|
|
12922
|
-
"text": "string | undefined"
|
|
12923
|
-
},
|
|
12924
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12925
|
-
"fieldName": "color"
|
|
12926
|
-
},
|
|
12927
|
-
{
|
|
12928
|
-
"name": "label",
|
|
12929
|
-
"type": {
|
|
12930
|
-
"text": "string | undefined"
|
|
12931
|
-
},
|
|
12932
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12933
|
-
"fieldName": "label"
|
|
12934
|
-
}
|
|
12935
|
-
],
|
|
12936
|
-
"superclass": {
|
|
12937
|
-
"name": "LitElement",
|
|
12938
|
-
"package": "lit"
|
|
12939
|
-
},
|
|
12940
|
-
"localization": [],
|
|
12941
|
-
"status": "ready",
|
|
12942
|
-
"category": "feedback",
|
|
12943
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for indicating users that their action is being processed.\n- Use the label property to provide an accessible label for the spinner. If no label is supplied, the spinner is hidden from assistive technology.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to show progress. Favor a progress bar instead.\n\n</div>\n",
|
|
12944
|
-
"examples": [],
|
|
12945
|
-
"dependencies": [],
|
|
12946
|
-
"tagName": "nord-spinner",
|
|
12947
|
-
"customElement": true
|
|
12948
|
-
}
|
|
12949
|
-
],
|
|
12950
|
-
"exports": [
|
|
12951
|
-
{
|
|
12952
|
-
"kind": "js",
|
|
12953
|
-
"name": "default",
|
|
12954
|
-
"declaration": {
|
|
12955
|
-
"name": "Spinner",
|
|
12956
|
-
"module": "src/spinner/Spinner.ts"
|
|
12957
|
-
}
|
|
12958
|
-
},
|
|
12959
|
-
{
|
|
12960
|
-
"kind": "custom-element-definition",
|
|
12961
|
-
"name": "nord-spinner",
|
|
12962
|
-
"declaration": {
|
|
12963
|
-
"name": "Spinner",
|
|
12964
|
-
"module": "src/spinner/Spinner.ts"
|
|
12965
|
-
}
|
|
12966
|
-
}
|
|
12967
|
-
]
|
|
12968
|
-
},
|
|
12969
13208
|
{
|
|
12970
13209
|
"kind": "javascript-module",
|
|
12971
13210
|
"path": "src/tab/Tab.ts",
|
|
@@ -13172,7 +13411,8 @@
|
|
|
13172
13411
|
"kind": "field",
|
|
13173
13412
|
"name": "initialSelectedTab",
|
|
13174
13413
|
"privacy": "private",
|
|
13175
|
-
"description": "Get the selected tab button, or the first tab button."
|
|
13414
|
+
"description": "Get the selected tab button, or the first tab button.",
|
|
13415
|
+
"readonly": true
|
|
13176
13416
|
},
|
|
13177
13417
|
{
|
|
13178
13418
|
"kind": "method",
|
|
@@ -13320,18 +13560,170 @@
|
|
|
13320
13560
|
"name": ""
|
|
13321
13561
|
}
|
|
13322
13562
|
],
|
|
13323
|
-
"members": [],
|
|
13563
|
+
"members": [],
|
|
13564
|
+
"superclass": {
|
|
13565
|
+
"name": "LitElement",
|
|
13566
|
+
"package": "lit"
|
|
13567
|
+
},
|
|
13568
|
+
"localization": [],
|
|
13569
|
+
"status": "ready",
|
|
13570
|
+
"category": "navigation",
|
|
13571
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab panel component within the tab group component.\n- Use both non-interactive and interactive elements within the contents of the tab panel.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use the tab panel component outside of the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the related tab component to select the tab but prevent the order of the tabs being affected.\n",
|
|
13572
|
+
"examples": [],
|
|
13573
|
+
"dependencies": [],
|
|
13574
|
+
"tagName": "nord-tab-panel",
|
|
13575
|
+
"customElement": true
|
|
13576
|
+
}
|
|
13577
|
+
],
|
|
13578
|
+
"exports": [
|
|
13579
|
+
{
|
|
13580
|
+
"kind": "js",
|
|
13581
|
+
"name": "default",
|
|
13582
|
+
"declaration": {
|
|
13583
|
+
"name": "TabPanel",
|
|
13584
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
13585
|
+
}
|
|
13586
|
+
},
|
|
13587
|
+
{
|
|
13588
|
+
"kind": "custom-element-definition",
|
|
13589
|
+
"name": "nord-tab-panel",
|
|
13590
|
+
"declaration": {
|
|
13591
|
+
"name": "TabPanel",
|
|
13592
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
13593
|
+
}
|
|
13594
|
+
}
|
|
13595
|
+
]
|
|
13596
|
+
},
|
|
13597
|
+
{
|
|
13598
|
+
"kind": "javascript-module",
|
|
13599
|
+
"path": "src/table/Table.ts",
|
|
13600
|
+
"declarations": [
|
|
13601
|
+
{
|
|
13602
|
+
"kind": "class",
|
|
13603
|
+
"description": "Table is used to organize and display information from a data set.\nProvides table styles in addition to features like sticky\nheaders and support for narrow viewports.",
|
|
13604
|
+
"name": "Table",
|
|
13605
|
+
"cssProperties": [
|
|
13606
|
+
{
|
|
13607
|
+
"description": "Controls the padding around the table cells.",
|
|
13608
|
+
"name": "--n-table-td-padding",
|
|
13609
|
+
"default": "calc(var(--n-space-m) * 0.95)"
|
|
13610
|
+
},
|
|
13611
|
+
{
|
|
13612
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
13613
|
+
"name": "--n-table-border-radius",
|
|
13614
|
+
"default": "var(--n-border-radius-s)"
|
|
13615
|
+
}
|
|
13616
|
+
],
|
|
13617
|
+
"slots": [
|
|
13618
|
+
{
|
|
13619
|
+
"description": "Default slot which holds the HTML `<table>` element.",
|
|
13620
|
+
"name": ""
|
|
13621
|
+
}
|
|
13622
|
+
],
|
|
13623
|
+
"members": [
|
|
13624
|
+
{
|
|
13625
|
+
"kind": "field",
|
|
13626
|
+
"name": "density",
|
|
13627
|
+
"type": {
|
|
13628
|
+
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
13629
|
+
},
|
|
13630
|
+
"default": "\"default\"",
|
|
13631
|
+
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
13632
|
+
"attribute": "density",
|
|
13633
|
+
"reflects": true
|
|
13634
|
+
},
|
|
13635
|
+
{
|
|
13636
|
+
"kind": "field",
|
|
13637
|
+
"name": "scrollSnap",
|
|
13638
|
+
"type": {
|
|
13639
|
+
"text": "boolean"
|
|
13640
|
+
},
|
|
13641
|
+
"default": "false",
|
|
13642
|
+
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
13643
|
+
"attribute": "scroll-snap",
|
|
13644
|
+
"reflects": true
|
|
13645
|
+
},
|
|
13646
|
+
{
|
|
13647
|
+
"kind": "field",
|
|
13648
|
+
"name": "striped",
|
|
13649
|
+
"type": {
|
|
13650
|
+
"text": "boolean"
|
|
13651
|
+
},
|
|
13652
|
+
"default": "false",
|
|
13653
|
+
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
13654
|
+
"attribute": "striped",
|
|
13655
|
+
"reflects": true
|
|
13656
|
+
},
|
|
13657
|
+
{
|
|
13658
|
+
"kind": "method",
|
|
13659
|
+
"name": "renderStyles",
|
|
13660
|
+
"privacy": "private",
|
|
13661
|
+
"description": "renders table styles into nearest root.\nthis is necessary since we do not use shadow dom."
|
|
13662
|
+
},
|
|
13663
|
+
{
|
|
13664
|
+
"kind": "method",
|
|
13665
|
+
"name": "createRenderRoot",
|
|
13666
|
+
"privacy": "protected",
|
|
13667
|
+
"description": "opt out of shadow dom"
|
|
13668
|
+
}
|
|
13669
|
+
],
|
|
13670
|
+
"attributes": [
|
|
13671
|
+
{
|
|
13672
|
+
"name": "density",
|
|
13673
|
+
"type": {
|
|
13674
|
+
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
13675
|
+
},
|
|
13676
|
+
"default": "\"default\"",
|
|
13677
|
+
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
13678
|
+
"fieldName": "density"
|
|
13679
|
+
},
|
|
13680
|
+
{
|
|
13681
|
+
"name": "scroll-snap",
|
|
13682
|
+
"type": {
|
|
13683
|
+
"text": "boolean"
|
|
13684
|
+
},
|
|
13685
|
+
"default": "false",
|
|
13686
|
+
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
13687
|
+
"fieldName": "scrollSnap"
|
|
13688
|
+
},
|
|
13689
|
+
{
|
|
13690
|
+
"name": "striped",
|
|
13691
|
+
"type": {
|
|
13692
|
+
"text": "boolean"
|
|
13693
|
+
},
|
|
13694
|
+
"default": "false",
|
|
13695
|
+
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
13696
|
+
"fieldName": "striped"
|
|
13697
|
+
}
|
|
13698
|
+
],
|
|
13324
13699
|
"superclass": {
|
|
13325
13700
|
"name": "LitElement",
|
|
13326
13701
|
"package": "lit"
|
|
13327
13702
|
},
|
|
13328
13703
|
"localization": [],
|
|
13329
13704
|
"status": "ready",
|
|
13330
|
-
"category": "
|
|
13331
|
-
"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
|
|
13332
|
-
"examples": [
|
|
13705
|
+
"category": "list",
|
|
13706
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when you need to display tabular data in a view.\n- Use a `<table>` element directly within the component.\n- Use inside a [Card](/components/card/?example=with+table), and give the card a header.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to display list data.\n- Don’t use to display basic key and value pairs, consider a [description list](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl) instead.\n- Don’t use tables for layout.\n- Don't use a primary button in every row of a table.\n\n</div>\n\n---\n\n## Content guidelines\n\nHeaders in a table should be clear, accurate and predictable. When writing headers, 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 account</div>\n<div class=\"n-usage n-usage-dont\">User Account</div>\n\nInclude units of measurement symbols in the table header so they aren’t repeated throughout every single column:\n\n<div class=\"n-usage n-usage-do\">Temperature °C</div>\n<div class=\"n-usage n-usage-dont\">Temperature</div>\n\nAvoid unnecessary words and articles in table headers, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Description</div>\n<div class=\"n-usage n-usage-dont\">A description</div>\n\nKeep decimals consistent. For example, don’t use 3 decimals in one row and 2 in others:\n\n<div class=\"n-usage n-usage-do\">30.00<br/>25.00</div>\n<div class=\"n-usage n-usage-dont\">30.000<br/>25.0</div>\n\n---\n\n## Additional considerations\n\n- Nord’s table component acts as a lightweight and un-opinionated _wrapper_ component for enhancing tabular data. It is up to the user of this component to make sure that the table markup they use is accessible.\n- Despite the name the Nord table component does not supplement the HTML `<table>` element. Please ensure that a `<table>` element is a direct descendant of the table component.\n- It’s important to pay close attention to semantics when authoring tables. The markup in the examples can be used as a starting point. However, be aware that [HTML tables have a large feature set](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) which cannot be fully covered in this documentation.\n- When making adjustments to table columns such as width, color, alignment and other styles please consider using the HTML `<col>` and `<colgroup>` elements for applying them. Further information on the `<col>` and `<colgroup>` elements can be [found in the MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/col).\n\n---\n\n## Advanced use-cases\n\nThe table component itself does not provide any functionality, only styles. This works well for simple or static tables, but there are instances where functionality such as sorting, resizing, or column dragging are required. This kind of functionality is out of scope for the table component, as the spectrum of possible use-cases is too broad for a single component to cover effectively. Whilst the table component is limited out of the box, these same limitations make it easy to integrate with third-party libraries which offer advanced functionality.\n\nBroadly speaking, there are two categories of library for building advanced tables: _headless_ and _component-based_.\n\n### Which kind of table library should I use?\n\nEach approach has subtle tradeoffs. Understanding these subtleties will help you make the right decision for your application and team.\n\n#### Component-based Table Libraries\n\nComponent-based table libraries will typically supply you with a feature-rich drop-in solution, and ready-to-use components/markup complete with styles/theming.\n\n**Pros:**\n\n- Ship with ready-to-use markup/styles.\n- Little setup required.\n- Turn-key experience.\n\n**Cons:**\n\n- Less control over markup.\n- Custom styles are typically theme-based.\n- Larger bundle-sizes.\n\nIf you want a ready-to-use table and design/bundle-size are not hard requirements, then you should consider using a component-based table library.\n\n#### Headless Table Libraries\n\nHeadless table libraries will typically supply you with functions, state, utilities and event listeners to build your own table markup or attach to existing table markups.\n\n**Pros:**\n\n- Full control over markup and styles.\n- Supports all styling patterns (CSS, CSS-in-JS, UI libraries, etc).\n- Smaller bundle-sizes.\n\n**Cons:**\n\n- More setup and effort required.\n- No markup, styles or themes provided.\n\nIf you want a lighter-weight table or full control over the design, then you should consider using a headless table library.\n\n### Recommendation for headless libraries\n\nIn the headless category, we recommend [Tanstack Table](https://tanstack.com/table/). Tanstack table offers integrations for many UI frameworks, such as Vue and React. It is easy to work with, and because it does not bring any HTML or styles itself, you can use it to render a plain, semantic `<table>` wrapped in a `<nord-table>`, and you will get all the necessary styles.\n\nWe have created examples in both Vue and React, showing how to combine Tanstack table with Nord's table component, in order to build a table with both sorting and resizable columns. Check out the [React example](/components/table/?example=with+react+and+tanstack+table) and likewise the [Vue example](/components/table/?example=with+vue+and+tanstack+table).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / Tanstack table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / Tanstack table source\n </nord-button>\n</nord-stack>\n\n### Recommendation for component-based libraries\n\nIn the component-based category, we recommend [AG Grid](https://www.ag-grid.com/), specifically the community edition. AG Grid is feature-rich, has extensive documentation, and offers integrations for many UI frameworks, such as Vue and React. AG Grid takes control of all rendering and output, but offers extension points for taking control of some aspects. It does not output a `<table>` element, so it cannot be used with Nord's own table component.\n\nHowever it can be styled via themes, and we have created a Nord theme using our design tokens. The theme is published on npm as `@nordhealth/ag-theme-nord`. To use the theme, include the CSS in your project and add the class `ag-theme-nord` to the element wrapping AG Grid.\n\nWe have created examples in both Vue and React showing how to combine AG Grid with Nord's theme, in order to build a table with sorting, resizable columns, draggable and re-orderable columns, plus sticky/pinned columns. Check out the [React example](/components/table/?example=with+react+and+ag+grid) and likewise the [Vue example](/components/table/?example=with+vue+and+ag+grid).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l n-margin-be-s\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / AG Grid table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / AG Grid table source\n </nord-button>\n</nord-stack>\n",
|
|
13707
|
+
"examples": [
|
|
13708
|
+
{
|
|
13709
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
13710
|
+
"name": "with react and tanstack table"
|
|
13711
|
+
},
|
|
13712
|
+
{
|
|
13713
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
13714
|
+
"name": "with react and ag grid"
|
|
13715
|
+
},
|
|
13716
|
+
{
|
|
13717
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
13718
|
+
"name": "with vue and tanstack table"
|
|
13719
|
+
},
|
|
13720
|
+
{
|
|
13721
|
+
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
13722
|
+
"name": "with vue and ag grid"
|
|
13723
|
+
}
|
|
13724
|
+
],
|
|
13333
13725
|
"dependencies": [],
|
|
13334
|
-
"tagName": "nord-
|
|
13726
|
+
"tagName": "nord-table",
|
|
13335
13727
|
"customElement": true
|
|
13336
13728
|
}
|
|
13337
13729
|
],
|
|
@@ -13340,16 +13732,16 @@
|
|
|
13340
13732
|
"kind": "js",
|
|
13341
13733
|
"name": "default",
|
|
13342
13734
|
"declaration": {
|
|
13343
|
-
"name": "
|
|
13344
|
-
"module": "src/
|
|
13735
|
+
"name": "Table",
|
|
13736
|
+
"module": "src/table/Table.ts"
|
|
13345
13737
|
}
|
|
13346
13738
|
},
|
|
13347
13739
|
{
|
|
13348
13740
|
"kind": "custom-element-definition",
|
|
13349
|
-
"name": "nord-
|
|
13741
|
+
"name": "nord-table",
|
|
13350
13742
|
"declaration": {
|
|
13351
|
-
"name": "
|
|
13352
|
-
"module": "src/
|
|
13743
|
+
"name": "Table",
|
|
13744
|
+
"module": "src/table/Table.ts"
|
|
13353
13745
|
}
|
|
13354
13746
|
}
|
|
13355
13747
|
]
|
|
@@ -13551,6 +13943,7 @@
|
|
|
13551
13943
|
"kind": "field",
|
|
13552
13944
|
"name": "formValue",
|
|
13553
13945
|
"privacy": "protected",
|
|
13946
|
+
"readonly": true,
|
|
13554
13947
|
"inheritedFrom": {
|
|
13555
13948
|
"name": "FormAssociatedMixin",
|
|
13556
13949
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -13760,6 +14153,7 @@
|
|
|
13760
14153
|
"kind": "field",
|
|
13761
14154
|
"name": "hasHint",
|
|
13762
14155
|
"privacy": "protected",
|
|
14156
|
+
"readonly": true,
|
|
13763
14157
|
"inheritedFrom": {
|
|
13764
14158
|
"name": "FormAssociatedMixin",
|
|
13765
14159
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -13769,6 +14163,7 @@
|
|
|
13769
14163
|
"kind": "field",
|
|
13770
14164
|
"name": "hasError",
|
|
13771
14165
|
"privacy": "protected",
|
|
14166
|
+
"readonly": true,
|
|
13772
14167
|
"inheritedFrom": {
|
|
13773
14168
|
"name": "FormAssociatedMixin",
|
|
13774
14169
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -13849,6 +14244,7 @@
|
|
|
13849
14244
|
"kind": "field",
|
|
13850
14245
|
"name": "form",
|
|
13851
14246
|
"description": "Gets the form, if any, associated with the form element.",
|
|
14247
|
+
"readonly": true,
|
|
13852
14248
|
"inheritedFrom": {
|
|
13853
14249
|
"name": "InputMixin",
|
|
13854
14250
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -14125,227 +14521,51 @@
|
|
|
14125
14521
|
"module": "/src/common/mixins/InputMixin.js"
|
|
14126
14522
|
},
|
|
14127
14523
|
{
|
|
14128
|
-
"name": "FocusableMixin",
|
|
14129
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
14130
|
-
}
|
|
14131
|
-
],
|
|
14132
|
-
"superclass": {
|
|
14133
|
-
"name": "LitElement",
|
|
14134
|
-
"package": "lit"
|
|
14135
|
-
},
|
|
14136
|
-
"localization": [
|
|
14137
|
-
{
|
|
14138
|
-
"name": "remainingCharacters",
|
|
14139
|
-
"description": "A function which receives the number of remaining characters and returns a string to be used as the aria-live message."
|
|
14140
|
-
}
|
|
14141
|
-
],
|
|
14142
|
-
"status": "ready",
|
|
14143
|
-
"category": "form",
|
|
14144
|
-
"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 allow text input where the expected input is long.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when the expected text input is short. Use input component instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nTextarea labels act as a title for the text field. Labels should typically be short and in noun form:\n\n<div class=\"n-usage n-usage-do\">Company name</div>\n<div class=\"n-usage n-usage-dont\">What is your company name?</div>\n\nWhen writing textarea 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\">Provide description</div>\n<div class=\"n-usage n-usage-dont\">Provide Description</div>\n\nWhen a textarea isn’t part of a form and is placed individually on a page, you could provide the textarea label as a call to action:\n\n<div class=\"n-usage n-usage-do\">Leave a comment</div>\n<div class=\"n-usage n-usage-dont\">Comment</div>\n\nDo not use colons in textarea labels:\n\n<div class=\"n-usage n-usage-do\">Provide description</div>\n<div class=\"n-usage n-usage-dont\">Provide description:</div>\n",
|
|
14145
|
-
"examples": [],
|
|
14146
|
-
"dependencies": [],
|
|
14147
|
-
"tagName": "nord-textarea",
|
|
14148
|
-
"customElement": true,
|
|
14149
|
-
"events": [
|
|
14150
|
-
{
|
|
14151
|
-
"name": "input",
|
|
14152
|
-
"type": {
|
|
14153
|
-
"text": "NordEvent"
|
|
14154
|
-
},
|
|
14155
|
-
"description": "Fired as the user types into the input.",
|
|
14156
|
-
"inheritedFrom": {
|
|
14157
|
-
"name": "FormAssociatedMixin",
|
|
14158
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
14159
|
-
}
|
|
14160
|
-
},
|
|
14161
|
-
{
|
|
14162
|
-
"name": "change",
|
|
14163
|
-
"type": {
|
|
14164
|
-
"text": "NordEvent"
|
|
14165
|
-
},
|
|
14166
|
-
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
14167
|
-
"inheritedFrom": {
|
|
14168
|
-
"name": "FormAssociatedMixin",
|
|
14169
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
14170
|
-
}
|
|
14171
|
-
}
|
|
14172
|
-
]
|
|
14173
|
-
}
|
|
14174
|
-
],
|
|
14175
|
-
"exports": [
|
|
14176
|
-
{
|
|
14177
|
-
"kind": "js",
|
|
14178
|
-
"name": "default",
|
|
14179
|
-
"declaration": {
|
|
14180
|
-
"name": "Textarea",
|
|
14181
|
-
"module": "src/textarea/Textarea.ts"
|
|
14182
|
-
}
|
|
14183
|
-
},
|
|
14184
|
-
{
|
|
14185
|
-
"kind": "custom-element-definition",
|
|
14186
|
-
"name": "nord-textarea",
|
|
14187
|
-
"declaration": {
|
|
14188
|
-
"name": "Textarea",
|
|
14189
|
-
"module": "src/textarea/Textarea.ts"
|
|
14190
|
-
}
|
|
14191
|
-
}
|
|
14192
|
-
]
|
|
14193
|
-
},
|
|
14194
|
-
{
|
|
14195
|
-
"kind": "javascript-module",
|
|
14196
|
-
"path": "src/textarea/localization.ts",
|
|
14197
|
-
"declarations": [
|
|
14198
|
-
{
|
|
14199
|
-
"kind": "variable",
|
|
14200
|
-
"name": "localization",
|
|
14201
|
-
"type": {
|
|
14202
|
-
"text": "object"
|
|
14203
|
-
},
|
|
14204
|
-
"default": "{\n remainingCharacters: (remainder: number) => `Characters remaining: ${remainder}`,\n}"
|
|
14205
|
-
}
|
|
14206
|
-
],
|
|
14207
|
-
"exports": [
|
|
14208
|
-
{
|
|
14209
|
-
"kind": "js",
|
|
14210
|
-
"name": "default",
|
|
14211
|
-
"declaration": {
|
|
14212
|
-
"name": "localization",
|
|
14213
|
-
"module": "src/textarea/localization.ts"
|
|
14214
|
-
}
|
|
14215
|
-
}
|
|
14216
|
-
]
|
|
14217
|
-
},
|
|
14218
|
-
{
|
|
14219
|
-
"kind": "javascript-module",
|
|
14220
|
-
"path": "src/table/Table.ts",
|
|
14221
|
-
"declarations": [
|
|
14222
|
-
{
|
|
14223
|
-
"kind": "class",
|
|
14224
|
-
"description": "Table is used to organize and display information from a data set.\nProvides table styles in addition to features like sticky\nheaders and support for narrow viewports.",
|
|
14225
|
-
"name": "Table",
|
|
14226
|
-
"cssProperties": [
|
|
14227
|
-
{
|
|
14228
|
-
"description": "Controls the padding around the table cells.",
|
|
14229
|
-
"name": "--n-table-td-padding",
|
|
14230
|
-
"default": "calc(var(--n-space-m) * 0.95)"
|
|
14231
|
-
},
|
|
14232
|
-
{
|
|
14233
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
14234
|
-
"name": "--n-table-border-radius",
|
|
14235
|
-
"default": "var(--n-border-radius-s)"
|
|
14236
|
-
}
|
|
14237
|
-
],
|
|
14238
|
-
"slots": [
|
|
14239
|
-
{
|
|
14240
|
-
"description": "Default slot which holds the HTML `<table>` element.",
|
|
14241
|
-
"name": ""
|
|
14242
|
-
}
|
|
14243
|
-
],
|
|
14244
|
-
"members": [
|
|
14245
|
-
{
|
|
14246
|
-
"kind": "field",
|
|
14247
|
-
"name": "density",
|
|
14248
|
-
"type": {
|
|
14249
|
-
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
14250
|
-
},
|
|
14251
|
-
"default": "\"default\"",
|
|
14252
|
-
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
14253
|
-
"attribute": "density",
|
|
14254
|
-
"reflects": true
|
|
14255
|
-
},
|
|
14256
|
-
{
|
|
14257
|
-
"kind": "field",
|
|
14258
|
-
"name": "scrollSnap",
|
|
14259
|
-
"type": {
|
|
14260
|
-
"text": "boolean"
|
|
14261
|
-
},
|
|
14262
|
-
"default": "false",
|
|
14263
|
-
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
14264
|
-
"attribute": "scroll-snap",
|
|
14265
|
-
"reflects": true
|
|
14266
|
-
},
|
|
14267
|
-
{
|
|
14268
|
-
"kind": "field",
|
|
14269
|
-
"name": "striped",
|
|
14270
|
-
"type": {
|
|
14271
|
-
"text": "boolean"
|
|
14272
|
-
},
|
|
14273
|
-
"default": "false",
|
|
14274
|
-
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
14275
|
-
"attribute": "striped",
|
|
14276
|
-
"reflects": true
|
|
14277
|
-
},
|
|
14278
|
-
{
|
|
14279
|
-
"kind": "method",
|
|
14280
|
-
"name": "renderStyles",
|
|
14281
|
-
"privacy": "private",
|
|
14282
|
-
"description": "renders table styles into nearest root.\nthis is necessary since we do not use shadow dom."
|
|
14283
|
-
},
|
|
14284
|
-
{
|
|
14285
|
-
"kind": "method",
|
|
14286
|
-
"name": "createRenderRoot",
|
|
14287
|
-
"privacy": "protected",
|
|
14288
|
-
"description": "opt out of shadow dom"
|
|
14289
|
-
}
|
|
14290
|
-
],
|
|
14291
|
-
"attributes": [
|
|
14292
|
-
{
|
|
14293
|
-
"name": "density",
|
|
14294
|
-
"type": {
|
|
14295
|
-
"text": "\"condensed\" | \"default\" | \"relaxed\""
|
|
14296
|
-
},
|
|
14297
|
-
"default": "\"default\"",
|
|
14298
|
-
"description": "Controls the density of the table's rows and headers.\nRelaxed increases space, condensed reduces space.",
|
|
14299
|
-
"fieldName": "density"
|
|
14300
|
-
},
|
|
14301
|
-
{
|
|
14302
|
-
"name": "scroll-snap",
|
|
14303
|
-
"type": {
|
|
14304
|
-
"text": "boolean"
|
|
14305
|
-
},
|
|
14306
|
-
"default": "false",
|
|
14307
|
-
"description": "Enables scroll-snapping, meaning the scroll position is always column-aligned.",
|
|
14308
|
-
"fieldName": "scrollSnap"
|
|
14309
|
-
},
|
|
14310
|
-
{
|
|
14311
|
-
"name": "striped",
|
|
14312
|
-
"type": {
|
|
14313
|
-
"text": "boolean"
|
|
14314
|
-
},
|
|
14315
|
-
"default": "false",
|
|
14316
|
-
"description": "Controls whether to use zebra striping on tables, which can improve readability.",
|
|
14317
|
-
"fieldName": "striped"
|
|
14318
|
-
}
|
|
14319
|
-
],
|
|
14320
|
-
"superclass": {
|
|
14321
|
-
"name": "LitElement",
|
|
14322
|
-
"package": "lit"
|
|
14323
|
-
},
|
|
14324
|
-
"localization": [],
|
|
14325
|
-
"status": "ready",
|
|
14326
|
-
"category": "list",
|
|
14327
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when you need to display tabular data in a view.\n- Use a `<table>` element directly within the component.\n- Use inside a [Card](/components/card/?example=with+table), and give the card a header.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use to display list data.\n- Don’t use to display basic key and value pairs, consider a [description list](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl) instead.\n- Don’t use tables for layout.\n- Don't use a primary button in every row of a table.\n\n</div>\n\n---\n\n## Content guidelines\n\nHeaders in a table should be clear, accurate and predictable. When writing headers, 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 account</div>\n<div class=\"n-usage n-usage-dont\">User Account</div>\n\nInclude units of measurement symbols in the table header so they aren’t repeated throughout every single column:\n\n<div class=\"n-usage n-usage-do\">Temperature °C</div>\n<div class=\"n-usage n-usage-dont\">Temperature</div>\n\nAvoid unnecessary words and articles in table headers, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Description</div>\n<div class=\"n-usage n-usage-dont\">A description</div>\n\nKeep decimals consistent. For example, don’t use 3 decimals in one row and 2 in others:\n\n<div class=\"n-usage n-usage-do\">30.00<br/>25.00</div>\n<div class=\"n-usage n-usage-dont\">30.000<br/>25.0</div>\n\n---\n\n## Additional considerations\n\n- Nord’s table component acts as a lightweight and un-opinionated _wrapper_ component for enhancing tabular data. It is up to the user of this component to make sure that the table markup they use is accessible.\n- Despite the name the Nord table component does not supplement the HTML `<table>` element. Please ensure that a `<table>` element is a direct descendant of the table component.\n- It’s important to pay close attention to semantics when authoring tables. The markup in the examples can be used as a starting point. However, be aware that [HTML tables have a large feature set](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) which cannot be fully covered in this documentation.\n- When making adjustments to table columns such as width, color, alignment and other styles please consider using the HTML `<col>` and `<colgroup>` elements for applying them. Further information on the `<col>` and `<colgroup>` elements can be [found in the MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/col).\n\n---\n\n## Advanced use-cases\n\nThe table component itself does not provide any functionality, only styles. This works well for simple or static tables, but there are instances where functionality such as sorting, resizing, or column dragging are required. This kind of functionality is out of scope for the table component, as the spectrum of possible use-cases is too broad for a single component to cover effectively. Whilst the table component is limited out of the box, these same limitations make it easy to integrate with third-party libraries which offer advanced functionality.\n\nBroadly speaking, there are two categories of library for building advanced tables: _headless_ and _component-based_.\n\n### Which kind of table library should I use?\n\nEach approach has subtle tradeoffs. Understanding these subtleties will help you make the right decision for your application and team.\n\n#### Component-based Table Libraries\n\nComponent-based table libraries will typically supply you with a feature-rich drop-in solution, and ready-to-use components/markup complete with styles/theming.\n\n**Pros:**\n\n- Ship with ready-to-use markup/styles.\n- Little setup required.\n- Turn-key experience.\n\n**Cons:**\n\n- Less control over markup.\n- Custom styles are typically theme-based.\n- Larger bundle-sizes.\n\nIf you want a ready-to-use table and design/bundle-size are not hard requirements, then you should consider using a component-based table library.\n\n#### Headless Table Libraries\n\nHeadless table libraries will typically supply you with functions, state, utilities and event listeners to build your own table markup or attach to existing table markups.\n\n**Pros:**\n\n- Full control over markup and styles.\n- Supports all styling patterns (CSS, CSS-in-JS, UI libraries, etc).\n- Smaller bundle-sizes.\n\n**Cons:**\n\n- More setup and effort required.\n- No markup, styles or themes provided.\n\nIf you want a lighter-weight table or full control over the design, then you should consider using a headless table library.\n\n### Recommendation for headless libraries\n\nIn the headless category, we recommend [Tanstack Table](https://tanstack.com/table/). Tanstack table offers integrations for many UI frameworks, such as Vue and React. It is easy to work with, and because it does not bring any HTML or styles itself, you can use it to render a plain, semantic `<table>` wrapped in a `<nord-table>`, and you will get all the necessary styles.\n\nWe have created examples in both Vue and React, showing how to combine Tanstack table with Nord's table component, in order to build a table with both sorting and resizable columns. Check out the [React example](/components/table/?example=with+react+and+tanstack+table) and likewise the [Vue example](/components/table/?example=with+vue+and+tanstack+table).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / Tanstack table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / Tanstack table source\n </nord-button>\n</nord-stack>\n\n### Recommendation for component-based libraries\n\nIn the component-based category, we recommend [AG Grid](https://www.ag-grid.com/), specifically the community edition. AG Grid is feature-rich, has extensive documentation, and offers integrations for many UI frameworks, such as Vue and React. AG Grid takes control of all rendering and output, but offers extension points for taking control of some aspects. It does not output a `<table>` element, so it cannot be used with Nord's own table component.\n\nHowever it can be styled via themes, and we have created a Nord theme using our design tokens. The theme is published on npm as `@nordhealth/ag-theme-nord`. To use the theme, include the CSS in your project and add the class `ag-theme-nord` to the element wrapping AG Grid.\n\nWe have created examples in both Vue and React showing how to combine AG Grid with Nord's theme, in order to build a table with sorting, resizable columns, draggable and re-orderable columns, plus sticky/pinned columns. Check out the [React example](/components/table/?example=with+react+and+ag+grid) and likewise the [Vue example](/components/table/?example=with+vue+and+ag+grid).\n\n<nord-stack direction=\"horizontal\" class=\"n-margin-bs-l n-margin-be-s\">\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n React / AG Grid table source\n </nord-button>\n <nord-button href=\"https://github.com/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid\" target=\"_blank\">\n <nord-icon name=\"generic-github\" size=\"s\" slot=\"start\"></nord-icon>\n Vue / AG Grid table source\n </nord-button>\n</nord-stack>\n",
|
|
14328
|
-
"examples": [
|
|
14329
|
-
{
|
|
14330
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-tanstack-table?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
14331
|
-
"name": "with react and tanstack table"
|
|
14332
|
-
},
|
|
14333
|
-
{
|
|
14334
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-react-ag-grid?embed=1&file=src/DataTable/DataTable.tsx&hideNavigation=1&view=preview",
|
|
14335
|
-
"name": "with react and ag grid"
|
|
14336
|
-
},
|
|
14337
|
-
{
|
|
14338
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-tanstack-table?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
14339
|
-
"name": "with vue and tanstack table"
|
|
14340
|
-
},
|
|
14341
|
-
{
|
|
14342
|
-
"url": "https://stackblitz.com/github/nordhealth/advanced-table-examples/tree/main/nord-vue-ag-grid?embed=1&file=src/components/DataTable/DataTable.vue&hideNavigation=1&view=preview",
|
|
14343
|
-
"name": "with vue and ag grid"
|
|
14524
|
+
"name": "FocusableMixin",
|
|
14525
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
14526
|
+
}
|
|
14527
|
+
],
|
|
14528
|
+
"superclass": {
|
|
14529
|
+
"name": "LitElement",
|
|
14530
|
+
"package": "lit"
|
|
14531
|
+
},
|
|
14532
|
+
"localization": [
|
|
14533
|
+
{
|
|
14534
|
+
"name": "remainingCharacters",
|
|
14535
|
+
"description": "A function which receives the number of remaining characters and returns a string to be used as the aria-live message."
|
|
14344
14536
|
}
|
|
14345
14537
|
],
|
|
14538
|
+
"status": "ready",
|
|
14539
|
+
"category": "form",
|
|
14540
|
+
"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 allow text input where the expected input is long.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when the expected text input is short. Use input component instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nTextarea labels act as a title for the text field. Labels should typically be short and in noun form:\n\n<div class=\"n-usage n-usage-do\">Company name</div>\n<div class=\"n-usage n-usage-dont\">What is your company name?</div>\n\nWhen writing textarea 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\">Provide description</div>\n<div class=\"n-usage n-usage-dont\">Provide Description</div>\n\nWhen a textarea isn’t part of a form and is placed individually on a page, you could provide the textarea label as a call to action:\n\n<div class=\"n-usage n-usage-do\">Leave a comment</div>\n<div class=\"n-usage n-usage-dont\">Comment</div>\n\nDo not use colons in textarea labels:\n\n<div class=\"n-usage n-usage-do\">Provide description</div>\n<div class=\"n-usage n-usage-dont\">Provide description:</div>\n",
|
|
14541
|
+
"examples": [],
|
|
14346
14542
|
"dependencies": [],
|
|
14347
|
-
"tagName": "nord-
|
|
14348
|
-
"customElement": true
|
|
14543
|
+
"tagName": "nord-textarea",
|
|
14544
|
+
"customElement": true,
|
|
14545
|
+
"events": [
|
|
14546
|
+
{
|
|
14547
|
+
"name": "input",
|
|
14548
|
+
"type": {
|
|
14549
|
+
"text": "NordEvent"
|
|
14550
|
+
},
|
|
14551
|
+
"description": "Fired as the user types into the input.",
|
|
14552
|
+
"inheritedFrom": {
|
|
14553
|
+
"name": "FormAssociatedMixin",
|
|
14554
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
14555
|
+
}
|
|
14556
|
+
},
|
|
14557
|
+
{
|
|
14558
|
+
"name": "change",
|
|
14559
|
+
"type": {
|
|
14560
|
+
"text": "NordEvent"
|
|
14561
|
+
},
|
|
14562
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
14563
|
+
"inheritedFrom": {
|
|
14564
|
+
"name": "FormAssociatedMixin",
|
|
14565
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
14566
|
+
}
|
|
14567
|
+
}
|
|
14568
|
+
]
|
|
14349
14569
|
}
|
|
14350
14570
|
],
|
|
14351
14571
|
"exports": [
|
|
@@ -14353,16 +14573,40 @@
|
|
|
14353
14573
|
"kind": "js",
|
|
14354
14574
|
"name": "default",
|
|
14355
14575
|
"declaration": {
|
|
14356
|
-
"name": "
|
|
14357
|
-
"module": "src/
|
|
14576
|
+
"name": "Textarea",
|
|
14577
|
+
"module": "src/textarea/Textarea.ts"
|
|
14358
14578
|
}
|
|
14359
14579
|
},
|
|
14360
14580
|
{
|
|
14361
14581
|
"kind": "custom-element-definition",
|
|
14362
|
-
"name": "nord-
|
|
14582
|
+
"name": "nord-textarea",
|
|
14363
14583
|
"declaration": {
|
|
14364
|
-
"name": "
|
|
14365
|
-
"module": "src/
|
|
14584
|
+
"name": "Textarea",
|
|
14585
|
+
"module": "src/textarea/Textarea.ts"
|
|
14586
|
+
}
|
|
14587
|
+
}
|
|
14588
|
+
]
|
|
14589
|
+
},
|
|
14590
|
+
{
|
|
14591
|
+
"kind": "javascript-module",
|
|
14592
|
+
"path": "src/textarea/localization.ts",
|
|
14593
|
+
"declarations": [
|
|
14594
|
+
{
|
|
14595
|
+
"kind": "variable",
|
|
14596
|
+
"name": "localization",
|
|
14597
|
+
"type": {
|
|
14598
|
+
"text": "object"
|
|
14599
|
+
},
|
|
14600
|
+
"default": "{\n remainingCharacters: (remainder: number) => `Characters remaining: ${remainder}`,\n}"
|
|
14601
|
+
}
|
|
14602
|
+
],
|
|
14603
|
+
"exports": [
|
|
14604
|
+
{
|
|
14605
|
+
"kind": "js",
|
|
14606
|
+
"name": "default",
|
|
14607
|
+
"declaration": {
|
|
14608
|
+
"name": "localization",
|
|
14609
|
+
"module": "src/textarea/localization.ts"
|
|
14366
14610
|
}
|
|
14367
14611
|
}
|
|
14368
14612
|
]
|
|
@@ -14627,6 +14871,7 @@
|
|
|
14627
14871
|
"kind": "field",
|
|
14628
14872
|
"name": "formValue",
|
|
14629
14873
|
"privacy": "protected",
|
|
14874
|
+
"readonly": true,
|
|
14630
14875
|
"inheritedFrom": {
|
|
14631
14876
|
"name": "FormAssociatedMixin",
|
|
14632
14877
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -14925,6 +15170,7 @@
|
|
|
14925
15170
|
"kind": "field",
|
|
14926
15171
|
"name": "hasHint",
|
|
14927
15172
|
"privacy": "protected",
|
|
15173
|
+
"readonly": true,
|
|
14928
15174
|
"inheritedFrom": {
|
|
14929
15175
|
"name": "FormAssociatedMixin",
|
|
14930
15176
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -14934,6 +15180,7 @@
|
|
|
14934
15180
|
"kind": "field",
|
|
14935
15181
|
"name": "hasError",
|
|
14936
15182
|
"privacy": "protected",
|
|
15183
|
+
"readonly": true,
|
|
14937
15184
|
"inheritedFrom": {
|
|
14938
15185
|
"name": "FormAssociatedMixin",
|
|
14939
15186
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -14985,6 +15232,7 @@
|
|
|
14985
15232
|
"kind": "field",
|
|
14986
15233
|
"name": "form",
|
|
14987
15234
|
"description": "Gets the form, if any, associated with the form element.",
|
|
15235
|
+
"readonly": true,
|
|
14988
15236
|
"inheritedFrom": {
|
|
14989
15237
|
"name": "InputMixin",
|
|
14990
15238
|
"module": "src/common/mixins/InputMixin.ts"
|
|
@@ -15526,6 +15774,79 @@
|
|
|
15526
15774
|
}
|
|
15527
15775
|
]
|
|
15528
15776
|
},
|
|
15777
|
+
{
|
|
15778
|
+
"kind": "javascript-module",
|
|
15779
|
+
"path": "src/top-bar/TopBar.ts",
|
|
15780
|
+
"declarations": [
|
|
15781
|
+
{
|
|
15782
|
+
"kind": "class",
|
|
15783
|
+
"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.",
|
|
15784
|
+
"name": "TopBar",
|
|
15785
|
+
"slots": [
|
|
15786
|
+
{
|
|
15787
|
+
"description": "Used for the main content of the top bar. We recommend placing your application’s global search functionality into this slot.",
|
|
15788
|
+
"name": ""
|
|
15789
|
+
},
|
|
15790
|
+
{
|
|
15791
|
+
"description": "Optional slot for menus, buttons, toggles, etc.",
|
|
15792
|
+
"name": "end"
|
|
15793
|
+
}
|
|
15794
|
+
],
|
|
15795
|
+
"members": [
|
|
15796
|
+
{
|
|
15797
|
+
"kind": "field",
|
|
15798
|
+
"name": "_warningLogged",
|
|
15799
|
+
"type": {
|
|
15800
|
+
"text": "boolean"
|
|
15801
|
+
},
|
|
15802
|
+
"privacy": "private",
|
|
15803
|
+
"static": true,
|
|
15804
|
+
"default": "false",
|
|
15805
|
+
"inheritedFrom": {
|
|
15806
|
+
"name": "DraftComponentMixin",
|
|
15807
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
15808
|
+
}
|
|
15809
|
+
}
|
|
15810
|
+
],
|
|
15811
|
+
"mixins": [
|
|
15812
|
+
{
|
|
15813
|
+
"name": "DraftComponentMixin",
|
|
15814
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
15815
|
+
}
|
|
15816
|
+
],
|
|
15817
|
+
"superclass": {
|
|
15818
|
+
"name": "LitElement",
|
|
15819
|
+
"package": "lit"
|
|
15820
|
+
},
|
|
15821
|
+
"localization": [],
|
|
15822
|
+
"status": "draft",
|
|
15823
|
+
"category": "structure",
|
|
15824
|
+
"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",
|
|
15825
|
+
"examples": [],
|
|
15826
|
+
"dependencies": [],
|
|
15827
|
+
"tagName": "nord-top-bar",
|
|
15828
|
+
"customElement": true
|
|
15829
|
+
}
|
|
15830
|
+
],
|
|
15831
|
+
"exports": [
|
|
15832
|
+
{
|
|
15833
|
+
"kind": "js",
|
|
15834
|
+
"name": "default",
|
|
15835
|
+
"declaration": {
|
|
15836
|
+
"name": "TopBar",
|
|
15837
|
+
"module": "src/top-bar/TopBar.ts"
|
|
15838
|
+
}
|
|
15839
|
+
},
|
|
15840
|
+
{
|
|
15841
|
+
"kind": "custom-element-definition",
|
|
15842
|
+
"name": "nord-top-bar",
|
|
15843
|
+
"declaration": {
|
|
15844
|
+
"name": "TopBar",
|
|
15845
|
+
"module": "src/top-bar/TopBar.ts"
|
|
15846
|
+
}
|
|
15847
|
+
}
|
|
15848
|
+
]
|
|
15849
|
+
},
|
|
15529
15850
|
{
|
|
15530
15851
|
"kind": "javascript-module",
|
|
15531
15852
|
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
@@ -15604,15 +15925,18 @@
|
|
|
15604
15925
|
"name": "dir",
|
|
15605
15926
|
"type": {
|
|
15606
15927
|
"text": "WritingDirection"
|
|
15607
|
-
}
|
|
15928
|
+
},
|
|
15929
|
+
"readonly": true
|
|
15608
15930
|
},
|
|
15609
15931
|
{
|
|
15610
15932
|
"kind": "field",
|
|
15611
|
-
"name": "isLTR"
|
|
15933
|
+
"name": "isLTR",
|
|
15934
|
+
"readonly": true
|
|
15612
15935
|
},
|
|
15613
15936
|
{
|
|
15614
15937
|
"kind": "field",
|
|
15615
|
-
"name": "isRTL"
|
|
15938
|
+
"name": "isRTL",
|
|
15939
|
+
"readonly": true
|
|
15616
15940
|
},
|
|
15617
15941
|
{
|
|
15618
15942
|
"kind": "method",
|
|
@@ -15688,7 +16012,7 @@
|
|
|
15688
16012
|
{
|
|
15689
16013
|
"name": "listener",
|
|
15690
16014
|
"type": {
|
|
15691
|
-
"text": "(this: Window, ev: WindowEventMap[K]) =>
|
|
16015
|
+
"text": "(this: Window, ev: WindowEventMap[K]) => void"
|
|
15692
16016
|
}
|
|
15693
16017
|
},
|
|
15694
16018
|
{
|
|
@@ -15724,7 +16048,7 @@
|
|
|
15724
16048
|
{
|
|
15725
16049
|
"name": "listener",
|
|
15726
16050
|
"type": {
|
|
15727
|
-
"text": "(this: Document, ev: DocumentEventMap[K]) =>
|
|
16051
|
+
"text": "(this: Document, ev: DocumentEventMap[K]) => void"
|
|
15728
16052
|
}
|
|
15729
16053
|
},
|
|
15730
16054
|
{
|
|
@@ -15760,7 +16084,7 @@
|
|
|
15760
16084
|
{
|
|
15761
16085
|
"name": "listener",
|
|
15762
16086
|
"type": {
|
|
15763
|
-
"text": "(this: HTMLElement, ev: HTMLElementEventMap[K]) =>
|
|
16087
|
+
"text": "(this: HTMLElement, ev: HTMLElementEventMap[K]) => void"
|
|
15764
16088
|
}
|
|
15765
16089
|
},
|
|
15766
16090
|
{
|
|
@@ -15796,7 +16120,7 @@
|
|
|
15796
16120
|
{
|
|
15797
16121
|
"name": "listener",
|
|
15798
16122
|
"type": {
|
|
15799
|
-
"text": "(this: ShadowRoot, ev: ShadowRootEventMap[K]) =>
|
|
16123
|
+
"text": "(this: ShadowRoot, ev: ShadowRootEventMap[K]) => void"
|
|
15800
16124
|
}
|
|
15801
16125
|
},
|
|
15802
16126
|
{
|
|
@@ -15832,7 +16156,43 @@
|
|
|
15832
16156
|
{
|
|
15833
16157
|
"name": "listener",
|
|
15834
16158
|
"type": {
|
|
15835
|
-
"text": "(this: ShadowRoot, ev: MediaQueryListEventMap[K]) =>
|
|
16159
|
+
"text": "(this: ShadowRoot, ev: MediaQueryListEventMap[K]) => void"
|
|
16160
|
+
}
|
|
16161
|
+
},
|
|
16162
|
+
{
|
|
16163
|
+
"name": "options",
|
|
16164
|
+
"optional": true,
|
|
16165
|
+
"type": {
|
|
16166
|
+
"text": "boolean | AddEventListenerOptions"
|
|
16167
|
+
}
|
|
16168
|
+
}
|
|
16169
|
+
]
|
|
16170
|
+
},
|
|
16171
|
+
{
|
|
16172
|
+
"kind": "method",
|
|
16173
|
+
"name": "listen",
|
|
16174
|
+
"return": {
|
|
16175
|
+
"type": {
|
|
16176
|
+
"text": "void"
|
|
16177
|
+
}
|
|
16178
|
+
},
|
|
16179
|
+
"parameters": [
|
|
16180
|
+
{
|
|
16181
|
+
"name": "element",
|
|
16182
|
+
"type": {
|
|
16183
|
+
"text": "EventTarget"
|
|
16184
|
+
}
|
|
16185
|
+
},
|
|
16186
|
+
{
|
|
16187
|
+
"name": "type",
|
|
16188
|
+
"type": {
|
|
16189
|
+
"text": "string"
|
|
16190
|
+
}
|
|
16191
|
+
},
|
|
16192
|
+
{
|
|
16193
|
+
"name": "listener",
|
|
16194
|
+
"type": {
|
|
16195
|
+
"text": "(this: EventTarget, ev: Event) => void"
|
|
15836
16196
|
}
|
|
15837
16197
|
},
|
|
15838
16198
|
{
|
|
@@ -15851,7 +16211,7 @@
|
|
|
15851
16211
|
{
|
|
15852
16212
|
"name": "element",
|
|
15853
16213
|
"type": {
|
|
15854
|
-
"text": "
|
|
16214
|
+
"text": "EventTarget"
|
|
15855
16215
|
}
|
|
15856
16216
|
},
|
|
15857
16217
|
{
|
|
@@ -15863,7 +16223,7 @@
|
|
|
15863
16223
|
{
|
|
15864
16224
|
"name": "listener",
|
|
15865
16225
|
"type": {
|
|
15866
|
-
"text": "(ev:
|
|
16226
|
+
"text": "(this: EventTarget, ev: Event) => void"
|
|
15867
16227
|
}
|
|
15868
16228
|
},
|
|
15869
16229
|
{
|
|
@@ -16072,7 +16432,8 @@
|
|
|
16072
16432
|
"type": {
|
|
16073
16433
|
"text": "HTMLElement"
|
|
16074
16434
|
},
|
|
16075
|
-
"privacy": "private"
|
|
16435
|
+
"privacy": "private",
|
|
16436
|
+
"readonly": true
|
|
16076
16437
|
},
|
|
16077
16438
|
{
|
|
16078
16439
|
"kind": "method",
|
|
@@ -16184,6 +16545,7 @@
|
|
|
16184
16545
|
{
|
|
16185
16546
|
"kind": "field",
|
|
16186
16547
|
"name": "hasContent",
|
|
16548
|
+
"readonly": true,
|
|
16187
16549
|
"inheritedFrom": {
|
|
16188
16550
|
"name": "SlotController",
|
|
16189
16551
|
"module": "src/common/controllers/SlotController.ts"
|
|
@@ -16192,6 +16554,7 @@
|
|
|
16192
16554
|
{
|
|
16193
16555
|
"kind": "field",
|
|
16194
16556
|
"name": "isEmpty",
|
|
16557
|
+
"readonly": true,
|
|
16195
16558
|
"inheritedFrom": {
|
|
16196
16559
|
"name": "SlotController",
|
|
16197
16560
|
"module": "src/common/controllers/SlotController.ts"
|
|
@@ -16200,6 +16563,7 @@
|
|
|
16200
16563
|
{
|
|
16201
16564
|
"kind": "field",
|
|
16202
16565
|
"name": "content",
|
|
16566
|
+
"readonly": true,
|
|
16203
16567
|
"inheritedFrom": {
|
|
16204
16568
|
"name": "SlotController",
|
|
16205
16569
|
"module": "src/common/controllers/SlotController.ts"
|
|
@@ -16208,6 +16572,7 @@
|
|
|
16208
16572
|
{
|
|
16209
16573
|
"kind": "field",
|
|
16210
16574
|
"name": "assigned",
|
|
16575
|
+
"readonly": true,
|
|
16211
16576
|
"inheritedFrom": {
|
|
16212
16577
|
"name": "SlotController",
|
|
16213
16578
|
"module": "src/common/controllers/SlotController.ts"
|
|
@@ -16292,6 +16657,77 @@
|
|
|
16292
16657
|
}
|
|
16293
16658
|
]
|
|
16294
16659
|
},
|
|
16660
|
+
{
|
|
16661
|
+
"kind": "javascript-module",
|
|
16662
|
+
"path": "src/common/controllers/ResizeController.ts",
|
|
16663
|
+
"declarations": [
|
|
16664
|
+
{
|
|
16665
|
+
"kind": "class",
|
|
16666
|
+
"description": "",
|
|
16667
|
+
"name": "ResizeController",
|
|
16668
|
+
"members": [
|
|
16669
|
+
{
|
|
16670
|
+
"kind": "field",
|
|
16671
|
+
"name": "observer",
|
|
16672
|
+
"type": {
|
|
16673
|
+
"text": "ResizeObserver"
|
|
16674
|
+
},
|
|
16675
|
+
"privacy": "private",
|
|
16676
|
+
"default": "new ResizeObserver(([entry]) => {\n const [borderBoxSize] = entry.borderBoxSize\n this.borderBoxSize = borderBoxSize\n host.requestUpdate()\n })"
|
|
16677
|
+
},
|
|
16678
|
+
{
|
|
16679
|
+
"kind": "field",
|
|
16680
|
+
"name": "hadFirstUpdate",
|
|
16681
|
+
"type": {
|
|
16682
|
+
"text": "boolean"
|
|
16683
|
+
},
|
|
16684
|
+
"privacy": "private",
|
|
16685
|
+
"default": "false"
|
|
16686
|
+
},
|
|
16687
|
+
{
|
|
16688
|
+
"kind": "field",
|
|
16689
|
+
"name": "borderBoxSize",
|
|
16690
|
+
"type": {
|
|
16691
|
+
"text": "ResizeObserverSize | undefined"
|
|
16692
|
+
},
|
|
16693
|
+
"privacy": "private"
|
|
16694
|
+
},
|
|
16695
|
+
{
|
|
16696
|
+
"kind": "field",
|
|
16697
|
+
"name": "inlineSize",
|
|
16698
|
+
"readonly": true
|
|
16699
|
+
},
|
|
16700
|
+
{
|
|
16701
|
+
"kind": "field",
|
|
16702
|
+
"name": "blockSize",
|
|
16703
|
+
"readonly": true
|
|
16704
|
+
},
|
|
16705
|
+
{
|
|
16706
|
+
"kind": "method",
|
|
16707
|
+
"name": "hostUpdated"
|
|
16708
|
+
},
|
|
16709
|
+
{
|
|
16710
|
+
"kind": "method",
|
|
16711
|
+
"name": "hostConnected"
|
|
16712
|
+
},
|
|
16713
|
+
{
|
|
16714
|
+
"kind": "method",
|
|
16715
|
+
"name": "hostDisconnected"
|
|
16716
|
+
}
|
|
16717
|
+
]
|
|
16718
|
+
}
|
|
16719
|
+
],
|
|
16720
|
+
"exports": [
|
|
16721
|
+
{
|
|
16722
|
+
"kind": "js",
|
|
16723
|
+
"name": "ResizeController",
|
|
16724
|
+
"declaration": {
|
|
16725
|
+
"name": "ResizeController",
|
|
16726
|
+
"module": "src/common/controllers/ResizeController.ts"
|
|
16727
|
+
}
|
|
16728
|
+
}
|
|
16729
|
+
]
|
|
16730
|
+
},
|
|
16295
16731
|
{
|
|
16296
16732
|
"kind": "javascript-module",
|
|
16297
16733
|
"path": "src/common/controllers/ScrollbarController.ts",
|
|
@@ -16459,19 +16895,23 @@
|
|
|
16459
16895
|
},
|
|
16460
16896
|
{
|
|
16461
16897
|
"kind": "field",
|
|
16462
|
-
"name": "hasContent"
|
|
16898
|
+
"name": "hasContent",
|
|
16899
|
+
"readonly": true
|
|
16463
16900
|
},
|
|
16464
16901
|
{
|
|
16465
16902
|
"kind": "field",
|
|
16466
|
-
"name": "isEmpty"
|
|
16903
|
+
"name": "isEmpty",
|
|
16904
|
+
"readonly": true
|
|
16467
16905
|
},
|
|
16468
16906
|
{
|
|
16469
16907
|
"kind": "field",
|
|
16470
|
-
"name": "content"
|
|
16908
|
+
"name": "content",
|
|
16909
|
+
"readonly": true
|
|
16471
16910
|
},
|
|
16472
16911
|
{
|
|
16473
16912
|
"kind": "field",
|
|
16474
|
-
"name": "assigned"
|
|
16913
|
+
"name": "assigned",
|
|
16914
|
+
"readonly": true
|
|
16475
16915
|
},
|
|
16476
16916
|
{
|
|
16477
16917
|
"kind": "field",
|
|
@@ -17584,7 +18024,8 @@
|
|
|
17584
18024
|
"type": {
|
|
17585
18025
|
"text": "string | undefined"
|
|
17586
18026
|
},
|
|
17587
|
-
"privacy": "protected"
|
|
18027
|
+
"privacy": "protected",
|
|
18028
|
+
"readonly": true
|
|
17588
18029
|
},
|
|
17589
18030
|
{
|
|
17590
18031
|
"kind": "field",
|
|
@@ -17592,7 +18033,8 @@
|
|
|
17592
18033
|
"type": {
|
|
17593
18034
|
"text": "boolean"
|
|
17594
18035
|
},
|
|
17595
|
-
"privacy": "protected"
|
|
18036
|
+
"privacy": "protected",
|
|
18037
|
+
"readonly": true
|
|
17596
18038
|
},
|
|
17597
18039
|
{
|
|
17598
18040
|
"kind": "field",
|
|
@@ -17600,7 +18042,8 @@
|
|
|
17600
18042
|
"type": {
|
|
17601
18043
|
"text": "boolean"
|
|
17602
18044
|
},
|
|
17603
|
-
"privacy": "protected"
|
|
18045
|
+
"privacy": "protected",
|
|
18046
|
+
"readonly": true
|
|
17604
18047
|
},
|
|
17605
18048
|
{
|
|
17606
18049
|
"kind": "method",
|
|
@@ -17721,7 +18164,8 @@
|
|
|
17721
18164
|
{
|
|
17722
18165
|
"kind": "field",
|
|
17723
18166
|
"name": "formValue",
|
|
17724
|
-
"privacy": "protected"
|
|
18167
|
+
"privacy": "protected",
|
|
18168
|
+
"readonly": true
|
|
17725
18169
|
},
|
|
17726
18170
|
{
|
|
17727
18171
|
"kind": "field",
|
|
@@ -17875,12 +18319,14 @@
|
|
|
17875
18319
|
{
|
|
17876
18320
|
"kind": "field",
|
|
17877
18321
|
"name": "hasHint",
|
|
17878
|
-
"privacy": "protected"
|
|
18322
|
+
"privacy": "protected",
|
|
18323
|
+
"readonly": true
|
|
17879
18324
|
},
|
|
17880
18325
|
{
|
|
17881
18326
|
"kind": "field",
|
|
17882
18327
|
"name": "hasError",
|
|
17883
|
-
"privacy": "protected"
|
|
18328
|
+
"privacy": "protected",
|
|
18329
|
+
"readonly": true
|
|
17884
18330
|
}
|
|
17885
18331
|
],
|
|
17886
18332
|
"events": [
|
|
@@ -18025,7 +18471,8 @@
|
|
|
18025
18471
|
"name": "form",
|
|
18026
18472
|
"type": {
|
|
18027
18473
|
"text": "HTMLFormElement | null"
|
|
18028
|
-
}
|
|
18474
|
+
},
|
|
18475
|
+
"readonly": true
|
|
18029
18476
|
}
|
|
18030
18477
|
]
|
|
18031
18478
|
},
|
|
@@ -18067,7 +18514,8 @@
|
|
|
18067
18514
|
{
|
|
18068
18515
|
"kind": "field",
|
|
18069
18516
|
"name": "form",
|
|
18070
|
-
"description": "Gets the form, if any, associated with the form element."
|
|
18517
|
+
"description": "Gets the form, if any, associated with the form element.",
|
|
18518
|
+
"readonly": true
|
|
18071
18519
|
}
|
|
18072
18520
|
],
|
|
18073
18521
|
"attributes": [
|