@nordhealth/components 2.10.0 → 2.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +1573 -1463
- package/lib/{AutocompleteMixin-370de2be.js → AutocompleteMixin-5163f8db.js} +2 -2
- package/lib/{AutocompleteMixin-370de2be.js.map → AutocompleteMixin-5163f8db.js.map} +1 -1
- 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 +2 -0
- package/lib/ButtonGroup.js.map +1 -0
- package/lib/Calendar-e3786f07.js +2 -0
- package/lib/Calendar-e3786f07.js.map +1 -0
- package/lib/Calendar.js +1 -1
- package/lib/Card.js +1 -1
- package/lib/Card.js.map +1 -1
- package/lib/Checkbox.js +1 -1
- package/lib/Checkbox.js.map +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/Component-449e40fb.js +2 -0
- package/lib/Component-449e40fb.js.map +1 -0
- package/lib/DatePicker.js +1 -1
- package/lib/DatePicker.js.map +1 -1
- package/lib/Divider.js +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.js +1 -1
- package/lib/DropdownItem.js.map +1 -1
- package/lib/EmptyState.js +1 -1
- package/lib/EmptyState.js.map +1 -1
- package/lib/Fieldset.js +1 -1
- package/lib/Fieldset.js.map +1 -1
- package/lib/{FocusableMixin-34870ed3.js → FocusableMixin-32631bff.js} +2 -2
- package/lib/{FocusableMixin-34870ed3.js.map → FocusableMixin-32631bff.js.map} +1 -1
- package/lib/FormAssociatedMixin-e8bc2869.js +2 -0
- package/lib/{FormAssociatedMixin-aa74901e.js.map → FormAssociatedMixin-e8bc2869.js.map} +1 -1
- package/lib/FormField-413f22f5.js +2 -0
- package/lib/FormField-413f22f5.js.map +1 -0
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Icon.js +2 -2
- package/lib/Input.js +1 -1
- package/lib/Input.js.map +1 -1
- package/lib/{InputMixin-158f63fb.js → InputMixin-7fa755e1.js} +2 -2
- package/lib/{InputMixin-158f63fb.js.map → InputMixin-7fa755e1.js.map} +1 -1
- package/lib/Layout.js +1 -1
- package/lib/Layout.js.map +1 -1
- package/lib/LightDomController-052f446a.js +2 -0
- package/lib/{LightDomController-3c726b20.js.map → LightDomController-052f446a.js.map} +1 -1
- package/lib/Modal.js +1 -1
- package/lib/Modal.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.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/Popout-dae54e30.js +2 -0
- package/lib/{Popout-4aa0cc87.js.map → Popout-dae54e30.js.map} +1 -1
- package/lib/Popout.js +1 -1
- package/lib/ProgressBar.js +1 -1
- package/lib/ProgressBar.js.map +1 -1
- package/lib/Qrcode.js +1 -6
- package/lib/Qrcode.js.map +1 -1
- package/lib/Radio.js +1 -1
- package/lib/Radio.js.map +1 -1
- package/lib/Range.js +1 -1
- package/lib/Range.js.map +1 -1
- package/lib/Select.js +1 -1
- package/lib/Select.js.map +1 -1
- package/lib/{SizeMixin-4559b224.js → SizeMixin-d5afdb92.js} +2 -2
- package/lib/{SizeMixin-4559b224.js.map → SizeMixin-d5afdb92.js.map} +1 -1
- package/lib/Skeleton.js +1 -1
- package/lib/Skeleton.js.map +1 -1
- package/lib/Spinner.js +1 -1
- package/lib/Spinner.js.map +1 -1
- package/lib/Stack.js +1 -1
- package/lib/Stack.js.map +1 -1
- package/lib/Sticky-c4cf185e.js +2 -0
- package/lib/Sticky-c4cf185e.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/TabPanel.js +1 -1
- package/lib/TabPanel.js.map +1 -1
- package/lib/Table.js +1 -1
- package/lib/Table.js.map +1 -1
- package/lib/TextField-ca819c35.js +2 -0
- package/lib/{TextField-db22898b.js.map → TextField-ca819c35.js.map} +1 -1
- package/lib/Textarea.js +1 -1
- package/lib/Textarea.js.map +1 -1
- package/lib/Toast.js +1 -1
- package/lib/Toast.js.map +1 -1
- package/lib/ToastGroup.js +1 -1
- package/lib/ToastGroup.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/VisuallyHidden.js +1 -1
- package/lib/VisuallyHidden.js.map +1 -1
- package/lib/bundle.js +8 -8
- package/lib/bundle.js.map +1 -1
- package/lib/class-map-21152cee.js +7 -0
- package/lib/{class-map-949b7d3b.js.map → class-map-21152cee.js.map} +1 -1
- package/lib/collection-7eee4e72.js +7 -0
- package/lib/collection-7eee4e72.js.map +1 -0
- package/lib/cond-2da54107.js +2 -0
- package/lib/{cond-338158e9.js.map → cond-2da54107.js.map} +1 -1
- package/lib/date-adapter.js +1 -1
- package/lib/{dates-a8de5b83.js → dates-5b651fbe.js} +2 -2
- package/lib/{dates-a8de5b83.js.map → dates-5b651fbe.js.map} +1 -1
- package/lib/if-defined-720964c0.js +7 -0
- package/lib/{if-defined-4598a996.js.map → if-defined-720964c0.js.map} +1 -1
- package/lib/index.js +1 -1
- package/lib/query-assigned-elements-cf502539.js +35 -0
- package/lib/query-assigned-elements-cf502539.js.map +1 -0
- package/lib/{ref-0e619221.js → ref-c44e9f3c.js} +5 -5
- package/lib/{ref-0e619221.js.map → ref-c44e9f3c.js.map} +1 -1
- package/lib/src/button-group/ButtonGroup.d.ts +31 -0
- package/lib/src/button-group/ButtonGroup.test.d.ts +6 -0
- package/lib/src/calendar/Calendar.d.ts +10 -3
- package/lib/src/calendar/Calendar.test.d.ts +0 -1
- package/lib/src/date-picker/DatePicker.d.ts +10 -2
- package/lib/src/date-picker/DatePicker.test.d.ts +0 -1
- package/lib/src/index.d.ts +1 -0
- package/lib/src/layout/Layout.d.ts +9 -0
- package/lib/src/modal/Modal.d.ts +1 -1
- package/lib/src/nav-toggle/NavToggle.d.ts +1 -1
- package/lib/src/qrcode/Qrcode.d.ts +1 -1
- package/lib/src/range/Range.d.ts +1 -1
- package/lib/src/tab/Tab.d.ts +1 -1
- package/lib/src/tab-group/TabGroup.d.ts +1 -1
- package/lib/src/tab-panel/TabPanel.d.ts +1 -1
- package/lib/src/toast/Toast.d.ts +1 -1
- package/lib/src/toast-group/ToastGroup.d.ts +1 -1
- package/lib/src/toast-group/ToastGroup.test.d.ts +0 -1
- package/lib/src/toggle/Toggle.d.ts +1 -1
- package/lib/style-map-2e8fcab6.js +7 -0
- package/lib/style-map-2e8fcab6.js.map +1 -0
- package/package.json +2 -2
- package/lib/Calendar-29123404.js +0 -2
- package/lib/Calendar-29123404.js.map +0 -1
- package/lib/Component-92eb6234.js +0 -2
- package/lib/Component-92eb6234.js.map +0 -1
- package/lib/FormAssociatedMixin-aa74901e.js +0 -2
- package/lib/FormField-ae3570d2.js +0 -2
- package/lib/FormField-ae3570d2.js.map +0 -1
- package/lib/LightDomController-3c726b20.js +0 -2
- package/lib/Popout-4aa0cc87.js +0 -2
- package/lib/TextField-db22898b.js +0 -2
- package/lib/class-map-949b7d3b.js +0 -7
- package/lib/collection-800f5002.js +0 -2
- package/lib/collection-800f5002.js.map +0 -1
- package/lib/cond-338158e9.js +0 -2
- package/lib/if-defined-4598a996.js +0 -7
- package/lib/lit-element-9178eae5.js +0 -24
- package/lib/lit-element-9178eae5.js.map +0 -1
- package/lib/month-view.js +0 -2
- package/lib/month-view.js.map +0 -1
- package/lib/query-assigned-elements-e6cbac30.js +0 -12
- package/lib/query-assigned-elements-e6cbac30.js.map +0 -1
- package/lib/repeat-ae6f075f.js +0 -7
- package/lib/repeat-ae6f075f.js.map +0 -1
- package/lib/src/calendar/month-view.d.ts +0 -32
package/custom-elements.json
CHANGED
|
@@ -390,6 +390,14 @@
|
|
|
390
390
|
"name": "default",
|
|
391
391
|
"module": "\"./range/Range.js\""
|
|
392
392
|
}
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"kind": "js",
|
|
396
|
+
"name": "ButtonGroup",
|
|
397
|
+
"declaration": {
|
|
398
|
+
"name": "default",
|
|
399
|
+
"module": "\"./button-group/ButtonGroup.js\""
|
|
400
|
+
}
|
|
393
401
|
}
|
|
394
402
|
]
|
|
395
403
|
},
|
|
@@ -562,63 +570,103 @@
|
|
|
562
570
|
},
|
|
563
571
|
{
|
|
564
572
|
"kind": "javascript-module",
|
|
565
|
-
"path": "src/
|
|
573
|
+
"path": "src/button-group/ButtonGroup.ts",
|
|
566
574
|
"declarations": [
|
|
567
575
|
{
|
|
568
576
|
"kind": "class",
|
|
569
|
-
"description": "
|
|
570
|
-
"name": "
|
|
577
|
+
"description": "Button groups are designed to bring together button controls that are of a similar nature. For example text formatting controls.",
|
|
578
|
+
"name": "ButtonGroup",
|
|
571
579
|
"cssProperties": [
|
|
572
580
|
{
|
|
573
|
-
"description": "Controls
|
|
574
|
-
"name": "--n-
|
|
575
|
-
"default": "var(--n-border-radius)"
|
|
581
|
+
"description": "Controls the rounded corners of the button, using [border radius tokens](/tokens/#border-radius).",
|
|
582
|
+
"name": "--n-button-group-border-radius",
|
|
583
|
+
"default": "var(--n-border-radius-s)"
|
|
576
584
|
},
|
|
577
585
|
{
|
|
578
586
|
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
579
|
-
"name": "--n-
|
|
580
|
-
"default": "var(--n-box-shadow
|
|
587
|
+
"name": "--n-button-group-box-shadow",
|
|
588
|
+
"default": "var(--n-box-shadow)"
|
|
581
589
|
}
|
|
582
590
|
],
|
|
583
591
|
"slots": [
|
|
584
592
|
{
|
|
585
|
-
"description": "
|
|
593
|
+
"description": "The button group content",
|
|
586
594
|
"name": ""
|
|
587
595
|
}
|
|
588
596
|
],
|
|
589
597
|
"members": [
|
|
590
598
|
{
|
|
591
599
|
"kind": "field",
|
|
592
|
-
"name": "
|
|
600
|
+
"name": "direction",
|
|
593
601
|
"type": {
|
|
594
|
-
"text": "\"
|
|
602
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
595
603
|
},
|
|
596
|
-
"default": "\"
|
|
597
|
-
"description": "The
|
|
598
|
-
"attribute": "
|
|
604
|
+
"default": "\"horizontal\"",
|
|
605
|
+
"description": "The direction of the button group.",
|
|
606
|
+
"attribute": "direction",
|
|
607
|
+
"reflects": true
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"kind": "field",
|
|
611
|
+
"name": "role",
|
|
612
|
+
"type": {
|
|
613
|
+
"text": "string"
|
|
614
|
+
},
|
|
615
|
+
"default": "\"group\"",
|
|
616
|
+
"description": "The appropriate role for the containing element.",
|
|
617
|
+
"attribute": "role",
|
|
599
618
|
"reflects": true
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"kind": "field",
|
|
622
|
+
"name": "_warningLogged",
|
|
623
|
+
"type": {
|
|
624
|
+
"text": "boolean"
|
|
625
|
+
},
|
|
626
|
+
"privacy": "private",
|
|
627
|
+
"static": true,
|
|
628
|
+
"default": "false",
|
|
629
|
+
"inheritedFrom": {
|
|
630
|
+
"name": "DraftComponentMixin",
|
|
631
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
632
|
+
}
|
|
600
633
|
}
|
|
601
634
|
],
|
|
602
635
|
"attributes": [
|
|
603
636
|
{
|
|
604
|
-
"name": "
|
|
637
|
+
"name": "direction",
|
|
605
638
|
"type": {
|
|
606
|
-
"text": "\"
|
|
639
|
+
"text": "\"vertical\" | \"horizontal\""
|
|
607
640
|
},
|
|
608
|
-
"default": "\"
|
|
609
|
-
"description": "The
|
|
610
|
-
"fieldName": "
|
|
641
|
+
"default": "\"horizontal\"",
|
|
642
|
+
"description": "The direction of the button group.",
|
|
643
|
+
"fieldName": "direction"
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "role",
|
|
647
|
+
"type": {
|
|
648
|
+
"text": "string"
|
|
649
|
+
},
|
|
650
|
+
"default": "\"group\"",
|
|
651
|
+
"description": "The appropriate role for the containing element.",
|
|
652
|
+
"fieldName": "role"
|
|
653
|
+
}
|
|
654
|
+
],
|
|
655
|
+
"mixins": [
|
|
656
|
+
{
|
|
657
|
+
"name": "DraftComponentMixin",
|
|
658
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
611
659
|
}
|
|
612
660
|
],
|
|
613
661
|
"superclass": {
|
|
614
662
|
"name": "LitElement",
|
|
615
663
|
"package": "lit"
|
|
616
664
|
},
|
|
617
|
-
"status": "
|
|
618
|
-
"category": "
|
|
665
|
+
"status": "draft",
|
|
666
|
+
"category": "structure",
|
|
619
667
|
"displayName": null,
|
|
620
668
|
"examples": [],
|
|
621
|
-
"tagName": "nord-
|
|
669
|
+
"tagName": "nord-button-group",
|
|
622
670
|
"customElement": true
|
|
623
671
|
}
|
|
624
672
|
],
|
|
@@ -627,20 +675,20 @@
|
|
|
627
675
|
"kind": "js",
|
|
628
676
|
"name": "default",
|
|
629
677
|
"declaration": {
|
|
630
|
-
"name": "
|
|
631
|
-
"module": "src/
|
|
678
|
+
"name": "ButtonGroup",
|
|
679
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
632
680
|
}
|
|
633
681
|
},
|
|
634
682
|
{
|
|
635
683
|
"kind": "custom-element-definition",
|
|
636
|
-
"name": "nord-
|
|
684
|
+
"name": "nord-button-group",
|
|
637
685
|
"declaration": {
|
|
638
|
-
"name": "
|
|
639
|
-
"module": "src/
|
|
686
|
+
"name": "ButtonGroup",
|
|
687
|
+
"module": "src/button-group/ButtonGroup.ts"
|
|
640
688
|
}
|
|
641
689
|
}
|
|
642
690
|
],
|
|
643
|
-
"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
|
|
691
|
+
"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"
|
|
644
692
|
},
|
|
645
693
|
{
|
|
646
694
|
"kind": "javascript-module",
|
|
@@ -1239,6 +1287,88 @@
|
|
|
1239
1287
|
],
|
|
1240
1288
|
"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"
|
|
1241
1289
|
},
|
|
1290
|
+
{
|
|
1291
|
+
"kind": "javascript-module",
|
|
1292
|
+
"path": "src/banner/Banner.ts",
|
|
1293
|
+
"declarations": [
|
|
1294
|
+
{
|
|
1295
|
+
"kind": "class",
|
|
1296
|
+
"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.",
|
|
1297
|
+
"name": "Banner",
|
|
1298
|
+
"cssProperties": [
|
|
1299
|
+
{
|
|
1300
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1301
|
+
"name": "--n-banner-border-radius",
|
|
1302
|
+
"default": "var(--n-border-radius)"
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1306
|
+
"name": "--n-banner-box-shadow",
|
|
1307
|
+
"default": "var(--n-box-shadow-card)"
|
|
1308
|
+
}
|
|
1309
|
+
],
|
|
1310
|
+
"slots": [
|
|
1311
|
+
{
|
|
1312
|
+
"description": "default slot",
|
|
1313
|
+
"name": ""
|
|
1314
|
+
}
|
|
1315
|
+
],
|
|
1316
|
+
"members": [
|
|
1317
|
+
{
|
|
1318
|
+
"kind": "field",
|
|
1319
|
+
"name": "variant",
|
|
1320
|
+
"type": {
|
|
1321
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1322
|
+
},
|
|
1323
|
+
"default": "\"info\"",
|
|
1324
|
+
"description": "The style variant of the banner.",
|
|
1325
|
+
"attribute": "variant",
|
|
1326
|
+
"reflects": true
|
|
1327
|
+
}
|
|
1328
|
+
],
|
|
1329
|
+
"attributes": [
|
|
1330
|
+
{
|
|
1331
|
+
"name": "variant",
|
|
1332
|
+
"type": {
|
|
1333
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1334
|
+
},
|
|
1335
|
+
"default": "\"info\"",
|
|
1336
|
+
"description": "The style variant of the banner.",
|
|
1337
|
+
"fieldName": "variant"
|
|
1338
|
+
}
|
|
1339
|
+
],
|
|
1340
|
+
"superclass": {
|
|
1341
|
+
"name": "LitElement",
|
|
1342
|
+
"package": "lit"
|
|
1343
|
+
},
|
|
1344
|
+
"status": "ready",
|
|
1345
|
+
"category": "feedback",
|
|
1346
|
+
"displayName": null,
|
|
1347
|
+
"examples": [],
|
|
1348
|
+
"tagName": "nord-banner",
|
|
1349
|
+
"customElement": true
|
|
1350
|
+
}
|
|
1351
|
+
],
|
|
1352
|
+
"exports": [
|
|
1353
|
+
{
|
|
1354
|
+
"kind": "js",
|
|
1355
|
+
"name": "default",
|
|
1356
|
+
"declaration": {
|
|
1357
|
+
"name": "Banner",
|
|
1358
|
+
"module": "src/banner/Banner.ts"
|
|
1359
|
+
}
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"kind": "custom-element-definition",
|
|
1363
|
+
"name": "nord-banner",
|
|
1364
|
+
"declaration": {
|
|
1365
|
+
"name": "Banner",
|
|
1366
|
+
"module": "src/banner/Banner.ts"
|
|
1367
|
+
}
|
|
1368
|
+
}
|
|
1369
|
+
],
|
|
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 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"
|
|
1371
|
+
},
|
|
1242
1372
|
{
|
|
1243
1373
|
"kind": "javascript-module",
|
|
1244
1374
|
"path": "src/card/Card.ts",
|
|
@@ -1363,620 +1493,402 @@
|
|
|
1363
1493
|
},
|
|
1364
1494
|
{
|
|
1365
1495
|
"kind": "javascript-module",
|
|
1366
|
-
"path": "src/
|
|
1496
|
+
"path": "src/calendar/Calendar.ts",
|
|
1367
1497
|
"declarations": [
|
|
1368
1498
|
{
|
|
1369
1499
|
"kind": "class",
|
|
1370
|
-
"description": "
|
|
1371
|
-
"name": "
|
|
1372
|
-
"
|
|
1373
|
-
{
|
|
1374
|
-
"description": "Use when a label requires more than plain text.",
|
|
1375
|
-
"name": "label"
|
|
1376
|
-
},
|
|
1500
|
+
"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.",
|
|
1501
|
+
"name": "Calendar",
|
|
1502
|
+
"cssProperties": [
|
|
1377
1503
|
{
|
|
1378
|
-
"description": "
|
|
1379
|
-
"name": "
|
|
1504
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1505
|
+
"name": "--n-calendar-border-radius",
|
|
1506
|
+
"default": "var(--n-border-radius)"
|
|
1380
1507
|
},
|
|
1381
1508
|
{
|
|
1382
|
-
"description": "
|
|
1383
|
-
"name": "
|
|
1509
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1510
|
+
"name": "--n-calendar-box-shadow",
|
|
1511
|
+
"default": "var(--n-box-shadow-popout)"
|
|
1384
1512
|
}
|
|
1385
1513
|
],
|
|
1386
1514
|
"members": [
|
|
1387
1515
|
{
|
|
1388
1516
|
"kind": "field",
|
|
1389
|
-
"name": "
|
|
1390
|
-
"
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
}
|
|
1517
|
+
"name": "monthSelectNode",
|
|
1518
|
+
"type": {
|
|
1519
|
+
"text": "HTMLElement"
|
|
1520
|
+
},
|
|
1521
|
+
"privacy": "private"
|
|
1395
1522
|
},
|
|
1396
1523
|
{
|
|
1397
1524
|
"kind": "field",
|
|
1398
|
-
"name": "
|
|
1525
|
+
"name": "focusedDayNode",
|
|
1399
1526
|
"type": {
|
|
1400
|
-
"text": "
|
|
1527
|
+
"text": "HTMLButtonElement"
|
|
1401
1528
|
},
|
|
1402
|
-
"
|
|
1403
|
-
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
1404
|
-
"attribute": "indeterminate"
|
|
1529
|
+
"privacy": "private"
|
|
1405
1530
|
},
|
|
1406
1531
|
{
|
|
1407
1532
|
"kind": "field",
|
|
1408
|
-
"name": "
|
|
1409
|
-
"
|
|
1410
|
-
|
|
1411
|
-
},
|
|
1412
|
-
"default": "false",
|
|
1413
|
-
"description": "Controls whether the checkbox is checked or not.",
|
|
1414
|
-
"attribute": "checked"
|
|
1533
|
+
"name": "direction",
|
|
1534
|
+
"privacy": "private",
|
|
1535
|
+
"default": "new DirectionController(this)"
|
|
1415
1536
|
},
|
|
1416
1537
|
{
|
|
1417
|
-
"kind": "
|
|
1418
|
-
"name": "
|
|
1419
|
-
"privacy": "
|
|
1420
|
-
"
|
|
1421
|
-
{
|
|
1422
|
-
"name": "e",
|
|
1423
|
-
"type": {
|
|
1424
|
-
"text": "Event"
|
|
1425
|
-
}
|
|
1426
|
-
}
|
|
1427
|
-
],
|
|
1428
|
-
"return": {
|
|
1429
|
-
"type": {
|
|
1430
|
-
"text": "void"
|
|
1431
|
-
}
|
|
1432
|
-
},
|
|
1433
|
-
"inheritedFrom": {
|
|
1434
|
-
"name": "FormAssociatedMixin",
|
|
1435
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1436
|
-
}
|
|
1538
|
+
"kind": "field",
|
|
1539
|
+
"name": "swipe",
|
|
1540
|
+
"privacy": "private",
|
|
1541
|
+
"default": "new SwipeController(this, {\n matchesGesture: isHorizontalSwipe,\n onSwipeEnd: ({ distX }) => this.addMonths(distX < 0 ? 1 : -1),\n })"
|
|
1437
1542
|
},
|
|
1438
1543
|
{
|
|
1439
1544
|
"kind": "field",
|
|
1440
|
-
"name": "
|
|
1441
|
-
"
|
|
1442
|
-
"text": "\"s\" | \"m\" | \"l\""
|
|
1443
|
-
},
|
|
1444
|
-
"default": "\"m\"",
|
|
1445
|
-
"description": "The size of the component.",
|
|
1446
|
-
"attribute": "size",
|
|
1447
|
-
"reflects": true,
|
|
1448
|
-
"inheritedFrom": {
|
|
1449
|
-
"name": "SizeMixin",
|
|
1450
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
1451
|
-
}
|
|
1545
|
+
"name": "shortcuts",
|
|
1546
|
+
"privacy": "private"
|
|
1452
1547
|
},
|
|
1453
1548
|
{
|
|
1454
1549
|
"kind": "field",
|
|
1455
|
-
"name": "
|
|
1456
|
-
"privacy": "
|
|
1457
|
-
"default": "new
|
|
1458
|
-
"inheritedFrom": {
|
|
1459
|
-
"name": "FormAssociatedMixin",
|
|
1460
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1461
|
-
}
|
|
1550
|
+
"name": "localize",
|
|
1551
|
+
"privacy": "private",
|
|
1552
|
+
"default": "new LocalizeController<\"nord-calendar\">(this, {\n onLangChange: () => this.handleLangChange(),\n })"
|
|
1462
1553
|
},
|
|
1463
1554
|
{
|
|
1464
1555
|
"kind": "field",
|
|
1465
|
-
"name": "
|
|
1466
|
-
"
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
}
|
|
1556
|
+
"name": "dateFormatShort",
|
|
1557
|
+
"type": {
|
|
1558
|
+
"text": "Intl.DateTimeFormat"
|
|
1559
|
+
},
|
|
1560
|
+
"privacy": "private",
|
|
1561
|
+
"description": "Whilst dateAdapter is used for handling the formatting/parsing dates in the input,\nthese are used to format dates exclusively for the benefit of screen readers.\n\nWe prefer DateTimeFormat over date.toLocaleDateString, as the former has\nbetter performance when formatting large number of dates. See:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleDateString#Performance"
|
|
1472
1562
|
},
|
|
1473
1563
|
{
|
|
1474
1564
|
"kind": "field",
|
|
1475
|
-
"name": "
|
|
1476
|
-
"
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1481
|
-
}
|
|
1565
|
+
"name": "monthNames",
|
|
1566
|
+
"type": {
|
|
1567
|
+
"text": "string[]"
|
|
1568
|
+
},
|
|
1569
|
+
"privacy": "private"
|
|
1482
1570
|
},
|
|
1483
1571
|
{
|
|
1484
1572
|
"kind": "field",
|
|
1485
|
-
"name": "
|
|
1486
|
-
"
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1491
|
-
}
|
|
1573
|
+
"name": "monthNamesShort",
|
|
1574
|
+
"type": {
|
|
1575
|
+
"text": "string[]"
|
|
1576
|
+
},
|
|
1577
|
+
"privacy": "private"
|
|
1492
1578
|
},
|
|
1493
1579
|
{
|
|
1494
1580
|
"kind": "field",
|
|
1495
|
-
"name": "
|
|
1581
|
+
"name": "dayNames",
|
|
1496
1582
|
"type": {
|
|
1497
|
-
"text": "string"
|
|
1583
|
+
"text": "string[]"
|
|
1498
1584
|
},
|
|
1499
|
-
"privacy": "
|
|
1500
|
-
"default": "\"input\"",
|
|
1501
|
-
"inheritedFrom": {
|
|
1502
|
-
"name": "FormAssociatedMixin",
|
|
1503
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1504
|
-
}
|
|
1585
|
+
"privacy": "private"
|
|
1505
1586
|
},
|
|
1506
1587
|
{
|
|
1507
1588
|
"kind": "field",
|
|
1508
|
-
"name": "
|
|
1589
|
+
"name": "dayNamesShort",
|
|
1509
1590
|
"type": {
|
|
1510
|
-
"text": "string"
|
|
1591
|
+
"text": "string[]"
|
|
1511
1592
|
},
|
|
1512
|
-
"privacy": "
|
|
1513
|
-
"default": "\"error\"",
|
|
1514
|
-
"inheritedFrom": {
|
|
1515
|
-
"name": "FormAssociatedMixin",
|
|
1516
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1517
|
-
}
|
|
1593
|
+
"privacy": "private"
|
|
1518
1594
|
},
|
|
1519
1595
|
{
|
|
1520
1596
|
"kind": "field",
|
|
1521
|
-
"name": "
|
|
1597
|
+
"name": "value",
|
|
1522
1598
|
"type": {
|
|
1523
1599
|
"text": "string"
|
|
1524
1600
|
},
|
|
1525
|
-
"
|
|
1526
|
-
"
|
|
1527
|
-
"
|
|
1528
|
-
"name": "FormAssociatedMixin",
|
|
1529
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1530
|
-
}
|
|
1601
|
+
"default": "\"\"",
|
|
1602
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1603
|
+
"attribute": "value"
|
|
1531
1604
|
},
|
|
1532
1605
|
{
|
|
1533
1606
|
"kind": "field",
|
|
1534
|
-
"name": "
|
|
1607
|
+
"name": "firstDayOfWeek",
|
|
1608
|
+
"type": {
|
|
1609
|
+
"text": "DaysOfWeek"
|
|
1610
|
+
},
|
|
1611
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1612
|
+
"attribute": "firstDayOfWeek"
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
"kind": "field",
|
|
1616
|
+
"name": "min",
|
|
1535
1617
|
"type": {
|
|
1536
1618
|
"text": "string"
|
|
1537
1619
|
},
|
|
1538
1620
|
"default": "\"\"",
|
|
1539
|
-
"description": "
|
|
1540
|
-
"attribute": "
|
|
1541
|
-
"inheritedFrom": {
|
|
1542
|
-
"name": "FormAssociatedMixin",
|
|
1543
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1544
|
-
}
|
|
1621
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property.",
|
|
1622
|
+
"attribute": "min"
|
|
1545
1623
|
},
|
|
1546
1624
|
{
|
|
1547
1625
|
"kind": "field",
|
|
1548
|
-
"name": "
|
|
1626
|
+
"name": "max",
|
|
1549
1627
|
"type": {
|
|
1550
|
-
"text": "string
|
|
1628
|
+
"text": "string"
|
|
1551
1629
|
},
|
|
1552
|
-
"
|
|
1553
|
-
"
|
|
1554
|
-
"
|
|
1555
|
-
"name": "FormAssociatedMixin",
|
|
1556
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1557
|
-
}
|
|
1630
|
+
"default": "\"\"",
|
|
1631
|
+
"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.",
|
|
1632
|
+
"attribute": "max"
|
|
1558
1633
|
},
|
|
1559
1634
|
{
|
|
1560
1635
|
"kind": "field",
|
|
1561
|
-
"name": "
|
|
1636
|
+
"name": "expand",
|
|
1562
1637
|
"type": {
|
|
1563
1638
|
"text": "boolean"
|
|
1564
1639
|
},
|
|
1565
1640
|
"default": "false",
|
|
1566
|
-
"description": "
|
|
1567
|
-
"attribute": "
|
|
1568
|
-
"
|
|
1569
|
-
"name": "FormAssociatedMixin",
|
|
1570
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1571
|
-
}
|
|
1641
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1642
|
+
"attribute": "expand",
|
|
1643
|
+
"reflects": true
|
|
1572
1644
|
},
|
|
1573
1645
|
{
|
|
1574
1646
|
"kind": "field",
|
|
1575
|
-
"name": "
|
|
1647
|
+
"name": "isDateDisabled",
|
|
1576
1648
|
"type": {
|
|
1577
|
-
"text": "
|
|
1649
|
+
"text": "DatePredicate"
|
|
1578
1650
|
},
|
|
1579
|
-
"
|
|
1580
|
-
"
|
|
1581
|
-
"inheritedFrom": {
|
|
1582
|
-
"name": "FormAssociatedMixin",
|
|
1583
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1584
|
-
}
|
|
1651
|
+
"default": "isDateDisabled",
|
|
1652
|
+
"description": "Controls which days are disabled and therefore disallowed.\nFor example, this can be used to disallow selection of weekends."
|
|
1585
1653
|
},
|
|
1586
1654
|
{
|
|
1587
1655
|
"kind": "field",
|
|
1588
|
-
"name": "
|
|
1656
|
+
"name": "isDateHighlighted",
|
|
1589
1657
|
"type": {
|
|
1590
|
-
"text": "string |
|
|
1658
|
+
"text": "(date: Date) => string | boolean"
|
|
1591
1659
|
},
|
|
1592
|
-
"
|
|
1593
|
-
"
|
|
1594
|
-
"inheritedFrom": {
|
|
1595
|
-
"name": "FormAssociatedMixin",
|
|
1596
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1597
|
-
}
|
|
1660
|
+
"default": "isDateHighlighted",
|
|
1661
|
+
"description": "Controls which days are highlighted with a small indicator.\nReturning a \"falsy\" value will not show an indicator.\nReturning \"truthy\" value will show the indicator, but without an accessible label.\nReturning a string will show the indicator, and use the string as accessible label.\nIt is recommended to return a string rather than a truthy value whenever possible."
|
|
1598
1662
|
},
|
|
1599
1663
|
{
|
|
1600
1664
|
"kind": "field",
|
|
1601
|
-
"name": "
|
|
1665
|
+
"name": "activeFocus",
|
|
1602
1666
|
"type": {
|
|
1603
1667
|
"text": "boolean"
|
|
1604
1668
|
},
|
|
1605
|
-
"
|
|
1606
|
-
"
|
|
1607
|
-
"attribute": "required",
|
|
1608
|
-
"inheritedFrom": {
|
|
1609
|
-
"name": "FormAssociatedMixin",
|
|
1610
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1611
|
-
}
|
|
1669
|
+
"privacy": "private",
|
|
1670
|
+
"default": "false"
|
|
1612
1671
|
},
|
|
1613
1672
|
{
|
|
1614
1673
|
"kind": "field",
|
|
1615
|
-
"name": "
|
|
1616
|
-
"
|
|
1617
|
-
|
|
1618
|
-
},
|
|
1619
|
-
"default": "false",
|
|
1620
|
-
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
1621
|
-
"attribute": "hide-required",
|
|
1622
|
-
"inheritedFrom": {
|
|
1623
|
-
"name": "FormAssociatedMixin",
|
|
1624
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1625
|
-
}
|
|
1674
|
+
"name": "focusedDay",
|
|
1675
|
+
"privacy": "private",
|
|
1676
|
+
"default": "new Date()"
|
|
1626
1677
|
},
|
|
1627
1678
|
{
|
|
1628
1679
|
"kind": "method",
|
|
1629
|
-
"name": "
|
|
1630
|
-
"privacy": "protected",
|
|
1680
|
+
"name": "focus",
|
|
1631
1681
|
"parameters": [
|
|
1632
1682
|
{
|
|
1633
|
-
"name": "
|
|
1683
|
+
"name": "options",
|
|
1684
|
+
"optional": true,
|
|
1634
1685
|
"type": {
|
|
1635
|
-
"text": "
|
|
1636
|
-
}
|
|
1686
|
+
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
1687
|
+
},
|
|
1688
|
+
"description": "An object which controls aspects of the focusing process."
|
|
1637
1689
|
}
|
|
1638
1690
|
],
|
|
1639
|
-
"
|
|
1640
|
-
"name": "FormAssociatedMixin",
|
|
1641
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1642
|
-
}
|
|
1691
|
+
"description": "Programmatically move focus to the calendar."
|
|
1643
1692
|
},
|
|
1644
1693
|
{
|
|
1645
1694
|
"kind": "method",
|
|
1646
|
-
"name": "
|
|
1647
|
-
"privacy": "protected"
|
|
1695
|
+
"name": "handleValueChange",
|
|
1696
|
+
"privacy": "protected"
|
|
1697
|
+
},
|
|
1698
|
+
{
|
|
1699
|
+
"kind": "method",
|
|
1700
|
+
"name": "handleFocusedDayChange",
|
|
1701
|
+
"privacy": "protected"
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"kind": "method",
|
|
1705
|
+
"name": "handleLangChange",
|
|
1706
|
+
"privacy": "private"
|
|
1707
|
+
},
|
|
1708
|
+
{
|
|
1709
|
+
"kind": "field",
|
|
1710
|
+
"name": "handleDaySelect",
|
|
1711
|
+
"privacy": "private"
|
|
1712
|
+
},
|
|
1713
|
+
{
|
|
1714
|
+
"kind": "method",
|
|
1715
|
+
"name": "addDays",
|
|
1716
|
+
"privacy": "private",
|
|
1648
1717
|
"parameters": [
|
|
1649
1718
|
{
|
|
1650
|
-
"name": "
|
|
1651
|
-
"optional": true,
|
|
1719
|
+
"name": "days",
|
|
1652
1720
|
"type": {
|
|
1653
|
-
"text": "
|
|
1721
|
+
"text": "number"
|
|
1654
1722
|
}
|
|
1655
1723
|
}
|
|
1656
|
-
]
|
|
1657
|
-
"inheritedFrom": {
|
|
1658
|
-
"name": "FormAssociatedMixin",
|
|
1659
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1660
|
-
}
|
|
1724
|
+
]
|
|
1661
1725
|
},
|
|
1662
1726
|
{
|
|
1663
1727
|
"kind": "method",
|
|
1664
|
-
"name": "
|
|
1665
|
-
"privacy": "
|
|
1666
|
-
"
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1728
|
+
"name": "addMonths",
|
|
1729
|
+
"privacy": "private",
|
|
1730
|
+
"parameters": [
|
|
1731
|
+
{
|
|
1732
|
+
"name": "months",
|
|
1733
|
+
"type": {
|
|
1734
|
+
"text": "number"
|
|
1735
|
+
}
|
|
1736
|
+
}
|
|
1737
|
+
]
|
|
1670
1738
|
},
|
|
1671
1739
|
{
|
|
1672
1740
|
"kind": "method",
|
|
1673
|
-
"name": "
|
|
1674
|
-
"privacy": "
|
|
1675
|
-
"
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1741
|
+
"name": "addYears",
|
|
1742
|
+
"privacy": "private",
|
|
1743
|
+
"parameters": [
|
|
1744
|
+
{
|
|
1745
|
+
"name": "years",
|
|
1746
|
+
"type": {
|
|
1747
|
+
"text": "number"
|
|
1748
|
+
}
|
|
1749
|
+
}
|
|
1750
|
+
]
|
|
1679
1751
|
},
|
|
1680
1752
|
{
|
|
1681
1753
|
"kind": "method",
|
|
1682
|
-
"name": "
|
|
1683
|
-
"privacy": "
|
|
1684
|
-
"inheritedFrom": {
|
|
1685
|
-
"name": "FormAssociatedMixin",
|
|
1686
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1687
|
-
}
|
|
1754
|
+
"name": "startOfWeek",
|
|
1755
|
+
"privacy": "private"
|
|
1688
1756
|
},
|
|
1689
1757
|
{
|
|
1690
|
-
"kind": "
|
|
1691
|
-
"name": "
|
|
1692
|
-
"privacy": "
|
|
1693
|
-
"inheritedFrom": {
|
|
1694
|
-
"name": "FormAssociatedMixin",
|
|
1695
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1696
|
-
}
|
|
1758
|
+
"kind": "method",
|
|
1759
|
+
"name": "endOfWeek",
|
|
1760
|
+
"privacy": "private"
|
|
1697
1761
|
},
|
|
1698
1762
|
{
|
|
1699
|
-
"kind": "
|
|
1700
|
-
"name": "
|
|
1701
|
-
"privacy": "
|
|
1702
|
-
"
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1763
|
+
"kind": "method",
|
|
1764
|
+
"name": "setMonth",
|
|
1765
|
+
"privacy": "private",
|
|
1766
|
+
"parameters": [
|
|
1767
|
+
{
|
|
1768
|
+
"name": "month",
|
|
1769
|
+
"type": {
|
|
1770
|
+
"text": "number"
|
|
1771
|
+
}
|
|
1772
|
+
}
|
|
1773
|
+
]
|
|
1706
1774
|
},
|
|
1707
1775
|
{
|
|
1708
|
-
"kind": "
|
|
1709
|
-
"name": "
|
|
1710
|
-
"
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1720
|
-
}
|
|
1776
|
+
"kind": "method",
|
|
1777
|
+
"name": "setYear",
|
|
1778
|
+
"privacy": "private",
|
|
1779
|
+
"parameters": [
|
|
1780
|
+
{
|
|
1781
|
+
"name": "year",
|
|
1782
|
+
"type": {
|
|
1783
|
+
"text": "number"
|
|
1784
|
+
}
|
|
1785
|
+
}
|
|
1786
|
+
]
|
|
1721
1787
|
},
|
|
1722
1788
|
{
|
|
1723
|
-
"kind": "
|
|
1724
|
-
"name": "
|
|
1725
|
-
"
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1789
|
+
"kind": "method",
|
|
1790
|
+
"name": "setFocusedDay",
|
|
1791
|
+
"privacy": "private",
|
|
1792
|
+
"parameters": [
|
|
1793
|
+
{
|
|
1794
|
+
"name": "day",
|
|
1795
|
+
"type": {
|
|
1796
|
+
"text": "Date"
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1799
|
+
]
|
|
1734
1800
|
},
|
|
1735
1801
|
{
|
|
1736
1802
|
"kind": "field",
|
|
1737
|
-
"name": "
|
|
1738
|
-
"
|
|
1739
|
-
"text": "string"
|
|
1740
|
-
},
|
|
1741
|
-
"default": "\"\"",
|
|
1742
|
-
"description": "The value of the form component.",
|
|
1743
|
-
"attribute": "value",
|
|
1744
|
-
"inheritedFrom": {
|
|
1745
|
-
"name": "InputMixin",
|
|
1746
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1747
|
-
}
|
|
1803
|
+
"name": "handleMonthSelect",
|
|
1804
|
+
"privacy": "private"
|
|
1748
1805
|
},
|
|
1749
1806
|
{
|
|
1750
1807
|
"kind": "field",
|
|
1751
|
-
"name": "
|
|
1752
|
-
"
|
|
1753
|
-
"inheritedFrom": {
|
|
1754
|
-
"name": "InputMixin",
|
|
1755
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1756
|
-
}
|
|
1808
|
+
"name": "handleYearSelect",
|
|
1809
|
+
"privacy": "private"
|
|
1757
1810
|
},
|
|
1758
1811
|
{
|
|
1759
1812
|
"kind": "field",
|
|
1760
|
-
"name": "
|
|
1761
|
-
"privacy": "
|
|
1762
|
-
"inheritedFrom": {
|
|
1763
|
-
"name": "FocusableMixin",
|
|
1764
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1765
|
-
}
|
|
1813
|
+
"name": "handleNextMonthClick",
|
|
1814
|
+
"privacy": "private"
|
|
1766
1815
|
},
|
|
1767
1816
|
{
|
|
1768
|
-
"kind": "
|
|
1769
|
-
"name": "
|
|
1770
|
-
"
|
|
1771
|
-
{
|
|
1772
|
-
"name": "options",
|
|
1773
|
-
"optional": true,
|
|
1774
|
-
"type": {
|
|
1775
|
-
"text": "FocusOptions"
|
|
1776
|
-
},
|
|
1777
|
-
"description": "An object which controls aspects of the focusing process."
|
|
1778
|
-
}
|
|
1779
|
-
],
|
|
1780
|
-
"description": "Programmatically move focus to the component.",
|
|
1781
|
-
"inheritedFrom": {
|
|
1782
|
-
"name": "FocusableMixin",
|
|
1783
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1784
|
-
}
|
|
1817
|
+
"kind": "field",
|
|
1818
|
+
"name": "handlePreviousMonthClick",
|
|
1819
|
+
"privacy": "private"
|
|
1785
1820
|
},
|
|
1786
1821
|
{
|
|
1787
|
-
"kind": "
|
|
1788
|
-
"name": "
|
|
1789
|
-
"
|
|
1790
|
-
"inheritedFrom": {
|
|
1791
|
-
"name": "FocusableMixin",
|
|
1792
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1793
|
-
}
|
|
1822
|
+
"kind": "field",
|
|
1823
|
+
"name": "enableActiveFocus",
|
|
1824
|
+
"privacy": "private"
|
|
1794
1825
|
},
|
|
1795
1826
|
{
|
|
1796
|
-
"kind": "
|
|
1797
|
-
"name": "
|
|
1798
|
-
"
|
|
1799
|
-
"inheritedFrom": {
|
|
1800
|
-
"name": "FocusableMixin",
|
|
1801
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1802
|
-
}
|
|
1827
|
+
"kind": "field",
|
|
1828
|
+
"name": "disableActiveFocus",
|
|
1829
|
+
"privacy": "private"
|
|
1803
1830
|
}
|
|
1804
1831
|
],
|
|
1805
|
-
"
|
|
1806
|
-
{
|
|
1807
|
-
"name": "indeterminate",
|
|
1808
|
-
"type": {
|
|
1809
|
-
"text": "boolean"
|
|
1810
|
-
},
|
|
1811
|
-
"default": "false",
|
|
1812
|
-
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
1813
|
-
"fieldName": "indeterminate"
|
|
1814
|
-
},
|
|
1832
|
+
"events": [
|
|
1815
1833
|
{
|
|
1816
|
-
"name": "
|
|
1834
|
+
"name": "nord-focus-date",
|
|
1817
1835
|
"type": {
|
|
1818
|
-
"text": "
|
|
1836
|
+
"text": "DateSelectEvent"
|
|
1819
1837
|
},
|
|
1820
|
-
"
|
|
1821
|
-
"description": "Controls whether the checkbox is checked or not.",
|
|
1822
|
-
"fieldName": "checked"
|
|
1838
|
+
"description": "Dispatched when the calendar's focused date changes."
|
|
1823
1839
|
},
|
|
1824
1840
|
{
|
|
1825
|
-
"name": "size",
|
|
1826
1841
|
"type": {
|
|
1827
|
-
"text": "
|
|
1842
|
+
"text": "DateSelectEvent"
|
|
1828
1843
|
},
|
|
1829
|
-
"
|
|
1830
|
-
"
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
"module": "src/common/mixins/SizeMixin.ts"
|
|
1835
|
-
}
|
|
1836
|
-
},
|
|
1844
|
+
"description": "Dispatched when a date is selected and the value changes.",
|
|
1845
|
+
"name": "change"
|
|
1846
|
+
}
|
|
1847
|
+
],
|
|
1848
|
+
"attributes": [
|
|
1837
1849
|
{
|
|
1838
|
-
"name": "
|
|
1850
|
+
"name": "value",
|
|
1839
1851
|
"type": {
|
|
1840
1852
|
"text": "string"
|
|
1841
1853
|
},
|
|
1842
1854
|
"default": "\"\"",
|
|
1843
|
-
"description": "
|
|
1844
|
-
"fieldName": "
|
|
1845
|
-
"inheritedFrom": {
|
|
1846
|
-
"name": "FormAssociatedMixin",
|
|
1847
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1848
|
-
}
|
|
1849
|
-
},
|
|
1850
|
-
{
|
|
1851
|
-
"name": "hint",
|
|
1852
|
-
"type": {
|
|
1853
|
-
"text": "string | undefined"
|
|
1854
|
-
},
|
|
1855
|
-
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
1856
|
-
"fieldName": "hint",
|
|
1857
|
-
"inheritedFrom": {
|
|
1858
|
-
"name": "FormAssociatedMixin",
|
|
1859
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1860
|
-
}
|
|
1861
|
-
},
|
|
1862
|
-
{
|
|
1863
|
-
"name": "hide-label",
|
|
1864
|
-
"type": {
|
|
1865
|
-
"text": "boolean"
|
|
1866
|
-
},
|
|
1867
|
-
"default": "false",
|
|
1868
|
-
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
1869
|
-
"fieldName": "hideLabel",
|
|
1870
|
-
"inheritedFrom": {
|
|
1871
|
-
"name": "FormAssociatedMixin",
|
|
1872
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1873
|
-
}
|
|
1855
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1856
|
+
"fieldName": "value"
|
|
1874
1857
|
},
|
|
1875
1858
|
{
|
|
1876
|
-
"name": "
|
|
1859
|
+
"name": "firstDayOfWeek",
|
|
1877
1860
|
"type": {
|
|
1878
|
-
"text": "
|
|
1861
|
+
"text": "DaysOfWeek"
|
|
1879
1862
|
},
|
|
1880
|
-
"description": "
|
|
1881
|
-
"fieldName": "
|
|
1882
|
-
"inheritedFrom": {
|
|
1883
|
-
"name": "FormAssociatedMixin",
|
|
1884
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1885
|
-
}
|
|
1863
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1864
|
+
"fieldName": "firstDayOfWeek"
|
|
1886
1865
|
},
|
|
1887
1866
|
{
|
|
1888
|
-
"name": "
|
|
1867
|
+
"name": "min",
|
|
1889
1868
|
"type": {
|
|
1890
|
-
"text": "string
|
|
1869
|
+
"text": "string"
|
|
1891
1870
|
},
|
|
1892
|
-
"
|
|
1893
|
-
"
|
|
1894
|
-
"
|
|
1895
|
-
"name": "FormAssociatedMixin",
|
|
1896
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1897
|
-
}
|
|
1871
|
+
"default": "\"\"",
|
|
1872
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property.",
|
|
1873
|
+
"fieldName": "min"
|
|
1898
1874
|
},
|
|
1899
1875
|
{
|
|
1900
|
-
"name": "
|
|
1876
|
+
"name": "max",
|
|
1901
1877
|
"type": {
|
|
1902
|
-
"text": "
|
|
1878
|
+
"text": "string"
|
|
1903
1879
|
},
|
|
1904
|
-
"default": "
|
|
1905
|
-
"description": "
|
|
1906
|
-
"fieldName": "
|
|
1907
|
-
"inheritedFrom": {
|
|
1908
|
-
"name": "FormAssociatedMixin",
|
|
1909
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1910
|
-
}
|
|
1880
|
+
"default": "\"\"",
|
|
1881
|
+
"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.",
|
|
1882
|
+
"fieldName": "max"
|
|
1911
1883
|
},
|
|
1912
1884
|
{
|
|
1913
|
-
"name": "
|
|
1885
|
+
"name": "expand",
|
|
1914
1886
|
"type": {
|
|
1915
1887
|
"text": "boolean"
|
|
1916
1888
|
},
|
|
1917
1889
|
"default": "false",
|
|
1918
|
-
"description": "
|
|
1919
|
-
"fieldName": "
|
|
1920
|
-
"inheritedFrom": {
|
|
1921
|
-
"name": "FormAssociatedMixin",
|
|
1922
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
1923
|
-
}
|
|
1924
|
-
},
|
|
1925
|
-
{
|
|
1926
|
-
"name": "disabled",
|
|
1927
|
-
"type": {
|
|
1928
|
-
"text": "boolean"
|
|
1929
|
-
},
|
|
1930
|
-
"default": "false",
|
|
1931
|
-
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
1932
|
-
"fieldName": "disabled",
|
|
1933
|
-
"inheritedFrom": {
|
|
1934
|
-
"name": "InputMixin",
|
|
1935
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1936
|
-
}
|
|
1937
|
-
},
|
|
1938
|
-
{
|
|
1939
|
-
"name": "name",
|
|
1940
|
-
"type": {
|
|
1941
|
-
"text": "string | undefined"
|
|
1942
|
-
},
|
|
1943
|
-
"description": "The name of the form component.",
|
|
1944
|
-
"fieldName": "name",
|
|
1945
|
-
"inheritedFrom": {
|
|
1946
|
-
"name": "InputMixin",
|
|
1947
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1948
|
-
}
|
|
1949
|
-
},
|
|
1950
|
-
{
|
|
1951
|
-
"name": "value",
|
|
1952
|
-
"type": {
|
|
1953
|
-
"text": "string"
|
|
1954
|
-
},
|
|
1955
|
-
"default": "\"\"",
|
|
1956
|
-
"description": "The value of the form component.",
|
|
1957
|
-
"fieldName": "value",
|
|
1958
|
-
"inheritedFrom": {
|
|
1959
|
-
"name": "InputMixin",
|
|
1960
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1961
|
-
}
|
|
1962
|
-
}
|
|
1963
|
-
],
|
|
1964
|
-
"mixins": [
|
|
1965
|
-
{
|
|
1966
|
-
"name": "SizeMixin",
|
|
1967
|
-
"module": "/src/common/mixins/SizeMixin.js"
|
|
1968
|
-
},
|
|
1969
|
-
{
|
|
1970
|
-
"name": "FormAssociatedMixin",
|
|
1971
|
-
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
1972
|
-
},
|
|
1973
|
-
{
|
|
1974
|
-
"name": "InputMixin",
|
|
1975
|
-
"module": "/src/common/mixins/InputMixin.js"
|
|
1976
|
-
},
|
|
1977
|
-
{
|
|
1978
|
-
"name": "FocusableMixin",
|
|
1979
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
1890
|
+
"description": "Controls whether the calendar expands to fill the width of its container.",
|
|
1891
|
+
"fieldName": "expand"
|
|
1980
1892
|
}
|
|
1981
1893
|
],
|
|
1982
1894
|
"superclass": {
|
|
@@ -1984,35 +1896,11 @@
|
|
|
1984
1896
|
"package": "lit"
|
|
1985
1897
|
},
|
|
1986
1898
|
"status": "ready",
|
|
1987
|
-
"category": "
|
|
1899
|
+
"category": "list",
|
|
1988
1900
|
"displayName": null,
|
|
1989
1901
|
"examples": [],
|
|
1990
|
-
"tagName": "nord-
|
|
1991
|
-
"customElement": true
|
|
1992
|
-
"events": [
|
|
1993
|
-
{
|
|
1994
|
-
"name": "input",
|
|
1995
|
-
"type": {
|
|
1996
|
-
"text": "NordEvent"
|
|
1997
|
-
},
|
|
1998
|
-
"description": "Fired as the user types into the input.",
|
|
1999
|
-
"inheritedFrom": {
|
|
2000
|
-
"name": "FormAssociatedMixin",
|
|
2001
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2002
|
-
}
|
|
2003
|
-
},
|
|
2004
|
-
{
|
|
2005
|
-
"name": "change",
|
|
2006
|
-
"type": {
|
|
2007
|
-
"text": "NordEvent"
|
|
2008
|
-
},
|
|
2009
|
-
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
2010
|
-
"inheritedFrom": {
|
|
2011
|
-
"name": "FormAssociatedMixin",
|
|
2012
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2013
|
-
}
|
|
2014
|
-
}
|
|
2015
|
-
]
|
|
1902
|
+
"tagName": "nord-calendar",
|
|
1903
|
+
"customElement": true
|
|
2016
1904
|
}
|
|
2017
1905
|
],
|
|
2018
1906
|
"exports": [
|
|
@@ -2020,419 +1908,689 @@
|
|
|
2020
1908
|
"kind": "js",
|
|
2021
1909
|
"name": "default",
|
|
2022
1910
|
"declaration": {
|
|
2023
|
-
"name": "
|
|
2024
|
-
"module": "src/
|
|
1911
|
+
"name": "Calendar",
|
|
1912
|
+
"module": "src/calendar/Calendar.ts"
|
|
2025
1913
|
}
|
|
2026
1914
|
},
|
|
2027
1915
|
{
|
|
2028
1916
|
"kind": "custom-element-definition",
|
|
2029
|
-
"name": "nord-
|
|
1917
|
+
"name": "nord-calendar",
|
|
2030
1918
|
"declaration": {
|
|
2031
|
-
"name": "
|
|
2032
|
-
"module": "src/
|
|
1919
|
+
"name": "Calendar",
|
|
1920
|
+
"module": "src/calendar/Calendar.ts"
|
|
2033
1921
|
}
|
|
2034
1922
|
}
|
|
2035
1923
|
],
|
|
2036
|
-
"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
|
|
1924
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
2037
1925
|
},
|
|
2038
1926
|
{
|
|
2039
1927
|
"kind": "javascript-module",
|
|
2040
|
-
"path": "src/calendar/
|
|
1928
|
+
"path": "src/calendar/DateSelectEvent.ts",
|
|
2041
1929
|
"declarations": [
|
|
2042
1930
|
{
|
|
2043
1931
|
"kind": "class",
|
|
2044
|
-
"description": "
|
|
2045
|
-
"name": "
|
|
2046
|
-
"
|
|
1932
|
+
"description": "",
|
|
1933
|
+
"name": "DateSelectEvent",
|
|
1934
|
+
"superclass": {
|
|
1935
|
+
"name": "NordEvent",
|
|
1936
|
+
"module": "/src/common/events.js"
|
|
1937
|
+
},
|
|
1938
|
+
"examples": []
|
|
1939
|
+
}
|
|
1940
|
+
],
|
|
1941
|
+
"exports": [
|
|
1942
|
+
{
|
|
1943
|
+
"kind": "js",
|
|
1944
|
+
"name": "DateSelectEvent",
|
|
1945
|
+
"declaration": {
|
|
1946
|
+
"name": "DateSelectEvent",
|
|
1947
|
+
"module": "src/calendar/DateSelectEvent.ts"
|
|
1948
|
+
}
|
|
1949
|
+
}
|
|
1950
|
+
],
|
|
1951
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
"kind": "javascript-module",
|
|
1955
|
+
"path": "src/calendar/localization.ts",
|
|
1956
|
+
"declarations": [
|
|
1957
|
+
{
|
|
1958
|
+
"kind": "variable",
|
|
1959
|
+
"name": "calendarLocalization",
|
|
1960
|
+
"type": {
|
|
1961
|
+
"text": "object"
|
|
1962
|
+
},
|
|
1963
|
+
"default": "{\n prevMonthLabel: \"Previous month\",\n nextMonthLabel: \"Next month\",\n monthSelectLabel: \"Month\",\n yearSelectLabel: \"Year\",\n}"
|
|
1964
|
+
}
|
|
1965
|
+
],
|
|
1966
|
+
"exports": [
|
|
1967
|
+
{
|
|
1968
|
+
"kind": "js",
|
|
1969
|
+
"name": "default",
|
|
1970
|
+
"declaration": {
|
|
1971
|
+
"name": "calendarLocalization",
|
|
1972
|
+
"module": "src/calendar/localization.ts"
|
|
1973
|
+
}
|
|
1974
|
+
}
|
|
1975
|
+
],
|
|
1976
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
1977
|
+
},
|
|
1978
|
+
{
|
|
1979
|
+
"kind": "javascript-module",
|
|
1980
|
+
"path": "src/checkbox/Checkbox.ts",
|
|
1981
|
+
"declarations": [
|
|
1982
|
+
{
|
|
1983
|
+
"kind": "class",
|
|
1984
|
+
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
1985
|
+
"name": "Checkbox",
|
|
1986
|
+
"slots": [
|
|
2047
1987
|
{
|
|
2048
|
-
"description": "
|
|
2049
|
-
"name": "
|
|
2050
|
-
"default": "var(--n-border-radius)"
|
|
1988
|
+
"description": "Use when a label requires more than plain text.",
|
|
1989
|
+
"name": "label"
|
|
2051
1990
|
},
|
|
2052
1991
|
{
|
|
2053
|
-
"description": "
|
|
2054
|
-
"name": "
|
|
2055
|
-
|
|
1992
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
1993
|
+
"name": "hint"
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"description": "Optional slot that holds error text for the input.",
|
|
1997
|
+
"name": "error"
|
|
2056
1998
|
}
|
|
2057
1999
|
],
|
|
2058
2000
|
"members": [
|
|
2059
2001
|
{
|
|
2060
2002
|
"kind": "field",
|
|
2061
|
-
"name": "
|
|
2062
|
-
"
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2003
|
+
"name": "formValue",
|
|
2004
|
+
"privacy": "protected",
|
|
2005
|
+
"inheritedFrom": {
|
|
2006
|
+
"name": "FormAssociatedMixin",
|
|
2007
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2008
|
+
}
|
|
2067
2009
|
},
|
|
2068
2010
|
{
|
|
2069
2011
|
"kind": "field",
|
|
2070
|
-
"name": "
|
|
2012
|
+
"name": "indeterminate",
|
|
2071
2013
|
"type": {
|
|
2072
|
-
"text": "
|
|
2014
|
+
"text": "boolean"
|
|
2073
2015
|
},
|
|
2074
|
-
"
|
|
2016
|
+
"default": "false",
|
|
2017
|
+
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2018
|
+
"attribute": "indeterminate"
|
|
2075
2019
|
},
|
|
2076
2020
|
{
|
|
2077
2021
|
"kind": "field",
|
|
2078
|
-
"name": "
|
|
2022
|
+
"name": "checked",
|
|
2079
2023
|
"type": {
|
|
2080
|
-
"text": "
|
|
2024
|
+
"text": "boolean"
|
|
2081
2025
|
},
|
|
2082
|
-
"
|
|
2026
|
+
"default": "false",
|
|
2027
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
2028
|
+
"attribute": "checked"
|
|
2083
2029
|
},
|
|
2084
2030
|
{
|
|
2085
|
-
"kind": "
|
|
2086
|
-
"name": "
|
|
2087
|
-
"privacy": "
|
|
2088
|
-
"
|
|
2031
|
+
"kind": "method",
|
|
2032
|
+
"name": "handleChange",
|
|
2033
|
+
"privacy": "protected",
|
|
2034
|
+
"parameters": [
|
|
2035
|
+
{
|
|
2036
|
+
"name": "e",
|
|
2037
|
+
"type": {
|
|
2038
|
+
"text": "Event"
|
|
2039
|
+
}
|
|
2040
|
+
}
|
|
2041
|
+
],
|
|
2042
|
+
"return": {
|
|
2043
|
+
"type": {
|
|
2044
|
+
"text": "void"
|
|
2045
|
+
}
|
|
2046
|
+
},
|
|
2047
|
+
"inheritedFrom": {
|
|
2048
|
+
"name": "FormAssociatedMixin",
|
|
2049
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2050
|
+
}
|
|
2089
2051
|
},
|
|
2090
2052
|
{
|
|
2091
2053
|
"kind": "field",
|
|
2092
|
-
"name": "
|
|
2093
|
-
"
|
|
2094
|
-
|
|
2054
|
+
"name": "size",
|
|
2055
|
+
"type": {
|
|
2056
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
2057
|
+
},
|
|
2058
|
+
"default": "\"m\"",
|
|
2059
|
+
"description": "The size of the component.",
|
|
2060
|
+
"attribute": "size",
|
|
2061
|
+
"reflects": true,
|
|
2062
|
+
"inheritedFrom": {
|
|
2063
|
+
"name": "SizeMixin",
|
|
2064
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
2065
|
+
}
|
|
2095
2066
|
},
|
|
2096
2067
|
{
|
|
2097
2068
|
"kind": "field",
|
|
2098
|
-
"name": "
|
|
2099
|
-
"privacy": "
|
|
2069
|
+
"name": "labelSlot",
|
|
2070
|
+
"privacy": "protected",
|
|
2071
|
+
"default": "new SlotController(this, \"label\")",
|
|
2072
|
+
"inheritedFrom": {
|
|
2073
|
+
"name": "FormAssociatedMixin",
|
|
2074
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2075
|
+
}
|
|
2100
2076
|
},
|
|
2101
2077
|
{
|
|
2102
2078
|
"kind": "field",
|
|
2103
|
-
"name": "
|
|
2104
|
-
"privacy": "
|
|
2105
|
-
"default": "new
|
|
2106
|
-
|
|
2079
|
+
"name": "errorSlot",
|
|
2080
|
+
"privacy": "protected",
|
|
2081
|
+
"default": "new SlotController(this, \"error\")",
|
|
2082
|
+
"inheritedFrom": {
|
|
2083
|
+
"name": "FormAssociatedMixin",
|
|
2084
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2085
|
+
}
|
|
2086
|
+
},
|
|
2107
2087
|
{
|
|
2108
2088
|
"kind": "field",
|
|
2109
|
-
"name": "
|
|
2110
|
-
"
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2089
|
+
"name": "hintSlot",
|
|
2090
|
+
"privacy": "protected",
|
|
2091
|
+
"default": "new SlotController(this, \"hint\")",
|
|
2092
|
+
"inheritedFrom": {
|
|
2093
|
+
"name": "FormAssociatedMixin",
|
|
2094
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2095
|
+
}
|
|
2115
2096
|
},
|
|
2116
2097
|
{
|
|
2117
2098
|
"kind": "field",
|
|
2118
|
-
"name": "
|
|
2119
|
-
"
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2099
|
+
"name": "formData",
|
|
2100
|
+
"privacy": "protected",
|
|
2101
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
2102
|
+
"inheritedFrom": {
|
|
2103
|
+
"name": "FormAssociatedMixin",
|
|
2104
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2105
|
+
}
|
|
2123
2106
|
},
|
|
2124
2107
|
{
|
|
2125
2108
|
"kind": "field",
|
|
2126
|
-
"name": "
|
|
2109
|
+
"name": "inputId",
|
|
2127
2110
|
"type": {
|
|
2128
|
-
"text": "string
|
|
2111
|
+
"text": "string"
|
|
2129
2112
|
},
|
|
2130
|
-
"privacy": "
|
|
2113
|
+
"privacy": "protected",
|
|
2114
|
+
"default": "\"input\"",
|
|
2115
|
+
"inheritedFrom": {
|
|
2116
|
+
"name": "FormAssociatedMixin",
|
|
2117
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2118
|
+
}
|
|
2131
2119
|
},
|
|
2132
2120
|
{
|
|
2133
2121
|
"kind": "field",
|
|
2134
|
-
"name": "
|
|
2122
|
+
"name": "errorId",
|
|
2135
2123
|
"type": {
|
|
2136
|
-
"text": "string
|
|
2124
|
+
"text": "string"
|
|
2137
2125
|
},
|
|
2138
|
-
"privacy": "
|
|
2126
|
+
"privacy": "protected",
|
|
2127
|
+
"default": "\"error\"",
|
|
2128
|
+
"inheritedFrom": {
|
|
2129
|
+
"name": "FormAssociatedMixin",
|
|
2130
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2131
|
+
}
|
|
2139
2132
|
},
|
|
2140
2133
|
{
|
|
2141
2134
|
"kind": "field",
|
|
2142
|
-
"name": "
|
|
2135
|
+
"name": "hintId",
|
|
2143
2136
|
"type": {
|
|
2144
|
-
"text": "string
|
|
2137
|
+
"text": "string"
|
|
2145
2138
|
},
|
|
2146
|
-
"privacy": "
|
|
2139
|
+
"privacy": "protected",
|
|
2140
|
+
"default": "\"hint\"",
|
|
2141
|
+
"inheritedFrom": {
|
|
2142
|
+
"name": "FormAssociatedMixin",
|
|
2143
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2144
|
+
}
|
|
2147
2145
|
},
|
|
2148
2146
|
{
|
|
2149
2147
|
"kind": "field",
|
|
2150
|
-
"name": "
|
|
2148
|
+
"name": "label",
|
|
2151
2149
|
"type": {
|
|
2152
2150
|
"text": "string"
|
|
2153
2151
|
},
|
|
2154
2152
|
"default": "\"\"",
|
|
2155
|
-
"description": "
|
|
2156
|
-
"attribute": "
|
|
2153
|
+
"description": "Label for the input.",
|
|
2154
|
+
"attribute": "label",
|
|
2155
|
+
"inheritedFrom": {
|
|
2156
|
+
"name": "FormAssociatedMixin",
|
|
2157
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2158
|
+
}
|
|
2157
2159
|
},
|
|
2158
2160
|
{
|
|
2159
2161
|
"kind": "field",
|
|
2160
|
-
"name": "
|
|
2162
|
+
"name": "hint",
|
|
2161
2163
|
"type": {
|
|
2162
|
-
"text": "
|
|
2164
|
+
"text": "string | undefined"
|
|
2163
2165
|
},
|
|
2164
|
-
"description": "
|
|
2165
|
-
"attribute": "
|
|
2166
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
2167
|
+
"attribute": "hint",
|
|
2168
|
+
"inheritedFrom": {
|
|
2169
|
+
"name": "FormAssociatedMixin",
|
|
2170
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2171
|
+
}
|
|
2166
2172
|
},
|
|
2167
2173
|
{
|
|
2168
2174
|
"kind": "field",
|
|
2169
|
-
"name": "
|
|
2175
|
+
"name": "hideLabel",
|
|
2170
2176
|
"type": {
|
|
2171
|
-
"text": "
|
|
2177
|
+
"text": "boolean"
|
|
2172
2178
|
},
|
|
2173
|
-
"default": "
|
|
2174
|
-
"description": "
|
|
2175
|
-
"attribute": "
|
|
2179
|
+
"default": "false",
|
|
2180
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
2181
|
+
"attribute": "hide-label",
|
|
2182
|
+
"inheritedFrom": {
|
|
2183
|
+
"name": "FormAssociatedMixin",
|
|
2184
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2185
|
+
}
|
|
2176
2186
|
},
|
|
2177
2187
|
{
|
|
2178
2188
|
"kind": "field",
|
|
2179
|
-
"name": "
|
|
2189
|
+
"name": "placeholder",
|
|
2180
2190
|
"type": {
|
|
2181
|
-
"text": "string"
|
|
2191
|
+
"text": "string | undefined"
|
|
2182
2192
|
},
|
|
2183
|
-
"
|
|
2184
|
-
"
|
|
2185
|
-
"
|
|
2193
|
+
"description": "Placeholder text to display within the input.",
|
|
2194
|
+
"attribute": "placeholder",
|
|
2195
|
+
"inheritedFrom": {
|
|
2196
|
+
"name": "FormAssociatedMixin",
|
|
2197
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2198
|
+
}
|
|
2186
2199
|
},
|
|
2187
2200
|
{
|
|
2188
2201
|
"kind": "field",
|
|
2189
|
-
"name": "
|
|
2202
|
+
"name": "error",
|
|
2190
2203
|
"type": {
|
|
2191
|
-
"text": "
|
|
2204
|
+
"text": "string | undefined"
|
|
2192
2205
|
},
|
|
2193
|
-
"
|
|
2194
|
-
"
|
|
2195
|
-
"
|
|
2196
|
-
|
|
2206
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
2207
|
+
"attribute": "error",
|
|
2208
|
+
"inheritedFrom": {
|
|
2209
|
+
"name": "FormAssociatedMixin",
|
|
2210
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2211
|
+
}
|
|
2197
2212
|
},
|
|
2198
2213
|
{
|
|
2199
2214
|
"kind": "field",
|
|
2200
|
-
"name": "
|
|
2215
|
+
"name": "required",
|
|
2201
2216
|
"type": {
|
|
2202
|
-
"text": "
|
|
2217
|
+
"text": "boolean"
|
|
2203
2218
|
},
|
|
2204
|
-
"default": "
|
|
2205
|
-
"description": "
|
|
2219
|
+
"default": "false",
|
|
2220
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
2221
|
+
"attribute": "required",
|
|
2222
|
+
"inheritedFrom": {
|
|
2223
|
+
"name": "FormAssociatedMixin",
|
|
2224
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2225
|
+
}
|
|
2206
2226
|
},
|
|
2207
2227
|
{
|
|
2208
2228
|
"kind": "field",
|
|
2209
|
-
"name": "
|
|
2229
|
+
"name": "hideRequired",
|
|
2210
2230
|
"type": {
|
|
2211
2231
|
"text": "boolean"
|
|
2212
2232
|
},
|
|
2213
|
-
"
|
|
2214
|
-
"
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
"default": "new Date()"
|
|
2221
|
-
},
|
|
2222
|
-
{
|
|
2223
|
-
"kind": "method",
|
|
2224
|
-
"name": "focus",
|
|
2225
|
-
"parameters": [
|
|
2226
|
-
{
|
|
2227
|
-
"name": "options",
|
|
2228
|
-
"optional": true,
|
|
2229
|
-
"type": {
|
|
2230
|
-
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
2231
|
-
},
|
|
2232
|
-
"description": "An object which controls aspects of the focusing process."
|
|
2233
|
-
}
|
|
2234
|
-
],
|
|
2235
|
-
"description": "Programmatically move focus to the calendar."
|
|
2236
|
-
},
|
|
2237
|
-
{
|
|
2238
|
-
"kind": "method",
|
|
2239
|
-
"name": "handleValueChange",
|
|
2240
|
-
"privacy": "protected"
|
|
2241
|
-
},
|
|
2242
|
-
{
|
|
2243
|
-
"kind": "method",
|
|
2244
|
-
"name": "handleFocusedDayChange",
|
|
2245
|
-
"privacy": "protected"
|
|
2246
|
-
},
|
|
2247
|
-
{
|
|
2248
|
-
"kind": "method",
|
|
2249
|
-
"name": "handleLangChange",
|
|
2250
|
-
"privacy": "private"
|
|
2251
|
-
},
|
|
2252
|
-
{
|
|
2253
|
-
"kind": "field",
|
|
2254
|
-
"name": "handleDaySelect",
|
|
2255
|
-
"privacy": "private"
|
|
2233
|
+
"default": "false",
|
|
2234
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
2235
|
+
"attribute": "hide-required",
|
|
2236
|
+
"inheritedFrom": {
|
|
2237
|
+
"name": "FormAssociatedMixin",
|
|
2238
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2239
|
+
}
|
|
2256
2240
|
},
|
|
2257
2241
|
{
|
|
2258
2242
|
"kind": "method",
|
|
2259
|
-
"name": "
|
|
2260
|
-
"privacy": "
|
|
2243
|
+
"name": "handleInput",
|
|
2244
|
+
"privacy": "protected",
|
|
2261
2245
|
"parameters": [
|
|
2262
2246
|
{
|
|
2263
|
-
"name": "
|
|
2247
|
+
"name": "e",
|
|
2264
2248
|
"type": {
|
|
2265
|
-
"text": "
|
|
2249
|
+
"text": "Event"
|
|
2266
2250
|
}
|
|
2267
2251
|
}
|
|
2268
|
-
]
|
|
2252
|
+
],
|
|
2253
|
+
"inheritedFrom": {
|
|
2254
|
+
"name": "FormAssociatedMixin",
|
|
2255
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2256
|
+
}
|
|
2269
2257
|
},
|
|
2270
2258
|
{
|
|
2271
2259
|
"kind": "method",
|
|
2272
|
-
"name": "
|
|
2273
|
-
"privacy": "
|
|
2260
|
+
"name": "renderLabel",
|
|
2261
|
+
"privacy": "protected",
|
|
2274
2262
|
"parameters": [
|
|
2275
2263
|
{
|
|
2276
|
-
"name": "
|
|
2264
|
+
"name": "additionalContent",
|
|
2265
|
+
"optional": true,
|
|
2277
2266
|
"type": {
|
|
2278
|
-
"text": "
|
|
2267
|
+
"text": "TemplateResult"
|
|
2279
2268
|
}
|
|
2280
2269
|
}
|
|
2281
|
-
]
|
|
2270
|
+
],
|
|
2271
|
+
"inheritedFrom": {
|
|
2272
|
+
"name": "FormAssociatedMixin",
|
|
2273
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2274
|
+
}
|
|
2282
2275
|
},
|
|
2283
2276
|
{
|
|
2284
2277
|
"kind": "method",
|
|
2285
|
-
"name": "
|
|
2286
|
-
"privacy": "
|
|
2287
|
-
"
|
|
2288
|
-
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
"text": "number"
|
|
2292
|
-
}
|
|
2293
|
-
}
|
|
2294
|
-
]
|
|
2278
|
+
"name": "renderError",
|
|
2279
|
+
"privacy": "protected",
|
|
2280
|
+
"inheritedFrom": {
|
|
2281
|
+
"name": "FormAssociatedMixin",
|
|
2282
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2283
|
+
}
|
|
2295
2284
|
},
|
|
2296
2285
|
{
|
|
2297
2286
|
"kind": "method",
|
|
2298
|
-
"name": "
|
|
2299
|
-
"privacy": "
|
|
2287
|
+
"name": "getDescribedBy",
|
|
2288
|
+
"privacy": "protected",
|
|
2289
|
+
"inheritedFrom": {
|
|
2290
|
+
"name": "FormAssociatedMixin",
|
|
2291
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2292
|
+
}
|
|
2300
2293
|
},
|
|
2301
2294
|
{
|
|
2302
2295
|
"kind": "method",
|
|
2303
|
-
"name": "
|
|
2304
|
-
"privacy": "
|
|
2296
|
+
"name": "getInvalid",
|
|
2297
|
+
"privacy": "protected",
|
|
2298
|
+
"inheritedFrom": {
|
|
2299
|
+
"name": "FormAssociatedMixin",
|
|
2300
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2301
|
+
}
|
|
2305
2302
|
},
|
|
2306
2303
|
{
|
|
2307
|
-
"kind": "
|
|
2308
|
-
"name": "
|
|
2309
|
-
"privacy": "
|
|
2310
|
-
"
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
"text": "number"
|
|
2315
|
-
}
|
|
2316
|
-
}
|
|
2317
|
-
]
|
|
2304
|
+
"kind": "field",
|
|
2305
|
+
"name": "hasHint",
|
|
2306
|
+
"privacy": "protected",
|
|
2307
|
+
"inheritedFrom": {
|
|
2308
|
+
"name": "FormAssociatedMixin",
|
|
2309
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2310
|
+
}
|
|
2318
2311
|
},
|
|
2319
2312
|
{
|
|
2320
|
-
"kind": "
|
|
2321
|
-
"name": "
|
|
2322
|
-
"privacy": "
|
|
2323
|
-
"
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
"text": "number"
|
|
2328
|
-
}
|
|
2329
|
-
}
|
|
2330
|
-
]
|
|
2313
|
+
"kind": "field",
|
|
2314
|
+
"name": "hasError",
|
|
2315
|
+
"privacy": "protected",
|
|
2316
|
+
"inheritedFrom": {
|
|
2317
|
+
"name": "FormAssociatedMixin",
|
|
2318
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2319
|
+
}
|
|
2331
2320
|
},
|
|
2332
2321
|
{
|
|
2333
|
-
"kind": "
|
|
2334
|
-
"name": "
|
|
2335
|
-
"
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2322
|
+
"kind": "field",
|
|
2323
|
+
"name": "disabled",
|
|
2324
|
+
"type": {
|
|
2325
|
+
"text": "boolean"
|
|
2326
|
+
},
|
|
2327
|
+
"default": "false",
|
|
2328
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
2329
|
+
"attribute": "disabled",
|
|
2330
|
+
"reflects": true,
|
|
2331
|
+
"inheritedFrom": {
|
|
2332
|
+
"name": "InputMixin",
|
|
2333
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2334
|
+
}
|
|
2344
2335
|
},
|
|
2345
2336
|
{
|
|
2346
2337
|
"kind": "field",
|
|
2347
|
-
"name": "
|
|
2348
|
-
"
|
|
2338
|
+
"name": "name",
|
|
2339
|
+
"type": {
|
|
2340
|
+
"text": "string | undefined"
|
|
2341
|
+
},
|
|
2342
|
+
"description": "The name of the form component.",
|
|
2343
|
+
"attribute": "name",
|
|
2344
|
+
"inheritedFrom": {
|
|
2345
|
+
"name": "InputMixin",
|
|
2346
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2347
|
+
}
|
|
2349
2348
|
},
|
|
2350
2349
|
{
|
|
2351
2350
|
"kind": "field",
|
|
2352
|
-
"name": "
|
|
2353
|
-
"
|
|
2351
|
+
"name": "value",
|
|
2352
|
+
"type": {
|
|
2353
|
+
"text": "string"
|
|
2354
|
+
},
|
|
2355
|
+
"default": "\"\"",
|
|
2356
|
+
"description": "The value of the form component.",
|
|
2357
|
+
"attribute": "value",
|
|
2358
|
+
"inheritedFrom": {
|
|
2359
|
+
"name": "InputMixin",
|
|
2360
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2361
|
+
}
|
|
2354
2362
|
},
|
|
2355
2363
|
{
|
|
2356
2364
|
"kind": "field",
|
|
2357
|
-
"name": "
|
|
2358
|
-
"
|
|
2365
|
+
"name": "form",
|
|
2366
|
+
"description": "Gets the form, if any, associated with the form element.",
|
|
2367
|
+
"inheritedFrom": {
|
|
2368
|
+
"name": "InputMixin",
|
|
2369
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2370
|
+
}
|
|
2359
2371
|
},
|
|
2360
2372
|
{
|
|
2361
2373
|
"kind": "field",
|
|
2362
|
-
"name": "
|
|
2363
|
-
"privacy": "
|
|
2374
|
+
"name": "focusableRef",
|
|
2375
|
+
"privacy": "protected",
|
|
2376
|
+
"inheritedFrom": {
|
|
2377
|
+
"name": "FocusableMixin",
|
|
2378
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2379
|
+
}
|
|
2364
2380
|
},
|
|
2365
2381
|
{
|
|
2366
|
-
"kind": "
|
|
2367
|
-
"name": "
|
|
2368
|
-
"
|
|
2382
|
+
"kind": "method",
|
|
2383
|
+
"name": "focus",
|
|
2384
|
+
"parameters": [
|
|
2385
|
+
{
|
|
2386
|
+
"name": "options",
|
|
2387
|
+
"optional": true,
|
|
2388
|
+
"type": {
|
|
2389
|
+
"text": "FocusOptions"
|
|
2390
|
+
},
|
|
2391
|
+
"description": "An object which controls aspects of the focusing process."
|
|
2392
|
+
}
|
|
2393
|
+
],
|
|
2394
|
+
"description": "Programmatically move focus to the component.",
|
|
2395
|
+
"inheritedFrom": {
|
|
2396
|
+
"name": "FocusableMixin",
|
|
2397
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2398
|
+
}
|
|
2369
2399
|
},
|
|
2370
2400
|
{
|
|
2371
|
-
"kind": "
|
|
2372
|
-
"name": "
|
|
2373
|
-
"
|
|
2401
|
+
"kind": "method",
|
|
2402
|
+
"name": "blur",
|
|
2403
|
+
"description": "Programmatically remove focus from the component.",
|
|
2404
|
+
"inheritedFrom": {
|
|
2405
|
+
"name": "FocusableMixin",
|
|
2406
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2407
|
+
}
|
|
2408
|
+
},
|
|
2409
|
+
{
|
|
2410
|
+
"kind": "method",
|
|
2411
|
+
"name": "click",
|
|
2412
|
+
"description": "Programmatically simulates a click on the component.",
|
|
2413
|
+
"inheritedFrom": {
|
|
2414
|
+
"name": "FocusableMixin",
|
|
2415
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
2416
|
+
}
|
|
2374
2417
|
}
|
|
2375
2418
|
],
|
|
2376
|
-
"
|
|
2419
|
+
"attributes": [
|
|
2377
2420
|
{
|
|
2378
|
-
"name": "
|
|
2421
|
+
"name": "indeterminate",
|
|
2379
2422
|
"type": {
|
|
2380
|
-
"text": "
|
|
2423
|
+
"text": "boolean"
|
|
2381
2424
|
},
|
|
2382
|
-
"
|
|
2425
|
+
"default": "false",
|
|
2426
|
+
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2427
|
+
"fieldName": "indeterminate"
|
|
2383
2428
|
},
|
|
2384
2429
|
{
|
|
2430
|
+
"name": "checked",
|
|
2385
2431
|
"type": {
|
|
2386
|
-
"text": "
|
|
2432
|
+
"text": "boolean"
|
|
2387
2433
|
},
|
|
2388
|
-
"
|
|
2389
|
-
"
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
"attributes": [
|
|
2434
|
+
"default": "false",
|
|
2435
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
2436
|
+
"fieldName": "checked"
|
|
2437
|
+
},
|
|
2393
2438
|
{
|
|
2394
|
-
"name": "
|
|
2439
|
+
"name": "size",
|
|
2440
|
+
"type": {
|
|
2441
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
2442
|
+
},
|
|
2443
|
+
"default": "\"m\"",
|
|
2444
|
+
"description": "The size of the component.",
|
|
2445
|
+
"fieldName": "size",
|
|
2446
|
+
"inheritedFrom": {
|
|
2447
|
+
"name": "SizeMixin",
|
|
2448
|
+
"module": "src/common/mixins/SizeMixin.ts"
|
|
2449
|
+
}
|
|
2450
|
+
},
|
|
2451
|
+
{
|
|
2452
|
+
"name": "label",
|
|
2395
2453
|
"type": {
|
|
2396
2454
|
"text": "string"
|
|
2397
2455
|
},
|
|
2398
2456
|
"default": "\"\"",
|
|
2399
|
-
"description": "
|
|
2400
|
-
"fieldName": "
|
|
2457
|
+
"description": "Label for the input.",
|
|
2458
|
+
"fieldName": "label",
|
|
2459
|
+
"inheritedFrom": {
|
|
2460
|
+
"name": "FormAssociatedMixin",
|
|
2461
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2462
|
+
}
|
|
2401
2463
|
},
|
|
2402
2464
|
{
|
|
2403
|
-
"name": "
|
|
2465
|
+
"name": "hint",
|
|
2404
2466
|
"type": {
|
|
2405
|
-
"text": "
|
|
2467
|
+
"text": "string | undefined"
|
|
2406
2468
|
},
|
|
2407
|
-
"description": "
|
|
2408
|
-
"fieldName": "
|
|
2469
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
2470
|
+
"fieldName": "hint",
|
|
2471
|
+
"inheritedFrom": {
|
|
2472
|
+
"name": "FormAssociatedMixin",
|
|
2473
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2474
|
+
}
|
|
2409
2475
|
},
|
|
2410
2476
|
{
|
|
2411
|
-
"name": "
|
|
2477
|
+
"name": "hide-label",
|
|
2412
2478
|
"type": {
|
|
2413
|
-
"text": "
|
|
2479
|
+
"text": "boolean"
|
|
2414
2480
|
},
|
|
2415
|
-
"default": "
|
|
2416
|
-
"description": "
|
|
2417
|
-
"fieldName": "
|
|
2481
|
+
"default": "false",
|
|
2482
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
2483
|
+
"fieldName": "hideLabel",
|
|
2484
|
+
"inheritedFrom": {
|
|
2485
|
+
"name": "FormAssociatedMixin",
|
|
2486
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2487
|
+
}
|
|
2418
2488
|
},
|
|
2419
2489
|
{
|
|
2420
|
-
"name": "
|
|
2490
|
+
"name": "placeholder",
|
|
2421
2491
|
"type": {
|
|
2422
|
-
"text": "string"
|
|
2492
|
+
"text": "string | undefined"
|
|
2423
2493
|
},
|
|
2424
|
-
"
|
|
2425
|
-
"
|
|
2426
|
-
"
|
|
2494
|
+
"description": "Placeholder text to display within the input.",
|
|
2495
|
+
"fieldName": "placeholder",
|
|
2496
|
+
"inheritedFrom": {
|
|
2497
|
+
"name": "FormAssociatedMixin",
|
|
2498
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2499
|
+
}
|
|
2427
2500
|
},
|
|
2428
2501
|
{
|
|
2429
|
-
"name": "
|
|
2502
|
+
"name": "error",
|
|
2503
|
+
"type": {
|
|
2504
|
+
"text": "string | undefined"
|
|
2505
|
+
},
|
|
2506
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
2507
|
+
"fieldName": "error",
|
|
2508
|
+
"inheritedFrom": {
|
|
2509
|
+
"name": "FormAssociatedMixin",
|
|
2510
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2511
|
+
}
|
|
2512
|
+
},
|
|
2513
|
+
{
|
|
2514
|
+
"name": "required",
|
|
2430
2515
|
"type": {
|
|
2431
2516
|
"text": "boolean"
|
|
2432
2517
|
},
|
|
2433
2518
|
"default": "false",
|
|
2434
|
-
"description": "
|
|
2435
|
-
"fieldName": "
|
|
2519
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
2520
|
+
"fieldName": "required",
|
|
2521
|
+
"inheritedFrom": {
|
|
2522
|
+
"name": "FormAssociatedMixin",
|
|
2523
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2524
|
+
}
|
|
2525
|
+
},
|
|
2526
|
+
{
|
|
2527
|
+
"name": "hide-required",
|
|
2528
|
+
"type": {
|
|
2529
|
+
"text": "boolean"
|
|
2530
|
+
},
|
|
2531
|
+
"default": "false",
|
|
2532
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
2533
|
+
"fieldName": "hideRequired",
|
|
2534
|
+
"inheritedFrom": {
|
|
2535
|
+
"name": "FormAssociatedMixin",
|
|
2536
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2537
|
+
}
|
|
2538
|
+
},
|
|
2539
|
+
{
|
|
2540
|
+
"name": "disabled",
|
|
2541
|
+
"type": {
|
|
2542
|
+
"text": "boolean"
|
|
2543
|
+
},
|
|
2544
|
+
"default": "false",
|
|
2545
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
2546
|
+
"fieldName": "disabled",
|
|
2547
|
+
"inheritedFrom": {
|
|
2548
|
+
"name": "InputMixin",
|
|
2549
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2550
|
+
}
|
|
2551
|
+
},
|
|
2552
|
+
{
|
|
2553
|
+
"name": "name",
|
|
2554
|
+
"type": {
|
|
2555
|
+
"text": "string | undefined"
|
|
2556
|
+
},
|
|
2557
|
+
"description": "The name of the form component.",
|
|
2558
|
+
"fieldName": "name",
|
|
2559
|
+
"inheritedFrom": {
|
|
2560
|
+
"name": "InputMixin",
|
|
2561
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2562
|
+
}
|
|
2563
|
+
},
|
|
2564
|
+
{
|
|
2565
|
+
"name": "value",
|
|
2566
|
+
"type": {
|
|
2567
|
+
"text": "string"
|
|
2568
|
+
},
|
|
2569
|
+
"default": "\"\"",
|
|
2570
|
+
"description": "The value of the form component.",
|
|
2571
|
+
"fieldName": "value",
|
|
2572
|
+
"inheritedFrom": {
|
|
2573
|
+
"name": "InputMixin",
|
|
2574
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
2575
|
+
}
|
|
2576
|
+
}
|
|
2577
|
+
],
|
|
2578
|
+
"mixins": [
|
|
2579
|
+
{
|
|
2580
|
+
"name": "SizeMixin",
|
|
2581
|
+
"module": "/src/common/mixins/SizeMixin.js"
|
|
2582
|
+
},
|
|
2583
|
+
{
|
|
2584
|
+
"name": "FormAssociatedMixin",
|
|
2585
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
2586
|
+
},
|
|
2587
|
+
{
|
|
2588
|
+
"name": "InputMixin",
|
|
2589
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
2590
|
+
},
|
|
2591
|
+
{
|
|
2592
|
+
"name": "FocusableMixin",
|
|
2593
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
2436
2594
|
}
|
|
2437
2595
|
],
|
|
2438
2596
|
"superclass": {
|
|
@@ -2440,109 +2598,32 @@
|
|
|
2440
2598
|
"package": "lit"
|
|
2441
2599
|
},
|
|
2442
2600
|
"status": "ready",
|
|
2443
|
-
"category": "
|
|
2601
|
+
"category": "form",
|
|
2444
2602
|
"displayName": null,
|
|
2445
2603
|
"examples": [],
|
|
2446
|
-
"tagName": "nord-
|
|
2447
|
-
"customElement": true
|
|
2448
|
-
|
|
2449
|
-
],
|
|
2450
|
-
"exports": [
|
|
2451
|
-
{
|
|
2452
|
-
"kind": "js",
|
|
2453
|
-
"name": "default",
|
|
2454
|
-
"declaration": {
|
|
2455
|
-
"name": "Calendar",
|
|
2456
|
-
"module": "src/calendar/Calendar.ts"
|
|
2457
|
-
}
|
|
2458
|
-
},
|
|
2459
|
-
{
|
|
2460
|
-
"kind": "custom-element-definition",
|
|
2461
|
-
"name": "nord-calendar",
|
|
2462
|
-
"declaration": {
|
|
2463
|
-
"name": "Calendar",
|
|
2464
|
-
"module": "src/calendar/Calendar.ts"
|
|
2465
|
-
}
|
|
2466
|
-
}
|
|
2467
|
-
],
|
|
2468
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
2469
|
-
},
|
|
2470
|
-
{
|
|
2471
|
-
"kind": "javascript-module",
|
|
2472
|
-
"path": "src/calendar/DateSelectEvent.ts",
|
|
2473
|
-
"declarations": [
|
|
2474
|
-
{
|
|
2475
|
-
"kind": "class",
|
|
2476
|
-
"description": "",
|
|
2477
|
-
"name": "DateSelectEvent",
|
|
2478
|
-
"superclass": {
|
|
2479
|
-
"name": "NordEvent",
|
|
2480
|
-
"module": "/src/common/events.js"
|
|
2481
|
-
},
|
|
2482
|
-
"examples": []
|
|
2483
|
-
}
|
|
2484
|
-
],
|
|
2485
|
-
"exports": [
|
|
2486
|
-
{
|
|
2487
|
-
"kind": "js",
|
|
2488
|
-
"name": "DateSelectEvent",
|
|
2489
|
-
"declaration": {
|
|
2490
|
-
"name": "DateSelectEvent",
|
|
2491
|
-
"module": "src/calendar/DateSelectEvent.ts"
|
|
2492
|
-
}
|
|
2493
|
-
}
|
|
2494
|
-
],
|
|
2495
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
2496
|
-
},
|
|
2497
|
-
{
|
|
2498
|
-
"kind": "javascript-module",
|
|
2499
|
-
"path": "src/calendar/localization.ts",
|
|
2500
|
-
"declarations": [
|
|
2501
|
-
{
|
|
2502
|
-
"kind": "variable",
|
|
2503
|
-
"name": "calendarLocalization",
|
|
2504
|
-
"type": {
|
|
2505
|
-
"text": "object"
|
|
2506
|
-
},
|
|
2507
|
-
"default": "{\n prevMonthLabel: \"Previous month\",\n nextMonthLabel: \"Next month\",\n monthSelectLabel: \"Month\",\n yearSelectLabel: \"Year\",\n}"
|
|
2508
|
-
}
|
|
2509
|
-
],
|
|
2510
|
-
"exports": [
|
|
2511
|
-
{
|
|
2512
|
-
"kind": "js",
|
|
2513
|
-
"name": "default",
|
|
2514
|
-
"declaration": {
|
|
2515
|
-
"name": "calendarLocalization",
|
|
2516
|
-
"module": "src/calendar/localization.ts"
|
|
2517
|
-
}
|
|
2518
|
-
}
|
|
2519
|
-
],
|
|
2520
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use when the user needs to choose a single date or a date range.\n- Close calendar after a single date is selected, unless a range with a start and end date is required.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for entering date of birth. Use input component instead.\n- Don’t use for choosing a date that is over 10 years in the future or the past.\n\n</div>\n\n---\n\n## Keyboard accessibility\n\nCalendar component is built to closely follow [W3C Date Picker Dialog example](https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html) with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.\n\n### Month/year buttons\n\n- `Space, Enter`: Changes the month and/or year displayed.\n\n### Calendar grid\n\n- `Space, Enter`: Selects a date.\n- `Arrow up`: Moves focus to the same day of the previous week.\n- `Arrow down`: Moves focus to the same day of the next week.\n- `Arrow right`: Moves focus to the next day. In right-to-left languages, moves focus to the previous day.\n- `Arrow left`: Moves focus to the previous day. In right-to-left languages, moves focus to the next day.\n- `Home`: Moves focus to the first day (e.g Monday) of the current week.\n- `End`: Moves focus to the last day (e.g. Sunday) of the current week.\n- `Page Up`: Changes the grid of dates to the previous month and sets focus on the same day of the same week.\n- `Shift + Page Up`: Changes the grid of dates to the previous year and sets focus on the same day of the same week.\n- `Page Down`: Changes the grid of dates to the next month and sets focus on the same day of the same week.\n- `Shift + Page Down`: Changes the grid of dates to the next year and sets focus on the same day of the same week.\n"
|
|
2521
|
-
},
|
|
2522
|
-
{
|
|
2523
|
-
"kind": "javascript-module",
|
|
2524
|
-
"path": "src/calendar/month-view.ts",
|
|
2525
|
-
"declarations": [
|
|
2526
|
-
{
|
|
2527
|
-
"kind": "function",
|
|
2528
|
-
"name": "dayView",
|
|
2529
|
-
"parameters": [
|
|
2604
|
+
"tagName": "nord-checkbox",
|
|
2605
|
+
"customElement": true,
|
|
2606
|
+
"events": [
|
|
2530
2607
|
{
|
|
2531
|
-
"name": "
|
|
2608
|
+
"name": "input",
|
|
2532
2609
|
"type": {
|
|
2533
|
-
"text": "
|
|
2610
|
+
"text": "NordEvent"
|
|
2611
|
+
},
|
|
2612
|
+
"description": "Fired as the user types into the input.",
|
|
2613
|
+
"inheritedFrom": {
|
|
2614
|
+
"name": "FormAssociatedMixin",
|
|
2615
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2534
2616
|
}
|
|
2535
|
-
}
|
|
2536
|
-
]
|
|
2537
|
-
},
|
|
2538
|
-
{
|
|
2539
|
-
"kind": "function",
|
|
2540
|
-
"name": "monthView",
|
|
2541
|
-
"parameters": [
|
|
2617
|
+
},
|
|
2542
2618
|
{
|
|
2543
|
-
"name": "
|
|
2619
|
+
"name": "change",
|
|
2544
2620
|
"type": {
|
|
2545
|
-
"text": "
|
|
2621
|
+
"text": "NordEvent"
|
|
2622
|
+
},
|
|
2623
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
2624
|
+
"inheritedFrom": {
|
|
2625
|
+
"name": "FormAssociatedMixin",
|
|
2626
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2546
2627
|
}
|
|
2547
2628
|
}
|
|
2548
2629
|
]
|
|
@@ -2551,22 +2632,22 @@
|
|
|
2551
2632
|
"exports": [
|
|
2552
2633
|
{
|
|
2553
2634
|
"kind": "js",
|
|
2554
|
-
"name": "
|
|
2635
|
+
"name": "default",
|
|
2555
2636
|
"declaration": {
|
|
2556
|
-
"name": "
|
|
2557
|
-
"module": "src/
|
|
2637
|
+
"name": "Checkbox",
|
|
2638
|
+
"module": "src/checkbox/Checkbox.ts"
|
|
2558
2639
|
}
|
|
2559
2640
|
},
|
|
2560
2641
|
{
|
|
2561
|
-
"kind": "
|
|
2562
|
-
"name": "
|
|
2642
|
+
"kind": "custom-element-definition",
|
|
2643
|
+
"name": "nord-checkbox",
|
|
2563
2644
|
"declaration": {
|
|
2564
|
-
"name": "
|
|
2565
|
-
"module": "src/
|
|
2645
|
+
"name": "Checkbox",
|
|
2646
|
+
"module": "src/checkbox/Checkbox.ts"
|
|
2566
2647
|
}
|
|
2567
2648
|
}
|
|
2568
2649
|
],
|
|
2569
|
-
"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
|
|
2650
|
+
"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 making it possible to choose one or more options from a limited number of options.\n- Use for “accepting terms of service” and similar functionality.\n- Use in forms to toggle something on or off.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another checkbox when another one is clicked. Only exception is when a checkbox is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nCheckbox labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing checkbox labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n"
|
|
2570
2651
|
},
|
|
2571
2652
|
{
|
|
2572
2653
|
"kind": "javascript-module",
|
|
@@ -4608,11 +4689,20 @@
|
|
|
4608
4689
|
"kind": "field",
|
|
4609
4690
|
"name": "isDateDisabled",
|
|
4610
4691
|
"type": {
|
|
4611
|
-
"text": "
|
|
4692
|
+
"text": "DatePredicate"
|
|
4612
4693
|
},
|
|
4613
4694
|
"default": "isDateDisabled",
|
|
4614
4695
|
"description": "Controls which days are disabled and therefore disallowed.\nFor example, this can be used to disallow selection of weekends."
|
|
4615
4696
|
},
|
|
4697
|
+
{
|
|
4698
|
+
"kind": "field",
|
|
4699
|
+
"name": "isDateHighlighted",
|
|
4700
|
+
"type": {
|
|
4701
|
+
"text": "(date: Date) => string | boolean"
|
|
4702
|
+
},
|
|
4703
|
+
"default": "isDateHighlighted",
|
|
4704
|
+
"description": "Controls which days are highlighted with a small indicator.\nReturning `false` will not show an indicator.\nReturning `true` will show the indicator, but without an accessible label. Therefore\nReturning a string will show the indicator, and use the string as accessible label.\nIt is recommended to return a string rather than `true` whenever possible."
|
|
4705
|
+
},
|
|
4616
4706
|
{
|
|
4617
4707
|
"kind": "field",
|
|
4618
4708
|
"name": "expand",
|
|
@@ -7463,6 +7553,12 @@
|
|
|
7463
7553
|
},
|
|
7464
7554
|
"privacy": "private"
|
|
7465
7555
|
},
|
|
7556
|
+
{
|
|
7557
|
+
"kind": "field",
|
|
7558
|
+
"name": "resizeObserver",
|
|
7559
|
+
"privacy": "private",
|
|
7560
|
+
"default": "new ResizeObserver(entries => {\n this.stickySize = Math.round(entries[0].borderBoxSize[0].blockSize)\n })"
|
|
7561
|
+
},
|
|
7466
7562
|
{
|
|
7467
7563
|
"kind": "field",
|
|
7468
7564
|
"name": "navSlot",
|
|
@@ -7493,6 +7589,14 @@
|
|
|
7493
7589
|
"privacy": "private",
|
|
7494
7590
|
"default": "new LightDismissController(this, {\n isOpen: () => this.navState === \"opened\" && !this.wideScreen,\n onDismiss: () => this.navTransition(\"close\"),\n isDismissible: node => node !== this.navEl,\n })"
|
|
7495
7591
|
},
|
|
7592
|
+
{
|
|
7593
|
+
"kind": "field",
|
|
7594
|
+
"name": "stickyElement",
|
|
7595
|
+
"type": {
|
|
7596
|
+
"text": "HTMLDivElement"
|
|
7597
|
+
},
|
|
7598
|
+
"privacy": "private"
|
|
7599
|
+
},
|
|
7496
7600
|
{
|
|
7497
7601
|
"kind": "field",
|
|
7498
7602
|
"name": "navEl",
|
|
@@ -7528,6 +7632,15 @@
|
|
|
7528
7632
|
"name": "wideScreen",
|
|
7529
7633
|
"privacy": "private"
|
|
7530
7634
|
},
|
|
7635
|
+
{
|
|
7636
|
+
"kind": "field",
|
|
7637
|
+
"name": "stickySize",
|
|
7638
|
+
"type": {
|
|
7639
|
+
"text": "number | null"
|
|
7640
|
+
},
|
|
7641
|
+
"privacy": "private",
|
|
7642
|
+
"default": "0"
|
|
7643
|
+
},
|
|
7531
7644
|
{
|
|
7532
7645
|
"kind": "field",
|
|
7533
7646
|
"name": "navOpen",
|
|
@@ -7559,11 +7672,35 @@
|
|
|
7559
7672
|
"attribute": "padding",
|
|
7560
7673
|
"reflects": true
|
|
7561
7674
|
},
|
|
7675
|
+
{
|
|
7676
|
+
"kind": "field",
|
|
7677
|
+
"name": "sticky",
|
|
7678
|
+
"type": {
|
|
7679
|
+
"text": "boolean"
|
|
7680
|
+
},
|
|
7681
|
+
"default": "false",
|
|
7682
|
+
"description": "Controls whether the layout's header has sticky positioning.",
|
|
7683
|
+
"attribute": "sticky",
|
|
7684
|
+
"reflects": true
|
|
7685
|
+
},
|
|
7562
7686
|
{
|
|
7563
7687
|
"kind": "method",
|
|
7564
7688
|
"name": "renderNavToggle",
|
|
7565
7689
|
"privacy": "private"
|
|
7566
7690
|
},
|
|
7691
|
+
{
|
|
7692
|
+
"kind": "method",
|
|
7693
|
+
"name": "handleStickyChange",
|
|
7694
|
+
"privacy": "protected",
|
|
7695
|
+
"parameters": [
|
|
7696
|
+
{
|
|
7697
|
+
"name": "prev",
|
|
7698
|
+
"type": {
|
|
7699
|
+
"text": "boolean"
|
|
7700
|
+
}
|
|
7701
|
+
}
|
|
7702
|
+
]
|
|
7703
|
+
},
|
|
7567
7704
|
{
|
|
7568
7705
|
"kind": "method",
|
|
7569
7706
|
"name": "handleNavWidthChange",
|
|
@@ -7763,6 +7900,15 @@
|
|
|
7763
7900
|
"default": "\"m\"",
|
|
7764
7901
|
"description": "Controls the padding of the default main section slot. When set to “none”,\nthe nav and header slots will still have padding.",
|
|
7765
7902
|
"fieldName": "padding"
|
|
7903
|
+
},
|
|
7904
|
+
{
|
|
7905
|
+
"name": "sticky",
|
|
7906
|
+
"type": {
|
|
7907
|
+
"text": "boolean"
|
|
7908
|
+
},
|
|
7909
|
+
"default": "false",
|
|
7910
|
+
"description": "Controls whether the layout's header has sticky positioning.",
|
|
7911
|
+
"fieldName": "sticky"
|
|
7766
7912
|
}
|
|
7767
7913
|
],
|
|
7768
7914
|
"superclass": {
|
|
@@ -8279,7 +8425,7 @@
|
|
|
8279
8425
|
"name": "LitElement",
|
|
8280
8426
|
"package": "lit"
|
|
8281
8427
|
},
|
|
8282
|
-
"status": "
|
|
8428
|
+
"status": "ready",
|
|
8283
8429
|
"category": "overlay",
|
|
8284
8430
|
"displayName": null,
|
|
8285
8431
|
"examples": [],
|
|
@@ -8866,37 +9012,19 @@
|
|
|
8866
9012
|
"name": "FocusableMixin",
|
|
8867
9013
|
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8868
9014
|
}
|
|
8869
|
-
},
|
|
8870
|
-
{
|
|
8871
|
-
"kind": "field",
|
|
8872
|
-
"name": "_warningLogged",
|
|
8873
|
-
"type": {
|
|
8874
|
-
"text": "boolean"
|
|
8875
|
-
},
|
|
8876
|
-
"privacy": "private",
|
|
8877
|
-
"static": true,
|
|
8878
|
-
"default": "false",
|
|
8879
|
-
"inheritedFrom": {
|
|
8880
|
-
"name": "DraftComponentMixin",
|
|
8881
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
8882
|
-
}
|
|
8883
9015
|
}
|
|
8884
9016
|
],
|
|
8885
9017
|
"mixins": [
|
|
8886
9018
|
{
|
|
8887
9019
|
"name": "FocusableMixin",
|
|
8888
9020
|
"module": "/src/common/mixins/FocusableMixin.js"
|
|
8889
|
-
},
|
|
8890
|
-
{
|
|
8891
|
-
"name": "DraftComponentMixin",
|
|
8892
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
8893
9021
|
}
|
|
8894
9022
|
],
|
|
8895
9023
|
"superclass": {
|
|
8896
9024
|
"name": "LitElement",
|
|
8897
9025
|
"package": "lit"
|
|
8898
9026
|
},
|
|
8899
|
-
"status": "
|
|
9027
|
+
"status": "new",
|
|
8900
9028
|
"category": "action",
|
|
8901
9029
|
"displayName": null,
|
|
8902
9030
|
"examples": [],
|
|
@@ -9422,248 +9550,63 @@
|
|
|
9422
9550
|
"name": "blur",
|
|
9423
9551
|
"description": "Programmatically remove focus from the component.",
|
|
9424
9552
|
"inheritedFrom": {
|
|
9425
|
-
"name": "FocusableMixin",
|
|
9426
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9427
|
-
}
|
|
9428
|
-
},
|
|
9429
|
-
{
|
|
9430
|
-
"kind": "method",
|
|
9431
|
-
"name": "click",
|
|
9432
|
-
"description": "Programmatically simulates a click on the component.",
|
|
9433
|
-
"inheritedFrom": {
|
|
9434
|
-
"name": "FocusableMixin",
|
|
9435
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9436
|
-
}
|
|
9437
|
-
}
|
|
9438
|
-
],
|
|
9439
|
-
"attributes": [
|
|
9440
|
-
{
|
|
9441
|
-
"name": "value",
|
|
9442
|
-
"type": {
|
|
9443
|
-
"text": "number | undefined"
|
|
9444
|
-
},
|
|
9445
|
-
"description": "Specifies how much of the task has been completed. Must be a valid floating\npoint number between 0 and max, or between 0 and 100 if max is omitted. If\nthere is no value, the progress bar is indeterminate; this indicates that\nan activity is ongoing with no indication of how long it’s expected to take.",
|
|
9446
|
-
"fieldName": "value"
|
|
9447
|
-
},
|
|
9448
|
-
{
|
|
9449
|
-
"name": "max",
|
|
9450
|
-
"type": {
|
|
9451
|
-
"text": "number"
|
|
9452
|
-
},
|
|
9453
|
-
"default": "100",
|
|
9454
|
-
"description": "Describes how much work the task indicated by the progress element requires.\nThe max attribute, if present, must have a value greater than 0 and be a\nvalid floating point number.",
|
|
9455
|
-
"fieldName": "max"
|
|
9456
|
-
},
|
|
9457
|
-
{
|
|
9458
|
-
"name": "label",
|
|
9459
|
-
"type": {
|
|
9460
|
-
"text": "string"
|
|
9461
|
-
},
|
|
9462
|
-
"default": "\"Current progress\"",
|
|
9463
|
-
"description": "Accessible label for the progress indicator. Visually hidden, but shown\nfor assistive technology.",
|
|
9464
|
-
"fieldName": "label"
|
|
9465
|
-
}
|
|
9466
|
-
],
|
|
9467
|
-
"mixins": [
|
|
9468
|
-
{
|
|
9469
|
-
"name": "FocusableMixin",
|
|
9470
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
9471
|
-
}
|
|
9472
|
-
],
|
|
9473
|
-
"superclass": {
|
|
9474
|
-
"name": "LitElement",
|
|
9475
|
-
"package": "lit"
|
|
9476
|
-
},
|
|
9477
|
-
"status": "ready",
|
|
9478
|
-
"category": "feedback",
|
|
9479
|
-
"displayName": null,
|
|
9480
|
-
"examples": [],
|
|
9481
|
-
"tagName": "nord-progress-bar",
|
|
9482
|
-
"customElement": true
|
|
9483
|
-
}
|
|
9484
|
-
],
|
|
9485
|
-
"exports": [
|
|
9486
|
-
{
|
|
9487
|
-
"kind": "js",
|
|
9488
|
-
"name": "default",
|
|
9489
|
-
"declaration": {
|
|
9490
|
-
"name": "ProgressBar",
|
|
9491
|
-
"module": "src/progress-bar/ProgressBar.ts"
|
|
9492
|
-
}
|
|
9493
|
-
},
|
|
9494
|
-
{
|
|
9495
|
-
"kind": "custom-element-definition",
|
|
9496
|
-
"name": "nord-progress-bar",
|
|
9497
|
-
"declaration": {
|
|
9498
|
-
"name": "ProgressBar",
|
|
9499
|
-
"module": "src/progress-bar/ProgressBar.ts"
|
|
9500
|
-
}
|
|
9501
|
-
}
|
|
9502
|
-
],
|
|
9503
|
-
"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 show the completion status of an ongoing task.\n- Use progress bar when you can determine the percentage of the completed task at any time.\n- Always provide an accessible label when using Progress Bar.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use in constrained spaces indicating indeterminate loading state, see [Spinner](/components/spinner/) instead.\n\n</div>\n"
|
|
9504
|
-
},
|
|
9505
|
-
{
|
|
9506
|
-
"kind": "javascript-module",
|
|
9507
|
-
"path": "src/qrcode/Qrcode.ts",
|
|
9508
|
-
"declarations": [
|
|
9509
|
-
{
|
|
9510
|
-
"kind": "class",
|
|
9511
|
-
"description": "QR Code component is used for providing information or links\nto users which they can quickly scan with their smartphone.",
|
|
9512
|
-
"name": "Qrcode",
|
|
9513
|
-
"members": [
|
|
9514
|
-
{
|
|
9515
|
-
"kind": "field",
|
|
9516
|
-
"name": "canvas",
|
|
9517
|
-
"type": {
|
|
9518
|
-
"text": "HTMLElement"
|
|
9519
|
-
},
|
|
9520
|
-
"privacy": "private"
|
|
9521
|
-
},
|
|
9522
|
-
{
|
|
9523
|
-
"kind": "field",
|
|
9524
|
-
"name": "computed",
|
|
9525
|
-
"type": {
|
|
9526
|
-
"text": "HTMLElement"
|
|
9527
|
-
},
|
|
9528
|
-
"privacy": "private"
|
|
9529
|
-
},
|
|
9530
|
-
{
|
|
9531
|
-
"kind": "field",
|
|
9532
|
-
"name": "value",
|
|
9533
|
-
"type": {
|
|
9534
|
-
"text": "string"
|
|
9535
|
-
},
|
|
9536
|
-
"default": "\"\"",
|
|
9537
|
-
"description": "The value of the QR Code, most commonly an URL.",
|
|
9538
|
-
"attribute": "value",
|
|
9539
|
-
"reflects": true
|
|
9540
|
-
},
|
|
9541
|
-
{
|
|
9542
|
-
"kind": "field",
|
|
9543
|
-
"name": "label",
|
|
9544
|
-
"type": {
|
|
9545
|
-
"text": "string"
|
|
9546
|
-
},
|
|
9547
|
-
"default": "\"\"",
|
|
9548
|
-
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
9549
|
-
"attribute": "label",
|
|
9550
|
-
"reflects": true
|
|
9551
|
-
},
|
|
9552
|
-
{
|
|
9553
|
-
"kind": "field",
|
|
9554
|
-
"name": "size",
|
|
9555
|
-
"type": {
|
|
9556
|
-
"text": "number"
|
|
9557
|
-
},
|
|
9558
|
-
"default": "128",
|
|
9559
|
-
"description": "The size of the rendered QR Code in pixels.",
|
|
9560
|
-
"attribute": "size",
|
|
9561
|
-
"reflects": true
|
|
9562
|
-
},
|
|
9563
|
-
{
|
|
9564
|
-
"kind": "field",
|
|
9565
|
-
"name": "color",
|
|
9566
|
-
"type": {
|
|
9567
|
-
"text": "string"
|
|
9568
|
-
},
|
|
9569
|
-
"default": "\"var(--n-color-text)\"",
|
|
9570
|
-
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
9571
|
-
"attribute": "color",
|
|
9572
|
-
"reflects": true
|
|
9573
|
-
},
|
|
9574
|
-
{
|
|
9575
|
-
"kind": "field",
|
|
9576
|
-
"name": "background",
|
|
9577
|
-
"type": {
|
|
9578
|
-
"text": "string"
|
|
9579
|
-
},
|
|
9580
|
-
"default": "\"var(--n-color-surface)\"",
|
|
9581
|
-
"description": "The background color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
9582
|
-
"attribute": "background",
|
|
9583
|
-
"reflects": true
|
|
9584
|
-
},
|
|
9585
|
-
{
|
|
9586
|
-
"kind": "field",
|
|
9587
|
-
"name": "correction",
|
|
9588
|
-
"type": {
|
|
9589
|
-
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
9590
|
-
},
|
|
9591
|
-
"default": "\"H\"",
|
|
9592
|
-
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
9593
|
-
"attribute": "correction",
|
|
9594
|
-
"reflects": true
|
|
9553
|
+
"name": "FocusableMixin",
|
|
9554
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9555
|
+
}
|
|
9595
9556
|
},
|
|
9596
9557
|
{
|
|
9597
9558
|
"kind": "method",
|
|
9598
|
-
"name": "
|
|
9599
|
-
"
|
|
9559
|
+
"name": "click",
|
|
9560
|
+
"description": "Programmatically simulates a click on the component.",
|
|
9561
|
+
"inheritedFrom": {
|
|
9562
|
+
"name": "FocusableMixin",
|
|
9563
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
9564
|
+
}
|
|
9600
9565
|
}
|
|
9601
9566
|
],
|
|
9602
9567
|
"attributes": [
|
|
9603
9568
|
{
|
|
9604
9569
|
"name": "value",
|
|
9605
9570
|
"type": {
|
|
9606
|
-
"text": "
|
|
9571
|
+
"text": "number | undefined"
|
|
9607
9572
|
},
|
|
9608
|
-
"
|
|
9609
|
-
"description": "The value of the QR Code, most commonly an URL.",
|
|
9573
|
+
"description": "Specifies how much of the task has been completed. Must be a valid floating\npoint number between 0 and max, or between 0 and 100 if max is omitted. If\nthere is no value, the progress bar is indeterminate; this indicates that\nan activity is ongoing with no indication of how long it’s expected to take.",
|
|
9610
9574
|
"fieldName": "value"
|
|
9611
9575
|
},
|
|
9612
9576
|
{
|
|
9613
|
-
"name": "
|
|
9614
|
-
"type": {
|
|
9615
|
-
"text": "string"
|
|
9616
|
-
},
|
|
9617
|
-
"default": "\"\"",
|
|
9618
|
-
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
9619
|
-
"fieldName": "label"
|
|
9620
|
-
},
|
|
9621
|
-
{
|
|
9622
|
-
"name": "size",
|
|
9577
|
+
"name": "max",
|
|
9623
9578
|
"type": {
|
|
9624
9579
|
"text": "number"
|
|
9625
9580
|
},
|
|
9626
|
-
"default": "
|
|
9627
|
-
"description": "
|
|
9628
|
-
"fieldName": "
|
|
9629
|
-
},
|
|
9630
|
-
{
|
|
9631
|
-
"name": "color",
|
|
9632
|
-
"type": {
|
|
9633
|
-
"text": "string"
|
|
9634
|
-
},
|
|
9635
|
-
"default": "\"var(--n-color-text)\"",
|
|
9636
|
-
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
9637
|
-
"fieldName": "color"
|
|
9581
|
+
"default": "100",
|
|
9582
|
+
"description": "Describes how much work the task indicated by the progress element requires.\nThe max attribute, if present, must have a value greater than 0 and be a\nvalid floating point number.",
|
|
9583
|
+
"fieldName": "max"
|
|
9638
9584
|
},
|
|
9639
9585
|
{
|
|
9640
|
-
"name": "
|
|
9586
|
+
"name": "label",
|
|
9641
9587
|
"type": {
|
|
9642
9588
|
"text": "string"
|
|
9643
9589
|
},
|
|
9644
|
-
"default": "\"
|
|
9645
|
-
"description": "
|
|
9646
|
-
"fieldName": "
|
|
9647
|
-
}
|
|
9590
|
+
"default": "\"Current progress\"",
|
|
9591
|
+
"description": "Accessible label for the progress indicator. Visually hidden, but shown\nfor assistive technology.",
|
|
9592
|
+
"fieldName": "label"
|
|
9593
|
+
}
|
|
9594
|
+
],
|
|
9595
|
+
"mixins": [
|
|
9648
9596
|
{
|
|
9649
|
-
"name": "
|
|
9650
|
-
"
|
|
9651
|
-
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
9652
|
-
},
|
|
9653
|
-
"default": "\"H\"",
|
|
9654
|
-
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
9655
|
-
"fieldName": "correction"
|
|
9597
|
+
"name": "FocusableMixin",
|
|
9598
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
9656
9599
|
}
|
|
9657
9600
|
],
|
|
9658
9601
|
"superclass": {
|
|
9659
9602
|
"name": "LitElement",
|
|
9660
9603
|
"package": "lit"
|
|
9661
9604
|
},
|
|
9662
|
-
"status": "
|
|
9663
|
-
"category": "
|
|
9664
|
-
"displayName":
|
|
9605
|
+
"status": "ready",
|
|
9606
|
+
"category": "feedback",
|
|
9607
|
+
"displayName": null,
|
|
9665
9608
|
"examples": [],
|
|
9666
|
-
"tagName": "nord-
|
|
9609
|
+
"tagName": "nord-progress-bar",
|
|
9667
9610
|
"customElement": true
|
|
9668
9611
|
}
|
|
9669
9612
|
],
|
|
@@ -9672,20 +9615,20 @@
|
|
|
9672
9615
|
"kind": "js",
|
|
9673
9616
|
"name": "default",
|
|
9674
9617
|
"declaration": {
|
|
9675
|
-
"name": "
|
|
9676
|
-
"module": "src/
|
|
9618
|
+
"name": "ProgressBar",
|
|
9619
|
+
"module": "src/progress-bar/ProgressBar.ts"
|
|
9677
9620
|
}
|
|
9678
9621
|
},
|
|
9679
9622
|
{
|
|
9680
9623
|
"kind": "custom-element-definition",
|
|
9681
|
-
"name": "nord-
|
|
9624
|
+
"name": "nord-progress-bar",
|
|
9682
9625
|
"declaration": {
|
|
9683
|
-
"name": "
|
|
9684
|
-
"module": "src/
|
|
9626
|
+
"name": "ProgressBar",
|
|
9627
|
+
"module": "src/progress-bar/ProgressBar.ts"
|
|
9685
9628
|
}
|
|
9686
9629
|
}
|
|
9687
9630
|
],
|
|
9688
|
-
"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
|
|
9631
|
+
"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 show the completion status of an ongoing task.\n- Use progress bar when you can determine the percentage of the completed task at any time.\n- Always provide an accessible label when using Progress Bar.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use in constrained spaces indicating indeterminate loading state, see [Spinner](/components/spinner/) instead.\n\n</div>\n"
|
|
9689
9632
|
},
|
|
9690
9633
|
{
|
|
9691
9634
|
"kind": "javascript-module",
|
|
@@ -10313,17 +10256,202 @@
|
|
|
10313
10256
|
}
|
|
10314
10257
|
},
|
|
10315
10258
|
{
|
|
10316
|
-
"name": "change",
|
|
10259
|
+
"name": "change",
|
|
10260
|
+
"type": {
|
|
10261
|
+
"text": "NordEvent"
|
|
10262
|
+
},
|
|
10263
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
10264
|
+
"inheritedFrom": {
|
|
10265
|
+
"name": "FormAssociatedMixin",
|
|
10266
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
10267
|
+
}
|
|
10268
|
+
}
|
|
10269
|
+
]
|
|
10270
|
+
}
|
|
10271
|
+
],
|
|
10272
|
+
"exports": [
|
|
10273
|
+
{
|
|
10274
|
+
"kind": "js",
|
|
10275
|
+
"name": "default",
|
|
10276
|
+
"declaration": {
|
|
10277
|
+
"name": "Radio",
|
|
10278
|
+
"module": "src/radio/Radio.ts"
|
|
10279
|
+
}
|
|
10280
|
+
},
|
|
10281
|
+
{
|
|
10282
|
+
"kind": "custom-element-definition",
|
|
10283
|
+
"name": "nord-radio",
|
|
10284
|
+
"declaration": {
|
|
10285
|
+
"name": "Radio",
|
|
10286
|
+
"module": "src/radio/Radio.ts"
|
|
10287
|
+
}
|
|
10288
|
+
}
|
|
10289
|
+
],
|
|
10290
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a radio component when users can only select one option from a list.\n- Favour radios over a select component when there are a small number of options. This reduces the number of clicks a user has to make, increasing efficiency.\n- Radio buttons are grouped by their `name` attribute. Therefore, it is crucial that the same `name` is used for a group of radios.\n- Give each radio within a group a unique `value`.\n- Radios **must** be used in combination with a fieldset component.\n- In most cases, a stack component should be used to layout a group of radio buttons.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place interactive content (buttons, links etc) inside the label.\n- Don’t use when a user can select more than one option. In this case, use a checkbox instead.\n- Don’t use for “accepting terms of service” and similar functionality. Use a checkbox instead.\n- When you have more than 10 options to choose from. Consider using a select instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nRadio button labels should be clear, accurate and predictable. It should be possible for the user to understand what they are enabling or disabling:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing radio 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 ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Blue</div>\n<div class=\"n-usage n-usage-dont\">Blue.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patient</div>\n<div class=\"n-usage n-usage-dont\">Patient;</div>\n\n---\n\n## Additional considerations\n\n- Hint text can be used to offer further information or explanation for an option.\n- Once a radio has been selected, users cannot return to having no radios selected without refreshing their browser window. Therefore, you should include \"None of the above\" or \"I do not know\" if they are valid options.\n- In most cases, radio buttons should be stacked vertically. However, radio buttons can be stacked horizontally when there are only two options with short labels. An example might be a yes/no question.\n"
|
|
10291
|
+
},
|
|
10292
|
+
{
|
|
10293
|
+
"kind": "javascript-module",
|
|
10294
|
+
"path": "src/qrcode/Qrcode.ts",
|
|
10295
|
+
"declarations": [
|
|
10296
|
+
{
|
|
10297
|
+
"kind": "class",
|
|
10298
|
+
"description": "QR Code component is used for providing information or links\nto users which they can quickly scan with their smartphone.",
|
|
10299
|
+
"name": "Qrcode",
|
|
10300
|
+
"members": [
|
|
10301
|
+
{
|
|
10302
|
+
"kind": "field",
|
|
10303
|
+
"name": "canvas",
|
|
10304
|
+
"type": {
|
|
10305
|
+
"text": "HTMLElement"
|
|
10306
|
+
},
|
|
10307
|
+
"privacy": "private"
|
|
10308
|
+
},
|
|
10309
|
+
{
|
|
10310
|
+
"kind": "field",
|
|
10311
|
+
"name": "computed",
|
|
10312
|
+
"type": {
|
|
10313
|
+
"text": "HTMLElement"
|
|
10314
|
+
},
|
|
10315
|
+
"privacy": "private"
|
|
10316
|
+
},
|
|
10317
|
+
{
|
|
10318
|
+
"kind": "field",
|
|
10319
|
+
"name": "value",
|
|
10320
|
+
"type": {
|
|
10321
|
+
"text": "string"
|
|
10322
|
+
},
|
|
10323
|
+
"default": "\"\"",
|
|
10324
|
+
"description": "The value of the QR Code, most commonly an URL.",
|
|
10325
|
+
"attribute": "value",
|
|
10326
|
+
"reflects": true
|
|
10327
|
+
},
|
|
10328
|
+
{
|
|
10329
|
+
"kind": "field",
|
|
10330
|
+
"name": "label",
|
|
10331
|
+
"type": {
|
|
10332
|
+
"text": "string"
|
|
10333
|
+
},
|
|
10334
|
+
"default": "\"\"",
|
|
10335
|
+
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
10336
|
+
"attribute": "label",
|
|
10337
|
+
"reflects": true
|
|
10338
|
+
},
|
|
10339
|
+
{
|
|
10340
|
+
"kind": "field",
|
|
10341
|
+
"name": "size",
|
|
10342
|
+
"type": {
|
|
10343
|
+
"text": "number"
|
|
10344
|
+
},
|
|
10345
|
+
"default": "128",
|
|
10346
|
+
"description": "The size of the rendered QR Code in pixels.",
|
|
10347
|
+
"attribute": "size",
|
|
10348
|
+
"reflects": true
|
|
10349
|
+
},
|
|
10350
|
+
{
|
|
10351
|
+
"kind": "field",
|
|
10352
|
+
"name": "color",
|
|
10353
|
+
"type": {
|
|
10354
|
+
"text": "string"
|
|
10355
|
+
},
|
|
10356
|
+
"default": "\"var(--n-color-text)\"",
|
|
10357
|
+
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
10358
|
+
"attribute": "color",
|
|
10359
|
+
"reflects": true
|
|
10360
|
+
},
|
|
10361
|
+
{
|
|
10362
|
+
"kind": "field",
|
|
10363
|
+
"name": "background",
|
|
10364
|
+
"type": {
|
|
10365
|
+
"text": "string"
|
|
10366
|
+
},
|
|
10367
|
+
"default": "\"var(--n-color-surface)\"",
|
|
10368
|
+
"description": "The background color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
10369
|
+
"attribute": "background",
|
|
10370
|
+
"reflects": true
|
|
10371
|
+
},
|
|
10372
|
+
{
|
|
10373
|
+
"kind": "field",
|
|
10374
|
+
"name": "correction",
|
|
10375
|
+
"type": {
|
|
10376
|
+
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
10377
|
+
},
|
|
10378
|
+
"default": "\"H\"",
|
|
10379
|
+
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
10380
|
+
"attribute": "correction",
|
|
10381
|
+
"reflects": true
|
|
10382
|
+
},
|
|
10383
|
+
{
|
|
10384
|
+
"kind": "method",
|
|
10385
|
+
"name": "generate",
|
|
10386
|
+
"privacy": "private"
|
|
10387
|
+
}
|
|
10388
|
+
],
|
|
10389
|
+
"attributes": [
|
|
10390
|
+
{
|
|
10391
|
+
"name": "value",
|
|
10392
|
+
"type": {
|
|
10393
|
+
"text": "string"
|
|
10394
|
+
},
|
|
10395
|
+
"default": "\"\"",
|
|
10396
|
+
"description": "The value of the QR Code, most commonly an URL.",
|
|
10397
|
+
"fieldName": "value"
|
|
10398
|
+
},
|
|
10399
|
+
{
|
|
10400
|
+
"name": "label",
|
|
10401
|
+
"type": {
|
|
10402
|
+
"text": "string"
|
|
10403
|
+
},
|
|
10404
|
+
"default": "\"\"",
|
|
10405
|
+
"description": "Label used by assistive technology. If unspecified, the value will\nbe used instead.",
|
|
10406
|
+
"fieldName": "label"
|
|
10407
|
+
},
|
|
10408
|
+
{
|
|
10409
|
+
"name": "size",
|
|
10410
|
+
"type": {
|
|
10411
|
+
"text": "number"
|
|
10412
|
+
},
|
|
10413
|
+
"default": "128",
|
|
10414
|
+
"description": "The size of the rendered QR Code in pixels.",
|
|
10415
|
+
"fieldName": "size"
|
|
10416
|
+
},
|
|
10417
|
+
{
|
|
10418
|
+
"name": "color",
|
|
10419
|
+
"type": {
|
|
10420
|
+
"text": "string"
|
|
10421
|
+
},
|
|
10422
|
+
"default": "\"var(--n-color-text)\"",
|
|
10423
|
+
"description": "The fill color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
10424
|
+
"fieldName": "color"
|
|
10425
|
+
},
|
|
10426
|
+
{
|
|
10427
|
+
"name": "background",
|
|
10428
|
+
"type": {
|
|
10429
|
+
"text": "string"
|
|
10430
|
+
},
|
|
10431
|
+
"default": "\"var(--n-color-surface)\"",
|
|
10432
|
+
"description": "The background color of the QR Code.\nCan accept any valid CSS color value, including custom properties.",
|
|
10433
|
+
"fieldName": "background"
|
|
10434
|
+
},
|
|
10435
|
+
{
|
|
10436
|
+
"name": "correction",
|
|
10317
10437
|
"type": {
|
|
10318
|
-
"text": "
|
|
10438
|
+
"text": "\"L\" | \"M\" | \"Q\" | \"H\""
|
|
10319
10439
|
},
|
|
10320
|
-
"
|
|
10321
|
-
"
|
|
10322
|
-
|
|
10323
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
10324
|
-
}
|
|
10440
|
+
"default": "\"H\"",
|
|
10441
|
+
"description": "Error correction level makes the QR Code bigger and helps users to\nscan it without issues. L, M, Q and H values will use 7%, 15%, 25%\nand 30% of the QR code for error correction respectively.",
|
|
10442
|
+
"fieldName": "correction"
|
|
10325
10443
|
}
|
|
10326
|
-
]
|
|
10444
|
+
],
|
|
10445
|
+
"superclass": {
|
|
10446
|
+
"name": "LitElement",
|
|
10447
|
+
"package": "lit"
|
|
10448
|
+
},
|
|
10449
|
+
"status": "ready",
|
|
10450
|
+
"category": "image",
|
|
10451
|
+
"displayName": "QR Code",
|
|
10452
|
+
"examples": [],
|
|
10453
|
+
"tagName": "nord-qrcode",
|
|
10454
|
+
"customElement": true
|
|
10327
10455
|
}
|
|
10328
10456
|
],
|
|
10329
10457
|
"exports": [
|
|
@@ -10331,20 +10459,20 @@
|
|
|
10331
10459
|
"kind": "js",
|
|
10332
10460
|
"name": "default",
|
|
10333
10461
|
"declaration": {
|
|
10334
|
-
"name": "
|
|
10335
|
-
"module": "src/
|
|
10462
|
+
"name": "Qrcode",
|
|
10463
|
+
"module": "src/qrcode/Qrcode.ts"
|
|
10336
10464
|
}
|
|
10337
10465
|
},
|
|
10338
10466
|
{
|
|
10339
10467
|
"kind": "custom-element-definition",
|
|
10340
|
-
"name": "nord-
|
|
10468
|
+
"name": "nord-qrcode",
|
|
10341
10469
|
"declaration": {
|
|
10342
|
-
"name": "
|
|
10343
|
-
"module": "src/
|
|
10470
|
+
"name": "Qrcode",
|
|
10471
|
+
"module": "src/qrcode/Qrcode.ts"
|
|
10344
10472
|
}
|
|
10345
10473
|
}
|
|
10346
10474
|
],
|
|
10347
|
-
"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
|
|
10475
|
+
"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 people to access information on their smartphone without the need to type.\n- Always provide an alternative way to access the same information.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t hide important information behind a QR Code only.\n\n</div>\n"
|
|
10348
10476
|
},
|
|
10349
10477
|
{
|
|
10350
10478
|
"kind": "javascript-module",
|
|
@@ -10455,20 +10583,6 @@
|
|
|
10455
10583
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
10456
10584
|
}
|
|
10457
10585
|
},
|
|
10458
|
-
{
|
|
10459
|
-
"kind": "field",
|
|
10460
|
-
"name": "_warningLogged",
|
|
10461
|
-
"type": {
|
|
10462
|
-
"text": "boolean"
|
|
10463
|
-
},
|
|
10464
|
-
"privacy": "private",
|
|
10465
|
-
"static": true,
|
|
10466
|
-
"default": "false",
|
|
10467
|
-
"inheritedFrom": {
|
|
10468
|
-
"name": "DraftComponentMixin",
|
|
10469
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
10470
|
-
}
|
|
10471
|
-
},
|
|
10472
10586
|
{
|
|
10473
10587
|
"kind": "field",
|
|
10474
10588
|
"name": "labelSlot",
|
|
@@ -11074,10 +11188,6 @@
|
|
|
11074
11188
|
}
|
|
11075
11189
|
],
|
|
11076
11190
|
"mixins": [
|
|
11077
|
-
{
|
|
11078
|
-
"name": "DraftComponentMixin",
|
|
11079
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
11080
|
-
},
|
|
11081
11191
|
{
|
|
11082
11192
|
"name": "FormAssociatedMixin",
|
|
11083
11193
|
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
@@ -11103,7 +11213,7 @@
|
|
|
11103
11213
|
"name": "LitElement",
|
|
11104
11214
|
"package": "lit"
|
|
11105
11215
|
},
|
|
11106
|
-
"status": "
|
|
11216
|
+
"status": "new",
|
|
11107
11217
|
"category": "form",
|
|
11108
11218
|
"displayName": null,
|
|
11109
11219
|
"examples": [],
|
|
@@ -11939,106 +12049,6 @@
|
|
|
11939
12049
|
],
|
|
11940
12050
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use skeleton component for dynamic content only.\n- Use to give the user an indication of what the page layout will be like once loaded.\n- Mimick the actual layout using multiple Skeleton components.\n- Use `aria-busy=\"true\"` to indicate which area on the screen is currently loading and remove it or set it to `false` once loaded.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use Skeleton component for static content.\n- Don’t show placeholder content after Skeleton disappears that will change when the page fully loads.\n\n</div>\n"
|
|
11941
12051
|
},
|
|
11942
|
-
{
|
|
11943
|
-
"kind": "javascript-module",
|
|
11944
|
-
"path": "src/spinner/Spinner.ts",
|
|
11945
|
-
"declarations": [
|
|
11946
|
-
{
|
|
11947
|
-
"kind": "class",
|
|
11948
|
-
"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.",
|
|
11949
|
-
"name": "Spinner",
|
|
11950
|
-
"members": [
|
|
11951
|
-
{
|
|
11952
|
-
"kind": "field",
|
|
11953
|
-
"name": "size",
|
|
11954
|
-
"type": {
|
|
11955
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
11956
|
-
},
|
|
11957
|
-
"default": "\"m\"",
|
|
11958
|
-
"description": "The size of the spinner.",
|
|
11959
|
-
"attribute": "size",
|
|
11960
|
-
"reflects": true
|
|
11961
|
-
},
|
|
11962
|
-
{
|
|
11963
|
-
"kind": "field",
|
|
11964
|
-
"name": "color",
|
|
11965
|
-
"type": {
|
|
11966
|
-
"text": "string | undefined"
|
|
11967
|
-
},
|
|
11968
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
11969
|
-
"attribute": "color",
|
|
11970
|
-
"reflects": true
|
|
11971
|
-
},
|
|
11972
|
-
{
|
|
11973
|
-
"kind": "field",
|
|
11974
|
-
"name": "label",
|
|
11975
|
-
"type": {
|
|
11976
|
-
"text": "string | undefined"
|
|
11977
|
-
},
|
|
11978
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
11979
|
-
"attribute": "label",
|
|
11980
|
-
"reflects": true
|
|
11981
|
-
}
|
|
11982
|
-
],
|
|
11983
|
-
"attributes": [
|
|
11984
|
-
{
|
|
11985
|
-
"name": "size",
|
|
11986
|
-
"type": {
|
|
11987
|
-
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
11988
|
-
},
|
|
11989
|
-
"default": "\"m\"",
|
|
11990
|
-
"description": "The size of the spinner.",
|
|
11991
|
-
"fieldName": "size"
|
|
11992
|
-
},
|
|
11993
|
-
{
|
|
11994
|
-
"name": "color",
|
|
11995
|
-
"type": {
|
|
11996
|
-
"text": "string | undefined"
|
|
11997
|
-
},
|
|
11998
|
-
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
11999
|
-
"fieldName": "color"
|
|
12000
|
-
},
|
|
12001
|
-
{
|
|
12002
|
-
"name": "label",
|
|
12003
|
-
"type": {
|
|
12004
|
-
"text": "string | undefined"
|
|
12005
|
-
},
|
|
12006
|
-
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12007
|
-
"fieldName": "label"
|
|
12008
|
-
}
|
|
12009
|
-
],
|
|
12010
|
-
"superclass": {
|
|
12011
|
-
"name": "LitElement",
|
|
12012
|
-
"package": "lit"
|
|
12013
|
-
},
|
|
12014
|
-
"status": "ready",
|
|
12015
|
-
"category": "feedback",
|
|
12016
|
-
"displayName": null,
|
|
12017
|
-
"examples": [],
|
|
12018
|
-
"tagName": "nord-spinner",
|
|
12019
|
-
"customElement": true
|
|
12020
|
-
}
|
|
12021
|
-
],
|
|
12022
|
-
"exports": [
|
|
12023
|
-
{
|
|
12024
|
-
"kind": "js",
|
|
12025
|
-
"name": "default",
|
|
12026
|
-
"declaration": {
|
|
12027
|
-
"name": "Spinner",
|
|
12028
|
-
"module": "src/spinner/Spinner.ts"
|
|
12029
|
-
}
|
|
12030
|
-
},
|
|
12031
|
-
{
|
|
12032
|
-
"kind": "custom-element-definition",
|
|
12033
|
-
"name": "nord-spinner",
|
|
12034
|
-
"declaration": {
|
|
12035
|
-
"name": "Spinner",
|
|
12036
|
-
"module": "src/spinner/Spinner.ts"
|
|
12037
|
-
}
|
|
12038
|
-
}
|
|
12039
|
-
],
|
|
12040
|
-
"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"
|
|
12041
|
-
},
|
|
12042
12052
|
{
|
|
12043
12053
|
"kind": "javascript-module",
|
|
12044
12054
|
"path": "src/stack/Stack.ts",
|
|
@@ -12148,40 +12158,140 @@
|
|
|
12148
12158
|
"fieldName": "direction"
|
|
12149
12159
|
},
|
|
12150
12160
|
{
|
|
12151
|
-
"name": "align-items",
|
|
12161
|
+
"name": "align-items",
|
|
12162
|
+
"type": {
|
|
12163
|
+
"text": "\"center\" | \"start\" | \"end\" | \"stretch\" | undefined"
|
|
12164
|
+
},
|
|
12165
|
+
"default": "\"stretch\"",
|
|
12166
|
+
"description": "How to align the child items inside the stack.",
|
|
12167
|
+
"fieldName": "alignItems"
|
|
12168
|
+
},
|
|
12169
|
+
{
|
|
12170
|
+
"name": "responsive",
|
|
12171
|
+
"type": {
|
|
12172
|
+
"text": "boolean"
|
|
12173
|
+
},
|
|
12174
|
+
"default": "false",
|
|
12175
|
+
"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).",
|
|
12176
|
+
"deprecated": "true",
|
|
12177
|
+
"fieldName": "responsive"
|
|
12178
|
+
},
|
|
12179
|
+
{
|
|
12180
|
+
"name": "wrap",
|
|
12181
|
+
"type": {
|
|
12182
|
+
"text": "boolean"
|
|
12183
|
+
},
|
|
12184
|
+
"default": "false",
|
|
12185
|
+
"description": "Defines whether the Stack items are forced in a single line\nor can be flowed into multiple lines.",
|
|
12186
|
+
"fieldName": "wrap"
|
|
12187
|
+
},
|
|
12188
|
+
{
|
|
12189
|
+
"name": "justify-content",
|
|
12190
|
+
"type": {
|
|
12191
|
+
"text": "| \"center\"\n | \"start\"\n | \"end\"\n | \"baseline\"\n | \"space-between\"\n | \"space-around\"\n | \"space-evenly\" | undefined"
|
|
12192
|
+
},
|
|
12193
|
+
"description": "How to justify the child items inside the stack.",
|
|
12194
|
+
"fieldName": "justifyContent"
|
|
12195
|
+
}
|
|
12196
|
+
],
|
|
12197
|
+
"superclass": {
|
|
12198
|
+
"name": "LitElement",
|
|
12199
|
+
"package": "lit"
|
|
12200
|
+
},
|
|
12201
|
+
"status": "ready",
|
|
12202
|
+
"category": "structure",
|
|
12203
|
+
"displayName": null,
|
|
12204
|
+
"examples": [],
|
|
12205
|
+
"tagName": "nord-stack",
|
|
12206
|
+
"customElement": true
|
|
12207
|
+
}
|
|
12208
|
+
],
|
|
12209
|
+
"exports": [
|
|
12210
|
+
{
|
|
12211
|
+
"kind": "js",
|
|
12212
|
+
"name": "default",
|
|
12213
|
+
"declaration": {
|
|
12214
|
+
"name": "Stack",
|
|
12215
|
+
"module": "src/stack/Stack.ts"
|
|
12216
|
+
}
|
|
12217
|
+
},
|
|
12218
|
+
{
|
|
12219
|
+
"kind": "custom-element-definition",
|
|
12220
|
+
"name": "nord-stack",
|
|
12221
|
+
"declaration": {
|
|
12222
|
+
"name": "Stack",
|
|
12223
|
+
"module": "src/stack/Stack.ts"
|
|
12224
|
+
}
|
|
12225
|
+
}
|
|
12226
|
+
],
|
|
12227
|
+
"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 stack multiple components vertically or horizontally.\n- Use when you want to adjust the white space between two or more components.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for building grid based layouts.\n\n</div>\n"
|
|
12228
|
+
},
|
|
12229
|
+
{
|
|
12230
|
+
"kind": "javascript-module",
|
|
12231
|
+
"path": "src/spinner/Spinner.ts",
|
|
12232
|
+
"declarations": [
|
|
12233
|
+
{
|
|
12234
|
+
"kind": "class",
|
|
12235
|
+
"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.",
|
|
12236
|
+
"name": "Spinner",
|
|
12237
|
+
"members": [
|
|
12238
|
+
{
|
|
12239
|
+
"kind": "field",
|
|
12240
|
+
"name": "size",
|
|
12241
|
+
"type": {
|
|
12242
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
12243
|
+
},
|
|
12244
|
+
"default": "\"m\"",
|
|
12245
|
+
"description": "The size of the spinner.",
|
|
12246
|
+
"attribute": "size",
|
|
12247
|
+
"reflects": true
|
|
12248
|
+
},
|
|
12249
|
+
{
|
|
12250
|
+
"kind": "field",
|
|
12251
|
+
"name": "color",
|
|
12252
|
+
"type": {
|
|
12253
|
+
"text": "string | undefined"
|
|
12254
|
+
},
|
|
12255
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12256
|
+
"attribute": "color",
|
|
12257
|
+
"reflects": true
|
|
12258
|
+
},
|
|
12259
|
+
{
|
|
12260
|
+
"kind": "field",
|
|
12261
|
+
"name": "label",
|
|
12152
12262
|
"type": {
|
|
12153
|
-
"text": "
|
|
12263
|
+
"text": "string | undefined"
|
|
12154
12264
|
},
|
|
12155
|
-
"
|
|
12156
|
-
"
|
|
12157
|
-
"
|
|
12158
|
-
}
|
|
12265
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12266
|
+
"attribute": "label",
|
|
12267
|
+
"reflects": true
|
|
12268
|
+
}
|
|
12269
|
+
],
|
|
12270
|
+
"attributes": [
|
|
12159
12271
|
{
|
|
12160
|
-
"name": "
|
|
12272
|
+
"name": "size",
|
|
12161
12273
|
"type": {
|
|
12162
|
-
"text": "
|
|
12274
|
+
"text": "\"xs\" | \"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
12163
12275
|
},
|
|
12164
|
-
"default": "
|
|
12165
|
-
"description": "
|
|
12166
|
-
"
|
|
12167
|
-
"fieldName": "responsive"
|
|
12276
|
+
"default": "\"m\"",
|
|
12277
|
+
"description": "The size of the spinner.",
|
|
12278
|
+
"fieldName": "size"
|
|
12168
12279
|
},
|
|
12169
12280
|
{
|
|
12170
|
-
"name": "
|
|
12281
|
+
"name": "color",
|
|
12171
12282
|
"type": {
|
|
12172
|
-
"text": "
|
|
12283
|
+
"text": "string | undefined"
|
|
12173
12284
|
},
|
|
12174
|
-
"
|
|
12175
|
-
"
|
|
12176
|
-
"fieldName": "wrap"
|
|
12285
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.",
|
|
12286
|
+
"fieldName": "color"
|
|
12177
12287
|
},
|
|
12178
12288
|
{
|
|
12179
|
-
"name": "
|
|
12289
|
+
"name": "label",
|
|
12180
12290
|
"type": {
|
|
12181
|
-
"text": "
|
|
12291
|
+
"text": "string | undefined"
|
|
12182
12292
|
},
|
|
12183
|
-
"description": "
|
|
12184
|
-
"fieldName": "
|
|
12293
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
12294
|
+
"fieldName": "label"
|
|
12185
12295
|
}
|
|
12186
12296
|
],
|
|
12187
12297
|
"superclass": {
|
|
@@ -12189,10 +12299,10 @@
|
|
|
12189
12299
|
"package": "lit"
|
|
12190
12300
|
},
|
|
12191
12301
|
"status": "ready",
|
|
12192
|
-
"category": "
|
|
12302
|
+
"category": "feedback",
|
|
12193
12303
|
"displayName": null,
|
|
12194
12304
|
"examples": [],
|
|
12195
|
-
"tagName": "nord-
|
|
12305
|
+
"tagName": "nord-spinner",
|
|
12196
12306
|
"customElement": true
|
|
12197
12307
|
}
|
|
12198
12308
|
],
|
|
@@ -12201,20 +12311,20 @@
|
|
|
12201
12311
|
"kind": "js",
|
|
12202
12312
|
"name": "default",
|
|
12203
12313
|
"declaration": {
|
|
12204
|
-
"name": "
|
|
12205
|
-
"module": "src/
|
|
12314
|
+
"name": "Spinner",
|
|
12315
|
+
"module": "src/spinner/Spinner.ts"
|
|
12206
12316
|
}
|
|
12207
12317
|
},
|
|
12208
12318
|
{
|
|
12209
12319
|
"kind": "custom-element-definition",
|
|
12210
|
-
"name": "nord-
|
|
12320
|
+
"name": "nord-spinner",
|
|
12211
12321
|
"declaration": {
|
|
12212
|
-
"name": "
|
|
12213
|
-
"module": "src/
|
|
12322
|
+
"name": "Spinner",
|
|
12323
|
+
"module": "src/spinner/Spinner.ts"
|
|
12214
12324
|
}
|
|
12215
12325
|
}
|
|
12216
12326
|
],
|
|
12217
|
-
"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
|
|
12327
|
+
"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"
|
|
12218
12328
|
},
|
|
12219
12329
|
{
|
|
12220
12330
|
"kind": "javascript-module",
|
|
@@ -12282,7 +12392,7 @@
|
|
|
12282
12392
|
"name": "LitElement",
|
|
12283
12393
|
"package": "lit"
|
|
12284
12394
|
},
|
|
12285
|
-
"status": "
|
|
12395
|
+
"status": "ready",
|
|
12286
12396
|
"category": "navigation",
|
|
12287
12397
|
"displayName": null,
|
|
12288
12398
|
"examples": [],
|
|
@@ -12524,7 +12634,7 @@
|
|
|
12524
12634
|
"name": "LitElement",
|
|
12525
12635
|
"package": "lit"
|
|
12526
12636
|
},
|
|
12527
|
-
"status": "
|
|
12637
|
+
"status": "ready",
|
|
12528
12638
|
"category": "navigation",
|
|
12529
12639
|
"displayName": null,
|
|
12530
12640
|
"examples": [],
|
|
@@ -12571,7 +12681,7 @@
|
|
|
12571
12681
|
"name": "LitElement",
|
|
12572
12682
|
"package": "lit"
|
|
12573
12683
|
},
|
|
12574
|
-
"status": "
|
|
12684
|
+
"status": "ready",
|
|
12575
12685
|
"category": "navigation",
|
|
12576
12686
|
"displayName": null,
|
|
12577
12687
|
"examples": [],
|
|
@@ -13498,7 +13608,221 @@
|
|
|
13498
13608
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
13499
13609
|
}
|
|
13500
13610
|
}
|
|
13501
|
-
]
|
|
13611
|
+
]
|
|
13612
|
+
}
|
|
13613
|
+
],
|
|
13614
|
+
"exports": [
|
|
13615
|
+
{
|
|
13616
|
+
"kind": "js",
|
|
13617
|
+
"name": "default",
|
|
13618
|
+
"declaration": {
|
|
13619
|
+
"name": "Textarea",
|
|
13620
|
+
"module": "src/textarea/Textarea.ts"
|
|
13621
|
+
}
|
|
13622
|
+
},
|
|
13623
|
+
{
|
|
13624
|
+
"kind": "custom-element-definition",
|
|
13625
|
+
"name": "nord-textarea",
|
|
13626
|
+
"declaration": {
|
|
13627
|
+
"name": "Textarea",
|
|
13628
|
+
"module": "src/textarea/Textarea.ts"
|
|
13629
|
+
}
|
|
13630
|
+
}
|
|
13631
|
+
],
|
|
13632
|
+
"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"
|
|
13633
|
+
},
|
|
13634
|
+
{
|
|
13635
|
+
"kind": "javascript-module",
|
|
13636
|
+
"path": "src/toast/Toast.ts",
|
|
13637
|
+
"declarations": [
|
|
13638
|
+
{
|
|
13639
|
+
"kind": "class",
|
|
13640
|
+
"description": "Toasts are non-disruptive messages that appear in the interface\nto provide quick, at-a-glance feedback on the outcome of an action.",
|
|
13641
|
+
"name": "Toast",
|
|
13642
|
+
"slots": [
|
|
13643
|
+
{
|
|
13644
|
+
"description": "Default slot used for the toast text/message.",
|
|
13645
|
+
"name": ""
|
|
13646
|
+
}
|
|
13647
|
+
],
|
|
13648
|
+
"members": [
|
|
13649
|
+
{
|
|
13650
|
+
"kind": "field",
|
|
13651
|
+
"name": "timeoutId",
|
|
13652
|
+
"type": {
|
|
13653
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
13654
|
+
},
|
|
13655
|
+
"privacy": "private"
|
|
13656
|
+
},
|
|
13657
|
+
{
|
|
13658
|
+
"kind": "field",
|
|
13659
|
+
"name": "events",
|
|
13660
|
+
"privacy": "private",
|
|
13661
|
+
"default": "new EventController(this)"
|
|
13662
|
+
},
|
|
13663
|
+
{
|
|
13664
|
+
"kind": "field",
|
|
13665
|
+
"name": "toast",
|
|
13666
|
+
"type": {
|
|
13667
|
+
"text": "HTMLElement"
|
|
13668
|
+
},
|
|
13669
|
+
"privacy": "private"
|
|
13670
|
+
},
|
|
13671
|
+
{
|
|
13672
|
+
"kind": "field",
|
|
13673
|
+
"name": "dismissed",
|
|
13674
|
+
"type": {
|
|
13675
|
+
"text": "boolean"
|
|
13676
|
+
},
|
|
13677
|
+
"privacy": "private",
|
|
13678
|
+
"default": "false"
|
|
13679
|
+
},
|
|
13680
|
+
{
|
|
13681
|
+
"kind": "field",
|
|
13682
|
+
"name": "variant",
|
|
13683
|
+
"type": {
|
|
13684
|
+
"text": "\"default\" | \"danger\""
|
|
13685
|
+
},
|
|
13686
|
+
"default": "\"default\"",
|
|
13687
|
+
"description": "The style variant of the toast.",
|
|
13688
|
+
"attribute": "variant",
|
|
13689
|
+
"reflects": true
|
|
13690
|
+
},
|
|
13691
|
+
{
|
|
13692
|
+
"kind": "field",
|
|
13693
|
+
"name": "autoDismiss",
|
|
13694
|
+
"type": {
|
|
13695
|
+
"text": "number"
|
|
13696
|
+
},
|
|
13697
|
+
"default": "10000",
|
|
13698
|
+
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
13699
|
+
"attribute": "auto-dismiss"
|
|
13700
|
+
},
|
|
13701
|
+
{
|
|
13702
|
+
"kind": "method",
|
|
13703
|
+
"name": "dismiss",
|
|
13704
|
+
"description": "Programmatically dismiss the toast.\nThe returned promise resolves when toast's exit animation is complete."
|
|
13705
|
+
},
|
|
13706
|
+
{
|
|
13707
|
+
"kind": "method",
|
|
13708
|
+
"name": "handleAutoDismissChange",
|
|
13709
|
+
"privacy": "protected"
|
|
13710
|
+
}
|
|
13711
|
+
],
|
|
13712
|
+
"events": [
|
|
13713
|
+
{
|
|
13714
|
+
"name": "dismiss",
|
|
13715
|
+
"type": {
|
|
13716
|
+
"text": "NordEvent"
|
|
13717
|
+
},
|
|
13718
|
+
"description": "Fired when the toast is dismissed (via user action or auto-dismiss), and its exit animation has completed. This event should be used to remove the dismissed toast from the DOM."
|
|
13719
|
+
}
|
|
13720
|
+
],
|
|
13721
|
+
"attributes": [
|
|
13722
|
+
{
|
|
13723
|
+
"name": "variant",
|
|
13724
|
+
"type": {
|
|
13725
|
+
"text": "\"default\" | \"danger\""
|
|
13726
|
+
},
|
|
13727
|
+
"default": "\"default\"",
|
|
13728
|
+
"description": "The style variant of the toast.",
|
|
13729
|
+
"fieldName": "variant"
|
|
13730
|
+
},
|
|
13731
|
+
{
|
|
13732
|
+
"name": "auto-dismiss",
|
|
13733
|
+
"type": {
|
|
13734
|
+
"text": "number"
|
|
13735
|
+
},
|
|
13736
|
+
"default": "10000",
|
|
13737
|
+
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
13738
|
+
"fieldName": "autoDismiss"
|
|
13739
|
+
}
|
|
13740
|
+
],
|
|
13741
|
+
"superclass": {
|
|
13742
|
+
"name": "LitElement",
|
|
13743
|
+
"package": "lit"
|
|
13744
|
+
},
|
|
13745
|
+
"status": "ready",
|
|
13746
|
+
"category": "feedback",
|
|
13747
|
+
"displayName": null,
|
|
13748
|
+
"examples": [],
|
|
13749
|
+
"tagName": "nord-toast",
|
|
13750
|
+
"customElement": true
|
|
13751
|
+
}
|
|
13752
|
+
],
|
|
13753
|
+
"exports": [
|
|
13754
|
+
{
|
|
13755
|
+
"kind": "js",
|
|
13756
|
+
"name": "default",
|
|
13757
|
+
"declaration": {
|
|
13758
|
+
"name": "Toast",
|
|
13759
|
+
"module": "src/toast/Toast.ts"
|
|
13760
|
+
}
|
|
13761
|
+
},
|
|
13762
|
+
{
|
|
13763
|
+
"kind": "custom-element-definition",
|
|
13764
|
+
"name": "nord-toast",
|
|
13765
|
+
"declaration": {
|
|
13766
|
+
"name": "Toast",
|
|
13767
|
+
"module": "src/toast/Toast.ts"
|
|
13768
|
+
}
|
|
13769
|
+
}
|
|
13770
|
+
],
|
|
13771
|
+
"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 short messages that confirm an action taken by a user.\n- Use for ephemeral status updates.\n- Use in combination with [Toast group](../toast-group/) so that toasts get styled and announced to screen readers correctly.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use toasts for critical information that user needs to act on.\n- Don’t rely on users seeing toasts. Toasts are transient and should not be used for critical messages.\n- Don’t place interactive content in toasts. Assistive technology like screen readers will not convey any semantics when announcing toast messages.\n- Don’t use for error messages unless absolutely necessary. Try to favor a [Banner](/components/banner/) for error messaging instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n"
|
|
13772
|
+
},
|
|
13773
|
+
{
|
|
13774
|
+
"kind": "javascript-module",
|
|
13775
|
+
"path": "src/toast-group/ToastGroup.ts",
|
|
13776
|
+
"declarations": [
|
|
13777
|
+
{
|
|
13778
|
+
"kind": "class",
|
|
13779
|
+
"description": "Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.",
|
|
13780
|
+
"name": "ToastGroup",
|
|
13781
|
+
"slots": [
|
|
13782
|
+
{
|
|
13783
|
+
"description": "Default slot in which to place toasts.",
|
|
13784
|
+
"name": ""
|
|
13785
|
+
}
|
|
13786
|
+
],
|
|
13787
|
+
"members": [
|
|
13788
|
+
{
|
|
13789
|
+
"kind": "method",
|
|
13790
|
+
"name": "addToast",
|
|
13791
|
+
"parameters": [
|
|
13792
|
+
{
|
|
13793
|
+
"name": "text",
|
|
13794
|
+
"type": {
|
|
13795
|
+
"text": "string"
|
|
13796
|
+
},
|
|
13797
|
+
"description": "The text/message of the toast."
|
|
13798
|
+
},
|
|
13799
|
+
{
|
|
13800
|
+
"name": "options",
|
|
13801
|
+
"default": "{}",
|
|
13802
|
+
"type": {
|
|
13803
|
+
"text": "ToastOptions"
|
|
13804
|
+
},
|
|
13805
|
+
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
13806
|
+
}
|
|
13807
|
+
],
|
|
13808
|
+
"description": "Convenience method for creating and adding a toast to the group.",
|
|
13809
|
+
"return": {
|
|
13810
|
+
"type": {
|
|
13811
|
+
"text": "Toast"
|
|
13812
|
+
}
|
|
13813
|
+
}
|
|
13814
|
+
}
|
|
13815
|
+
],
|
|
13816
|
+
"superclass": {
|
|
13817
|
+
"name": "LitElement",
|
|
13818
|
+
"package": "lit"
|
|
13819
|
+
},
|
|
13820
|
+
"status": "ready",
|
|
13821
|
+
"category": "feedback",
|
|
13822
|
+
"displayName": null,
|
|
13823
|
+
"examples": [],
|
|
13824
|
+
"tagName": "nord-toast-group",
|
|
13825
|
+
"customElement": true
|
|
13502
13826
|
}
|
|
13503
13827
|
],
|
|
13504
13828
|
"exports": [
|
|
@@ -13506,20 +13830,20 @@
|
|
|
13506
13830
|
"kind": "js",
|
|
13507
13831
|
"name": "default",
|
|
13508
13832
|
"declaration": {
|
|
13509
|
-
"name": "
|
|
13510
|
-
"module": "src/
|
|
13833
|
+
"name": "ToastGroup",
|
|
13834
|
+
"module": "src/toast-group/ToastGroup.ts"
|
|
13511
13835
|
}
|
|
13512
13836
|
},
|
|
13513
13837
|
{
|
|
13514
13838
|
"kind": "custom-element-definition",
|
|
13515
|
-
"name": "nord-
|
|
13839
|
+
"name": "nord-toast-group",
|
|
13516
13840
|
"declaration": {
|
|
13517
|
-
"name": "
|
|
13518
|
-
"module": "src/
|
|
13841
|
+
"name": "ToastGroup",
|
|
13842
|
+
"module": "src/toast-group/ToastGroup.ts"
|
|
13519
13843
|
}
|
|
13520
13844
|
}
|
|
13521
13845
|
],
|
|
13522
|
-
"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
|
|
13846
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Toast](/components/toast/) so that toasts get styled and announced to screen readers correctly.\n- Add as close to the bottom of the document as possible, ideally near the body closing tag, to maintain correct stacking order.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than toast components\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and understandable by the user:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n"
|
|
13523
13847
|
},
|
|
13524
13848
|
{
|
|
13525
13849
|
"kind": "javascript-module",
|
|
@@ -14131,7 +14455,7 @@
|
|
|
14131
14455
|
"name": "LitElement",
|
|
14132
14456
|
"package": "lit"
|
|
14133
14457
|
},
|
|
14134
|
-
"status": "
|
|
14458
|
+
"status": "ready",
|
|
14135
14459
|
"category": "form",
|
|
14136
14460
|
"displayName": null,
|
|
14137
14461
|
"examples": [],
|
|
@@ -14183,220 +14507,6 @@
|
|
|
14183
14507
|
],
|
|
14184
14508
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use toggles when your intent is to turn something on or off instantly.\n- Use for any feature or option that can be turned on or off.\n- If a physical switch would work for the action, the toggle is probably the best component to use.\n- Use for making it possible to choose one or more options from a limited number of options.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Toggles should never require users to click a button to apply or save the setting.\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another toggle when another one is clicked. Only exception is when a toggle is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nToggle labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing toggle labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n"
|
|
14185
14509
|
},
|
|
14186
|
-
{
|
|
14187
|
-
"kind": "javascript-module",
|
|
14188
|
-
"path": "src/toast/Toast.ts",
|
|
14189
|
-
"declarations": [
|
|
14190
|
-
{
|
|
14191
|
-
"kind": "class",
|
|
14192
|
-
"description": "Toasts are non-disruptive messages that appear in the interface\nto provide quick, at-a-glance feedback on the outcome of an action.",
|
|
14193
|
-
"name": "Toast",
|
|
14194
|
-
"slots": [
|
|
14195
|
-
{
|
|
14196
|
-
"description": "Default slot used for the toast text/message.",
|
|
14197
|
-
"name": ""
|
|
14198
|
-
}
|
|
14199
|
-
],
|
|
14200
|
-
"members": [
|
|
14201
|
-
{
|
|
14202
|
-
"kind": "field",
|
|
14203
|
-
"name": "timeoutId",
|
|
14204
|
-
"type": {
|
|
14205
|
-
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
14206
|
-
},
|
|
14207
|
-
"privacy": "private"
|
|
14208
|
-
},
|
|
14209
|
-
{
|
|
14210
|
-
"kind": "field",
|
|
14211
|
-
"name": "events",
|
|
14212
|
-
"privacy": "private",
|
|
14213
|
-
"default": "new EventController(this)"
|
|
14214
|
-
},
|
|
14215
|
-
{
|
|
14216
|
-
"kind": "field",
|
|
14217
|
-
"name": "toast",
|
|
14218
|
-
"type": {
|
|
14219
|
-
"text": "HTMLElement"
|
|
14220
|
-
},
|
|
14221
|
-
"privacy": "private"
|
|
14222
|
-
},
|
|
14223
|
-
{
|
|
14224
|
-
"kind": "field",
|
|
14225
|
-
"name": "dismissed",
|
|
14226
|
-
"type": {
|
|
14227
|
-
"text": "boolean"
|
|
14228
|
-
},
|
|
14229
|
-
"privacy": "private",
|
|
14230
|
-
"default": "false"
|
|
14231
|
-
},
|
|
14232
|
-
{
|
|
14233
|
-
"kind": "field",
|
|
14234
|
-
"name": "variant",
|
|
14235
|
-
"type": {
|
|
14236
|
-
"text": "\"default\" | \"danger\""
|
|
14237
|
-
},
|
|
14238
|
-
"default": "\"default\"",
|
|
14239
|
-
"description": "The style variant of the toast.",
|
|
14240
|
-
"attribute": "variant",
|
|
14241
|
-
"reflects": true
|
|
14242
|
-
},
|
|
14243
|
-
{
|
|
14244
|
-
"kind": "field",
|
|
14245
|
-
"name": "autoDismiss",
|
|
14246
|
-
"type": {
|
|
14247
|
-
"text": "number"
|
|
14248
|
-
},
|
|
14249
|
-
"default": "10000",
|
|
14250
|
-
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
14251
|
-
"attribute": "auto-dismiss"
|
|
14252
|
-
},
|
|
14253
|
-
{
|
|
14254
|
-
"kind": "method",
|
|
14255
|
-
"name": "dismiss",
|
|
14256
|
-
"description": "Programmatically dismiss the toast.\nThe returned promise resolves when toast's exit animation is complete."
|
|
14257
|
-
},
|
|
14258
|
-
{
|
|
14259
|
-
"kind": "method",
|
|
14260
|
-
"name": "handleAutoDismissChange",
|
|
14261
|
-
"privacy": "protected"
|
|
14262
|
-
}
|
|
14263
|
-
],
|
|
14264
|
-
"events": [
|
|
14265
|
-
{
|
|
14266
|
-
"name": "dismiss",
|
|
14267
|
-
"type": {
|
|
14268
|
-
"text": "NordEvent"
|
|
14269
|
-
},
|
|
14270
|
-
"description": "Fired when the toast is dismissed (via user action or auto-dismiss), and its exit animation has completed. This event should be used to remove the dismissed toast from the DOM."
|
|
14271
|
-
}
|
|
14272
|
-
],
|
|
14273
|
-
"attributes": [
|
|
14274
|
-
{
|
|
14275
|
-
"name": "variant",
|
|
14276
|
-
"type": {
|
|
14277
|
-
"text": "\"default\" | \"danger\""
|
|
14278
|
-
},
|
|
14279
|
-
"default": "\"default\"",
|
|
14280
|
-
"description": "The style variant of the toast.",
|
|
14281
|
-
"fieldName": "variant"
|
|
14282
|
-
},
|
|
14283
|
-
{
|
|
14284
|
-
"name": "auto-dismiss",
|
|
14285
|
-
"type": {
|
|
14286
|
-
"text": "number"
|
|
14287
|
-
},
|
|
14288
|
-
"default": "10000",
|
|
14289
|
-
"description": "Timeout in milliseconds before the toast is automatically dismissed.",
|
|
14290
|
-
"fieldName": "autoDismiss"
|
|
14291
|
-
}
|
|
14292
|
-
],
|
|
14293
|
-
"superclass": {
|
|
14294
|
-
"name": "LitElement",
|
|
14295
|
-
"package": "lit"
|
|
14296
|
-
},
|
|
14297
|
-
"status": "new",
|
|
14298
|
-
"category": "feedback",
|
|
14299
|
-
"displayName": null,
|
|
14300
|
-
"examples": [],
|
|
14301
|
-
"tagName": "nord-toast",
|
|
14302
|
-
"customElement": true
|
|
14303
|
-
}
|
|
14304
|
-
],
|
|
14305
|
-
"exports": [
|
|
14306
|
-
{
|
|
14307
|
-
"kind": "js",
|
|
14308
|
-
"name": "default",
|
|
14309
|
-
"declaration": {
|
|
14310
|
-
"name": "Toast",
|
|
14311
|
-
"module": "src/toast/Toast.ts"
|
|
14312
|
-
}
|
|
14313
|
-
},
|
|
14314
|
-
{
|
|
14315
|
-
"kind": "custom-element-definition",
|
|
14316
|
-
"name": "nord-toast",
|
|
14317
|
-
"declaration": {
|
|
14318
|
-
"name": "Toast",
|
|
14319
|
-
"module": "src/toast/Toast.ts"
|
|
14320
|
-
}
|
|
14321
|
-
}
|
|
14322
|
-
],
|
|
14323
|
-
"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 short messages that confirm an action taken by a user.\n- Use for ephemeral status updates.\n- Use in combination with [Toast group](../toast-group/) so that toasts get styled and announced to screen readers correctly.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use toasts for critical information that user needs to act on.\n- Don’t rely on users seeing toasts. Toasts are transient and should not be used for critical messages.\n- Don’t place interactive content in toasts. Assistive technology like screen readers will not convey any semantics when announcing toast messages.\n- Don’t use for error messages unless absolutely necessary. Try to favor a [Banner](/components/banner/) for error messaging instead.\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n"
|
|
14324
|
-
},
|
|
14325
|
-
{
|
|
14326
|
-
"kind": "javascript-module",
|
|
14327
|
-
"path": "src/toast-group/ToastGroup.ts",
|
|
14328
|
-
"declarations": [
|
|
14329
|
-
{
|
|
14330
|
-
"kind": "class",
|
|
14331
|
-
"description": "Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.",
|
|
14332
|
-
"name": "ToastGroup",
|
|
14333
|
-
"slots": [
|
|
14334
|
-
{
|
|
14335
|
-
"description": "Default slot in which to place toasts.",
|
|
14336
|
-
"name": ""
|
|
14337
|
-
}
|
|
14338
|
-
],
|
|
14339
|
-
"members": [
|
|
14340
|
-
{
|
|
14341
|
-
"kind": "method",
|
|
14342
|
-
"name": "addToast",
|
|
14343
|
-
"parameters": [
|
|
14344
|
-
{
|
|
14345
|
-
"name": "text",
|
|
14346
|
-
"type": {
|
|
14347
|
-
"text": "string"
|
|
14348
|
-
},
|
|
14349
|
-
"description": "The text/message of the toast."
|
|
14350
|
-
},
|
|
14351
|
-
{
|
|
14352
|
-
"name": "options",
|
|
14353
|
-
"default": "{}",
|
|
14354
|
-
"type": {
|
|
14355
|
-
"text": "ToastOptions"
|
|
14356
|
-
},
|
|
14357
|
-
"description": "An optional object for configuring the toast's `variant` and `autoDismiss`."
|
|
14358
|
-
}
|
|
14359
|
-
],
|
|
14360
|
-
"description": "Convenience method for creating and adding a toast to the group.",
|
|
14361
|
-
"return": {
|
|
14362
|
-
"type": {
|
|
14363
|
-
"text": "Toast"
|
|
14364
|
-
}
|
|
14365
|
-
}
|
|
14366
|
-
}
|
|
14367
|
-
],
|
|
14368
|
-
"superclass": {
|
|
14369
|
-
"name": "LitElement",
|
|
14370
|
-
"package": "lit"
|
|
14371
|
-
},
|
|
14372
|
-
"status": "new",
|
|
14373
|
-
"category": "feedback",
|
|
14374
|
-
"displayName": null,
|
|
14375
|
-
"examples": [],
|
|
14376
|
-
"tagName": "nord-toast-group",
|
|
14377
|
-
"customElement": true
|
|
14378
|
-
}
|
|
14379
|
-
],
|
|
14380
|
-
"exports": [
|
|
14381
|
-
{
|
|
14382
|
-
"kind": "js",
|
|
14383
|
-
"name": "default",
|
|
14384
|
-
"declaration": {
|
|
14385
|
-
"name": "ToastGroup",
|
|
14386
|
-
"module": "src/toast-group/ToastGroup.ts"
|
|
14387
|
-
}
|
|
14388
|
-
},
|
|
14389
|
-
{
|
|
14390
|
-
"kind": "custom-element-definition",
|
|
14391
|
-
"name": "nord-toast-group",
|
|
14392
|
-
"declaration": {
|
|
14393
|
-
"name": "ToastGroup",
|
|
14394
|
-
"module": "src/toast-group/ToastGroup.ts"
|
|
14395
|
-
}
|
|
14396
|
-
}
|
|
14397
|
-
],
|
|
14398
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use in combination with [Toast](/components/toast/) so that toasts get styled and announced to screen readers correctly.\n- Add as close to the bottom of the document as possible, ideally near the body closing tag, to maintain correct stacking order.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for grouping anything other than toast components\n\n</div>\n\n---\n\n## Content guidelines\n\nToast content should be clear, accurate and understandable by the user:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Your message has been sent</div>\n\nWhen writing the toast content, use the {noun} + {verb} content formula:\n\n<div class=\"n-usage n-usage-do\">Patient created</div>\n<div class=\"n-usage n-usage-dont\">Your patient has been successfully updated</div>\n\nUse a maximum of 3 words when writing the toast content:\n\n<div class=\"n-usage n-usage-do\">Product updated</div>\n<div class=\"n-usage n-usage-dont\">Your product was updated just now</div>\n\nWhen writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message Sent</div>\n\nAvoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Changes saved</div>\n<div class=\"n-usage n-usage-dont\">The changes were saved</div>\n\nNever end in punctuation:\n\n<div class=\"n-usage n-usage-do\">Message sent</div>\n<div class=\"n-usage n-usage-dont\">Message sent.</div>\n\n---\n\n## Additional considerations\n\n- Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.\n- If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.\n"
|
|
14399
|
-
},
|
|
14400
14510
|
{
|
|
14401
14511
|
"kind": "javascript-module",
|
|
14402
14512
|
"path": "src/tooltip/Tooltip.ts",
|