@nordhealth/components 2.6.0 → 2.7.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 +726 -303
- package/lib/Avatar.js +1 -1
- package/lib/Avatar.js.map +1 -1
- package/lib/Badge.js +1 -1
- package/lib/Banner.js +1 -1
- package/lib/Button.js +1 -1
- package/lib/Button.js.map +1 -1
- package/lib/{Calendar-49dc5248.js → Calendar-1cdf8429.js} +2 -2
- package/lib/{Calendar-49dc5248.js.map → Calendar-1cdf8429.js.map} +1 -1
- package/lib/Calendar.js +1 -1
- package/lib/Card.js +1 -1
- package/lib/Checkbox.js +1 -1
- package/lib/CommandMenu.js +1 -1
- package/lib/CommandMenu.js.map +1 -1
- package/lib/CommandMenuAction.js +1 -1
- package/lib/{Component-49a41387.js → Component-92eb6234.js} +2 -2
- package/lib/Component-92eb6234.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/DraftComponentMixin-9e4b7b34.js +2 -0
- package/lib/DraftComponentMixin-9e4b7b34.js.map +1 -0
- 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/DropdownItem.js +1 -1
- package/lib/EmptyState.js +1 -1
- package/lib/Fieldset.js +1 -1
- package/lib/FocusableMixin-34870ed3.js +2 -0
- package/lib/FocusableMixin-34870ed3.js.map +1 -0
- package/lib/{FormAssociatedMixin-f6e5b3cd.js → FormAssociatedMixin-3cc6e83b.js} +2 -2
- package/lib/{FormAssociatedMixin-f6e5b3cd.js.map → FormAssociatedMixin-3cc6e83b.js.map} +1 -1
- package/lib/{FormField-72062bf1.js → FormField-081da729.js} +2 -2
- package/lib/FormField-081da729.js.map +1 -0
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Icon.js +1 -1
- package/lib/Input.js +1 -1
- package/lib/Layout.js +1 -1
- package/lib/Layout.js.map +1 -1
- package/lib/{LightDomController-9a6e398f.js → LightDomController-3c726b20.js} +2 -2
- package/lib/{LightDomController-9a6e398f.js.map → LightDomController-3c726b20.js.map} +1 -1
- package/lib/LocalizeController.js +1 -1
- package/lib/LocalizeController.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/NavItem.js +1 -1
- package/lib/NavToggle.js +2 -0
- package/lib/NavToggle.js.map +1 -0
- package/lib/Navigation.js +1 -1
- package/lib/Popout-08f11a8d.js +2 -0
- package/lib/Popout-08f11a8d.js.map +1 -0
- package/lib/Popout.js +1 -1
- package/lib/Popout.js.map +1 -1
- package/lib/ProgressBar.js +1 -1
- package/lib/Qrcode.js +1 -1
- package/lib/Radio.js +1 -1
- package/lib/Select.js +1 -1
- package/lib/Select.js.map +1 -1
- package/lib/Skeleton.js +1 -1
- package/lib/Spinner.js +1 -1
- package/lib/Stack.js +1 -1
- package/lib/Tab.js +1 -1
- package/lib/TabGroup.js +1 -1
- package/lib/TabPanel.js +1 -1
- package/lib/Table.js +1 -1
- package/lib/{TextField-94b0839b.js → TextField-a7382912.js} +2 -2
- package/lib/{TextField-94b0839b.js.map → TextField-a7382912.js.map} +1 -1
- package/lib/Textarea.js +1 -1
- package/lib/Toast.js +1 -1
- package/lib/ToastGroup.js +1 -1
- package/lib/Toggle.js +1 -1
- package/lib/Tooltip.js +1 -1
- package/lib/Tooltip.js.map +1 -1
- package/lib/VisuallyHidden.js +1 -1
- package/lib/bundle.js +6 -6
- package/lib/bundle.js.map +1 -1
- package/lib/{class-map-cd6c8cbd.js → class-map-949b7d3b.js} +2 -2
- package/lib/{class-map-cd6c8cbd.js.map → class-map-949b7d3b.js.map} +1 -1
- package/lib/cond-338158e9.js +2 -0
- package/lib/{cond-0a8d4554.js.map → cond-338158e9.js.map} +1 -1
- package/lib/en-us.js +1 -1
- package/lib/en-us.js.map +1 -1
- package/lib/fi-fi.js +1 -1
- package/lib/fi-fi.js.map +1 -1
- package/lib/{if-defined-f43b1487.js → if-defined-4598a996.js} +2 -2
- package/lib/{if-defined-f43b1487.js.map → if-defined-4598a996.js.map} +1 -1
- package/lib/index.js +1 -1
- package/lib/{lit-element-79bc2e0e.js → lit-element-9178eae5.js} +3 -3
- package/lib/{lit-element-79bc2e0e.js.map → lit-element-9178eae5.js.map} +1 -1
- package/lib/localization5.js +2 -0
- package/lib/localization5.js.map +1 -0
- package/lib/month-view.js +1 -1
- package/lib/positioning-3bbd3548.js.map +1 -1
- package/lib/{ref-697b28b5.js → ref-0e619221.js} +3 -3
- package/lib/{ref-697b28b5.js.map → ref-0e619221.js.map} +1 -1
- package/lib/repeat-ae6f075f.js +7 -0
- package/lib/{repeat-e7acc0bd.js.map → repeat-ae6f075f.js.map} +1 -1
- package/lib/src/avatar/Avatar.d.ts +7 -1
- package/lib/src/button/Button.test.d.ts +1 -0
- package/lib/src/common/mixins/FloatingComponentMixin.d.ts +11 -0
- package/lib/src/common/positioning.d.ts +2 -1
- package/lib/src/drawer/Drawer.test.d.ts +1 -0
- package/lib/src/dropdown/Dropdown.d.ts +3 -21
- package/lib/src/index.d.ts +1 -0
- package/lib/src/layout/Layout.d.ts +6 -0
- package/lib/src/layout/Layout.test.d.ts +1 -0
- package/lib/src/localization/en-us.d.ts +3 -0
- package/lib/src/nav-toggle/NavToggle.d.ts +24 -0
- package/lib/src/nav-toggle/NavToggle.test.d.ts +2 -0
- package/lib/src/nav-toggle/localization.d.ts +4 -0
- package/lib/src/popout/Popout.d.ts +9 -20
- package/lib/translation.js +1 -1
- package/lib/translation.js.map +1 -1
- package/lib/{unsafe-html-be8023cd.js → unsafe-html-6be42999.js} +2 -2
- package/lib/{unsafe-html-be8023cd.js.map → unsafe-html-6be42999.js.map} +1 -1
- package/package.json +3 -3
- package/lib/Component-49a41387.js.map +0 -1
- package/lib/FocusableMixin-99db12c1.js +0 -2
- package/lib/FocusableMixin-99db12c1.js.map +0 -1
- package/lib/FormField-72062bf1.js.map +0 -1
- package/lib/cond-0a8d4554.js +0 -2
- package/lib/repeat-e7acc0bd.js +0 -7
package/custom-elements.json
CHANGED
|
@@ -374,6 +374,14 @@
|
|
|
374
374
|
"name": "default",
|
|
375
375
|
"module": "\"./drawer/Drawer.js\""
|
|
376
376
|
}
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
"kind": "js",
|
|
380
|
+
"name": "NavToggle",
|
|
381
|
+
"declaration": {
|
|
382
|
+
"name": "default",
|
|
383
|
+
"module": "\"./nav-toggle/NavToggle.js\""
|
|
384
|
+
}
|
|
377
385
|
}
|
|
378
386
|
]
|
|
379
387
|
},
|
|
@@ -386,6 +394,11 @@
|
|
|
386
394
|
"description": "Avatar is used for showing a thumbnail representation of a user or entity.\nDefault avatar illustration is displayed when no src is specified.",
|
|
387
395
|
"name": "Avatar",
|
|
388
396
|
"cssProperties": [
|
|
397
|
+
{
|
|
398
|
+
"description": "Controls the color of the avatar fallback, using [color tokens](/tokens/#color).",
|
|
399
|
+
"name": "--n-avatar-color",
|
|
400
|
+
"default": "var(--n-color-status-highlight)"
|
|
401
|
+
},
|
|
389
402
|
{
|
|
390
403
|
"description": "Controls the size of the avatar, using [icon sizing tokens](/tokens/#size).",
|
|
391
404
|
"name": "--n-avatar-size",
|
|
@@ -406,7 +419,7 @@
|
|
|
406
419
|
"kind": "field",
|
|
407
420
|
"name": "size",
|
|
408
421
|
"type": {
|
|
409
|
-
"text": "\"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
422
|
+
"text": "\"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
410
423
|
},
|
|
411
424
|
"default": "\"m\"",
|
|
412
425
|
"description": "The size of the avatar.",
|
|
@@ -433,6 +446,17 @@
|
|
|
433
446
|
"description": "The name of the person.",
|
|
434
447
|
"attribute": "name"
|
|
435
448
|
},
|
|
449
|
+
{
|
|
450
|
+
"kind": "field",
|
|
451
|
+
"name": "variant",
|
|
452
|
+
"type": {
|
|
453
|
+
"text": "\"default\" | \"square\""
|
|
454
|
+
},
|
|
455
|
+
"default": "\"default\"",
|
|
456
|
+
"description": "The style variant of the avatar.",
|
|
457
|
+
"attribute": "variant",
|
|
458
|
+
"reflects": true
|
|
459
|
+
},
|
|
436
460
|
{
|
|
437
461
|
"kind": "method",
|
|
438
462
|
"name": "handleSrcChange",
|
|
@@ -463,7 +487,7 @@
|
|
|
463
487
|
{
|
|
464
488
|
"name": "size",
|
|
465
489
|
"type": {
|
|
466
|
-
"text": "\"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
490
|
+
"text": "\"s\" | \"m\" | \"l\" | \"xl\" | \"xxl\""
|
|
467
491
|
},
|
|
468
492
|
"default": "\"m\"",
|
|
469
493
|
"description": "The size of the avatar.",
|
|
@@ -485,6 +509,15 @@
|
|
|
485
509
|
"default": "\"\"",
|
|
486
510
|
"description": "The name of the person.",
|
|
487
511
|
"fieldName": "name"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"name": "variant",
|
|
515
|
+
"type": {
|
|
516
|
+
"text": "\"default\" | \"square\""
|
|
517
|
+
},
|
|
518
|
+
"default": "\"default\"",
|
|
519
|
+
"description": "The style variant of the avatar.",
|
|
520
|
+
"fieldName": "variant"
|
|
488
521
|
}
|
|
489
522
|
],
|
|
490
523
|
"superclass": {
|
|
@@ -519,6 +552,175 @@
|
|
|
519
552
|
],
|
|
520
553
|
"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- Always add the name of the person using the `name` property.\n- For the best results, use square images or images cropped into a square.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Try to avoid using landscape or portrait images as avatars. Let users crop their images before or after uploading if possible.\n\n</div>\n"
|
|
521
554
|
},
|
|
555
|
+
{
|
|
556
|
+
"kind": "javascript-module",
|
|
557
|
+
"path": "src/banner/Banner.ts",
|
|
558
|
+
"declarations": [
|
|
559
|
+
{
|
|
560
|
+
"kind": "class",
|
|
561
|
+
"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.",
|
|
562
|
+
"name": "Banner",
|
|
563
|
+
"cssProperties": [
|
|
564
|
+
{
|
|
565
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
566
|
+
"name": "--n-banner-border-radius",
|
|
567
|
+
"default": "var(--n-border-radius)"
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
571
|
+
"name": "--n-banner-box-shadow",
|
|
572
|
+
"default": "var(--n-box-shadow-card)"
|
|
573
|
+
}
|
|
574
|
+
],
|
|
575
|
+
"slots": [
|
|
576
|
+
{
|
|
577
|
+
"description": "default slot",
|
|
578
|
+
"name": ""
|
|
579
|
+
}
|
|
580
|
+
],
|
|
581
|
+
"members": [
|
|
582
|
+
{
|
|
583
|
+
"kind": "field",
|
|
584
|
+
"name": "variant",
|
|
585
|
+
"type": {
|
|
586
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
587
|
+
},
|
|
588
|
+
"default": "\"info\"",
|
|
589
|
+
"description": "The style variant of the banner.",
|
|
590
|
+
"attribute": "variant",
|
|
591
|
+
"reflects": true
|
|
592
|
+
}
|
|
593
|
+
],
|
|
594
|
+
"attributes": [
|
|
595
|
+
{
|
|
596
|
+
"name": "variant",
|
|
597
|
+
"type": {
|
|
598
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
599
|
+
},
|
|
600
|
+
"default": "\"info\"",
|
|
601
|
+
"description": "The style variant of the banner.",
|
|
602
|
+
"fieldName": "variant"
|
|
603
|
+
}
|
|
604
|
+
],
|
|
605
|
+
"superclass": {
|
|
606
|
+
"name": "LitElement",
|
|
607
|
+
"package": "lit"
|
|
608
|
+
},
|
|
609
|
+
"status": "ready",
|
|
610
|
+
"category": "feedback",
|
|
611
|
+
"displayName": null,
|
|
612
|
+
"examples": [],
|
|
613
|
+
"tagName": "nord-banner",
|
|
614
|
+
"customElement": true
|
|
615
|
+
}
|
|
616
|
+
],
|
|
617
|
+
"exports": [
|
|
618
|
+
{
|
|
619
|
+
"kind": "js",
|
|
620
|
+
"name": "default",
|
|
621
|
+
"declaration": {
|
|
622
|
+
"name": "Banner",
|
|
623
|
+
"module": "src/banner/Banner.ts"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"kind": "custom-element-definition",
|
|
628
|
+
"name": "nord-banner",
|
|
629
|
+
"declaration": {
|
|
630
|
+
"name": "Banner",
|
|
631
|
+
"module": "src/banner/Banner.ts"
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
],
|
|
635
|
+
"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"
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"kind": "javascript-module",
|
|
639
|
+
"path": "src/badge/Badge.ts",
|
|
640
|
+
"declarations": [
|
|
641
|
+
{
|
|
642
|
+
"kind": "class",
|
|
643
|
+
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
644
|
+
"name": "Badge",
|
|
645
|
+
"slots": [
|
|
646
|
+
{
|
|
647
|
+
"description": "The badge content.",
|
|
648
|
+
"name": ""
|
|
649
|
+
}
|
|
650
|
+
],
|
|
651
|
+
"members": [
|
|
652
|
+
{
|
|
653
|
+
"kind": "field",
|
|
654
|
+
"name": "type",
|
|
655
|
+
"type": {
|
|
656
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
657
|
+
},
|
|
658
|
+
"default": "\"neutral\"",
|
|
659
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
660
|
+
"attribute": "type",
|
|
661
|
+
"reflects": true
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"kind": "field",
|
|
665
|
+
"name": "progress",
|
|
666
|
+
"type": {
|
|
667
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
668
|
+
},
|
|
669
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
670
|
+
"attribute": "progress"
|
|
671
|
+
}
|
|
672
|
+
],
|
|
673
|
+
"attributes": [
|
|
674
|
+
{
|
|
675
|
+
"name": "type",
|
|
676
|
+
"type": {
|
|
677
|
+
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
678
|
+
},
|
|
679
|
+
"default": "\"neutral\"",
|
|
680
|
+
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
681
|
+
"fieldName": "type"
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"name": "progress",
|
|
685
|
+
"type": {
|
|
686
|
+
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
687
|
+
},
|
|
688
|
+
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
689
|
+
"fieldName": "progress"
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"superclass": {
|
|
693
|
+
"name": "LitElement",
|
|
694
|
+
"package": "lit"
|
|
695
|
+
},
|
|
696
|
+
"status": "ready",
|
|
697
|
+
"category": "text",
|
|
698
|
+
"displayName": null,
|
|
699
|
+
"examples": [],
|
|
700
|
+
"tagName": "nord-badge",
|
|
701
|
+
"customElement": true
|
|
702
|
+
}
|
|
703
|
+
],
|
|
704
|
+
"exports": [
|
|
705
|
+
{
|
|
706
|
+
"kind": "js",
|
|
707
|
+
"name": "default",
|
|
708
|
+
"declaration": {
|
|
709
|
+
"name": "Badge",
|
|
710
|
+
"module": "src/badge/Badge.ts"
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"kind": "custom-element-definition",
|
|
715
|
+
"name": "nord-badge",
|
|
716
|
+
"declaration": {
|
|
717
|
+
"name": "Badge",
|
|
718
|
+
"module": "src/badge/Badge.ts"
|
|
719
|
+
}
|
|
720
|
+
}
|
|
721
|
+
],
|
|
722
|
+
"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"
|
|
723
|
+
},
|
|
522
724
|
{
|
|
523
725
|
"kind": "javascript-module",
|
|
524
726
|
"path": "src/calendar/Calendar.ts",
|
|
@@ -1557,175 +1759,6 @@
|
|
|
1557
1759
|
],
|
|
1558
1760
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Only use one primary button per section, as a main call-to-action.\n- Use clear and accurate labels.\n- Use established button colors appropriately. For example, only use a danger button style for an action that’s difficult or impossible to undo.\n- Prioritize the most important actions. Too many buttons will cause confusion.\n- Be consistent with positioning of buttons in the user interface.\n- Use strong, actionable verbs in labels such as “Add”, “Close”, “Cancel”, or “Save”.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use a primary button in every row of a table.\n- Don’t use buttons to link to other pages. Use regular link or a plain style instead where necessary.\n- Don’t use buttons for navigation where the link appears within or following a sentence.\n- Don’t use labels such as “Read more”, “Click here” or “More”.\n\n</div>\n\n---\n\n## Content guidelines\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `default` | Default style is the most common button variant. Only switch to another variant if you need to adjust the visual weight of the element. |\n| `primary` | Primary style is reserved for main call-to-actions. Should be used only once per content area or panel, e.g. for a “Save” action. |\n| `dashed` | Dashed style should be used for actions that trigger filtering. |\n| `danger` | Danger style should be used for actions that delete data or otherwise make it hard to undo the action. |\n| `plain` | Used for less important or less common actions. Can be also used for linking to other pages. |\n| `disabled` | Used for actions that aren’t currently available or not available anymore. Also prevents users from being able to interact with the component, and conveys its inactive state to assistive technologies. |\n| `switch` | Switch style is reserved for the clinic switcher in the top left corner of an application. |\n\n---\n\n## Additional considerations\n\n- Users of assistive technology expect a button to submit data or do an action. If you need the button to navigate into another view, use the `href` property which will output `<a>` tag instead of a `<button>`.\n- When you need to disable a button, use `disabled` property as it conveys this information correctly to assistive technologies like screen readers.\n- Button component provides 3 size variants; small, medium and large. The large size should only be used for marketing purposes or on areas such as an empty space/content notice.\n"
|
|
1559
1761
|
},
|
|
1560
|
-
{
|
|
1561
|
-
"kind": "javascript-module",
|
|
1562
|
-
"path": "src/banner/Banner.ts",
|
|
1563
|
-
"declarations": [
|
|
1564
|
-
{
|
|
1565
|
-
"kind": "class",
|
|
1566
|
-
"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.",
|
|
1567
|
-
"name": "Banner",
|
|
1568
|
-
"cssProperties": [
|
|
1569
|
-
{
|
|
1570
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
1571
|
-
"name": "--n-banner-border-radius",
|
|
1572
|
-
"default": "var(--n-border-radius)"
|
|
1573
|
-
},
|
|
1574
|
-
{
|
|
1575
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
1576
|
-
"name": "--n-banner-box-shadow",
|
|
1577
|
-
"default": "var(--n-box-shadow-card)"
|
|
1578
|
-
}
|
|
1579
|
-
],
|
|
1580
|
-
"slots": [
|
|
1581
|
-
{
|
|
1582
|
-
"description": "default slot",
|
|
1583
|
-
"name": ""
|
|
1584
|
-
}
|
|
1585
|
-
],
|
|
1586
|
-
"members": [
|
|
1587
|
-
{
|
|
1588
|
-
"kind": "field",
|
|
1589
|
-
"name": "variant",
|
|
1590
|
-
"type": {
|
|
1591
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1592
|
-
},
|
|
1593
|
-
"default": "\"info\"",
|
|
1594
|
-
"description": "The style variant of the banner.",
|
|
1595
|
-
"attribute": "variant",
|
|
1596
|
-
"reflects": true
|
|
1597
|
-
}
|
|
1598
|
-
],
|
|
1599
|
-
"attributes": [
|
|
1600
|
-
{
|
|
1601
|
-
"name": "variant",
|
|
1602
|
-
"type": {
|
|
1603
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1604
|
-
},
|
|
1605
|
-
"default": "\"info\"",
|
|
1606
|
-
"description": "The style variant of the banner.",
|
|
1607
|
-
"fieldName": "variant"
|
|
1608
|
-
}
|
|
1609
|
-
],
|
|
1610
|
-
"superclass": {
|
|
1611
|
-
"name": "LitElement",
|
|
1612
|
-
"package": "lit"
|
|
1613
|
-
},
|
|
1614
|
-
"status": "ready",
|
|
1615
|
-
"category": "feedback",
|
|
1616
|
-
"displayName": null,
|
|
1617
|
-
"examples": [],
|
|
1618
|
-
"tagName": "nord-banner",
|
|
1619
|
-
"customElement": true
|
|
1620
|
-
}
|
|
1621
|
-
],
|
|
1622
|
-
"exports": [
|
|
1623
|
-
{
|
|
1624
|
-
"kind": "js",
|
|
1625
|
-
"name": "default",
|
|
1626
|
-
"declaration": {
|
|
1627
|
-
"name": "Banner",
|
|
1628
|
-
"module": "src/banner/Banner.ts"
|
|
1629
|
-
}
|
|
1630
|
-
},
|
|
1631
|
-
{
|
|
1632
|
-
"kind": "custom-element-definition",
|
|
1633
|
-
"name": "nord-banner",
|
|
1634
|
-
"declaration": {
|
|
1635
|
-
"name": "Banner",
|
|
1636
|
-
"module": "src/banner/Banner.ts"
|
|
1637
|
-
}
|
|
1638
|
-
}
|
|
1639
|
-
],
|
|
1640
|
-
"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"
|
|
1641
|
-
},
|
|
1642
|
-
{
|
|
1643
|
-
"kind": "javascript-module",
|
|
1644
|
-
"path": "src/badge/Badge.ts",
|
|
1645
|
-
"declarations": [
|
|
1646
|
-
{
|
|
1647
|
-
"kind": "class",
|
|
1648
|
-
"description": "Badges are used to inform users of the status of an object\nor of an action that’s been taken. Commonly used in tabular\ndata to indicate status.",
|
|
1649
|
-
"name": "Badge",
|
|
1650
|
-
"slots": [
|
|
1651
|
-
{
|
|
1652
|
-
"description": "The badge content.",
|
|
1653
|
-
"name": ""
|
|
1654
|
-
}
|
|
1655
|
-
],
|
|
1656
|
-
"members": [
|
|
1657
|
-
{
|
|
1658
|
-
"kind": "field",
|
|
1659
|
-
"name": "type",
|
|
1660
|
-
"type": {
|
|
1661
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
1662
|
-
},
|
|
1663
|
-
"default": "\"neutral\"",
|
|
1664
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1665
|
-
"attribute": "type",
|
|
1666
|
-
"reflects": true
|
|
1667
|
-
},
|
|
1668
|
-
{
|
|
1669
|
-
"kind": "field",
|
|
1670
|
-
"name": "progress",
|
|
1671
|
-
"type": {
|
|
1672
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
1673
|
-
},
|
|
1674
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
1675
|
-
"attribute": "progress"
|
|
1676
|
-
}
|
|
1677
|
-
],
|
|
1678
|
-
"attributes": [
|
|
1679
|
-
{
|
|
1680
|
-
"name": "type",
|
|
1681
|
-
"type": {
|
|
1682
|
-
"text": "\"warning\" | \"success\" | \"danger\" | \"highlight\" | \"info\" | \"neutral\" | \"progress\" | undefined"
|
|
1683
|
-
},
|
|
1684
|
-
"default": "\"neutral\"",
|
|
1685
|
-
"description": "The type of badge.\nDetermines the background color of the badge.",
|
|
1686
|
-
"fieldName": "type"
|
|
1687
|
-
},
|
|
1688
|
-
{
|
|
1689
|
-
"name": "progress",
|
|
1690
|
-
"type": {
|
|
1691
|
-
"text": "\"cancelled\" | \"complete\" | \"incomplete\" | \"partially-complete\" | undefined"
|
|
1692
|
-
},
|
|
1693
|
-
"description": "The progress of the badge. Displays a progress\nindicator next to the label.",
|
|
1694
|
-
"fieldName": "progress"
|
|
1695
|
-
}
|
|
1696
|
-
],
|
|
1697
|
-
"superclass": {
|
|
1698
|
-
"name": "LitElement",
|
|
1699
|
-
"package": "lit"
|
|
1700
|
-
},
|
|
1701
|
-
"status": "ready",
|
|
1702
|
-
"category": "text",
|
|
1703
|
-
"displayName": null,
|
|
1704
|
-
"examples": [],
|
|
1705
|
-
"tagName": "nord-badge",
|
|
1706
|
-
"customElement": true
|
|
1707
|
-
}
|
|
1708
|
-
],
|
|
1709
|
-
"exports": [
|
|
1710
|
-
{
|
|
1711
|
-
"kind": "js",
|
|
1712
|
-
"name": "default",
|
|
1713
|
-
"declaration": {
|
|
1714
|
-
"name": "Badge",
|
|
1715
|
-
"module": "src/badge/Badge.ts"
|
|
1716
|
-
}
|
|
1717
|
-
},
|
|
1718
|
-
{
|
|
1719
|
-
"kind": "custom-element-definition",
|
|
1720
|
-
"name": "nord-badge",
|
|
1721
|
-
"declaration": {
|
|
1722
|
-
"name": "Badge",
|
|
1723
|
-
"module": "src/badge/Badge.ts"
|
|
1724
|
-
}
|
|
1725
|
-
}
|
|
1726
|
-
],
|
|
1727
|
-
"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"
|
|
1728
|
-
},
|
|
1729
1762
|
{
|
|
1730
1763
|
"kind": "javascript-module",
|
|
1731
1764
|
"path": "src/card/Card.ts",
|
|
@@ -5487,7 +5520,7 @@
|
|
|
5487
5520
|
}
|
|
5488
5521
|
}
|
|
5489
5522
|
],
|
|
5490
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for displaying contextual actions or information. For example, when clicking on a table row.\n- Use when you don’t want to block users from completing their task in the main view of an application.\n- Always include a header that summarizes the actions and information in the drawer.\n- Should be closeable through actions like “Done” and “Close”.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t reset the drawer’s state when closed if used for settings or filters. Settings should persist.\n- Don’t open from within another drawer. Only one drawer can be open at a time.\n- Don’t use for presenting a small amount of content or an actions menu, use the [popout](/components/popout/) or [dropdown](/components/dropdown/) component instead.\n\n</div>\n"
|
|
5523
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use for displaying contextual actions or information. For example, when clicking on a table row.\n- Use when you don’t want to block users from completing their task in the main view of an application.\n- Always include a header that summarizes the actions and information in the drawer.\n- Should be closeable through actions like “Done” and “Close”.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t reset the drawer’s state when closed if used for settings or filters. Settings should persist.\n- Don’t open from within another drawer. Only one drawer can be open at a time.\n- Don’t use for presenting a small amount of content or an actions menu, use the [popout](/components/popout/) or [dropdown](/components/dropdown/) component instead.\n\n</div>\n\n---\n\n## Additional considerations\n\n- You can customize the width of the component using `--n-layout-drawer-inline-size` CSS Custom Property that is offered on [Layout component](/components/layout/).\n"
|
|
5491
5524
|
},
|
|
5492
5525
|
{
|
|
5493
5526
|
"kind": "javascript-module",
|
|
@@ -5521,38 +5554,7 @@
|
|
|
5521
5554
|
"type": {
|
|
5522
5555
|
"text": "Popout"
|
|
5523
5556
|
},
|
|
5524
|
-
"privacy": "private"
|
|
5525
|
-
},
|
|
5526
|
-
{
|
|
5527
|
-
"kind": "field",
|
|
5528
|
-
"name": "open",
|
|
5529
|
-
"type": {
|
|
5530
|
-
"text": "boolean"
|
|
5531
|
-
},
|
|
5532
|
-
"default": "false",
|
|
5533
|
-
"description": "Controls whether the dropdown is open or not.",
|
|
5534
|
-
"attribute": "open",
|
|
5535
|
-
"reflects": true
|
|
5536
|
-
},
|
|
5537
|
-
{
|
|
5538
|
-
"kind": "field",
|
|
5539
|
-
"name": "align",
|
|
5540
|
-
"type": {
|
|
5541
|
-
"text": "Popout[\"align\"] | undefined"
|
|
5542
|
-
},
|
|
5543
|
-
"description": "Set the alignment of the dropdown in relation to the toggle depending on the position.\n`start` will align the left of the dropdown to the left of the toggle.\n`end` will align the right of the dropdown to the right of the toggle.\nA dropdown with a set position of `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom of the dropdown respectively.",
|
|
5544
|
-
"attribute": "align",
|
|
5545
|
-
"reflects": true
|
|
5546
|
-
},
|
|
5547
|
-
{
|
|
5548
|
-
"kind": "field",
|
|
5549
|
-
"name": "position",
|
|
5550
|
-
"type": {
|
|
5551
|
-
"text": "Popout[\"position\"] | undefined"
|
|
5552
|
-
},
|
|
5553
|
-
"description": "Set the position of the dropdown in relation to the toggle.\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
5554
|
-
"attribute": "position",
|
|
5555
|
-
"reflects": true
|
|
5557
|
+
"privacy": "private"
|
|
5556
5558
|
},
|
|
5557
5559
|
{
|
|
5558
5560
|
"kind": "field",
|
|
@@ -5615,34 +5617,54 @@
|
|
|
5615
5617
|
"kind": "method",
|
|
5616
5618
|
"name": "handleClose",
|
|
5617
5619
|
"privacy": "private"
|
|
5618
|
-
}
|
|
5619
|
-
],
|
|
5620
|
-
"attributes": [
|
|
5620
|
+
},
|
|
5621
5621
|
{
|
|
5622
|
+
"kind": "field",
|
|
5622
5623
|
"name": "open",
|
|
5623
5624
|
"type": {
|
|
5624
5625
|
"text": "boolean"
|
|
5625
5626
|
},
|
|
5626
5627
|
"default": "false",
|
|
5627
|
-
"description": "Controls whether the
|
|
5628
|
-
"
|
|
5628
|
+
"description": "Controls whether the component is open or not.",
|
|
5629
|
+
"attribute": "open",
|
|
5630
|
+
"reflects": true,
|
|
5631
|
+
"inheritedFrom": {
|
|
5632
|
+
"name": "FloatingMixin",
|
|
5633
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
5634
|
+
}
|
|
5629
5635
|
},
|
|
5630
5636
|
{
|
|
5637
|
+
"kind": "field",
|
|
5631
5638
|
"name": "align",
|
|
5632
5639
|
"type": {
|
|
5633
|
-
"text": "
|
|
5640
|
+
"text": "\"start\" | \"end\""
|
|
5634
5641
|
},
|
|
5635
|
-
"
|
|
5636
|
-
"
|
|
5642
|
+
"default": "\"start\"",
|
|
5643
|
+
"description": "Set the alignment in relation to the toggle (or anchor) depending on the position.\n`start` will align it to the left of the toggle (or anchor).\n`end` will align it to the right of the toggle (or anchor).\nSetting the `position` to `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom respectively.",
|
|
5644
|
+
"attribute": "align",
|
|
5645
|
+
"reflects": true,
|
|
5646
|
+
"inheritedFrom": {
|
|
5647
|
+
"name": "FloatingMixin",
|
|
5648
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
5649
|
+
}
|
|
5637
5650
|
},
|
|
5638
5651
|
{
|
|
5652
|
+
"kind": "field",
|
|
5639
5653
|
"name": "position",
|
|
5640
5654
|
"type": {
|
|
5641
|
-
"text": "
|
|
5655
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
5642
5656
|
},
|
|
5643
|
-
"
|
|
5644
|
-
"
|
|
5645
|
-
|
|
5657
|
+
"default": "\"block-end\"",
|
|
5658
|
+
"description": "Set the position in relation to the toggle (or anchor).\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
5659
|
+
"attribute": "position",
|
|
5660
|
+
"reflects": true,
|
|
5661
|
+
"inheritedFrom": {
|
|
5662
|
+
"name": "FloatingMixin",
|
|
5663
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
5664
|
+
}
|
|
5665
|
+
}
|
|
5666
|
+
],
|
|
5667
|
+
"attributes": [
|
|
5646
5668
|
{
|
|
5647
5669
|
"name": "expand",
|
|
5648
5670
|
"type": {
|
|
@@ -5660,6 +5682,51 @@
|
|
|
5660
5682
|
"default": "\"m\"",
|
|
5661
5683
|
"description": "The size of the dropdown. This affects the minimum and maximum inline-size\nof the dropdown.",
|
|
5662
5684
|
"fieldName": "size"
|
|
5685
|
+
},
|
|
5686
|
+
{
|
|
5687
|
+
"name": "open",
|
|
5688
|
+
"type": {
|
|
5689
|
+
"text": "boolean"
|
|
5690
|
+
},
|
|
5691
|
+
"default": "false",
|
|
5692
|
+
"description": "Controls whether the component is open or not.",
|
|
5693
|
+
"fieldName": "open",
|
|
5694
|
+
"inheritedFrom": {
|
|
5695
|
+
"name": "FloatingMixin",
|
|
5696
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
5697
|
+
}
|
|
5698
|
+
},
|
|
5699
|
+
{
|
|
5700
|
+
"name": "align",
|
|
5701
|
+
"type": {
|
|
5702
|
+
"text": "\"start\" | \"end\""
|
|
5703
|
+
},
|
|
5704
|
+
"default": "\"start\"",
|
|
5705
|
+
"description": "Set the alignment in relation to the toggle (or anchor) depending on the position.\n`start` will align it to the left of the toggle (or anchor).\n`end` will align it to the right of the toggle (or anchor).\nSetting the `position` to `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom respectively.",
|
|
5706
|
+
"fieldName": "align",
|
|
5707
|
+
"inheritedFrom": {
|
|
5708
|
+
"name": "FloatingMixin",
|
|
5709
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
5710
|
+
}
|
|
5711
|
+
},
|
|
5712
|
+
{
|
|
5713
|
+
"name": "position",
|
|
5714
|
+
"type": {
|
|
5715
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
5716
|
+
},
|
|
5717
|
+
"default": "\"block-end\"",
|
|
5718
|
+
"description": "Set the position in relation to the toggle (or anchor).\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
5719
|
+
"fieldName": "position",
|
|
5720
|
+
"inheritedFrom": {
|
|
5721
|
+
"name": "FloatingMixin",
|
|
5722
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
5723
|
+
}
|
|
5724
|
+
}
|
|
5725
|
+
],
|
|
5726
|
+
"mixins": [
|
|
5727
|
+
{
|
|
5728
|
+
"name": "FloatingMixin",
|
|
5729
|
+
"module": "/src/common/mixins/FloatingComponentMixin.js"
|
|
5663
5730
|
}
|
|
5664
5731
|
],
|
|
5665
5732
|
"superclass": {
|
|
@@ -7161,6 +7228,10 @@
|
|
|
7161
7228
|
{
|
|
7162
7229
|
"description": "Used to place additional content/details relating to a selected item.",
|
|
7163
7230
|
"name": "drawer"
|
|
7231
|
+
},
|
|
7232
|
+
{
|
|
7233
|
+
"description": "Used to place a own nav-toggle component, for cases where you might need to add a tooltip.",
|
|
7234
|
+
"name": "nav-toggle"
|
|
7164
7235
|
}
|
|
7165
7236
|
],
|
|
7166
7237
|
"members": [
|
|
@@ -7200,7 +7271,7 @@
|
|
|
7200
7271
|
"kind": "field",
|
|
7201
7272
|
"name": "lightDismiss",
|
|
7202
7273
|
"privacy": "private",
|
|
7203
|
-
"default": "new LightDismissController(this, {\n isOpen: () => this.navState === \"opened\" && !
|
|
7274
|
+
"default": "new LightDismissController(this, {\n isOpen: () => this.navState === \"opened\" && !this.wideScreen,\n onDismiss: () => this.navTransition(\"close\"),\n isDismissible: node => node !== this.navEl,\n })"
|
|
7204
7275
|
},
|
|
7205
7276
|
{
|
|
7206
7277
|
"kind": "field",
|
|
@@ -7232,6 +7303,11 @@
|
|
|
7232
7303
|
},
|
|
7233
7304
|
"privacy": "private"
|
|
7234
7305
|
},
|
|
7306
|
+
{
|
|
7307
|
+
"kind": "field",
|
|
7308
|
+
"name": "wideScreen",
|
|
7309
|
+
"privacy": "private"
|
|
7310
|
+
},
|
|
7235
7311
|
{
|
|
7236
7312
|
"kind": "field",
|
|
7237
7313
|
"name": "navOpen",
|
|
@@ -7248,7 +7324,8 @@
|
|
|
7248
7324
|
"type": {
|
|
7249
7325
|
"text": "string | undefined"
|
|
7250
7326
|
},
|
|
7251
|
-
"description": "ID reference of element used to toggle the navigation.",
|
|
7327
|
+
"description": "ID reference of element used to toggle the navigation.\nThis is deprecated, the layout component will now render its own nav toggle to simplify usage.",
|
|
7328
|
+
"deprecated": "true",
|
|
7252
7329
|
"attribute": "nav-toggle"
|
|
7253
7330
|
},
|
|
7254
7331
|
{
|
|
@@ -7262,6 +7339,11 @@
|
|
|
7262
7339
|
"attribute": "padding",
|
|
7263
7340
|
"reflects": true
|
|
7264
7341
|
},
|
|
7342
|
+
{
|
|
7343
|
+
"kind": "method",
|
|
7344
|
+
"name": "renderNavToggle",
|
|
7345
|
+
"privacy": "private"
|
|
7346
|
+
},
|
|
7265
7347
|
{
|
|
7266
7348
|
"kind": "method",
|
|
7267
7349
|
"name": "handleNavWidthChange",
|
|
@@ -7449,7 +7531,8 @@
|
|
|
7449
7531
|
"type": {
|
|
7450
7532
|
"text": "string | undefined"
|
|
7451
7533
|
},
|
|
7452
|
-
"description": "ID reference of element used to toggle the navigation.",
|
|
7534
|
+
"description": "ID reference of element used to toggle the navigation.\nThis is deprecated, the layout component will now render its own nav toggle to simplify usage.",
|
|
7535
|
+
"deprecated": "true",
|
|
7453
7536
|
"fieldName": "navToggle"
|
|
7454
7537
|
},
|
|
7455
7538
|
{
|
|
@@ -7590,7 +7673,7 @@
|
|
|
7590
7673
|
"type": {
|
|
7591
7674
|
"text": "object"
|
|
7592
7675
|
},
|
|
7593
|
-
"default": "{\n $lang: \"en-US\",\n $name: \"English\",\n $dir: \"ltr\" as \"ltr\" | \"rtl\",\n \"nord-command-menu\": commandMenuLocalization,\n \"nord-calendar\": calendarLocalization,\n \"nord-date-picker\": datePickerLocalization,\n \"nord-modal\": modalLocalization,\n}"
|
|
7676
|
+
"default": "{\n $lang: \"en-US\",\n $name: \"English\",\n $dir: \"ltr\" as \"ltr\" | \"rtl\",\n \"nord-command-menu\": commandMenuLocalization,\n \"nord-calendar\": calendarLocalization,\n \"nord-date-picker\": datePickerLocalization,\n \"nord-modal\": modalLocalization,\n \"nord-nav-toggle\": navToggleLocalization,\n}"
|
|
7594
7677
|
}
|
|
7595
7678
|
],
|
|
7596
7679
|
"exports": [
|
|
@@ -7614,7 +7697,7 @@
|
|
|
7614
7697
|
"type": {
|
|
7615
7698
|
"text": "Translation"
|
|
7616
7699
|
},
|
|
7617
|
-
"default": "{\n $lang: \"fi\",\n $name: \"Suomi\",\n $dir: \"ltr\",\n\n \"nord-command-menu\": {\n instructions: \"Paina 'Enter' vahvistaaksesi valinnan tai 'Escape' peruuttaaksesi\",\n inputLabel: \"Kirjoita komento jonka haluat suorittaa.\",\n footerArrowKeys: \"Siirry\",\n footerEnterKey: \"Valitse\",\n footerEscapeKey: \"Esc sulje\",\n footerBackspaceKey: \"Siirry takaisin\",\n noResults: searchTerm => `Ei tuloksia haulle \"${searchTerm}\"`,\n tip: \"Vinkki: jotkin haut vaativat tarkan hakutermin. Koita kirjoittaa koko hakutermi kokonaisuudessaan, tai kokeile toista sanaa tai fraasia.\",\n },\n\n \"nord-calendar\": {\n prevMonthLabel: \"Edellinen kuukausi\",\n nextMonthLabel: \"Seuraava kuukausi\",\n monthSelectLabel: \"Kuukausi\",\n yearSelectLabel: \"Vuosi\",\n },\n\n \"nord-date-picker\": {\n modalHeading: \"Valitse päivämäärä\",\n closeLabel: \"Sulje ikkuna\",\n buttonLabel: \"Valitse päivämäärä\",\n selectedDateMessage: \"Valittu päivämäärä on\",\n },\n\n \"nord-modal\": {\n closeLabel: \"Sulje ikkuna\",\n },\n}"
|
|
7700
|
+
"default": "{\n $lang: \"fi\",\n $name: \"Suomi\",\n $dir: \"ltr\",\n\n \"nord-command-menu\": {\n instructions: \"Paina 'Enter' vahvistaaksesi valinnan tai 'Escape' peruuttaaksesi\",\n inputLabel: \"Kirjoita komento jonka haluat suorittaa.\",\n footerArrowKeys: \"Siirry\",\n footerEnterKey: \"Valitse\",\n footerEscapeKey: \"Esc sulje\",\n footerBackspaceKey: \"Siirry takaisin\",\n noResults: searchTerm => `Ei tuloksia haulle \"${searchTerm}\"`,\n tip: \"Vinkki: jotkin haut vaativat tarkan hakutermin. Koita kirjoittaa koko hakutermi kokonaisuudessaan, tai kokeile toista sanaa tai fraasia.\",\n },\n\n \"nord-calendar\": {\n prevMonthLabel: \"Edellinen kuukausi\",\n nextMonthLabel: \"Seuraava kuukausi\",\n monthSelectLabel: \"Kuukausi\",\n yearSelectLabel: \"Vuosi\",\n },\n\n \"nord-date-picker\": {\n modalHeading: \"Valitse päivämäärä\",\n closeLabel: \"Sulje ikkuna\",\n buttonLabel: \"Valitse päivämäärä\",\n selectedDateMessage: \"Valittu päivämäärä on\",\n },\n\n \"nord-modal\": {\n closeLabel: \"Sulje ikkuna\",\n },\n\n \"nord-nav-toggle\": {\n label: \"Näytä/Piilota valikko\",\n },\n}"
|
|
7618
7701
|
}
|
|
7619
7702
|
],
|
|
7620
7703
|
"exports": [
|
|
@@ -8404,6 +8487,155 @@
|
|
|
8404
8487
|
],
|
|
8405
8488
|
"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- Group navigation items into navigation groups based on related categories.\n- Use group headings to clarify the category of a section.\n- Use icons for all top level navigation items.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use navigation item outside of navigation group and navigation components.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing navigation item labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in item labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Change theme</div>\n<div class=\"n-usage n-usage-dont\">Change the theme</div>\n\nAvoid ending item labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Switch user</div>\n<div class=\"n-usage n-usage-dont\">Switch user.</div>\n\nUse as few words as possible to describe each item label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for item labels and group titles:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n"
|
|
8406
8489
|
},
|
|
8490
|
+
{
|
|
8491
|
+
"kind": "javascript-module",
|
|
8492
|
+
"path": "src/nav-toggle/NavToggle.ts",
|
|
8493
|
+
"declarations": [
|
|
8494
|
+
{
|
|
8495
|
+
"kind": "class",
|
|
8496
|
+
"description": "Nav toggle is meant for hiding and showing the primary navigation.\nThis component is used internally in the Layout component, but can also be\nused separate to further customize the behaviour.",
|
|
8497
|
+
"name": "NavToggle",
|
|
8498
|
+
"members": [
|
|
8499
|
+
{
|
|
8500
|
+
"kind": "field",
|
|
8501
|
+
"name": "direction",
|
|
8502
|
+
"privacy": "private",
|
|
8503
|
+
"default": "new DirectionController(this)"
|
|
8504
|
+
},
|
|
8505
|
+
{
|
|
8506
|
+
"kind": "field",
|
|
8507
|
+
"name": "localization",
|
|
8508
|
+
"privacy": "private",
|
|
8509
|
+
"default": "new LocalizeController<\"nord-nav-toggle\">(this)"
|
|
8510
|
+
},
|
|
8511
|
+
{
|
|
8512
|
+
"kind": "field",
|
|
8513
|
+
"name": "focusableRef",
|
|
8514
|
+
"privacy": "protected",
|
|
8515
|
+
"inheritedFrom": {
|
|
8516
|
+
"name": "FocusableMixin",
|
|
8517
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8518
|
+
}
|
|
8519
|
+
},
|
|
8520
|
+
{
|
|
8521
|
+
"kind": "method",
|
|
8522
|
+
"name": "focus",
|
|
8523
|
+
"parameters": [
|
|
8524
|
+
{
|
|
8525
|
+
"name": "options",
|
|
8526
|
+
"optional": true,
|
|
8527
|
+
"type": {
|
|
8528
|
+
"text": "FocusOptions"
|
|
8529
|
+
},
|
|
8530
|
+
"description": "An object which controls aspects of the focusing process."
|
|
8531
|
+
}
|
|
8532
|
+
],
|
|
8533
|
+
"description": "Programmatically move focus to the component.",
|
|
8534
|
+
"inheritedFrom": {
|
|
8535
|
+
"name": "FocusableMixin",
|
|
8536
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8537
|
+
}
|
|
8538
|
+
},
|
|
8539
|
+
{
|
|
8540
|
+
"kind": "method",
|
|
8541
|
+
"name": "blur",
|
|
8542
|
+
"description": "Programmatically remove focus from the component.",
|
|
8543
|
+
"inheritedFrom": {
|
|
8544
|
+
"name": "FocusableMixin",
|
|
8545
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8546
|
+
}
|
|
8547
|
+
},
|
|
8548
|
+
{
|
|
8549
|
+
"kind": "method",
|
|
8550
|
+
"name": "click",
|
|
8551
|
+
"description": "Programmatically simulates a click on the component.",
|
|
8552
|
+
"inheritedFrom": {
|
|
8553
|
+
"name": "FocusableMixin",
|
|
8554
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
8555
|
+
}
|
|
8556
|
+
},
|
|
8557
|
+
{
|
|
8558
|
+
"kind": "field",
|
|
8559
|
+
"name": "_warningLogged",
|
|
8560
|
+
"type": {
|
|
8561
|
+
"text": "boolean"
|
|
8562
|
+
},
|
|
8563
|
+
"privacy": "private",
|
|
8564
|
+
"static": true,
|
|
8565
|
+
"default": "false",
|
|
8566
|
+
"inheritedFrom": {
|
|
8567
|
+
"name": "DraftComponentMixin",
|
|
8568
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
8569
|
+
}
|
|
8570
|
+
}
|
|
8571
|
+
],
|
|
8572
|
+
"mixins": [
|
|
8573
|
+
{
|
|
8574
|
+
"name": "FocusableMixin",
|
|
8575
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
8576
|
+
},
|
|
8577
|
+
{
|
|
8578
|
+
"name": "DraftComponentMixin",
|
|
8579
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
8580
|
+
}
|
|
8581
|
+
],
|
|
8582
|
+
"superclass": {
|
|
8583
|
+
"name": "LitElement",
|
|
8584
|
+
"package": "lit"
|
|
8585
|
+
},
|
|
8586
|
+
"status": "draft",
|
|
8587
|
+
"category": "action",
|
|
8588
|
+
"displayName": null,
|
|
8589
|
+
"examples": [],
|
|
8590
|
+
"tagName": "nord-nav-toggle",
|
|
8591
|
+
"customElement": true
|
|
8592
|
+
}
|
|
8593
|
+
],
|
|
8594
|
+
"exports": [
|
|
8595
|
+
{
|
|
8596
|
+
"kind": "js",
|
|
8597
|
+
"name": "default",
|
|
8598
|
+
"declaration": {
|
|
8599
|
+
"name": "NavToggle",
|
|
8600
|
+
"module": "src/nav-toggle/NavToggle.ts"
|
|
8601
|
+
}
|
|
8602
|
+
},
|
|
8603
|
+
{
|
|
8604
|
+
"kind": "custom-element-definition",
|
|
8605
|
+
"name": "nord-nav-toggle",
|
|
8606
|
+
"declaration": {
|
|
8607
|
+
"name": "NavToggle",
|
|
8608
|
+
"module": "src/nav-toggle/NavToggle.ts"
|
|
8609
|
+
}
|
|
8610
|
+
}
|
|
8611
|
+
],
|
|
8612
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a tooltip with the toggle that’s labelled as `Toggle navigation`.\n- We recommend setting a keyboard shortcut that toggles the navigation.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use as a generic button or toggle. Use the [Button component](/components/button/) instead.\n\n</div>\n"
|
|
8613
|
+
},
|
|
8614
|
+
{
|
|
8615
|
+
"kind": "javascript-module",
|
|
8616
|
+
"path": "src/nav-toggle/localization.ts",
|
|
8617
|
+
"declarations": [
|
|
8618
|
+
{
|
|
8619
|
+
"kind": "variable",
|
|
8620
|
+
"name": "localization",
|
|
8621
|
+
"type": {
|
|
8622
|
+
"text": "object"
|
|
8623
|
+
},
|
|
8624
|
+
"default": "{\n label: \"Toggle navigation\",\n}"
|
|
8625
|
+
}
|
|
8626
|
+
],
|
|
8627
|
+
"exports": [
|
|
8628
|
+
{
|
|
8629
|
+
"kind": "js",
|
|
8630
|
+
"name": "default",
|
|
8631
|
+
"declaration": {
|
|
8632
|
+
"name": "localization",
|
|
8633
|
+
"module": "src/nav-toggle/localization.ts"
|
|
8634
|
+
}
|
|
8635
|
+
}
|
|
8636
|
+
],
|
|
8637
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a tooltip with the toggle that’s labelled as `Toggle navigation`.\n- We recommend setting a keyboard shortcut that toggles the navigation.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use as a generic button or toggle. Use the [Button component](/components/button/) instead.\n\n</div>\n"
|
|
8638
|
+
},
|
|
8407
8639
|
{
|
|
8408
8640
|
"kind": "javascript-module",
|
|
8409
8641
|
"path": "src/navigation/Navigation.ts",
|
|
@@ -8482,6 +8714,14 @@
|
|
|
8482
8714
|
},
|
|
8483
8715
|
"privacy": "private"
|
|
8484
8716
|
},
|
|
8717
|
+
{
|
|
8718
|
+
"kind": "field",
|
|
8719
|
+
"name": "anchorElement",
|
|
8720
|
+
"type": {
|
|
8721
|
+
"text": "Element"
|
|
8722
|
+
},
|
|
8723
|
+
"privacy": "private"
|
|
8724
|
+
},
|
|
8485
8725
|
{
|
|
8486
8726
|
"kind": "field",
|
|
8487
8727
|
"name": "cleanupAutoUpdate",
|
|
@@ -8538,46 +8778,23 @@
|
|
|
8538
8778
|
},
|
|
8539
8779
|
{
|
|
8540
8780
|
"kind": "field",
|
|
8541
|
-
"name": "
|
|
8542
|
-
"type": {
|
|
8543
|
-
"text": "boolean"
|
|
8544
|
-
},
|
|
8545
|
-
"default": "false",
|
|
8546
|
-
"description": "Controls whether the popout is open or not.",
|
|
8547
|
-
"attribute": "open",
|
|
8548
|
-
"reflects": true
|
|
8549
|
-
},
|
|
8550
|
-
{
|
|
8551
|
-
"kind": "field",
|
|
8552
|
-
"name": "align",
|
|
8553
|
-
"type": {
|
|
8554
|
-
"text": "\"start\" | \"end\""
|
|
8555
|
-
},
|
|
8556
|
-
"default": "\"start\"",
|
|
8557
|
-
"description": "Set the alignment of the popout in relation to the toggle depending on the position.\n`start` will align the left of the popout to the left of the toggle.\n`end` will align the right of the popout to the right of the toggle.\nA popout with a set position of `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom of the popout respectively.",
|
|
8558
|
-
"attribute": "align",
|
|
8559
|
-
"reflects": true
|
|
8560
|
-
},
|
|
8561
|
-
{
|
|
8562
|
-
"kind": "field",
|
|
8563
|
-
"name": "position",
|
|
8781
|
+
"name": "id",
|
|
8564
8782
|
"type": {
|
|
8565
|
-
"text": "
|
|
8783
|
+
"text": "string"
|
|
8566
8784
|
},
|
|
8567
|
-
"default": "\"
|
|
8568
|
-
"description": "
|
|
8569
|
-
"attribute": "
|
|
8785
|
+
"default": "\"\"",
|
|
8786
|
+
"description": "The id for the active element to reference via aria-controls.",
|
|
8787
|
+
"attribute": "id",
|
|
8570
8788
|
"reflects": true
|
|
8571
8789
|
},
|
|
8572
8790
|
{
|
|
8573
8791
|
"kind": "field",
|
|
8574
|
-
"name": "
|
|
8792
|
+
"name": "anchor",
|
|
8575
8793
|
"type": {
|
|
8576
|
-
"text": "string"
|
|
8794
|
+
"text": "string | undefined"
|
|
8577
8795
|
},
|
|
8578
|
-
"
|
|
8579
|
-
"
|
|
8580
|
-
"attribute": "id",
|
|
8796
|
+
"description": "Set an optional anchor element to align against, replacing the triggering element.",
|
|
8797
|
+
"attribute": "anchor",
|
|
8581
8798
|
"reflects": true
|
|
8582
8799
|
},
|
|
8583
8800
|
{
|
|
@@ -8629,7 +8846,12 @@
|
|
|
8629
8846
|
},
|
|
8630
8847
|
{
|
|
8631
8848
|
"kind": "method",
|
|
8632
|
-
"name": "getToggle",
|
|
8849
|
+
"name": "getToggle",
|
|
8850
|
+
"privacy": "private"
|
|
8851
|
+
},
|
|
8852
|
+
{
|
|
8853
|
+
"kind": "method",
|
|
8854
|
+
"name": "getAnchor",
|
|
8633
8855
|
"privacy": "private"
|
|
8634
8856
|
},
|
|
8635
8857
|
{
|
|
@@ -8637,6 +8859,51 @@
|
|
|
8637
8859
|
"name": "handleMediaQueryChange",
|
|
8638
8860
|
"privacy": "private",
|
|
8639
8861
|
"description": "Update the smallViewport flag to switch between \"sheet\" and \"floating\".\nautoUpdate is needed when a viewport gets larger and the popout is open."
|
|
8862
|
+
},
|
|
8863
|
+
{
|
|
8864
|
+
"kind": "field",
|
|
8865
|
+
"name": "open",
|
|
8866
|
+
"type": {
|
|
8867
|
+
"text": "boolean"
|
|
8868
|
+
},
|
|
8869
|
+
"default": "false",
|
|
8870
|
+
"description": "Controls whether the component is open or not.",
|
|
8871
|
+
"attribute": "open",
|
|
8872
|
+
"reflects": true,
|
|
8873
|
+
"inheritedFrom": {
|
|
8874
|
+
"name": "FloatingMixin",
|
|
8875
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
8876
|
+
}
|
|
8877
|
+
},
|
|
8878
|
+
{
|
|
8879
|
+
"kind": "field",
|
|
8880
|
+
"name": "align",
|
|
8881
|
+
"type": {
|
|
8882
|
+
"text": "\"start\" | \"end\""
|
|
8883
|
+
},
|
|
8884
|
+
"default": "\"start\"",
|
|
8885
|
+
"description": "Set the alignment in relation to the toggle (or anchor) depending on the position.\n`start` will align it to the left of the toggle (or anchor).\n`end` will align it to the right of the toggle (or anchor).\nSetting the `position` to `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom respectively.",
|
|
8886
|
+
"attribute": "align",
|
|
8887
|
+
"reflects": true,
|
|
8888
|
+
"inheritedFrom": {
|
|
8889
|
+
"name": "FloatingMixin",
|
|
8890
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
8891
|
+
}
|
|
8892
|
+
},
|
|
8893
|
+
{
|
|
8894
|
+
"kind": "field",
|
|
8895
|
+
"name": "position",
|
|
8896
|
+
"type": {
|
|
8897
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
8898
|
+
},
|
|
8899
|
+
"default": "\"block-end\"",
|
|
8900
|
+
"description": "Set the position in relation to the toggle (or anchor).\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
8901
|
+
"attribute": "position",
|
|
8902
|
+
"reflects": true,
|
|
8903
|
+
"inheritedFrom": {
|
|
8904
|
+
"name": "FloatingMixin",
|
|
8905
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
8906
|
+
}
|
|
8640
8907
|
}
|
|
8641
8908
|
],
|
|
8642
8909
|
"events": [
|
|
@@ -8656,14 +8923,35 @@
|
|
|
8656
8923
|
}
|
|
8657
8924
|
],
|
|
8658
8925
|
"attributes": [
|
|
8926
|
+
{
|
|
8927
|
+
"name": "id",
|
|
8928
|
+
"type": {
|
|
8929
|
+
"text": "string"
|
|
8930
|
+
},
|
|
8931
|
+
"default": "\"\"",
|
|
8932
|
+
"description": "The id for the active element to reference via aria-controls.",
|
|
8933
|
+
"fieldName": "id"
|
|
8934
|
+
},
|
|
8935
|
+
{
|
|
8936
|
+
"name": "anchor",
|
|
8937
|
+
"type": {
|
|
8938
|
+
"text": "string | undefined"
|
|
8939
|
+
},
|
|
8940
|
+
"description": "Set an optional anchor element to align against, replacing the triggering element.",
|
|
8941
|
+
"fieldName": "anchor"
|
|
8942
|
+
},
|
|
8659
8943
|
{
|
|
8660
8944
|
"name": "open",
|
|
8661
8945
|
"type": {
|
|
8662
8946
|
"text": "boolean"
|
|
8663
8947
|
},
|
|
8664
8948
|
"default": "false",
|
|
8665
|
-
"description": "Controls whether the
|
|
8666
|
-
"fieldName": "open"
|
|
8949
|
+
"description": "Controls whether the component is open or not.",
|
|
8950
|
+
"fieldName": "open",
|
|
8951
|
+
"inheritedFrom": {
|
|
8952
|
+
"name": "FloatingMixin",
|
|
8953
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
8954
|
+
}
|
|
8667
8955
|
},
|
|
8668
8956
|
{
|
|
8669
8957
|
"name": "align",
|
|
@@ -8671,8 +8959,12 @@
|
|
|
8671
8959
|
"text": "\"start\" | \"end\""
|
|
8672
8960
|
},
|
|
8673
8961
|
"default": "\"start\"",
|
|
8674
|
-
"description": "Set the alignment
|
|
8675
|
-
"fieldName": "align"
|
|
8962
|
+
"description": "Set the alignment in relation to the toggle (or anchor) depending on the position.\n`start` will align it to the left of the toggle (or anchor).\n`end` will align it to the right of the toggle (or anchor).\nSetting the `position` to `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom respectively.",
|
|
8963
|
+
"fieldName": "align",
|
|
8964
|
+
"inheritedFrom": {
|
|
8965
|
+
"name": "FloatingMixin",
|
|
8966
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
8967
|
+
}
|
|
8676
8968
|
},
|
|
8677
8969
|
{
|
|
8678
8970
|
"name": "position",
|
|
@@ -8680,17 +8972,18 @@
|
|
|
8680
8972
|
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
8681
8973
|
},
|
|
8682
8974
|
"default": "\"block-end\"",
|
|
8683
|
-
"description": "Set the position
|
|
8684
|
-
"fieldName": "position"
|
|
8685
|
-
|
|
8975
|
+
"description": "Set the position in relation to the toggle (or anchor).\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
8976
|
+
"fieldName": "position",
|
|
8977
|
+
"inheritedFrom": {
|
|
8978
|
+
"name": "FloatingMixin",
|
|
8979
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
8980
|
+
}
|
|
8981
|
+
}
|
|
8982
|
+
],
|
|
8983
|
+
"mixins": [
|
|
8686
8984
|
{
|
|
8687
|
-
"name": "
|
|
8688
|
-
"
|
|
8689
|
-
"text": "string"
|
|
8690
|
-
},
|
|
8691
|
-
"default": "\"\"",
|
|
8692
|
-
"description": "The id for the active element to reference via aria-controls.",
|
|
8693
|
-
"fieldName": "id"
|
|
8985
|
+
"name": "FloatingMixin",
|
|
8986
|
+
"module": "/src/common/mixins/FloatingComponentMixin.js"
|
|
8694
8987
|
}
|
|
8695
8988
|
],
|
|
8696
8989
|
"superclass": {
|
|
@@ -13164,41 +13457,6 @@
|
|
|
13164
13457
|
],
|
|
13165
13458
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to hide text visually from the screen, but keep it available to assistive technologies, such as screen readers.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for hiding interactive content.\n\n</div>\n"
|
|
13166
13459
|
},
|
|
13167
|
-
{
|
|
13168
|
-
"kind": "javascript-module",
|
|
13169
|
-
"path": "src/common/decorators/observe.ts",
|
|
13170
|
-
"declarations": [
|
|
13171
|
-
{
|
|
13172
|
-
"kind": "function",
|
|
13173
|
-
"name": "observe",
|
|
13174
|
-
"parameters": [
|
|
13175
|
-
{
|
|
13176
|
-
"name": "propertyName",
|
|
13177
|
-
"type": {
|
|
13178
|
-
"text": "string"
|
|
13179
|
-
}
|
|
13180
|
-
},
|
|
13181
|
-
{
|
|
13182
|
-
"name": "lifecycle",
|
|
13183
|
-
"default": "\"update\"",
|
|
13184
|
-
"type": {
|
|
13185
|
-
"text": "ObserveLifecycle"
|
|
13186
|
-
}
|
|
13187
|
-
}
|
|
13188
|
-
]
|
|
13189
|
-
}
|
|
13190
|
-
],
|
|
13191
|
-
"exports": [
|
|
13192
|
-
{
|
|
13193
|
-
"kind": "js",
|
|
13194
|
-
"name": "observe",
|
|
13195
|
-
"declaration": {
|
|
13196
|
-
"name": "observe",
|
|
13197
|
-
"module": "src/common/decorators/observe.ts"
|
|
13198
|
-
}
|
|
13199
|
-
}
|
|
13200
|
-
]
|
|
13201
|
-
},
|
|
13202
13460
|
{
|
|
13203
13461
|
"kind": "javascript-module",
|
|
13204
13462
|
"path": "src/common/controllers/DirectionController.ts",
|
|
@@ -14231,6 +14489,41 @@
|
|
|
14231
14489
|
}
|
|
14232
14490
|
]
|
|
14233
14491
|
},
|
|
14492
|
+
{
|
|
14493
|
+
"kind": "javascript-module",
|
|
14494
|
+
"path": "src/common/decorators/observe.ts",
|
|
14495
|
+
"declarations": [
|
|
14496
|
+
{
|
|
14497
|
+
"kind": "function",
|
|
14498
|
+
"name": "observe",
|
|
14499
|
+
"parameters": [
|
|
14500
|
+
{
|
|
14501
|
+
"name": "propertyName",
|
|
14502
|
+
"type": {
|
|
14503
|
+
"text": "string"
|
|
14504
|
+
}
|
|
14505
|
+
},
|
|
14506
|
+
{
|
|
14507
|
+
"name": "lifecycle",
|
|
14508
|
+
"default": "\"update\"",
|
|
14509
|
+
"type": {
|
|
14510
|
+
"text": "ObserveLifecycle"
|
|
14511
|
+
}
|
|
14512
|
+
}
|
|
14513
|
+
]
|
|
14514
|
+
}
|
|
14515
|
+
],
|
|
14516
|
+
"exports": [
|
|
14517
|
+
{
|
|
14518
|
+
"kind": "js",
|
|
14519
|
+
"name": "observe",
|
|
14520
|
+
"declaration": {
|
|
14521
|
+
"name": "observe",
|
|
14522
|
+
"module": "src/common/decorators/observe.ts"
|
|
14523
|
+
}
|
|
14524
|
+
}
|
|
14525
|
+
]
|
|
14526
|
+
},
|
|
14234
14527
|
{
|
|
14235
14528
|
"kind": "javascript-module",
|
|
14236
14529
|
"path": "src/common/directives/cond.ts",
|
|
@@ -14781,6 +15074,136 @@
|
|
|
14781
15074
|
}
|
|
14782
15075
|
]
|
|
14783
15076
|
},
|
|
15077
|
+
{
|
|
15078
|
+
"kind": "javascript-module",
|
|
15079
|
+
"path": "src/common/mixins/FloatingComponentMixin.ts",
|
|
15080
|
+
"declarations": [
|
|
15081
|
+
{
|
|
15082
|
+
"kind": "class",
|
|
15083
|
+
"description": "",
|
|
15084
|
+
"name": "FloatingMixinInterface",
|
|
15085
|
+
"members": [
|
|
15086
|
+
{
|
|
15087
|
+
"kind": "field",
|
|
15088
|
+
"name": "open",
|
|
15089
|
+
"type": {
|
|
15090
|
+
"text": "boolean"
|
|
15091
|
+
}
|
|
15092
|
+
},
|
|
15093
|
+
{
|
|
15094
|
+
"kind": "field",
|
|
15095
|
+
"name": "align",
|
|
15096
|
+
"type": {
|
|
15097
|
+
"text": "Alignment"
|
|
15098
|
+
}
|
|
15099
|
+
},
|
|
15100
|
+
{
|
|
15101
|
+
"kind": "field",
|
|
15102
|
+
"name": "position",
|
|
15103
|
+
"type": {
|
|
15104
|
+
"text": "LogicalSide"
|
|
15105
|
+
}
|
|
15106
|
+
}
|
|
15107
|
+
],
|
|
15108
|
+
"examples": []
|
|
15109
|
+
},
|
|
15110
|
+
{
|
|
15111
|
+
"kind": "mixin",
|
|
15112
|
+
"description": "",
|
|
15113
|
+
"name": "FloatingMixin",
|
|
15114
|
+
"members": [
|
|
15115
|
+
{
|
|
15116
|
+
"kind": "field",
|
|
15117
|
+
"name": "open",
|
|
15118
|
+
"type": {
|
|
15119
|
+
"text": "boolean"
|
|
15120
|
+
},
|
|
15121
|
+
"default": "false",
|
|
15122
|
+
"description": "Controls whether the component is open or not.",
|
|
15123
|
+
"attribute": "open",
|
|
15124
|
+
"reflects": true
|
|
15125
|
+
},
|
|
15126
|
+
{
|
|
15127
|
+
"kind": "field",
|
|
15128
|
+
"name": "align",
|
|
15129
|
+
"type": {
|
|
15130
|
+
"text": "\"start\" | \"end\""
|
|
15131
|
+
},
|
|
15132
|
+
"default": "\"start\"",
|
|
15133
|
+
"description": "Set the alignment in relation to the toggle (or anchor) depending on the position.\n`start` will align it to the left of the toggle (or anchor).\n`end` will align it to the right of the toggle (or anchor).\nSetting the `position` to `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom respectively.",
|
|
15134
|
+
"attribute": "align",
|
|
15135
|
+
"reflects": true
|
|
15136
|
+
},
|
|
15137
|
+
{
|
|
15138
|
+
"kind": "field",
|
|
15139
|
+
"name": "position",
|
|
15140
|
+
"type": {
|
|
15141
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
15142
|
+
},
|
|
15143
|
+
"default": "\"block-end\"",
|
|
15144
|
+
"description": "Set the position in relation to the toggle (or anchor).\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
15145
|
+
"attribute": "position",
|
|
15146
|
+
"reflects": true
|
|
15147
|
+
}
|
|
15148
|
+
],
|
|
15149
|
+
"attributes": [
|
|
15150
|
+
{
|
|
15151
|
+
"name": "open",
|
|
15152
|
+
"type": {
|
|
15153
|
+
"text": "boolean"
|
|
15154
|
+
},
|
|
15155
|
+
"default": "false",
|
|
15156
|
+
"description": "Controls whether the component is open or not.",
|
|
15157
|
+
"fieldName": "open"
|
|
15158
|
+
},
|
|
15159
|
+
{
|
|
15160
|
+
"name": "align",
|
|
15161
|
+
"type": {
|
|
15162
|
+
"text": "\"start\" | \"end\""
|
|
15163
|
+
},
|
|
15164
|
+
"default": "\"start\"",
|
|
15165
|
+
"description": "Set the alignment in relation to the toggle (or anchor) depending on the position.\n`start` will align it to the left of the toggle (or anchor).\n`end` will align it to the right of the toggle (or anchor).\nSetting the `position` to `inline-start` or `inline-end` will switch\n`start` and `end` to the top and bottom respectively.",
|
|
15166
|
+
"fieldName": "align"
|
|
15167
|
+
},
|
|
15168
|
+
{
|
|
15169
|
+
"name": "position",
|
|
15170
|
+
"type": {
|
|
15171
|
+
"text": "\"block-end\" | \"block-start\" | \"inline-start\" | \"inline-end\""
|
|
15172
|
+
},
|
|
15173
|
+
"default": "\"block-end\"",
|
|
15174
|
+
"description": "Set the position in relation to the toggle (or anchor).\nOptions follow logical properties.\n`block-start` and `block-end` referring to top and bottom respectively,\n`inline-start` and `inline-end` referring to left and right respectively.",
|
|
15175
|
+
"fieldName": "position"
|
|
15176
|
+
}
|
|
15177
|
+
],
|
|
15178
|
+
"parameters": [
|
|
15179
|
+
{
|
|
15180
|
+
"name": "superClass",
|
|
15181
|
+
"type": {
|
|
15182
|
+
"text": "T"
|
|
15183
|
+
}
|
|
15184
|
+
}
|
|
15185
|
+
]
|
|
15186
|
+
}
|
|
15187
|
+
],
|
|
15188
|
+
"exports": [
|
|
15189
|
+
{
|
|
15190
|
+
"kind": "js",
|
|
15191
|
+
"name": "FloatingMixinInterface",
|
|
15192
|
+
"declaration": {
|
|
15193
|
+
"name": "FloatingMixinInterface",
|
|
15194
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
15195
|
+
}
|
|
15196
|
+
},
|
|
15197
|
+
{
|
|
15198
|
+
"kind": "js",
|
|
15199
|
+
"name": "FloatingMixin",
|
|
15200
|
+
"declaration": {
|
|
15201
|
+
"name": "FloatingMixin",
|
|
15202
|
+
"module": "src/common/mixins/FloatingComponentMixin.ts"
|
|
15203
|
+
}
|
|
15204
|
+
}
|
|
15205
|
+
]
|
|
15206
|
+
},
|
|
14784
15207
|
{
|
|
14785
15208
|
"kind": "javascript-module",
|
|
14786
15209
|
"path": "src/common/mixins/FocusableMixin.ts",
|