@nordhealth/components 2.16.1-alpha.0 → 2.16.1-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +317 -322
- package/lib/Button.js +1 -1
- package/lib/Button.js.map +1 -1
- package/lib/{Calendar-2cc56879.js → Calendar-88644376.js} +1 -1
- package/lib/{Calendar-2cc56879.js.map → Calendar-88644376.js.map} +1 -1
- package/lib/Calendar.js +1 -1
- package/lib/DatePicker.js +1 -1
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Layout.js +1 -1
- package/lib/Layout.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/Navigation.js +1 -1
- package/lib/Navigation.js.map +1 -1
- package/lib/bundle.js +3 -3
- package/lib/bundle.js.map +1 -1
- package/lib/index.js +1 -1
- package/lib/src/button/Button.d.ts +0 -1
- package/package.json +5 -5
package/custom-elements.json
CHANGED
|
@@ -589,57 +589,52 @@
|
|
|
589
589
|
},
|
|
590
590
|
{
|
|
591
591
|
"kind": "javascript-module",
|
|
592
|
-
"path": "src/
|
|
592
|
+
"path": "src/banner/Banner.ts",
|
|
593
593
|
"declarations": [
|
|
594
594
|
{
|
|
595
595
|
"kind": "class",
|
|
596
|
-
"description": "
|
|
597
|
-
"name": "
|
|
596
|
+
"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.",
|
|
597
|
+
"name": "Banner",
|
|
598
|
+
"cssProperties": [
|
|
599
|
+
{
|
|
600
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
601
|
+
"name": "--n-banner-border-radius",
|
|
602
|
+
"default": "var(--n-border-radius)"
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
606
|
+
"name": "--n-banner-box-shadow",
|
|
607
|
+
"default": "var(--n-box-shadow-card)"
|
|
608
|
+
}
|
|
609
|
+
],
|
|
598
610
|
"slots": [
|
|
599
611
|
{
|
|
600
|
-
"description": "
|
|
612
|
+
"description": "default slot",
|
|
601
613
|
"name": ""
|
|
602
614
|
}
|
|
603
615
|
],
|
|
604
616
|
"members": [
|
|
605
617
|
{
|
|
606
618
|
"kind": "field",
|
|
607
|
-
"name": "
|
|
619
|
+
"name": "variant",
|
|
608
620
|
"type": {
|
|
609
|
-
"text": "\"
|
|
621
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
610
622
|
},
|
|
611
|
-
"default": "\"
|
|
612
|
-
"description": "The
|
|
613
|
-
"attribute": "
|
|
623
|
+
"default": "\"info\"",
|
|
624
|
+
"description": "The style variant of the banner.",
|
|
625
|
+
"attribute": "variant",
|
|
614
626
|
"reflects": true
|
|
615
|
-
},
|
|
616
|
-
{
|
|
617
|
-
"kind": "field",
|
|
618
|
-
"name": "progress",
|
|
619
|
-
"type": {
|
|
620
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
621
|
-
},
|
|
622
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
623
|
-
"attribute": "progress"
|
|
624
627
|
}
|
|
625
628
|
],
|
|
626
629
|
"attributes": [
|
|
627
630
|
{
|
|
628
|
-
"name": "
|
|
629
|
-
"type": {
|
|
630
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
631
|
-
},
|
|
632
|
-
"default": "\"neutral\"",
|
|
633
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
634
|
-
"fieldName": "type"
|
|
635
|
-
},
|
|
636
|
-
{
|
|
637
|
-
"name": "progress",
|
|
631
|
+
"name": "variant",
|
|
638
632
|
"type": {
|
|
639
|
-
"text": "\"
|
|
633
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
640
634
|
},
|
|
641
|
-
"
|
|
642
|
-
"
|
|
635
|
+
"default": "\"info\"",
|
|
636
|
+
"description": "The style variant of the banner.",
|
|
637
|
+
"fieldName": "variant"
|
|
643
638
|
}
|
|
644
639
|
],
|
|
645
640
|
"superclass": {
|
|
@@ -648,10 +643,10 @@
|
|
|
648
643
|
},
|
|
649
644
|
"localization": [],
|
|
650
645
|
"status": "ready",
|
|
651
|
-
"category": "
|
|
652
|
-
"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
|
|
646
|
+
"category": "feedback",
|
|
647
|
+
"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",
|
|
653
648
|
"examples": [],
|
|
654
|
-
"tagName": "nord-
|
|
649
|
+
"tagName": "nord-banner",
|
|
655
650
|
"customElement": true
|
|
656
651
|
}
|
|
657
652
|
],
|
|
@@ -660,190 +655,73 @@
|
|
|
660
655
|
"kind": "js",
|
|
661
656
|
"name": "default",
|
|
662
657
|
"declaration": {
|
|
663
|
-
"name": "
|
|
664
|
-
"module": "src/
|
|
658
|
+
"name": "Banner",
|
|
659
|
+
"module": "src/banner/Banner.ts"
|
|
665
660
|
}
|
|
666
661
|
},
|
|
667
662
|
{
|
|
668
663
|
"kind": "custom-element-definition",
|
|
669
|
-
"name": "nord-
|
|
664
|
+
"name": "nord-banner",
|
|
670
665
|
"declaration": {
|
|
671
|
-
"name": "
|
|
672
|
-
"module": "src/
|
|
666
|
+
"name": "Banner",
|
|
667
|
+
"module": "src/banner/Banner.ts"
|
|
673
668
|
}
|
|
674
669
|
}
|
|
675
670
|
]
|
|
676
671
|
},
|
|
677
672
|
{
|
|
678
673
|
"kind": "javascript-module",
|
|
679
|
-
"path": "src/
|
|
674
|
+
"path": "src/badge/Badge.ts",
|
|
680
675
|
"declarations": [
|
|
681
676
|
{
|
|
682
677
|
"kind": "class",
|
|
683
|
-
"description": "
|
|
684
|
-
"name": "
|
|
685
|
-
"cssProperties": [
|
|
686
|
-
{
|
|
687
|
-
"description": "Controls the rounded corners of the button, using [border radius tokens](/tokens/#border-radius).",
|
|
688
|
-
"name": "--n-button-group-border-radius",
|
|
689
|
-
"default": "var(--n-border-radius-s)"
|
|
690
|
-
},
|
|
691
|
-
{
|
|
692
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
693
|
-
"name": "--n-button-group-box-shadow",
|
|
694
|
-
"default": "var(--n-box-shadow)"
|
|
695
|
-
}
|
|
696
|
-
],
|
|
678
|
+
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
679
|
+
"name": "Badge",
|
|
697
680
|
"slots": [
|
|
698
681
|
{
|
|
699
|
-
"description": "The
|
|
682
|
+
"description": "The badge content.",
|
|
700
683
|
"name": ""
|
|
701
684
|
}
|
|
702
685
|
],
|
|
703
686
|
"members": [
|
|
704
687
|
{
|
|
705
688
|
"kind": "field",
|
|
706
|
-
"name": "
|
|
707
|
-
"type": {
|
|
708
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
709
|
-
},
|
|
710
|
-
"default": "\"horizontal\"",
|
|
711
|
-
"description": "The direction of the button group.",
|
|
712
|
-
"attribute": "direction",
|
|
713
|
-
"reflects": true
|
|
714
|
-
},
|
|
715
|
-
{
|
|
716
|
-
"kind": "field",
|
|
717
|
-
"name": "role",
|
|
689
|
+
"name": "type",
|
|
718
690
|
"type": {
|
|
719
|
-
"text": "
|
|
691
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
720
692
|
},
|
|
721
|
-
"default": "\"
|
|
722
|
-
"description": "The
|
|
723
|
-
"attribute": "
|
|
693
|
+
"default": "\"neutral\"",
|
|
694
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
695
|
+
"attribute": "type",
|
|
724
696
|
"reflects": true
|
|
725
697
|
},
|
|
726
698
|
{
|
|
727
699
|
"kind": "field",
|
|
728
|
-
"name": "
|
|
700
|
+
"name": "progress",
|
|
729
701
|
"type": {
|
|
730
|
-
"text": "
|
|
702
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
731
703
|
},
|
|
732
|
-
"
|
|
733
|
-
"
|
|
734
|
-
"default": "false",
|
|
735
|
-
"inheritedFrom": {
|
|
736
|
-
"name": "DraftComponentMixin",
|
|
737
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
738
|
-
}
|
|
704
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
705
|
+
"attribute": "progress"
|
|
739
706
|
}
|
|
740
707
|
],
|
|
741
708
|
"attributes": [
|
|
742
709
|
{
|
|
743
|
-
"name": "
|
|
744
|
-
"type": {
|
|
745
|
-
"text": "\"vertical\" | \"horizontal\""
|
|
746
|
-
},
|
|
747
|
-
"default": "\"horizontal\"",
|
|
748
|
-
"description": "The direction of the button group.",
|
|
749
|
-
"fieldName": "direction"
|
|
750
|
-
},
|
|
751
|
-
{
|
|
752
|
-
"name": "role",
|
|
710
|
+
"name": "type",
|
|
753
711
|
"type": {
|
|
754
|
-
"text": "
|
|
712
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
755
713
|
},
|
|
756
|
-
"default": "\"
|
|
757
|
-
"description": "The
|
|
758
|
-
"fieldName": "
|
|
759
|
-
}
|
|
760
|
-
],
|
|
761
|
-
"mixins": [
|
|
762
|
-
{
|
|
763
|
-
"name": "DraftComponentMixin",
|
|
764
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
765
|
-
}
|
|
766
|
-
],
|
|
767
|
-
"superclass": {
|
|
768
|
-
"name": "LitElement",
|
|
769
|
-
"package": "lit"
|
|
770
|
-
},
|
|
771
|
-
"localization": [],
|
|
772
|
-
"status": "draft",
|
|
773
|
-
"category": "structure",
|
|
774
|
-
"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 group labels should be accurate and predictable.\n",
|
|
775
|
-
"examples": [],
|
|
776
|
-
"tagName": "nord-button-group",
|
|
777
|
-
"customElement": true
|
|
778
|
-
}
|
|
779
|
-
],
|
|
780
|
-
"exports": [
|
|
781
|
-
{
|
|
782
|
-
"kind": "js",
|
|
783
|
-
"name": "default",
|
|
784
|
-
"declaration": {
|
|
785
|
-
"name": "ButtonGroup",
|
|
786
|
-
"module": "src/button-group/ButtonGroup.ts"
|
|
787
|
-
}
|
|
788
|
-
},
|
|
789
|
-
{
|
|
790
|
-
"kind": "custom-element-definition",
|
|
791
|
-
"name": "nord-button-group",
|
|
792
|
-
"declaration": {
|
|
793
|
-
"name": "ButtonGroup",
|
|
794
|
-
"module": "src/button-group/ButtonGroup.ts"
|
|
795
|
-
}
|
|
796
|
-
}
|
|
797
|
-
]
|
|
798
|
-
},
|
|
799
|
-
{
|
|
800
|
-
"kind": "javascript-module",
|
|
801
|
-
"path": "src/banner/Banner.ts",
|
|
802
|
-
"declarations": [
|
|
803
|
-
{
|
|
804
|
-
"kind": "class",
|
|
805
|
-
"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.",
|
|
806
|
-
"name": "Banner",
|
|
807
|
-
"cssProperties": [
|
|
808
|
-
{
|
|
809
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
810
|
-
"name": "--n-banner-border-radius",
|
|
811
|
-
"default": "var(--n-border-radius)"
|
|
714
|
+
"default": "\"neutral\"",
|
|
715
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
716
|
+
"fieldName": "type"
|
|
812
717
|
},
|
|
813
718
|
{
|
|
814
|
-
"
|
|
815
|
-
"name": "--n-banner-box-shadow",
|
|
816
|
-
"default": "var(--n-box-shadow-card)"
|
|
817
|
-
}
|
|
818
|
-
],
|
|
819
|
-
"slots": [
|
|
820
|
-
{
|
|
821
|
-
"description": "default slot",
|
|
822
|
-
"name": ""
|
|
823
|
-
}
|
|
824
|
-
],
|
|
825
|
-
"members": [
|
|
826
|
-
{
|
|
827
|
-
"kind": "field",
|
|
828
|
-
"name": "variant",
|
|
829
|
-
"type": {
|
|
830
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
831
|
-
},
|
|
832
|
-
"default": "\"info\"",
|
|
833
|
-
"description": "The style variant of the banner.",
|
|
834
|
-
"attribute": "variant",
|
|
835
|
-
"reflects": true
|
|
836
|
-
}
|
|
837
|
-
],
|
|
838
|
-
"attributes": [
|
|
839
|
-
{
|
|
840
|
-
"name": "variant",
|
|
719
|
+
"name": "progress",
|
|
841
720
|
"type": {
|
|
842
|
-
"text": "\"
|
|
721
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
843
722
|
},
|
|
844
|
-
"
|
|
845
|
-
"
|
|
846
|
-
"fieldName": "variant"
|
|
723
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
724
|
+
"fieldName": "progress"
|
|
847
725
|
}
|
|
848
726
|
],
|
|
849
727
|
"superclass": {
|
|
@@ -852,10 +730,10 @@
|
|
|
852
730
|
},
|
|
853
731
|
"localization": [],
|
|
854
732
|
"status": "ready",
|
|
855
|
-
"category": "
|
|
856
|
-
"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
|
|
733
|
+
"category": "text",
|
|
734
|
+
"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",
|
|
857
735
|
"examples": [],
|
|
858
|
-
"tagName": "nord-
|
|
736
|
+
"tagName": "nord-badge",
|
|
859
737
|
"customElement": true
|
|
860
738
|
}
|
|
861
739
|
],
|
|
@@ -864,16 +742,16 @@
|
|
|
864
742
|
"kind": "js",
|
|
865
743
|
"name": "default",
|
|
866
744
|
"declaration": {
|
|
867
|
-
"name": "
|
|
868
|
-
"module": "src/
|
|
745
|
+
"name": "Badge",
|
|
746
|
+
"module": "src/badge/Badge.ts"
|
|
869
747
|
}
|
|
870
748
|
},
|
|
871
749
|
{
|
|
872
750
|
"kind": "custom-element-definition",
|
|
873
|
-
"name": "nord-
|
|
751
|
+
"name": "nord-badge",
|
|
874
752
|
"declaration": {
|
|
875
|
-
"name": "
|
|
876
|
-
"module": "src/
|
|
753
|
+
"name": "Badge",
|
|
754
|
+
"module": "src/badge/Badge.ts"
|
|
877
755
|
}
|
|
878
756
|
}
|
|
879
757
|
]
|
|
@@ -946,11 +824,6 @@
|
|
|
946
824
|
"description": "Controls the minimum block size, or height, of the button using our [spacing tokens](/tokens/#space).",
|
|
947
825
|
"name": "--n-button-min-block-size",
|
|
948
826
|
"default": "var(--n-space-xl)"
|
|
949
|
-
},
|
|
950
|
-
{
|
|
951
|
-
"description": "Controls the color of the dropdown icon, using our [color tokens](/tokens/#color).",
|
|
952
|
-
"name": "--n-button-dropdown-icon-color",
|
|
953
|
-
"default": "var(--n-color-icon)"
|
|
954
827
|
}
|
|
955
828
|
],
|
|
956
829
|
"slots": [
|
|
@@ -1343,52 +1216,174 @@
|
|
|
1343
1216
|
"fieldName": "loading"
|
|
1344
1217
|
},
|
|
1345
1218
|
{
|
|
1346
|
-
"name": "disabled",
|
|
1219
|
+
"name": "disabled",
|
|
1220
|
+
"type": {
|
|
1221
|
+
"text": "boolean"
|
|
1222
|
+
},
|
|
1223
|
+
"default": "false",
|
|
1224
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
1225
|
+
"fieldName": "disabled",
|
|
1226
|
+
"inheritedFrom": {
|
|
1227
|
+
"name": "InputMixin",
|
|
1228
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
1229
|
+
}
|
|
1230
|
+
},
|
|
1231
|
+
{
|
|
1232
|
+
"name": "name",
|
|
1233
|
+
"type": {
|
|
1234
|
+
"text": "string | undefined"
|
|
1235
|
+
},
|
|
1236
|
+
"description": "The name of the form component.",
|
|
1237
|
+
"fieldName": "name",
|
|
1238
|
+
"inheritedFrom": {
|
|
1239
|
+
"name": "InputMixin",
|
|
1240
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
1241
|
+
}
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"name": "value",
|
|
1245
|
+
"type": {
|
|
1246
|
+
"text": "string"
|
|
1247
|
+
},
|
|
1248
|
+
"default": "\"\"",
|
|
1249
|
+
"description": "The value of the form component.",
|
|
1250
|
+
"fieldName": "value",
|
|
1251
|
+
"inheritedFrom": {
|
|
1252
|
+
"name": "InputMixin",
|
|
1253
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
1254
|
+
}
|
|
1255
|
+
}
|
|
1256
|
+
],
|
|
1257
|
+
"mixins": [
|
|
1258
|
+
{
|
|
1259
|
+
"name": "InputMixin",
|
|
1260
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
1261
|
+
},
|
|
1262
|
+
{
|
|
1263
|
+
"name": "FocusableMixin",
|
|
1264
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
1265
|
+
}
|
|
1266
|
+
],
|
|
1267
|
+
"superclass": {
|
|
1268
|
+
"name": "LitElement",
|
|
1269
|
+
"package": "lit"
|
|
1270
|
+
},
|
|
1271
|
+
"localization": [],
|
|
1272
|
+
"status": "ready",
|
|
1273
|
+
"category": "action",
|
|
1274
|
+
"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| `switch` | **Deprecated:** Switch style is reserved for the clinic switcher in the top left corner of an application. |\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\" 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\" 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\" 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\" 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",
|
|
1275
|
+
"examples": [],
|
|
1276
|
+
"tagName": "nord-button",
|
|
1277
|
+
"customElement": true
|
|
1278
|
+
}
|
|
1279
|
+
],
|
|
1280
|
+
"exports": [
|
|
1281
|
+
{
|
|
1282
|
+
"kind": "js",
|
|
1283
|
+
"name": "default",
|
|
1284
|
+
"declaration": {
|
|
1285
|
+
"name": "Button",
|
|
1286
|
+
"module": "src/button/Button.ts"
|
|
1287
|
+
}
|
|
1288
|
+
},
|
|
1289
|
+
{
|
|
1290
|
+
"kind": "custom-element-definition",
|
|
1291
|
+
"name": "nord-button",
|
|
1292
|
+
"declaration": {
|
|
1293
|
+
"name": "Button",
|
|
1294
|
+
"module": "src/button/Button.ts"
|
|
1295
|
+
}
|
|
1296
|
+
}
|
|
1297
|
+
]
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"kind": "javascript-module",
|
|
1301
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
1302
|
+
"declarations": [
|
|
1303
|
+
{
|
|
1304
|
+
"kind": "class",
|
|
1305
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
1306
|
+
"name": "ButtonGroup",
|
|
1307
|
+
"cssProperties": [
|
|
1308
|
+
{
|
|
1309
|
+
"description": "Controls the rounded corners of the button, using [border radius tokens](/tokens/#border-radius).",
|
|
1310
|
+
"name": "--n-button-group-border-radius",
|
|
1311
|
+
"default": "var(--n-border-radius-s)"
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1315
|
+
"name": "--n-button-group-box-shadow",
|
|
1316
|
+
"default": "var(--n-box-shadow)"
|
|
1317
|
+
}
|
|
1318
|
+
],
|
|
1319
|
+
"slots": [
|
|
1320
|
+
{
|
|
1321
|
+
"description": "The button group content",
|
|
1322
|
+
"name": ""
|
|
1323
|
+
}
|
|
1324
|
+
],
|
|
1325
|
+
"members": [
|
|
1326
|
+
{
|
|
1327
|
+
"kind": "field",
|
|
1328
|
+
"name": "direction",
|
|
1329
|
+
"type": {
|
|
1330
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1331
|
+
},
|
|
1332
|
+
"default": "\"horizontal\"",
|
|
1333
|
+
"description": "The direction of the button group.",
|
|
1334
|
+
"attribute": "direction",
|
|
1335
|
+
"reflects": true
|
|
1336
|
+
},
|
|
1337
|
+
{
|
|
1338
|
+
"kind": "field",
|
|
1339
|
+
"name": "role",
|
|
1340
|
+
"type": {
|
|
1341
|
+
"text": "string"
|
|
1342
|
+
},
|
|
1343
|
+
"default": "\"group\"",
|
|
1344
|
+
"description": "The appropriate role for the containing element.",
|
|
1345
|
+
"attribute": "role",
|
|
1346
|
+
"reflects": true
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
"kind": "field",
|
|
1350
|
+
"name": "_warningLogged",
|
|
1347
1351
|
"type": {
|
|
1348
1352
|
"text": "boolean"
|
|
1349
1353
|
},
|
|
1354
|
+
"privacy": "private",
|
|
1355
|
+
"static": true,
|
|
1350
1356
|
"default": "false",
|
|
1351
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
1352
|
-
"fieldName": "disabled",
|
|
1353
1357
|
"inheritedFrom": {
|
|
1354
|
-
"name": "
|
|
1355
|
-
"module": "src/common/mixins/
|
|
1358
|
+
"name": "DraftComponentMixin",
|
|
1359
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
1356
1360
|
}
|
|
1357
|
-
}
|
|
1361
|
+
}
|
|
1362
|
+
],
|
|
1363
|
+
"attributes": [
|
|
1358
1364
|
{
|
|
1359
|
-
"name": "
|
|
1365
|
+
"name": "direction",
|
|
1360
1366
|
"type": {
|
|
1361
|
-
"text": "
|
|
1367
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
1362
1368
|
},
|
|
1363
|
-
"
|
|
1364
|
-
"
|
|
1365
|
-
"
|
|
1366
|
-
"name": "InputMixin",
|
|
1367
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1368
|
-
}
|
|
1369
|
+
"default": "\"horizontal\"",
|
|
1370
|
+
"description": "The direction of the button group.",
|
|
1371
|
+
"fieldName": "direction"
|
|
1369
1372
|
},
|
|
1370
1373
|
{
|
|
1371
|
-
"name": "
|
|
1374
|
+
"name": "role",
|
|
1372
1375
|
"type": {
|
|
1373
1376
|
"text": "string"
|
|
1374
1377
|
},
|
|
1375
|
-
"default": "\"\"",
|
|
1376
|
-
"description": "The
|
|
1377
|
-
"fieldName": "
|
|
1378
|
-
"inheritedFrom": {
|
|
1379
|
-
"name": "InputMixin",
|
|
1380
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1381
|
-
}
|
|
1378
|
+
"default": "\"group\"",
|
|
1379
|
+
"description": "The appropriate role for the containing element.",
|
|
1380
|
+
"fieldName": "role"
|
|
1382
1381
|
}
|
|
1383
1382
|
],
|
|
1384
1383
|
"mixins": [
|
|
1385
1384
|
{
|
|
1386
|
-
"name": "
|
|
1387
|
-
"module": "/src/common/mixins/
|
|
1388
|
-
},
|
|
1389
|
-
{
|
|
1390
|
-
"name": "FocusableMixin",
|
|
1391
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
1385
|
+
"name": "DraftComponentMixin",
|
|
1386
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
1392
1387
|
}
|
|
1393
1388
|
],
|
|
1394
1389
|
"superclass": {
|
|
@@ -1396,11 +1391,11 @@
|
|
|
1396
1391
|
"package": "lit"
|
|
1397
1392
|
},
|
|
1398
1393
|
"localization": [],
|
|
1399
|
-
"status": "
|
|
1400
|
-
"category": "
|
|
1401
|
-
"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-
|
|
1394
|
+
"status": "draft",
|
|
1395
|
+
"category": "structure",
|
|
1396
|
+
"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 group labels should be accurate and predictable.\n",
|
|
1402
1397
|
"examples": [],
|
|
1403
|
-
"tagName": "nord-button",
|
|
1398
|
+
"tagName": "nord-button-group",
|
|
1404
1399
|
"customElement": true
|
|
1405
1400
|
}
|
|
1406
1401
|
],
|
|
@@ -1409,16 +1404,16 @@
|
|
|
1409
1404
|
"kind": "js",
|
|
1410
1405
|
"name": "default",
|
|
1411
1406
|
"declaration": {
|
|
1412
|
-
"name": "
|
|
1413
|
-
"module": "src/button/
|
|
1407
|
+
"name": "ButtonGroup",
|
|
1408
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1414
1409
|
}
|
|
1415
1410
|
},
|
|
1416
1411
|
{
|
|
1417
1412
|
"kind": "custom-element-definition",
|
|
1418
|
-
"name": "nord-button",
|
|
1413
|
+
"name": "nord-button-group",
|
|
1419
1414
|
"declaration": {
|
|
1420
|
-
"name": "
|
|
1421
|
-
"module": "src/button/
|
|
1415
|
+
"name": "ButtonGroup",
|
|
1416
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
1422
1417
|
}
|
|
1423
1418
|
}
|
|
1424
1419
|
]
|
|
@@ -12612,6 +12607,100 @@
|
|
|
12612
12607
|
}
|
|
12613
12608
|
]
|
|
12614
12609
|
},
|
|
12610
|
+
{
|
|
12611
|
+
"kind": "javascript-module",
|
|
12612
|
+
"path": "src/tab/Tab.ts",
|
|
12613
|
+
"declarations": [
|
|
12614
|
+
{
|
|
12615
|
+
"kind": "class",
|
|
12616
|
+
"description": "The interactive tab button for use within the tab group component.",
|
|
12617
|
+
"name": "Tab",
|
|
12618
|
+
"cssProperties": [
|
|
12619
|
+
{
|
|
12620
|
+
"description": "Controls the text color of the tab, using our [color tokens](/tokens/#color).",
|
|
12621
|
+
"name": "--n-tab-color",
|
|
12622
|
+
"default": "var(--n-color-text-weak)"
|
|
12623
|
+
},
|
|
12624
|
+
{
|
|
12625
|
+
"description": "Controls the font weight of the tab, using our [font tokens](/tokens/#font).",
|
|
12626
|
+
"name": "--n-tab-font-weight",
|
|
12627
|
+
"default": "var(--n-font-weight)"
|
|
12628
|
+
}
|
|
12629
|
+
],
|
|
12630
|
+
"slots": [
|
|
12631
|
+
{
|
|
12632
|
+
"description": "The tab button content.",
|
|
12633
|
+
"name": ""
|
|
12634
|
+
}
|
|
12635
|
+
],
|
|
12636
|
+
"members": [
|
|
12637
|
+
{
|
|
12638
|
+
"kind": "field",
|
|
12639
|
+
"name": "defaultSlot",
|
|
12640
|
+
"privacy": "private",
|
|
12641
|
+
"default": "new SlotController(this)"
|
|
12642
|
+
},
|
|
12643
|
+
{
|
|
12644
|
+
"kind": "field",
|
|
12645
|
+
"name": "selected",
|
|
12646
|
+
"type": {
|
|
12647
|
+
"text": "boolean"
|
|
12648
|
+
},
|
|
12649
|
+
"default": "false",
|
|
12650
|
+
"description": "Whether the tab item is selected",
|
|
12651
|
+
"attribute": "selected",
|
|
12652
|
+
"reflects": true
|
|
12653
|
+
},
|
|
12654
|
+
{
|
|
12655
|
+
"kind": "method",
|
|
12656
|
+
"name": "handleSelectionChange",
|
|
12657
|
+
"privacy": "protected",
|
|
12658
|
+
"description": "Apply accessible attributes and values to the tab button.\nObserve the selected property if it changes"
|
|
12659
|
+
}
|
|
12660
|
+
],
|
|
12661
|
+
"attributes": [
|
|
12662
|
+
{
|
|
12663
|
+
"name": "selected",
|
|
12664
|
+
"type": {
|
|
12665
|
+
"text": "boolean"
|
|
12666
|
+
},
|
|
12667
|
+
"default": "false",
|
|
12668
|
+
"description": "Whether the tab item is selected",
|
|
12669
|
+
"fieldName": "selected"
|
|
12670
|
+
}
|
|
12671
|
+
],
|
|
12672
|
+
"superclass": {
|
|
12673
|
+
"name": "LitElement",
|
|
12674
|
+
"package": "lit"
|
|
12675
|
+
},
|
|
12676
|
+
"localization": [],
|
|
12677
|
+
"status": "ready",
|
|
12678
|
+
"category": "navigation",
|
|
12679
|
+
"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 component within the tab group component.\n- Use the `selected` option to signify if the tab is selected.\n- Use text, icons and other non-interactive content within the tab.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use the tab component outside of the tab group component.\n- Don't add interactive elements, such as buttons and links, inside the tab component.\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 section you wish to show out of order of the tabs UI itself consider using the `selected` option to select the tab but prevent the order of the tabs being affected.\n",
|
|
12680
|
+
"examples": [],
|
|
12681
|
+
"tagName": "nord-tab",
|
|
12682
|
+
"customElement": true
|
|
12683
|
+
}
|
|
12684
|
+
],
|
|
12685
|
+
"exports": [
|
|
12686
|
+
{
|
|
12687
|
+
"kind": "js",
|
|
12688
|
+
"name": "default",
|
|
12689
|
+
"declaration": {
|
|
12690
|
+
"name": "Tab",
|
|
12691
|
+
"module": "src/tab/Tab.ts"
|
|
12692
|
+
}
|
|
12693
|
+
},
|
|
12694
|
+
{
|
|
12695
|
+
"kind": "custom-element-definition",
|
|
12696
|
+
"name": "nord-tab",
|
|
12697
|
+
"declaration": {
|
|
12698
|
+
"name": "Tab",
|
|
12699
|
+
"module": "src/tab/Tab.ts"
|
|
12700
|
+
}
|
|
12701
|
+
}
|
|
12702
|
+
]
|
|
12703
|
+
},
|
|
12615
12704
|
{
|
|
12616
12705
|
"kind": "javascript-module",
|
|
12617
12706
|
"path": "src/tab-group/TabGroup.ts",
|
|
@@ -12854,100 +12943,6 @@
|
|
|
12854
12943
|
}
|
|
12855
12944
|
]
|
|
12856
12945
|
},
|
|
12857
|
-
{
|
|
12858
|
-
"kind": "javascript-module",
|
|
12859
|
-
"path": "src/tab/Tab.ts",
|
|
12860
|
-
"declarations": [
|
|
12861
|
-
{
|
|
12862
|
-
"kind": "class",
|
|
12863
|
-
"description": "The interactive tab button for use within the tab group component.",
|
|
12864
|
-
"name": "Tab",
|
|
12865
|
-
"cssProperties": [
|
|
12866
|
-
{
|
|
12867
|
-
"description": "Controls the text color of the tab, using our [color tokens](/tokens/#color).",
|
|
12868
|
-
"name": "--n-tab-color",
|
|
12869
|
-
"default": "var(--n-color-text-weak)"
|
|
12870
|
-
},
|
|
12871
|
-
{
|
|
12872
|
-
"description": "Controls the font weight of the tab, using our [font tokens](/tokens/#font).",
|
|
12873
|
-
"name": "--n-tab-font-weight",
|
|
12874
|
-
"default": "var(--n-font-weight)"
|
|
12875
|
-
}
|
|
12876
|
-
],
|
|
12877
|
-
"slots": [
|
|
12878
|
-
{
|
|
12879
|
-
"description": "The tab button content.",
|
|
12880
|
-
"name": ""
|
|
12881
|
-
}
|
|
12882
|
-
],
|
|
12883
|
-
"members": [
|
|
12884
|
-
{
|
|
12885
|
-
"kind": "field",
|
|
12886
|
-
"name": "defaultSlot",
|
|
12887
|
-
"privacy": "private",
|
|
12888
|
-
"default": "new SlotController(this)"
|
|
12889
|
-
},
|
|
12890
|
-
{
|
|
12891
|
-
"kind": "field",
|
|
12892
|
-
"name": "selected",
|
|
12893
|
-
"type": {
|
|
12894
|
-
"text": "boolean"
|
|
12895
|
-
},
|
|
12896
|
-
"default": "false",
|
|
12897
|
-
"description": "Whether the tab item is selected",
|
|
12898
|
-
"attribute": "selected",
|
|
12899
|
-
"reflects": true
|
|
12900
|
-
},
|
|
12901
|
-
{
|
|
12902
|
-
"kind": "method",
|
|
12903
|
-
"name": "handleSelectionChange",
|
|
12904
|
-
"privacy": "protected",
|
|
12905
|
-
"description": "Apply accessible attributes and values to the tab button.\nObserve the selected property if it changes"
|
|
12906
|
-
}
|
|
12907
|
-
],
|
|
12908
|
-
"attributes": [
|
|
12909
|
-
{
|
|
12910
|
-
"name": "selected",
|
|
12911
|
-
"type": {
|
|
12912
|
-
"text": "boolean"
|
|
12913
|
-
},
|
|
12914
|
-
"default": "false",
|
|
12915
|
-
"description": "Whether the tab item is selected",
|
|
12916
|
-
"fieldName": "selected"
|
|
12917
|
-
}
|
|
12918
|
-
],
|
|
12919
|
-
"superclass": {
|
|
12920
|
-
"name": "LitElement",
|
|
12921
|
-
"package": "lit"
|
|
12922
|
-
},
|
|
12923
|
-
"localization": [],
|
|
12924
|
-
"status": "ready",
|
|
12925
|
-
"category": "navigation",
|
|
12926
|
-
"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 component within the tab group component.\n- Use the `selected` option to signify if the tab is selected.\n- Use text, icons and other non-interactive content within the tab.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use the tab component outside of the tab group component.\n- Don't add interactive elements, such as buttons and links, inside the tab component.\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 section you wish to show out of order of the tabs UI itself consider using the `selected` option to select the tab but prevent the order of the tabs being affected.\n",
|
|
12927
|
-
"examples": [],
|
|
12928
|
-
"tagName": "nord-tab",
|
|
12929
|
-
"customElement": true
|
|
12930
|
-
}
|
|
12931
|
-
],
|
|
12932
|
-
"exports": [
|
|
12933
|
-
{
|
|
12934
|
-
"kind": "js",
|
|
12935
|
-
"name": "default",
|
|
12936
|
-
"declaration": {
|
|
12937
|
-
"name": "Tab",
|
|
12938
|
-
"module": "src/tab/Tab.ts"
|
|
12939
|
-
}
|
|
12940
|
-
},
|
|
12941
|
-
{
|
|
12942
|
-
"kind": "custom-element-definition",
|
|
12943
|
-
"name": "nord-tab",
|
|
12944
|
-
"declaration": {
|
|
12945
|
-
"name": "Tab",
|
|
12946
|
-
"module": "src/tab/Tab.ts"
|
|
12947
|
-
}
|
|
12948
|
-
}
|
|
12949
|
-
]
|
|
12950
|
-
},
|
|
12951
12946
|
{
|
|
12952
12947
|
"kind": "javascript-module",
|
|
12953
12948
|
"path": "src/tab-panel/TabPanel.ts",
|