@nordhealth/components 1.0.0-beta.20 → 1.0.0-beta.23
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 +1273 -1005
- package/lib/Avatar.js +1 -1
- package/lib/Avatar.js.map +1 -1
- package/lib/Button.js +1 -1
- package/lib/Button.js.map +1 -1
- package/lib/Calendar-72e99fb9.js +13 -0
- package/lib/Calendar-72e99fb9.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/DatePicker.js +1 -1
- package/lib/DatePicker.js.map +1 -1
- package/lib/EventController-d99ebeef.js +2 -0
- package/lib/EventController-d99ebeef.js.map +1 -0
- package/lib/Fieldset.js +1 -1
- package/lib/Fieldset.js.map +1 -1
- package/lib/FormAssociatedMixin-1f97ed66.js +2 -0
- package/lib/FormAssociatedMixin-1f97ed66.js.map +1 -0
- package/lib/Header.js +1 -1
- package/lib/Header.js.map +1 -1
- package/lib/Input.js +1 -1
- package/lib/Input.js.map +1 -1
- package/lib/LightDismissController-a35d0f66.js +2 -0
- package/lib/LightDismissController-a35d0f66.js.map +1 -0
- package/lib/NavItem.js +1 -1
- package/lib/NavItem.js.map +1 -1
- package/lib/Radio.js +1 -1
- package/lib/Radio.js.map +1 -1
- package/lib/Select.js +1 -1
- package/lib/Select.js.map +1 -1
- package/lib/SlotController-683d0e7c.js +2 -0
- package/lib/SlotController-683d0e7c.js.map +1 -0
- package/lib/Textarea.js +1 -1
- package/lib/Textarea.js.map +1 -1
- package/lib/Tooltip.js +1 -1
- package/lib/Tooltip.js.map +1 -1
- package/lib/bundle.js +8 -8
- package/lib/bundle.js.map +1 -1
- package/lib/fsm-50373df9.js +2 -0
- package/lib/fsm-50373df9.js.map +1 -0
- package/lib/index.js +1 -1
- package/lib/src/button/Button.d.ts +3 -3
- package/lib/src/common/controllers/EventController.d.ts +14 -0
- package/lib/src/common/controllers/FormDataController.d.ts +1 -1
- package/lib/src/common/controllers/LightDismissController.d.ts +1 -1
- package/lib/src/common/controllers/SlotController.d.ts +1 -1
- package/lib/src/common/controllers/SwipeController.d.ts +3 -5
- package/lib/src/common/fsm.d.ts +2 -0
- package/lib/src/input/Input.d.ts +2 -2
- package/lib/src/tooltip/Tooltip.d.ts +16 -18
- package/lib/src/tooltip/Tooltip.test.d.ts +1 -0
- package/package.json +13 -4
- package/lib/Calendar-582091ef.js +0 -13
- package/lib/Calendar-582091ef.js.map +0 -1
- package/lib/FormAssociatedMixin-ccae91fd.js +0 -2
- package/lib/FormAssociatedMixin-ccae91fd.js.map +0 -1
- package/lib/LightDismissController-cc5b4bf2.js +0 -2
- package/lib/LightDismissController-cc5b4bf2.js.map +0 -1
- package/lib/SlotController-5bfc47d1.js +0 -2
- package/lib/SlotController-5bfc47d1.js.map +0 -1
package/custom-elements.json
CHANGED
|
@@ -246,7 +246,7 @@
|
|
|
246
246
|
"kind": "field",
|
|
247
247
|
"name": "state",
|
|
248
248
|
"type": {
|
|
249
|
-
"text": "States"
|
|
249
|
+
"text": "States<typeof transition>"
|
|
250
250
|
},
|
|
251
251
|
"privacy": "private",
|
|
252
252
|
"default": "\"initial\""
|
|
@@ -431,330 +431,446 @@
|
|
|
431
431
|
},
|
|
432
432
|
{
|
|
433
433
|
"kind": "javascript-module",
|
|
434
|
-
"path": "src/
|
|
434
|
+
"path": "src/banner/Banner.ts",
|
|
435
435
|
"declarations": [
|
|
436
436
|
{
|
|
437
437
|
"kind": "class",
|
|
438
|
-
"description": "
|
|
439
|
-
"name": "
|
|
438
|
+
"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.",
|
|
439
|
+
"name": "Banner",
|
|
440
|
+
"slots": [
|
|
441
|
+
{
|
|
442
|
+
"description": "default slot",
|
|
443
|
+
"name": ""
|
|
444
|
+
}
|
|
445
|
+
],
|
|
440
446
|
"members": [
|
|
441
447
|
{
|
|
442
448
|
"kind": "field",
|
|
443
|
-
"name": "
|
|
449
|
+
"name": "variant",
|
|
444
450
|
"type": {
|
|
445
|
-
"text": "
|
|
451
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
446
452
|
},
|
|
447
|
-
"
|
|
448
|
-
"
|
|
449
|
-
|
|
453
|
+
"default": "\"info\"",
|
|
454
|
+
"description": "The style variant of the banner.",
|
|
455
|
+
"attribute": "variant",
|
|
456
|
+
"reflects": true
|
|
457
|
+
}
|
|
458
|
+
],
|
|
459
|
+
"attributes": [
|
|
450
460
|
{
|
|
451
|
-
"
|
|
452
|
-
"name": "monthSelectNode",
|
|
461
|
+
"name": "variant",
|
|
453
462
|
"type": {
|
|
454
|
-
"text": "
|
|
463
|
+
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
455
464
|
},
|
|
456
|
-
"
|
|
457
|
-
|
|
465
|
+
"default": "\"info\"",
|
|
466
|
+
"description": "The style variant of the banner.",
|
|
467
|
+
"fieldName": "variant"
|
|
468
|
+
}
|
|
469
|
+
],
|
|
470
|
+
"superclass": {
|
|
471
|
+
"name": "LitElement",
|
|
472
|
+
"package": "lit"
|
|
473
|
+
},
|
|
474
|
+
"status": "new",
|
|
475
|
+
"category": "feedback",
|
|
476
|
+
"tagName": "nord-banner",
|
|
477
|
+
"customElement": true
|
|
478
|
+
}
|
|
479
|
+
],
|
|
480
|
+
"exports": [
|
|
481
|
+
{
|
|
482
|
+
"kind": "js",
|
|
483
|
+
"name": "default",
|
|
484
|
+
"declaration": {
|
|
485
|
+
"name": "Banner",
|
|
486
|
+
"module": "src/banner/Banner.ts"
|
|
487
|
+
}
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
"kind": "custom-element-definition",
|
|
491
|
+
"name": "nord-banner",
|
|
492
|
+
"declaration": {
|
|
493
|
+
"name": "Banner",
|
|
494
|
+
"module": "src/banner/Banner.ts"
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
],
|
|
498
|
+
"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"
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"kind": "javascript-module",
|
|
502
|
+
"path": "src/button/Button.ts",
|
|
503
|
+
"declarations": [
|
|
504
|
+
{
|
|
505
|
+
"kind": "class",
|
|
506
|
+
"description": "Buttons are used for interface actions. Primary style should be\nused only once per section for main call-to-action, while other\nstyles can appear more frequently.",
|
|
507
|
+
"name": "Button",
|
|
508
|
+
"slots": [
|
|
458
509
|
{
|
|
459
|
-
"
|
|
460
|
-
"name": "
|
|
461
|
-
"type": {
|
|
462
|
-
"text": "HTMLButtonElement"
|
|
463
|
-
},
|
|
464
|
-
"privacy": "private"
|
|
510
|
+
"description": "The button content",
|
|
511
|
+
"name": ""
|
|
465
512
|
},
|
|
466
513
|
{
|
|
467
|
-
"
|
|
468
|
-
"name": "
|
|
469
|
-
"privacy": "private",
|
|
470
|
-
"default": "new DirectionController(this)"
|
|
514
|
+
"description": "Used to place content at the start of button text. Typically used for icons.",
|
|
515
|
+
"name": "start"
|
|
471
516
|
},
|
|
517
|
+
{
|
|
518
|
+
"description": "Used to place content at the end of button text. Typically used for icons.",
|
|
519
|
+
"name": "end"
|
|
520
|
+
}
|
|
521
|
+
],
|
|
522
|
+
"members": [
|
|
472
523
|
{
|
|
473
524
|
"kind": "field",
|
|
474
|
-
"name": "
|
|
475
|
-
"privacy": "private"
|
|
476
|
-
"default": "new SwipeController(this, {\n matchesGesture: isHorizontalSwipe,\n onSwipeEnd: ({ distX }) => this.addMonths(distX < 0 ? 1 : -1),\n })"
|
|
525
|
+
"name": "buttonRef",
|
|
526
|
+
"privacy": "private"
|
|
477
527
|
},
|
|
478
528
|
{
|
|
479
529
|
"kind": "field",
|
|
480
|
-
"name": "
|
|
481
|
-
"privacy": "private"
|
|
530
|
+
"name": "events",
|
|
531
|
+
"privacy": "private",
|
|
532
|
+
"default": "new EventController(this)"
|
|
482
533
|
},
|
|
483
534
|
{
|
|
484
535
|
"kind": "field",
|
|
485
|
-
"name": "
|
|
486
|
-
"type": {
|
|
487
|
-
"text": "Intl.DateTimeFormat"
|
|
488
|
-
},
|
|
536
|
+
"name": "lightDom",
|
|
489
537
|
"privacy": "private",
|
|
490
|
-
"
|
|
538
|
+
"default": "new LightDomController(this, {\n render: () => this.renderLightDom(),\n })"
|
|
491
539
|
},
|
|
492
540
|
{
|
|
493
541
|
"kind": "field",
|
|
494
|
-
"name": "
|
|
542
|
+
"name": "variant",
|
|
495
543
|
"type": {
|
|
496
|
-
"text": "
|
|
544
|
+
"text": "\"default\" | \"primary\" | \"dashed\" | \"plain\" | \"danger\""
|
|
497
545
|
},
|
|
498
|
-
"default": "
|
|
546
|
+
"default": "\"default\"",
|
|
547
|
+
"description": "The style variant of the button.",
|
|
548
|
+
"attribute": "variant",
|
|
549
|
+
"reflects": true
|
|
499
550
|
},
|
|
500
551
|
{
|
|
501
552
|
"kind": "field",
|
|
502
|
-
"name": "
|
|
553
|
+
"name": "type",
|
|
503
554
|
"type": {
|
|
504
|
-
"text": "
|
|
555
|
+
"text": "\"button\" | \"submit\" | \"reset\""
|
|
505
556
|
},
|
|
506
|
-
"default": "\"\"",
|
|
507
|
-
"description": "The
|
|
508
|
-
"attribute": "
|
|
557
|
+
"default": "\"submit\"",
|
|
558
|
+
"description": "The type of the button.",
|
|
559
|
+
"attribute": "type",
|
|
560
|
+
"reflects": true
|
|
509
561
|
},
|
|
510
562
|
{
|
|
511
563
|
"kind": "field",
|
|
512
|
-
"name": "
|
|
564
|
+
"name": "size",
|
|
513
565
|
"type": {
|
|
514
|
-
"text": "
|
|
566
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
515
567
|
},
|
|
516
|
-
"
|
|
517
|
-
"
|
|
568
|
+
"default": "\"m\"",
|
|
569
|
+
"description": "The size of the button.\nThis affects font-size and padding.",
|
|
570
|
+
"attribute": "size",
|
|
571
|
+
"reflects": true
|
|
518
572
|
},
|
|
519
573
|
{
|
|
520
574
|
"kind": "field",
|
|
521
|
-
"name": "
|
|
575
|
+
"name": "href",
|
|
522
576
|
"type": {
|
|
523
|
-
"text": "string"
|
|
577
|
+
"text": "string | undefined"
|
|
524
578
|
},
|
|
525
|
-
"
|
|
526
|
-
"
|
|
527
|
-
"
|
|
579
|
+
"description": "When provided, renders the button as a link,\nwith its href attribute set to the given value.",
|
|
580
|
+
"attribute": "href",
|
|
581
|
+
"reflects": true
|
|
528
582
|
},
|
|
529
583
|
{
|
|
530
584
|
"kind": "field",
|
|
531
|
-
"name": "
|
|
585
|
+
"name": "download",
|
|
532
586
|
"type": {
|
|
533
|
-
"text": "
|
|
587
|
+
"text": "boolean"
|
|
534
588
|
},
|
|
535
|
-
"default": "
|
|
536
|
-
"description": "
|
|
537
|
-
"attribute": "
|
|
589
|
+
"default": "false",
|
|
590
|
+
"description": "When provided together with a href property, the button will\ntrigger a file download instead of a page visit.",
|
|
591
|
+
"attribute": "download"
|
|
538
592
|
},
|
|
539
593
|
{
|
|
540
594
|
"kind": "field",
|
|
541
|
-
"name": "
|
|
595
|
+
"name": "target",
|
|
542
596
|
"type": {
|
|
543
|
-
"text": "
|
|
597
|
+
"text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
|
|
544
598
|
},
|
|
545
|
-
"default": "
|
|
546
|
-
"description": "
|
|
599
|
+
"default": "\"_self\"",
|
|
600
|
+
"description": "When provided together with a href property, determines where\nto open the linked URL. The keywords have special meanings for\nwhere to load the URL: “_self” means the current browsing context,\n“_blank” usually a new tab but users can configure browsers this to\nopen a new window instead, “_parent” means the parent browsing\ncontext of the current one, but if no parent exists, behaves as\n_self, and finally “top” means the topmost browsing context.",
|
|
601
|
+
"attribute": "target",
|
|
602
|
+
"reflects": true
|
|
547
603
|
},
|
|
548
604
|
{
|
|
549
605
|
"kind": "field",
|
|
550
|
-
"name": "
|
|
606
|
+
"name": "expand",
|
|
551
607
|
"type": {
|
|
552
608
|
"text": "boolean"
|
|
553
609
|
},
|
|
554
|
-
"
|
|
555
|
-
"
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
"kind": "field",
|
|
559
|
-
"name": "focusedDay",
|
|
560
|
-
"privacy": "private",
|
|
561
|
-
"default": "new Date()"
|
|
562
|
-
},
|
|
563
|
-
{
|
|
564
|
-
"kind": "method",
|
|
565
|
-
"name": "focus",
|
|
566
|
-
"parameters": [
|
|
567
|
-
{
|
|
568
|
-
"name": "options",
|
|
569
|
-
"optional": true,
|
|
570
|
-
"type": {
|
|
571
|
-
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
572
|
-
},
|
|
573
|
-
"description": "An object which controls aspects of the focusing process."
|
|
574
|
-
}
|
|
575
|
-
],
|
|
576
|
-
"description": "Programmatically move focus to the calendar."
|
|
577
|
-
},
|
|
578
|
-
{
|
|
579
|
-
"kind": "method",
|
|
580
|
-
"name": "createDateFormatter",
|
|
581
|
-
"privacy": "private"
|
|
582
|
-
},
|
|
583
|
-
{
|
|
584
|
-
"kind": "field",
|
|
585
|
-
"name": "handleDaySelect",
|
|
586
|
-
"privacy": "private"
|
|
587
|
-
},
|
|
588
|
-
{
|
|
589
|
-
"kind": "method",
|
|
590
|
-
"name": "addDays",
|
|
591
|
-
"privacy": "private",
|
|
592
|
-
"parameters": [
|
|
593
|
-
{
|
|
594
|
-
"name": "days",
|
|
595
|
-
"type": {
|
|
596
|
-
"text": "number"
|
|
597
|
-
}
|
|
598
|
-
}
|
|
599
|
-
]
|
|
610
|
+
"default": "false",
|
|
611
|
+
"description": "Controls whether the button expands to fill the width of its container.",
|
|
612
|
+
"attribute": "expand",
|
|
613
|
+
"reflects": true
|
|
600
614
|
},
|
|
601
615
|
{
|
|
602
616
|
"kind": "method",
|
|
603
|
-
"name": "
|
|
617
|
+
"name": "renderLink",
|
|
604
618
|
"privacy": "private",
|
|
605
619
|
"parameters": [
|
|
606
620
|
{
|
|
607
|
-
"name": "
|
|
621
|
+
"name": "innards",
|
|
608
622
|
"type": {
|
|
609
|
-
"text": "
|
|
623
|
+
"text": "TemplateResult"
|
|
610
624
|
}
|
|
611
625
|
}
|
|
612
|
-
]
|
|
626
|
+
],
|
|
627
|
+
"description": "We jump through some hoops here to ensure the link is treated correctly when \"disabled\".\nLinks cannot be disabled natively, so we need to rely on some aria magic to get the correct semantics.\nAlong with the advice in the article below, we also set tabindex to \"-1\", so it is taken out of tab order."
|
|
613
628
|
},
|
|
614
629
|
{
|
|
615
630
|
"kind": "method",
|
|
616
|
-
"name": "
|
|
631
|
+
"name": "renderButton",
|
|
617
632
|
"privacy": "private",
|
|
618
633
|
"parameters": [
|
|
619
634
|
{
|
|
620
|
-
"name": "
|
|
635
|
+
"name": "innards",
|
|
621
636
|
"type": {
|
|
622
|
-
"text": "
|
|
637
|
+
"text": "TemplateResult"
|
|
623
638
|
}
|
|
624
639
|
}
|
|
625
640
|
]
|
|
626
641
|
},
|
|
627
642
|
{
|
|
628
643
|
"kind": "method",
|
|
629
|
-
"name": "
|
|
644
|
+
"name": "renderLightDom",
|
|
630
645
|
"privacy": "private"
|
|
631
646
|
},
|
|
632
647
|
{
|
|
633
|
-
"kind": "
|
|
634
|
-
"name": "
|
|
648
|
+
"kind": "field",
|
|
649
|
+
"name": "handleOuterClick",
|
|
635
650
|
"privacy": "private"
|
|
636
651
|
},
|
|
637
652
|
{
|
|
638
653
|
"kind": "method",
|
|
639
|
-
"name": "
|
|
654
|
+
"name": "handleClick",
|
|
640
655
|
"privacy": "private",
|
|
641
656
|
"parameters": [
|
|
642
657
|
{
|
|
643
|
-
"name": "
|
|
658
|
+
"name": "e",
|
|
644
659
|
"type": {
|
|
645
|
-
"text": "
|
|
660
|
+
"text": "Event"
|
|
646
661
|
}
|
|
647
662
|
}
|
|
648
663
|
]
|
|
649
664
|
},
|
|
650
665
|
{
|
|
651
|
-
"kind": "
|
|
652
|
-
"name": "
|
|
653
|
-
"
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
666
|
+
"kind": "field",
|
|
667
|
+
"name": "disabled",
|
|
668
|
+
"type": {
|
|
669
|
+
"text": "boolean"
|
|
670
|
+
},
|
|
671
|
+
"default": "false",
|
|
672
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
673
|
+
"attribute": "disabled",
|
|
674
|
+
"reflects": true,
|
|
675
|
+
"inheritedFrom": {
|
|
676
|
+
"name": "InputMixin",
|
|
677
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
678
|
+
}
|
|
662
679
|
},
|
|
663
680
|
{
|
|
664
|
-
"kind": "
|
|
665
|
-
"name": "
|
|
666
|
-
"
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
681
|
+
"kind": "field",
|
|
682
|
+
"name": "name",
|
|
683
|
+
"type": {
|
|
684
|
+
"text": "string | undefined"
|
|
685
|
+
},
|
|
686
|
+
"description": "The name of the form component.",
|
|
687
|
+
"attribute": "name",
|
|
688
|
+
"inheritedFrom": {
|
|
689
|
+
"name": "InputMixin",
|
|
690
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
691
|
+
}
|
|
675
692
|
},
|
|
676
693
|
{
|
|
677
694
|
"kind": "field",
|
|
678
|
-
"name": "
|
|
679
|
-
"
|
|
695
|
+
"name": "value",
|
|
696
|
+
"type": {
|
|
697
|
+
"text": "string"
|
|
698
|
+
},
|
|
699
|
+
"default": "\"\"",
|
|
700
|
+
"description": "The value of the form component.",
|
|
701
|
+
"attribute": "value",
|
|
702
|
+
"inheritedFrom": {
|
|
703
|
+
"name": "InputMixin",
|
|
704
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
705
|
+
}
|
|
680
706
|
},
|
|
681
707
|
{
|
|
682
708
|
"kind": "field",
|
|
683
|
-
"name": "
|
|
684
|
-
"privacy": "
|
|
709
|
+
"name": "form",
|
|
710
|
+
"privacy": "protected",
|
|
711
|
+
"description": "Gets the form, if any, associated with the form element.",
|
|
712
|
+
"inheritedFrom": {
|
|
713
|
+
"name": "InputMixin",
|
|
714
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
715
|
+
}
|
|
685
716
|
},
|
|
686
717
|
{
|
|
687
718
|
"kind": "field",
|
|
688
|
-
"name": "
|
|
689
|
-
"privacy": "
|
|
719
|
+
"name": "focusableRef",
|
|
720
|
+
"privacy": "protected",
|
|
721
|
+
"inheritedFrom": {
|
|
722
|
+
"name": "FocusableMixin",
|
|
723
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
724
|
+
}
|
|
690
725
|
},
|
|
691
726
|
{
|
|
692
|
-
"kind": "
|
|
693
|
-
"name": "
|
|
694
|
-
"
|
|
727
|
+
"kind": "method",
|
|
728
|
+
"name": "focus",
|
|
729
|
+
"parameters": [
|
|
730
|
+
{
|
|
731
|
+
"name": "options",
|
|
732
|
+
"optional": true,
|
|
733
|
+
"type": {
|
|
734
|
+
"text": "FocusOptions"
|
|
735
|
+
},
|
|
736
|
+
"description": "An object which controls aspects of the focusing process."
|
|
737
|
+
}
|
|
738
|
+
],
|
|
739
|
+
"description": "Programmatically move focus to the component.",
|
|
740
|
+
"inheritedFrom": {
|
|
741
|
+
"name": "FocusableMixin",
|
|
742
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
743
|
+
}
|
|
695
744
|
},
|
|
696
745
|
{
|
|
697
|
-
"kind": "
|
|
698
|
-
"name": "
|
|
699
|
-
"
|
|
746
|
+
"kind": "method",
|
|
747
|
+
"name": "blur",
|
|
748
|
+
"description": "Programmatically remove focus from the component.",
|
|
749
|
+
"inheritedFrom": {
|
|
750
|
+
"name": "FocusableMixin",
|
|
751
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
752
|
+
}
|
|
700
753
|
},
|
|
701
754
|
{
|
|
702
|
-
"kind": "
|
|
703
|
-
"name": "
|
|
704
|
-
"
|
|
755
|
+
"kind": "method",
|
|
756
|
+
"name": "click",
|
|
757
|
+
"description": "Programmatically simulates a click on the component.",
|
|
758
|
+
"inheritedFrom": {
|
|
759
|
+
"name": "FocusableMixin",
|
|
760
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
761
|
+
}
|
|
705
762
|
}
|
|
706
763
|
],
|
|
707
|
-
"
|
|
764
|
+
"attributes": [
|
|
708
765
|
{
|
|
709
|
-
"name": "
|
|
766
|
+
"name": "variant",
|
|
710
767
|
"type": {
|
|
711
|
-
"text": "
|
|
768
|
+
"text": "\"default\" | \"primary\" | \"dashed\" | \"plain\" | \"danger\""
|
|
712
769
|
},
|
|
713
|
-
"
|
|
770
|
+
"default": "\"default\"",
|
|
771
|
+
"description": "The style variant of the button.",
|
|
772
|
+
"fieldName": "variant"
|
|
714
773
|
},
|
|
715
774
|
{
|
|
775
|
+
"name": "type",
|
|
716
776
|
"type": {
|
|
717
|
-
"text": "
|
|
777
|
+
"text": "\"button\" | \"submit\" | \"reset\""
|
|
718
778
|
},
|
|
719
|
-
"
|
|
720
|
-
"
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
"attributes": [
|
|
779
|
+
"default": "\"submit\"",
|
|
780
|
+
"description": "The type of the button.",
|
|
781
|
+
"fieldName": "type"
|
|
782
|
+
},
|
|
724
783
|
{
|
|
725
|
-
"name": "
|
|
784
|
+
"name": "size",
|
|
726
785
|
"type": {
|
|
727
|
-
"text": "
|
|
786
|
+
"text": "\"s\" | \"m\" | \"l\""
|
|
728
787
|
},
|
|
729
|
-
"default": "\"\"",
|
|
730
|
-
"description": "The
|
|
731
|
-
"fieldName": "
|
|
788
|
+
"default": "\"m\"",
|
|
789
|
+
"description": "The size of the button.\nThis affects font-size and padding.",
|
|
790
|
+
"fieldName": "size"
|
|
732
791
|
},
|
|
733
792
|
{
|
|
734
|
-
"name": "
|
|
793
|
+
"name": "href",
|
|
735
794
|
"type": {
|
|
736
|
-
"text": "
|
|
795
|
+
"text": "string | undefined"
|
|
737
796
|
},
|
|
738
|
-
"description": "
|
|
739
|
-
"fieldName": "
|
|
797
|
+
"description": "When provided, renders the button as a link,\nwith its href attribute set to the given value.",
|
|
798
|
+
"fieldName": "href"
|
|
740
799
|
},
|
|
741
800
|
{
|
|
742
|
-
"name": "
|
|
801
|
+
"name": "download",
|
|
743
802
|
"type": {
|
|
744
|
-
"text": "
|
|
803
|
+
"text": "boolean"
|
|
745
804
|
},
|
|
746
|
-
"default": "
|
|
747
|
-
"description": "
|
|
748
|
-
"fieldName": "
|
|
805
|
+
"default": "false",
|
|
806
|
+
"description": "When provided together with a href property, the button will\ntrigger a file download instead of a page visit.",
|
|
807
|
+
"fieldName": "download"
|
|
749
808
|
},
|
|
750
809
|
{
|
|
751
|
-
"name": "
|
|
810
|
+
"name": "target",
|
|
811
|
+
"type": {
|
|
812
|
+
"text": "\"_self\" | \"_blank\" | \"_parent\" | \"_top\""
|
|
813
|
+
},
|
|
814
|
+
"default": "\"_self\"",
|
|
815
|
+
"description": "When provided together with a href property, determines where\nto open the linked URL. The keywords have special meanings for\nwhere to load the URL: “_self” means the current browsing context,\n“_blank” usually a new tab but users can configure browsers this to\nopen a new window instead, “_parent” means the parent browsing\ncontext of the current one, but if no parent exists, behaves as\n_self, and finally “top” means the topmost browsing context.",
|
|
816
|
+
"fieldName": "target"
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "expand",
|
|
820
|
+
"type": {
|
|
821
|
+
"text": "boolean"
|
|
822
|
+
},
|
|
823
|
+
"default": "false",
|
|
824
|
+
"description": "Controls whether the button expands to fill the width of its container.",
|
|
825
|
+
"fieldName": "expand"
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
"name": "disabled",
|
|
829
|
+
"type": {
|
|
830
|
+
"text": "boolean"
|
|
831
|
+
},
|
|
832
|
+
"default": "false",
|
|
833
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
834
|
+
"fieldName": "disabled",
|
|
835
|
+
"inheritedFrom": {
|
|
836
|
+
"name": "InputMixin",
|
|
837
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
838
|
+
}
|
|
839
|
+
},
|
|
840
|
+
{
|
|
841
|
+
"name": "name",
|
|
842
|
+
"type": {
|
|
843
|
+
"text": "string | undefined"
|
|
844
|
+
},
|
|
845
|
+
"description": "The name of the form component.",
|
|
846
|
+
"fieldName": "name",
|
|
847
|
+
"inheritedFrom": {
|
|
848
|
+
"name": "InputMixin",
|
|
849
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
850
|
+
}
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "value",
|
|
752
854
|
"type": {
|
|
753
855
|
"text": "string"
|
|
754
856
|
},
|
|
755
857
|
"default": "\"\"",
|
|
756
|
-
"description": "
|
|
757
|
-
"fieldName": "
|
|
858
|
+
"description": "The value of the form component.",
|
|
859
|
+
"fieldName": "value",
|
|
860
|
+
"inheritedFrom": {
|
|
861
|
+
"name": "InputMixin",
|
|
862
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
],
|
|
866
|
+
"mixins": [
|
|
867
|
+
{
|
|
868
|
+
"name": "InputMixin",
|
|
869
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"name": "FocusableMixin",
|
|
873
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
758
874
|
}
|
|
759
875
|
],
|
|
760
876
|
"superclass": {
|
|
@@ -762,8 +878,8 @@
|
|
|
762
878
|
"package": "lit"
|
|
763
879
|
},
|
|
764
880
|
"status": "ready",
|
|
765
|
-
"category": "
|
|
766
|
-
"tagName": "nord-
|
|
881
|
+
"category": "action",
|
|
882
|
+
"tagName": "nord-button",
|
|
767
883
|
"customElement": true
|
|
768
884
|
}
|
|
769
885
|
],
|
|
@@ -772,499 +888,435 @@
|
|
|
772
888
|
"kind": "js",
|
|
773
889
|
"name": "default",
|
|
774
890
|
"declaration": {
|
|
775
|
-
"name": "
|
|
776
|
-
"module": "src/
|
|
891
|
+
"name": "Button",
|
|
892
|
+
"module": "src/button/Button.ts"
|
|
777
893
|
}
|
|
778
894
|
},
|
|
779
895
|
{
|
|
780
896
|
"kind": "custom-element-definition",
|
|
781
|
-
"name": "nord-
|
|
897
|
+
"name": "nord-button",
|
|
782
898
|
"declaration": {
|
|
783
|
-
"name": "
|
|
784
|
-
"module": "src/
|
|
899
|
+
"name": "Button",
|
|
900
|
+
"module": "src/button/Button.ts"
|
|
785
901
|
}
|
|
786
902
|
}
|
|
787
903
|
],
|
|
788
|
-
"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
|
|
904
|
+
"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 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 buttons to link to other pages. Use regular link or a plain style instead where necessary.\n- Don’t use buttons for navigation where the link appears within or following a sentence.\n- Don’t use labels such as “Read more”, “Click here” or “More”.\n\n</div>\n\n---\n\n## Content guidelines\n\nButton labels should be clear, accurate and predictable. It should be possible for the user to understand what will happen when they click a button:\n\n<div class=\"n-usage n-usage-do\">View user settings</div>\n<div class=\"n-usage n-usage-dont\">Click here</div>\n\nWhen writing button labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in button labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Add item</div>\n<div class=\"n-usage n-usage-dont\">Add an item</div>\n\n---\n\n## Variants\n\nThis section describes the different component variants, their purpose, and when to use each variant.\n\n| Name | Purpose |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `default` | Default style is the most common button variant. Only switch to another variant if you need to adjust the visual weight of the element. |\n| `primary` | Primary style is reserved for main call-to-actions. Should be used only once per content area or panel, e.g. for a “Save” action. |\n| `dashed` | Dashed style should be used for actions that trigger filtering. |\n| `danger` | Danger style should be used for actions that delete data or otherwise make it hard to undo the action. |\n| `plain` | Used for less important or less common actions. Can be also used for linking to other pages. |\n| `disabled` | Used for actions that aren’t currently available or not available anymore. Also prevents users from being able to interact with the component, and conveys its inactive state to assistive technologies. |\n\n---\n\n## 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"
|
|
789
905
|
},
|
|
790
906
|
{
|
|
791
907
|
"kind": "javascript-module",
|
|
792
|
-
"path": "src/
|
|
908
|
+
"path": "src/card/Card.ts",
|
|
793
909
|
"declarations": [
|
|
794
910
|
{
|
|
795
911
|
"kind": "class",
|
|
796
|
-
"description": "",
|
|
797
|
-
"name": "
|
|
912
|
+
"description": "Cards are shadowed surfaces that display content and actions on a\nsingle topic. They should be easy to scan for relevant and\nactionable information.",
|
|
913
|
+
"name": "Card",
|
|
914
|
+
"slots": [
|
|
915
|
+
{
|
|
916
|
+
"description": "The card content.",
|
|
917
|
+
"name": ""
|
|
918
|
+
},
|
|
919
|
+
{
|
|
920
|
+
"description": "Optional slot that holds a header for the card.",
|
|
921
|
+
"name": "header"
|
|
922
|
+
},
|
|
923
|
+
{
|
|
924
|
+
"description": "Optional slot that holds footer content for the card.",
|
|
925
|
+
"name": "footer"
|
|
926
|
+
}
|
|
927
|
+
],
|
|
798
928
|
"members": [
|
|
799
929
|
{
|
|
800
930
|
"kind": "field",
|
|
801
|
-
"name": "
|
|
931
|
+
"name": "headerSlot",
|
|
932
|
+
"privacy": "private",
|
|
933
|
+
"default": "new SlotController(this, \"header\")"
|
|
934
|
+
},
|
|
935
|
+
{
|
|
936
|
+
"kind": "field",
|
|
937
|
+
"name": "footerSlot",
|
|
938
|
+
"privacy": "private",
|
|
939
|
+
"default": "new SlotController(this, \"footer\")"
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
"kind": "field",
|
|
943
|
+
"name": "padding",
|
|
802
944
|
"type": {
|
|
803
|
-
"text": "
|
|
945
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
804
946
|
},
|
|
805
|
-
"default": "
|
|
947
|
+
"default": "\"m\"",
|
|
948
|
+
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
949
|
+
"attribute": "padding",
|
|
950
|
+
"reflects": true
|
|
806
951
|
}
|
|
807
952
|
],
|
|
808
|
-
"
|
|
809
|
-
"name": "NordEvent",
|
|
810
|
-
"module": "/src/common/events.js"
|
|
811
|
-
}
|
|
812
|
-
}
|
|
813
|
-
],
|
|
814
|
-
"exports": [
|
|
815
|
-
{
|
|
816
|
-
"kind": "js",
|
|
817
|
-
"name": "DateSelectEvent",
|
|
818
|
-
"declaration": {
|
|
819
|
-
"name": "DateSelectEvent",
|
|
820
|
-
"module": "src/calendar/DateSelectEvent.ts"
|
|
821
|
-
}
|
|
822
|
-
}
|
|
823
|
-
],
|
|
824
|
-
"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"
|
|
825
|
-
},
|
|
826
|
-
{
|
|
827
|
-
"kind": "javascript-module",
|
|
828
|
-
"path": "src/calendar/calendar-localization.ts",
|
|
829
|
-
"declarations": [
|
|
830
|
-
{
|
|
831
|
-
"kind": "variable",
|
|
832
|
-
"name": "localization",
|
|
833
|
-
"type": {
|
|
834
|
-
"text": "CalendarLocalizedText"
|
|
835
|
-
},
|
|
836
|
-
"default": "{\n prevMonthLabel: \"Previous month\",\n nextMonthLabel: \"Next month\",\n monthSelectLabel: \"Month\",\n yearSelectLabel: \"Year\",\n calendarHeading: \"Choose a date\",\n dayNames: [\"Sunday\", \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\"],\n monthNames: [\n \"January\",\n \"February\",\n \"March\",\n \"April\",\n \"May\",\n \"June\",\n \"July\",\n \"August\",\n \"September\",\n \"October\",\n \"November\",\n \"December\",\n ],\n monthNamesShort: [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"],\n locale: \"en-GB\",\n}"
|
|
837
|
-
}
|
|
838
|
-
],
|
|
839
|
-
"exports": [
|
|
840
|
-
{
|
|
841
|
-
"kind": "js",
|
|
842
|
-
"name": "default",
|
|
843
|
-
"declaration": {
|
|
844
|
-
"name": "localization",
|
|
845
|
-
"module": "src/calendar/calendar-localization.ts"
|
|
846
|
-
}
|
|
847
|
-
}
|
|
848
|
-
],
|
|
849
|
-
"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"
|
|
850
|
-
},
|
|
851
|
-
{
|
|
852
|
-
"kind": "javascript-module",
|
|
853
|
-
"path": "src/calendar/month-view.ts",
|
|
854
|
-
"declarations": [
|
|
855
|
-
{
|
|
856
|
-
"kind": "function",
|
|
857
|
-
"name": "dayView",
|
|
858
|
-
"parameters": [
|
|
859
|
-
{
|
|
860
|
-
"name": "{\n focusedDay,\n today,\n day,\n onDaySelect,\n onKeyboardNavigation,\n disabled,\n inRange,\n isSelected,\n dateFormatter,\n}",
|
|
861
|
-
"type": {
|
|
862
|
-
"text": "DatePickerDayProps"
|
|
863
|
-
}
|
|
864
|
-
}
|
|
865
|
-
]
|
|
866
|
-
},
|
|
867
|
-
{
|
|
868
|
-
"kind": "function",
|
|
869
|
-
"name": "monthView",
|
|
870
|
-
"parameters": [
|
|
953
|
+
"attributes": [
|
|
871
954
|
{
|
|
872
|
-
"name": "
|
|
955
|
+
"name": "padding",
|
|
873
956
|
"type": {
|
|
874
|
-
"text": "
|
|
875
|
-
}
|
|
957
|
+
"text": "\"m\" | \"l\" | \"none\""
|
|
958
|
+
},
|
|
959
|
+
"default": "\"m\"",
|
|
960
|
+
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
961
|
+
"fieldName": "padding"
|
|
876
962
|
}
|
|
877
|
-
]
|
|
963
|
+
],
|
|
964
|
+
"superclass": {
|
|
965
|
+
"name": "LitElement",
|
|
966
|
+
"package": "lit"
|
|
967
|
+
},
|
|
968
|
+
"status": "ready",
|
|
969
|
+
"category": "structure",
|
|
970
|
+
"tagName": "nord-card",
|
|
971
|
+
"customElement": true
|
|
878
972
|
}
|
|
879
973
|
],
|
|
880
974
|
"exports": [
|
|
881
975
|
{
|
|
882
976
|
"kind": "js",
|
|
883
|
-
"name": "
|
|
977
|
+
"name": "default",
|
|
884
978
|
"declaration": {
|
|
885
|
-
"name": "
|
|
886
|
-
"module": "src/
|
|
979
|
+
"name": "Card",
|
|
980
|
+
"module": "src/card/Card.ts"
|
|
887
981
|
}
|
|
888
982
|
},
|
|
889
983
|
{
|
|
890
|
-
"kind": "
|
|
891
|
-
"name": "
|
|
984
|
+
"kind": "custom-element-definition",
|
|
985
|
+
"name": "nord-card",
|
|
892
986
|
"declaration": {
|
|
893
|
-
"name": "
|
|
894
|
-
"module": "src/
|
|
987
|
+
"name": "Card",
|
|
988
|
+
"module": "src/card/Card.ts"
|
|
895
989
|
}
|
|
896
990
|
}
|
|
897
991
|
],
|
|
898
|
-
"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
|
|
992
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n"
|
|
899
993
|
},
|
|
900
994
|
{
|
|
901
995
|
"kind": "javascript-module",
|
|
902
|
-
"path": "src/
|
|
996
|
+
"path": "src/calendar/Calendar.ts",
|
|
903
997
|
"declarations": [
|
|
904
998
|
{
|
|
905
999
|
"kind": "class",
|
|
906
|
-
"description": "
|
|
907
|
-
"name": "
|
|
908
|
-
"
|
|
1000
|
+
"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.",
|
|
1001
|
+
"name": "Calendar",
|
|
1002
|
+
"members": [
|
|
909
1003
|
{
|
|
910
|
-
"
|
|
911
|
-
"name": ""
|
|
1004
|
+
"kind": "field",
|
|
1005
|
+
"name": "dialogLabelId",
|
|
1006
|
+
"type": {
|
|
1007
|
+
"text": "string"
|
|
1008
|
+
},
|
|
1009
|
+
"privacy": "private",
|
|
1010
|
+
"default": "\"dialog-header\""
|
|
912
1011
|
},
|
|
913
1012
|
{
|
|
914
|
-
"
|
|
915
|
-
"name": "
|
|
1013
|
+
"kind": "field",
|
|
1014
|
+
"name": "monthSelectNode",
|
|
1015
|
+
"type": {
|
|
1016
|
+
"text": "HTMLElement"
|
|
1017
|
+
},
|
|
1018
|
+
"privacy": "private"
|
|
916
1019
|
},
|
|
917
1020
|
{
|
|
918
|
-
"
|
|
919
|
-
"name": "
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
1021
|
+
"kind": "field",
|
|
1022
|
+
"name": "focusedDayNode",
|
|
1023
|
+
"type": {
|
|
1024
|
+
"text": "HTMLButtonElement"
|
|
1025
|
+
},
|
|
1026
|
+
"privacy": "private"
|
|
1027
|
+
},
|
|
923
1028
|
{
|
|
924
1029
|
"kind": "field",
|
|
925
|
-
"name": "
|
|
1030
|
+
"name": "direction",
|
|
1031
|
+
"privacy": "private",
|
|
1032
|
+
"default": "new DirectionController(this)"
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"kind": "field",
|
|
1036
|
+
"name": "swipe",
|
|
1037
|
+
"privacy": "private",
|
|
1038
|
+
"default": "new SwipeController(this, {\n matchesGesture: isHorizontalSwipe,\n onSwipeEnd: ({ distX }) => this.addMonths(distX < 0 ? 1 : -1),\n })"
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"kind": "field",
|
|
1042
|
+
"name": "shortcuts",
|
|
926
1043
|
"privacy": "private"
|
|
927
1044
|
},
|
|
928
1045
|
{
|
|
929
1046
|
"kind": "field",
|
|
930
|
-
"name": "
|
|
1047
|
+
"name": "dateFormatShort",
|
|
1048
|
+
"type": {
|
|
1049
|
+
"text": "Intl.DateTimeFormat"
|
|
1050
|
+
},
|
|
931
1051
|
"privacy": "private",
|
|
932
|
-
"
|
|
1052
|
+
"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"
|
|
933
1053
|
},
|
|
934
1054
|
{
|
|
935
1055
|
"kind": "field",
|
|
936
|
-
"name": "
|
|
1056
|
+
"name": "localization",
|
|
937
1057
|
"type": {
|
|
938
|
-
"text": "
|
|
1058
|
+
"text": "CalendarLocalizedText"
|
|
939
1059
|
},
|
|
940
|
-
"default": "
|
|
941
|
-
"description": "The style variant of the button.",
|
|
942
|
-
"attribute": "variant",
|
|
943
|
-
"reflects": true
|
|
1060
|
+
"default": "localization"
|
|
944
1061
|
},
|
|
945
1062
|
{
|
|
946
1063
|
"kind": "field",
|
|
947
|
-
"name": "
|
|
1064
|
+
"name": "value",
|
|
948
1065
|
"type": {
|
|
949
|
-
"text": "
|
|
1066
|
+
"text": "string"
|
|
950
1067
|
},
|
|
951
|
-
"default": "\"
|
|
952
|
-
"description": "The
|
|
953
|
-
"attribute": "
|
|
954
|
-
"reflects": true
|
|
1068
|
+
"default": "\"\"",
|
|
1069
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1070
|
+
"attribute": "value"
|
|
955
1071
|
},
|
|
956
1072
|
{
|
|
957
1073
|
"kind": "field",
|
|
958
|
-
"name": "
|
|
1074
|
+
"name": "firstDayOfWeek",
|
|
959
1075
|
"type": {
|
|
960
|
-
"text": "
|
|
1076
|
+
"text": "DaysOfWeek"
|
|
961
1077
|
},
|
|
962
|
-
"
|
|
963
|
-
"
|
|
964
|
-
"attribute": "size",
|
|
965
|
-
"reflects": true
|
|
1078
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1079
|
+
"attribute": "firstDayOfWeek"
|
|
966
1080
|
},
|
|
967
1081
|
{
|
|
968
1082
|
"kind": "field",
|
|
969
|
-
"name": "
|
|
1083
|
+
"name": "min",
|
|
970
1084
|
"type": {
|
|
971
|
-
"text": "string
|
|
1085
|
+
"text": "string"
|
|
972
1086
|
},
|
|
973
|
-
"
|
|
974
|
-
"
|
|
975
|
-
"
|
|
1087
|
+
"default": "\"\"",
|
|
1088
|
+
"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.",
|
|
1089
|
+
"attribute": "min"
|
|
976
1090
|
},
|
|
977
1091
|
{
|
|
978
1092
|
"kind": "field",
|
|
979
|
-
"name": "
|
|
1093
|
+
"name": "max",
|
|
980
1094
|
"type": {
|
|
981
|
-
"text": "
|
|
1095
|
+
"text": "string"
|
|
982
1096
|
},
|
|
983
|
-
"default": "
|
|
984
|
-
"description": "
|
|
985
|
-
"attribute": "
|
|
1097
|
+
"default": "\"\"",
|
|
1098
|
+
"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.",
|
|
1099
|
+
"attribute": "max"
|
|
986
1100
|
},
|
|
987
1101
|
{
|
|
988
1102
|
"kind": "field",
|
|
989
|
-
"name": "
|
|
1103
|
+
"name": "isDateDisabled",
|
|
990
1104
|
"type": {
|
|
991
|
-
"text": "
|
|
1105
|
+
"text": "DateDisabledPredicate"
|
|
992
1106
|
},
|
|
993
|
-
"default": "
|
|
994
|
-
"description": "
|
|
995
|
-
"attribute": "target",
|
|
996
|
-
"reflects": true
|
|
1107
|
+
"default": "isDateDisabled",
|
|
1108
|
+
"description": "Controls which days are disabled and therefore disallowed.\nFor example, this can be used to disallow selection of weekends."
|
|
997
1109
|
},
|
|
998
1110
|
{
|
|
999
1111
|
"kind": "field",
|
|
1000
|
-
"name": "
|
|
1112
|
+
"name": "activeFocus",
|
|
1001
1113
|
"type": {
|
|
1002
1114
|
"text": "boolean"
|
|
1003
1115
|
},
|
|
1004
|
-
"
|
|
1005
|
-
"
|
|
1006
|
-
"attribute": "expand",
|
|
1007
|
-
"reflects": true
|
|
1116
|
+
"privacy": "private",
|
|
1117
|
+
"default": "false"
|
|
1008
1118
|
},
|
|
1009
1119
|
{
|
|
1010
|
-
"kind": "
|
|
1011
|
-
"name": "
|
|
1120
|
+
"kind": "field",
|
|
1121
|
+
"name": "focusedDay",
|
|
1012
1122
|
"privacy": "private",
|
|
1013
|
-
"
|
|
1014
|
-
{
|
|
1015
|
-
"name": "innards",
|
|
1016
|
-
"type": {
|
|
1017
|
-
"text": "TemplateResult"
|
|
1018
|
-
}
|
|
1019
|
-
}
|
|
1020
|
-
],
|
|
1021
|
-
"description": "We jump through some hoops here to ensure the link is treated correctly when \"disabled\".\nLinks cannot be disabled natively, so we need to rely on some aria magic to get the correct semantics.\nAlong with the advice in the article below, we also set tabindex to \"-1\", so it is taken out of tab order."
|
|
1123
|
+
"default": "new Date()"
|
|
1022
1124
|
},
|
|
1023
1125
|
{
|
|
1024
1126
|
"kind": "method",
|
|
1025
|
-
"name": "
|
|
1026
|
-
"privacy": "private",
|
|
1127
|
+
"name": "focus",
|
|
1027
1128
|
"parameters": [
|
|
1028
1129
|
{
|
|
1029
|
-
"name": "
|
|
1130
|
+
"name": "options",
|
|
1131
|
+
"optional": true,
|
|
1030
1132
|
"type": {
|
|
1031
|
-
"text": "
|
|
1032
|
-
}
|
|
1133
|
+
"text": "FocusOptions & { target: \"day\" | \"month\" }"
|
|
1134
|
+
},
|
|
1135
|
+
"description": "An object which controls aspects of the focusing process."
|
|
1033
1136
|
}
|
|
1034
|
-
]
|
|
1137
|
+
],
|
|
1138
|
+
"description": "Programmatically move focus to the calendar."
|
|
1035
1139
|
},
|
|
1036
1140
|
{
|
|
1037
1141
|
"kind": "method",
|
|
1038
|
-
"name": "
|
|
1142
|
+
"name": "createDateFormatter",
|
|
1039
1143
|
"privacy": "private"
|
|
1040
1144
|
},
|
|
1041
1145
|
{
|
|
1042
1146
|
"kind": "field",
|
|
1043
|
-
"name": "
|
|
1147
|
+
"name": "handleDaySelect",
|
|
1044
1148
|
"privacy": "private"
|
|
1045
1149
|
},
|
|
1046
1150
|
{
|
|
1047
1151
|
"kind": "method",
|
|
1048
|
-
"name": "
|
|
1152
|
+
"name": "addDays",
|
|
1049
1153
|
"privacy": "private",
|
|
1050
1154
|
"parameters": [
|
|
1051
1155
|
{
|
|
1052
|
-
"name": "
|
|
1156
|
+
"name": "days",
|
|
1053
1157
|
"type": {
|
|
1054
|
-
"text": "
|
|
1158
|
+
"text": "number"
|
|
1055
1159
|
}
|
|
1056
1160
|
}
|
|
1057
1161
|
]
|
|
1058
1162
|
},
|
|
1059
1163
|
{
|
|
1060
|
-
"kind": "
|
|
1061
|
-
"name": "
|
|
1062
|
-
"
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1072
|
-
}
|
|
1164
|
+
"kind": "method",
|
|
1165
|
+
"name": "addMonths",
|
|
1166
|
+
"privacy": "private",
|
|
1167
|
+
"parameters": [
|
|
1168
|
+
{
|
|
1169
|
+
"name": "months",
|
|
1170
|
+
"type": {
|
|
1171
|
+
"text": "number"
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
]
|
|
1073
1175
|
},
|
|
1074
1176
|
{
|
|
1075
|
-
"kind": "
|
|
1076
|
-
"name": "
|
|
1077
|
-
"
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1177
|
+
"kind": "method",
|
|
1178
|
+
"name": "addYears",
|
|
1179
|
+
"privacy": "private",
|
|
1180
|
+
"parameters": [
|
|
1181
|
+
{
|
|
1182
|
+
"name": "years",
|
|
1183
|
+
"type": {
|
|
1184
|
+
"text": "number"
|
|
1185
|
+
}
|
|
1186
|
+
}
|
|
1187
|
+
]
|
|
1086
1188
|
},
|
|
1087
1189
|
{
|
|
1088
|
-
"kind": "
|
|
1089
|
-
"name": "
|
|
1090
|
-
"
|
|
1091
|
-
"text": "string"
|
|
1092
|
-
},
|
|
1093
|
-
"default": "\"\"",
|
|
1094
|
-
"description": "The value of the form component.",
|
|
1095
|
-
"attribute": "value",
|
|
1096
|
-
"inheritedFrom": {
|
|
1097
|
-
"name": "InputMixin",
|
|
1098
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1099
|
-
}
|
|
1190
|
+
"kind": "method",
|
|
1191
|
+
"name": "startOfWeek",
|
|
1192
|
+
"privacy": "private"
|
|
1100
1193
|
},
|
|
1101
1194
|
{
|
|
1102
|
-
"kind": "
|
|
1103
|
-
"name": "
|
|
1104
|
-
"privacy": "
|
|
1105
|
-
"description": "Gets the form, if any, associated with the form element.",
|
|
1106
|
-
"inheritedFrom": {
|
|
1107
|
-
"name": "InputMixin",
|
|
1108
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1109
|
-
}
|
|
1195
|
+
"kind": "method",
|
|
1196
|
+
"name": "endOfWeek",
|
|
1197
|
+
"privacy": "private"
|
|
1110
1198
|
},
|
|
1111
1199
|
{
|
|
1112
|
-
"kind": "
|
|
1113
|
-
"name": "
|
|
1114
|
-
"privacy": "
|
|
1115
|
-
"
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1200
|
+
"kind": "method",
|
|
1201
|
+
"name": "setMonth",
|
|
1202
|
+
"privacy": "private",
|
|
1203
|
+
"parameters": [
|
|
1204
|
+
{
|
|
1205
|
+
"name": "month",
|
|
1206
|
+
"type": {
|
|
1207
|
+
"text": "number"
|
|
1208
|
+
}
|
|
1209
|
+
}
|
|
1210
|
+
]
|
|
1119
1211
|
},
|
|
1120
1212
|
{
|
|
1121
1213
|
"kind": "method",
|
|
1122
|
-
"name": "
|
|
1214
|
+
"name": "setYear",
|
|
1215
|
+
"privacy": "private",
|
|
1123
1216
|
"parameters": [
|
|
1124
1217
|
{
|
|
1125
|
-
"name": "
|
|
1126
|
-
"optional": true,
|
|
1218
|
+
"name": "year",
|
|
1127
1219
|
"type": {
|
|
1128
|
-
"text": "
|
|
1129
|
-
}
|
|
1130
|
-
"description": "An object which controls aspects of the focusing process."
|
|
1220
|
+
"text": "number"
|
|
1221
|
+
}
|
|
1131
1222
|
}
|
|
1132
|
-
]
|
|
1133
|
-
"description": "Programmatically move focus to the component.",
|
|
1134
|
-
"inheritedFrom": {
|
|
1135
|
-
"name": "FocusableMixin",
|
|
1136
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1137
|
-
}
|
|
1223
|
+
]
|
|
1138
1224
|
},
|
|
1139
1225
|
{
|
|
1140
1226
|
"kind": "method",
|
|
1141
|
-
"name": "
|
|
1142
|
-
"
|
|
1143
|
-
"
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1227
|
+
"name": "setFocusedDay",
|
|
1228
|
+
"privacy": "private",
|
|
1229
|
+
"parameters": [
|
|
1230
|
+
{
|
|
1231
|
+
"name": "day",
|
|
1232
|
+
"type": {
|
|
1233
|
+
"text": "Date"
|
|
1234
|
+
}
|
|
1235
|
+
}
|
|
1236
|
+
]
|
|
1147
1237
|
},
|
|
1148
1238
|
{
|
|
1149
|
-
"kind": "
|
|
1150
|
-
"name": "
|
|
1151
|
-
"
|
|
1152
|
-
|
|
1153
|
-
"name": "FocusableMixin",
|
|
1154
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
1155
|
-
}
|
|
1156
|
-
}
|
|
1157
|
-
],
|
|
1158
|
-
"attributes": [
|
|
1239
|
+
"kind": "field",
|
|
1240
|
+
"name": "handleMonthSelect",
|
|
1241
|
+
"privacy": "private"
|
|
1242
|
+
},
|
|
1159
1243
|
{
|
|
1160
|
-
"
|
|
1161
|
-
"
|
|
1162
|
-
|
|
1163
|
-
},
|
|
1164
|
-
"default": "\"default\"",
|
|
1165
|
-
"description": "The style variant of the button.",
|
|
1166
|
-
"fieldName": "variant"
|
|
1244
|
+
"kind": "field",
|
|
1245
|
+
"name": "handleYearSelect",
|
|
1246
|
+
"privacy": "private"
|
|
1167
1247
|
},
|
|
1168
1248
|
{
|
|
1169
|
-
"
|
|
1170
|
-
"
|
|
1171
|
-
|
|
1172
|
-
},
|
|
1173
|
-
"default": "\"submit\"",
|
|
1174
|
-
"description": "The type of the button.",
|
|
1175
|
-
"fieldName": "type"
|
|
1249
|
+
"kind": "field",
|
|
1250
|
+
"name": "handleNextMonthClick",
|
|
1251
|
+
"privacy": "private"
|
|
1176
1252
|
},
|
|
1177
1253
|
{
|
|
1178
|
-
"
|
|
1179
|
-
"
|
|
1180
|
-
|
|
1181
|
-
},
|
|
1182
|
-
"default": "\"m\"",
|
|
1183
|
-
"description": "The size of the button.\nThis affects font-size and padding.",
|
|
1184
|
-
"fieldName": "size"
|
|
1254
|
+
"kind": "field",
|
|
1255
|
+
"name": "handlePreviousMonthClick",
|
|
1256
|
+
"privacy": "private"
|
|
1185
1257
|
},
|
|
1186
1258
|
{
|
|
1187
|
-
"
|
|
1188
|
-
"
|
|
1189
|
-
|
|
1190
|
-
},
|
|
1191
|
-
"description": "When provided, renders the button as a link,\nwith its href attribute set to the given value.",
|
|
1192
|
-
"fieldName": "href"
|
|
1259
|
+
"kind": "field",
|
|
1260
|
+
"name": "enableActiveFocus",
|
|
1261
|
+
"privacy": "private"
|
|
1193
1262
|
},
|
|
1194
1263
|
{
|
|
1195
|
-
"
|
|
1264
|
+
"kind": "field",
|
|
1265
|
+
"name": "disableActiveFocus",
|
|
1266
|
+
"privacy": "private"
|
|
1267
|
+
}
|
|
1268
|
+
],
|
|
1269
|
+
"events": [
|
|
1270
|
+
{
|
|
1271
|
+
"name": "nord-focus-date",
|
|
1196
1272
|
"type": {
|
|
1197
|
-
"text": "
|
|
1273
|
+
"text": "DateSelectEvent"
|
|
1198
1274
|
},
|
|
1199
|
-
"
|
|
1200
|
-
"description": "When provided together with a href property, the button will\ntrigger a file download instead of a page visit.",
|
|
1201
|
-
"fieldName": "download"
|
|
1275
|
+
"description": "Dispatched when the calendar's focused date changes."
|
|
1202
1276
|
},
|
|
1203
1277
|
{
|
|
1204
|
-
"name": "target",
|
|
1205
1278
|
"type": {
|
|
1206
|
-
"text": "
|
|
1279
|
+
"text": "DateSelectEvent"
|
|
1207
1280
|
},
|
|
1208
|
-
"
|
|
1209
|
-
"
|
|
1210
|
-
|
|
1211
|
-
|
|
1281
|
+
"description": "Dispatched when a date is selected and the value changes.",
|
|
1282
|
+
"name": "change"
|
|
1283
|
+
}
|
|
1284
|
+
],
|
|
1285
|
+
"attributes": [
|
|
1212
1286
|
{
|
|
1213
|
-
"name": "
|
|
1287
|
+
"name": "value",
|
|
1214
1288
|
"type": {
|
|
1215
|
-
"text": "
|
|
1289
|
+
"text": "string"
|
|
1216
1290
|
},
|
|
1217
|
-
"default": "
|
|
1218
|
-
"description": "
|
|
1219
|
-
"fieldName": "
|
|
1291
|
+
"default": "\"\"",
|
|
1292
|
+
"description": "The selected date on the calendar. Must be in IS0-8601 format: YYYY-MM-DD.",
|
|
1293
|
+
"fieldName": "value"
|
|
1220
1294
|
},
|
|
1221
1295
|
{
|
|
1222
|
-
"name": "
|
|
1296
|
+
"name": "firstDayOfWeek",
|
|
1223
1297
|
"type": {
|
|
1224
|
-
"text": "
|
|
1298
|
+
"text": "DaysOfWeek"
|
|
1225
1299
|
},
|
|
1226
|
-
"
|
|
1227
|
-
"
|
|
1228
|
-
"fieldName": "disabled",
|
|
1229
|
-
"inheritedFrom": {
|
|
1230
|
-
"name": "InputMixin",
|
|
1231
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1232
|
-
}
|
|
1300
|
+
"description": "Which day is considered first day of the week? `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
1301
|
+
"fieldName": "firstDayOfWeek"
|
|
1233
1302
|
},
|
|
1234
1303
|
{
|
|
1235
|
-
"name": "
|
|
1304
|
+
"name": "min",
|
|
1236
1305
|
"type": {
|
|
1237
|
-
"text": "string
|
|
1306
|
+
"text": "string"
|
|
1238
1307
|
},
|
|
1239
|
-
"
|
|
1240
|
-
"
|
|
1241
|
-
"
|
|
1242
|
-
"name": "InputMixin",
|
|
1243
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1244
|
-
}
|
|
1308
|
+
"default": "\"\"",
|
|
1309
|
+
"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.",
|
|
1310
|
+
"fieldName": "min"
|
|
1245
1311
|
},
|
|
1246
1312
|
{
|
|
1247
|
-
"name": "
|
|
1313
|
+
"name": "max",
|
|
1248
1314
|
"type": {
|
|
1249
1315
|
"text": "string"
|
|
1250
1316
|
},
|
|
1251
1317
|
"default": "\"\"",
|
|
1252
|
-
"description": "
|
|
1253
|
-
"fieldName": "
|
|
1254
|
-
"inheritedFrom": {
|
|
1255
|
-
"name": "InputMixin",
|
|
1256
|
-
"module": "src/common/mixins/InputMixin.ts"
|
|
1257
|
-
}
|
|
1258
|
-
}
|
|
1259
|
-
],
|
|
1260
|
-
"mixins": [
|
|
1261
|
-
{
|
|
1262
|
-
"name": "InputMixin",
|
|
1263
|
-
"module": "/src/common/mixins/InputMixin.js"
|
|
1264
|
-
},
|
|
1265
|
-
{
|
|
1266
|
-
"name": "FocusableMixin",
|
|
1267
|
-
"module": "/src/common/mixins/FocusableMixin.js"
|
|
1318
|
+
"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.",
|
|
1319
|
+
"fieldName": "max"
|
|
1268
1320
|
}
|
|
1269
1321
|
],
|
|
1270
1322
|
"superclass": {
|
|
@@ -1272,8 +1324,8 @@
|
|
|
1272
1324
|
"package": "lit"
|
|
1273
1325
|
},
|
|
1274
1326
|
"status": "ready",
|
|
1275
|
-
"category": "
|
|
1276
|
-
"tagName": "nord-
|
|
1327
|
+
"category": "list",
|
|
1328
|
+
"tagName": "nord-calendar",
|
|
1277
1329
|
"customElement": true
|
|
1278
1330
|
}
|
|
1279
1331
|
],
|
|
@@ -1282,176 +1334,130 @@
|
|
|
1282
1334
|
"kind": "js",
|
|
1283
1335
|
"name": "default",
|
|
1284
1336
|
"declaration": {
|
|
1285
|
-
"name": "
|
|
1286
|
-
"module": "src/
|
|
1337
|
+
"name": "Calendar",
|
|
1338
|
+
"module": "src/calendar/Calendar.ts"
|
|
1287
1339
|
}
|
|
1288
1340
|
},
|
|
1289
1341
|
{
|
|
1290
1342
|
"kind": "custom-element-definition",
|
|
1291
|
-
"name": "nord-
|
|
1343
|
+
"name": "nord-calendar",
|
|
1292
1344
|
"declaration": {
|
|
1293
|
-
"name": "
|
|
1294
|
-
"module": "src/
|
|
1345
|
+
"name": "Calendar",
|
|
1346
|
+
"module": "src/calendar/Calendar.ts"
|
|
1295
1347
|
}
|
|
1296
1348
|
}
|
|
1297
1349
|
],
|
|
1298
|
-
"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
|
|
1350
|
+
"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"
|
|
1299
1351
|
},
|
|
1300
1352
|
{
|
|
1301
1353
|
"kind": "javascript-module",
|
|
1302
|
-
"path": "src/
|
|
1354
|
+
"path": "src/calendar/DateSelectEvent.ts",
|
|
1303
1355
|
"declarations": [
|
|
1304
1356
|
{
|
|
1305
1357
|
"kind": "class",
|
|
1306
|
-
"description": "
|
|
1307
|
-
"name": "
|
|
1308
|
-
"slots": [
|
|
1309
|
-
{
|
|
1310
|
-
"description": "default slot",
|
|
1311
|
-
"name": ""
|
|
1312
|
-
}
|
|
1313
|
-
],
|
|
1358
|
+
"description": "",
|
|
1359
|
+
"name": "DateSelectEvent",
|
|
1314
1360
|
"members": [
|
|
1315
1361
|
{
|
|
1316
1362
|
"kind": "field",
|
|
1317
|
-
"name": "
|
|
1318
|
-
"type": {
|
|
1319
|
-
"text": "\"info\" | \"danger\" | \"success\" | \"warning\""
|
|
1320
|
-
},
|
|
1321
|
-
"default": "\"info\"",
|
|
1322
|
-
"description": "The style variant of the banner.",
|
|
1323
|
-
"attribute": "variant",
|
|
1324
|
-
"reflects": true
|
|
1325
|
-
}
|
|
1326
|
-
],
|
|
1327
|
-
"attributes": [
|
|
1328
|
-
{
|
|
1329
|
-
"name": "variant",
|
|
1363
|
+
"name": "date",
|
|
1330
1364
|
"type": {
|
|
1331
|
-
"text": "
|
|
1365
|
+
"text": "Date"
|
|
1332
1366
|
},
|
|
1333
|
-
"default": "
|
|
1334
|
-
"description": "The style variant of the banner.",
|
|
1335
|
-
"fieldName": "variant"
|
|
1367
|
+
"default": "date"
|
|
1336
1368
|
}
|
|
1337
1369
|
],
|
|
1338
1370
|
"superclass": {
|
|
1339
|
-
"name": "
|
|
1340
|
-
"
|
|
1341
|
-
}
|
|
1342
|
-
"status": "new",
|
|
1343
|
-
"category": "feedback",
|
|
1344
|
-
"tagName": "nord-banner",
|
|
1345
|
-
"customElement": true
|
|
1371
|
+
"name": "NordEvent",
|
|
1372
|
+
"module": "/src/common/events.js"
|
|
1373
|
+
}
|
|
1346
1374
|
}
|
|
1347
1375
|
],
|
|
1348
1376
|
"exports": [
|
|
1349
1377
|
{
|
|
1350
1378
|
"kind": "js",
|
|
1351
|
-
"name": "
|
|
1379
|
+
"name": "DateSelectEvent",
|
|
1352
1380
|
"declaration": {
|
|
1353
|
-
"name": "
|
|
1354
|
-
"module": "src/
|
|
1381
|
+
"name": "DateSelectEvent",
|
|
1382
|
+
"module": "src/calendar/DateSelectEvent.ts"
|
|
1355
1383
|
}
|
|
1356
|
-
}
|
|
1384
|
+
}
|
|
1385
|
+
],
|
|
1386
|
+
"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"
|
|
1387
|
+
},
|
|
1388
|
+
{
|
|
1389
|
+
"kind": "javascript-module",
|
|
1390
|
+
"path": "src/calendar/calendar-localization.ts",
|
|
1391
|
+
"declarations": [
|
|
1357
1392
|
{
|
|
1358
|
-
"kind": "
|
|
1359
|
-
"name": "
|
|
1393
|
+
"kind": "variable",
|
|
1394
|
+
"name": "localization",
|
|
1395
|
+
"type": {
|
|
1396
|
+
"text": "CalendarLocalizedText"
|
|
1397
|
+
},
|
|
1398
|
+
"default": "{\n prevMonthLabel: \"Previous month\",\n nextMonthLabel: \"Next month\",\n monthSelectLabel: \"Month\",\n yearSelectLabel: \"Year\",\n calendarHeading: \"Choose a date\",\n dayNames: [\"Sunday\", \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\"],\n monthNames: [\n \"January\",\n \"February\",\n \"March\",\n \"April\",\n \"May\",\n \"June\",\n \"July\",\n \"August\",\n \"September\",\n \"October\",\n \"November\",\n \"December\",\n ],\n monthNamesShort: [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"],\n locale: \"en-GB\",\n}"
|
|
1399
|
+
}
|
|
1400
|
+
],
|
|
1401
|
+
"exports": [
|
|
1402
|
+
{
|
|
1403
|
+
"kind": "js",
|
|
1404
|
+
"name": "default",
|
|
1360
1405
|
"declaration": {
|
|
1361
|
-
"name": "
|
|
1362
|
-
"module": "src/
|
|
1406
|
+
"name": "localization",
|
|
1407
|
+
"module": "src/calendar/calendar-localization.ts"
|
|
1363
1408
|
}
|
|
1364
1409
|
}
|
|
1365
1410
|
],
|
|
1366
|
-
"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
|
|
1411
|
+
"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"
|
|
1367
1412
|
},
|
|
1368
1413
|
{
|
|
1369
1414
|
"kind": "javascript-module",
|
|
1370
|
-
"path": "src/
|
|
1415
|
+
"path": "src/calendar/month-view.ts",
|
|
1371
1416
|
"declarations": [
|
|
1372
1417
|
{
|
|
1373
|
-
"kind": "
|
|
1374
|
-
"
|
|
1375
|
-
"
|
|
1376
|
-
"slots": [
|
|
1377
|
-
{
|
|
1378
|
-
"description": "The card content.",
|
|
1379
|
-
"name": ""
|
|
1380
|
-
},
|
|
1381
|
-
{
|
|
1382
|
-
"description": "Optional slot that holds a header for the card.",
|
|
1383
|
-
"name": "header"
|
|
1384
|
-
},
|
|
1385
|
-
{
|
|
1386
|
-
"description": "Optional slot that holds footer content for the card.",
|
|
1387
|
-
"name": "footer"
|
|
1388
|
-
}
|
|
1389
|
-
],
|
|
1390
|
-
"members": [
|
|
1391
|
-
{
|
|
1392
|
-
"kind": "field",
|
|
1393
|
-
"name": "headerSlot",
|
|
1394
|
-
"privacy": "private",
|
|
1395
|
-
"default": "new SlotController(this, \"header\")"
|
|
1396
|
-
},
|
|
1397
|
-
{
|
|
1398
|
-
"kind": "field",
|
|
1399
|
-
"name": "footerSlot",
|
|
1400
|
-
"privacy": "private",
|
|
1401
|
-
"default": "new SlotController(this, \"footer\")"
|
|
1402
|
-
},
|
|
1418
|
+
"kind": "function",
|
|
1419
|
+
"name": "dayView",
|
|
1420
|
+
"parameters": [
|
|
1403
1421
|
{
|
|
1404
|
-
"
|
|
1405
|
-
"name": "padding",
|
|
1422
|
+
"name": "{\n focusedDay,\n today,\n day,\n onDaySelect,\n onKeyboardNavigation,\n disabled,\n inRange,\n isSelected,\n dateFormatter,\n}",
|
|
1406
1423
|
"type": {
|
|
1407
|
-
"text": "
|
|
1408
|
-
}
|
|
1409
|
-
"default": "\"m\"",
|
|
1410
|
-
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1411
|
-
"attribute": "padding",
|
|
1412
|
-
"reflects": true
|
|
1424
|
+
"text": "DatePickerDayProps"
|
|
1425
|
+
}
|
|
1413
1426
|
}
|
|
1414
|
-
]
|
|
1415
|
-
|
|
1427
|
+
]
|
|
1428
|
+
},
|
|
1429
|
+
{
|
|
1430
|
+
"kind": "function",
|
|
1431
|
+
"name": "monthView",
|
|
1432
|
+
"parameters": [
|
|
1416
1433
|
{
|
|
1417
|
-
"name": "
|
|
1434
|
+
"name": "{\n onFocusIn,\n onFocusOut,\n selectedDate,\n focusedDate,\n labelledById,\n localization,\n firstDayOfWeek,\n min,\n max,\n dateFormatter,\n isDateDisabled,\n onDateSelect,\n onKeyboardNavigation,\n}",
|
|
1418
1435
|
"type": {
|
|
1419
|
-
"text": "
|
|
1420
|
-
}
|
|
1421
|
-
"default": "\"m\"",
|
|
1422
|
-
"description": "Controls the padding of card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
1423
|
-
"fieldName": "padding"
|
|
1436
|
+
"text": "MonthViewArgs"
|
|
1437
|
+
}
|
|
1424
1438
|
}
|
|
1425
|
-
]
|
|
1426
|
-
"superclass": {
|
|
1427
|
-
"name": "LitElement",
|
|
1428
|
-
"package": "lit"
|
|
1429
|
-
},
|
|
1430
|
-
"status": "ready",
|
|
1431
|
-
"category": "structure",
|
|
1432
|
-
"tagName": "nord-card",
|
|
1433
|
-
"customElement": true
|
|
1439
|
+
]
|
|
1434
1440
|
}
|
|
1435
1441
|
],
|
|
1436
1442
|
"exports": [
|
|
1437
1443
|
{
|
|
1438
1444
|
"kind": "js",
|
|
1439
|
-
"name": "
|
|
1445
|
+
"name": "dayView",
|
|
1440
1446
|
"declaration": {
|
|
1441
|
-
"name": "
|
|
1442
|
-
"module": "src/
|
|
1447
|
+
"name": "dayView",
|
|
1448
|
+
"module": "src/calendar/month-view.ts"
|
|
1443
1449
|
}
|
|
1444
1450
|
},
|
|
1445
1451
|
{
|
|
1446
|
-
"kind": "
|
|
1447
|
-
"name": "
|
|
1452
|
+
"kind": "js",
|
|
1453
|
+
"name": "monthView",
|
|
1448
1454
|
"declaration": {
|
|
1449
|
-
"name": "
|
|
1450
|
-
"module": "src/
|
|
1455
|
+
"name": "monthView",
|
|
1456
|
+
"module": "src/calendar/month-view.ts"
|
|
1451
1457
|
}
|
|
1452
1458
|
}
|
|
1453
1459
|
],
|
|
1454
|
-
"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
|
|
1460
|
+
"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"
|
|
1455
1461
|
},
|
|
1456
1462
|
{
|
|
1457
1463
|
"kind": "javascript-module",
|
|
@@ -4682,82 +4688,6 @@
|
|
|
4682
4688
|
],
|
|
4683
4689
|
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the fieldset component when you need to create a relationship between multiple form inputs.\n- It is especially important to use with a group of radio components.\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 with a checkbox component when there is **only one** checkbox. For example, when accepting terms and conditions.\n\n</div>\n\n-------\n\n## Content guidelines\n\nFieldset label should be clear, accurate and predictable. It should help the user to understand how the items in the fieldset are grouped together, or what kind of choice the user is making:\n\n<div class=\"n-usage n-usage-do\">Pick a color</div>\n<div class=\"n-usage n-usage-dont\">Choose</div>\n\nWhen writing fieldset 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\">Pick a color</div>\n<div class=\"n-usage n-usage-dont\">Pick A Color</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\">Pick a color</div>\n<div class=\"n-usage n-usage-dont\">Pick a color.</div>\n\nDo not use colons in fieldset label:\n\n<div class=\"n-usage n-usage-do\">Payment details</div>\n<div class=\"n-usage n-usage-dont\">Payment details:</div>\n\n-------\n\n## Additional considerations\n\n- A label (which becomes to `<legend>` inside the fieldset) is always required.\n- Hint text can be used to offer further information or explanation for an option.\n"
|
|
4684
4690
|
},
|
|
4685
|
-
{
|
|
4686
|
-
"kind": "javascript-module",
|
|
4687
|
-
"path": "src/header/Header.ts",
|
|
4688
|
-
"declarations": [
|
|
4689
|
-
{
|
|
4690
|
-
"kind": "class",
|
|
4691
|
-
"description": "The header is a block of designated space for labelling the currently\nviewed context as well as providing primary actions.",
|
|
4692
|
-
"name": "Header",
|
|
4693
|
-
"slots": [
|
|
4694
|
-
{
|
|
4695
|
-
"description": "The header content.",
|
|
4696
|
-
"name": ""
|
|
4697
|
-
},
|
|
4698
|
-
{
|
|
4699
|
-
"description": "Optional slot for buttons, toggles, etc.",
|
|
4700
|
-
"name": "action"
|
|
4701
|
-
}
|
|
4702
|
-
],
|
|
4703
|
-
"members": [
|
|
4704
|
-
{
|
|
4705
|
-
"kind": "field",
|
|
4706
|
-
"name": "actionSlot",
|
|
4707
|
-
"privacy": "private",
|
|
4708
|
-
"default": "new SlotController(this, \"action\")"
|
|
4709
|
-
},
|
|
4710
|
-
{
|
|
4711
|
-
"kind": "field",
|
|
4712
|
-
"name": "_warningLogged",
|
|
4713
|
-
"type": {
|
|
4714
|
-
"text": "boolean"
|
|
4715
|
-
},
|
|
4716
|
-
"privacy": "private",
|
|
4717
|
-
"static": true,
|
|
4718
|
-
"default": "false",
|
|
4719
|
-
"inheritedFrom": {
|
|
4720
|
-
"name": "DraftComponentMixin",
|
|
4721
|
-
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
4722
|
-
}
|
|
4723
|
-
}
|
|
4724
|
-
],
|
|
4725
|
-
"mixins": [
|
|
4726
|
-
{
|
|
4727
|
-
"name": "DraftComponentMixin",
|
|
4728
|
-
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
4729
|
-
}
|
|
4730
|
-
],
|
|
4731
|
-
"superclass": {
|
|
4732
|
-
"name": "LitElement",
|
|
4733
|
-
"package": "lit"
|
|
4734
|
-
},
|
|
4735
|
-
"status": "draft",
|
|
4736
|
-
"category": "structure",
|
|
4737
|
-
"tagName": "nord-header",
|
|
4738
|
-
"customElement": true
|
|
4739
|
-
}
|
|
4740
|
-
],
|
|
4741
|
-
"exports": [
|
|
4742
|
-
{
|
|
4743
|
-
"kind": "js",
|
|
4744
|
-
"name": "default",
|
|
4745
|
-
"declaration": {
|
|
4746
|
-
"name": "Header",
|
|
4747
|
-
"module": "src/header/Header.ts"
|
|
4748
|
-
}
|
|
4749
|
-
},
|
|
4750
|
-
{
|
|
4751
|
-
"kind": "custom-element-definition",
|
|
4752
|
-
"name": "nord-header",
|
|
4753
|
-
"declaration": {
|
|
4754
|
-
"name": "Header",
|
|
4755
|
-
"module": "src/header/Header.ts"
|
|
4756
|
-
}
|
|
4757
|
-
}
|
|
4758
|
-
],
|
|
4759
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the header component to show a heading to describe the current view.\n- Use the header component to hold primary actions.\n- Use the header component at a visual high position at full width.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t overcrowd the header component with too many actions or information.\n- Don’t nest the header component too deeply and restrict its available space.\n\n</div>\n\n-------\n\n## Content guidelines\n\nThe header component should be a containing element placed high on the page to present high level controls and to describe the page itself. It shouldn’t be overcrowded with controls or information.\n\n<div class=\"n-usage n-usage-do\">[Menu] Dashboard [Account] [Log out]</div>\n<div class=\"n-usage n-usage-dont\">[Menu] Use the cards below to view various information [Export] [Save] [Edit Profile] [Log out] [Preferences]</div>\n"
|
|
4760
|
-
},
|
|
4761
4691
|
{
|
|
4762
4692
|
"kind": "javascript-module",
|
|
4763
4693
|
"path": "src/icon/Icon.ts",
|
|
@@ -4996,6 +4926,82 @@
|
|
|
4996
4926
|
],
|
|
4997
4927
|
"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 provide additional meaning in addition to a text label.\n- Use to help users who have difficulties with reading and attention.\n- Use in places where text label doesn’t fit (remember to add an accessible label for the icon).\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use for decorative purposes alone.\n- Don’t use when a button’s action is already clear based on the text label.\n- Don’t use the same icon for differing purposes, as users will come to associate icons with specific types of actions.\n\n</div>\n\n---\n\n## Additional considerations\n\n- Icon components are hidden from assistive technologies by default.\n- Use `label` property to give an accessible label for the icon and to make it visible to assistive technologies.\n"
|
|
4998
4928
|
},
|
|
4929
|
+
{
|
|
4930
|
+
"kind": "javascript-module",
|
|
4931
|
+
"path": "src/header/Header.ts",
|
|
4932
|
+
"declarations": [
|
|
4933
|
+
{
|
|
4934
|
+
"kind": "class",
|
|
4935
|
+
"description": "The header is a block of designated space for labelling the currently\nviewed context as well as providing primary actions.",
|
|
4936
|
+
"name": "Header",
|
|
4937
|
+
"slots": [
|
|
4938
|
+
{
|
|
4939
|
+
"description": "The header content.",
|
|
4940
|
+
"name": ""
|
|
4941
|
+
},
|
|
4942
|
+
{
|
|
4943
|
+
"description": "Optional slot for buttons, toggles, etc.",
|
|
4944
|
+
"name": "action"
|
|
4945
|
+
}
|
|
4946
|
+
],
|
|
4947
|
+
"members": [
|
|
4948
|
+
{
|
|
4949
|
+
"kind": "field",
|
|
4950
|
+
"name": "actionSlot",
|
|
4951
|
+
"privacy": "private",
|
|
4952
|
+
"default": "new SlotController(this, \"action\")"
|
|
4953
|
+
},
|
|
4954
|
+
{
|
|
4955
|
+
"kind": "field",
|
|
4956
|
+
"name": "_warningLogged",
|
|
4957
|
+
"type": {
|
|
4958
|
+
"text": "boolean"
|
|
4959
|
+
},
|
|
4960
|
+
"privacy": "private",
|
|
4961
|
+
"static": true,
|
|
4962
|
+
"default": "false",
|
|
4963
|
+
"inheritedFrom": {
|
|
4964
|
+
"name": "DraftComponentMixin",
|
|
4965
|
+
"module": "src/common/mixins/DraftComponentMixin.ts"
|
|
4966
|
+
}
|
|
4967
|
+
}
|
|
4968
|
+
],
|
|
4969
|
+
"mixins": [
|
|
4970
|
+
{
|
|
4971
|
+
"name": "DraftComponentMixin",
|
|
4972
|
+
"module": "/src/common/mixins/DraftComponentMixin.js"
|
|
4973
|
+
}
|
|
4974
|
+
],
|
|
4975
|
+
"superclass": {
|
|
4976
|
+
"name": "LitElement",
|
|
4977
|
+
"package": "lit"
|
|
4978
|
+
},
|
|
4979
|
+
"status": "draft",
|
|
4980
|
+
"category": "structure",
|
|
4981
|
+
"tagName": "nord-header",
|
|
4982
|
+
"customElement": true
|
|
4983
|
+
}
|
|
4984
|
+
],
|
|
4985
|
+
"exports": [
|
|
4986
|
+
{
|
|
4987
|
+
"kind": "js",
|
|
4988
|
+
"name": "default",
|
|
4989
|
+
"declaration": {
|
|
4990
|
+
"name": "Header",
|
|
4991
|
+
"module": "src/header/Header.ts"
|
|
4992
|
+
}
|
|
4993
|
+
},
|
|
4994
|
+
{
|
|
4995
|
+
"kind": "custom-element-definition",
|
|
4996
|
+
"name": "nord-header",
|
|
4997
|
+
"declaration": {
|
|
4998
|
+
"name": "Header",
|
|
4999
|
+
"module": "src/header/Header.ts"
|
|
5000
|
+
}
|
|
5001
|
+
}
|
|
5002
|
+
],
|
|
5003
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the header component to show a heading to describe the current view.\n- Use the header component to hold primary actions.\n- Use the header component at a visual high position at full width.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t overcrowd the header component with too many actions or information.\n- Don’t nest the header component too deeply and restrict its available space.\n\n</div>\n\n-------\n\n## Content guidelines\n\nThe header component should be a containing element placed high on the page to present high level controls and to describe the page itself. It shouldn’t be overcrowded with controls or information.\n\n<div class=\"n-usage n-usage-do\">[Menu] Dashboard [Account] [Log out]</div>\n<div class=\"n-usage n-usage-dont\">[Menu] Use the cards below to view various information [Export] [Save] [Edit Profile] [Log out] [Preferences]</div>\n"
|
|
5004
|
+
},
|
|
4999
5005
|
{
|
|
5000
5006
|
"kind": "javascript-module",
|
|
5001
5007
|
"path": "src/input/Input.ts",
|
|
@@ -5018,16 +5024,16 @@
|
|
|
5018
5024
|
"name": "error"
|
|
5019
5025
|
},
|
|
5020
5026
|
{
|
|
5021
|
-
"description": "Optional slot
|
|
5022
|
-
"name": "
|
|
5027
|
+
"description": "Optional slot used to place an icon at the start of the input.",
|
|
5028
|
+
"name": "start"
|
|
5023
5029
|
}
|
|
5024
5030
|
],
|
|
5025
5031
|
"members": [
|
|
5026
5032
|
{
|
|
5027
5033
|
"kind": "field",
|
|
5028
|
-
"name": "
|
|
5034
|
+
"name": "startSlot",
|
|
5029
5035
|
"privacy": "private",
|
|
5030
|
-
"default": "new SlotController(this, \"
|
|
5036
|
+
"default": "new SlotController(this, \"start\")"
|
|
5031
5037
|
},
|
|
5032
5038
|
{
|
|
5033
5039
|
"kind": "field",
|
|
@@ -8515,9 +8521,23 @@
|
|
|
8515
8521
|
},
|
|
8516
8522
|
{
|
|
8517
8523
|
"kind": "field",
|
|
8518
|
-
"name": "
|
|
8524
|
+
"name": "events",
|
|
8525
|
+
"privacy": "private",
|
|
8526
|
+
"default": "new EventController(this)"
|
|
8527
|
+
},
|
|
8528
|
+
{
|
|
8529
|
+
"kind": "field",
|
|
8530
|
+
"name": "currentElement",
|
|
8531
|
+
"type": {
|
|
8532
|
+
"text": "FocusableElement | undefined"
|
|
8533
|
+
},
|
|
8534
|
+
"privacy": "private"
|
|
8535
|
+
},
|
|
8536
|
+
{
|
|
8537
|
+
"kind": "field",
|
|
8538
|
+
"name": "timeoutId",
|
|
8519
8539
|
"type": {
|
|
8520
|
-
"text": "
|
|
8540
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
8521
8541
|
},
|
|
8522
8542
|
"privacy": "private"
|
|
8523
8543
|
},
|
|
@@ -8529,12 +8549,22 @@
|
|
|
8529
8549
|
},
|
|
8530
8550
|
{
|
|
8531
8551
|
"kind": "field",
|
|
8532
|
-
"name": "
|
|
8552
|
+
"name": "state",
|
|
8533
8553
|
"type": {
|
|
8534
|
-
"text": "
|
|
8554
|
+
"text": "TooltipStates"
|
|
8535
8555
|
},
|
|
8536
|
-
"
|
|
8537
|
-
"
|
|
8556
|
+
"privacy": "private",
|
|
8557
|
+
"default": "\"hidden\"",
|
|
8558
|
+
"description": "The current state of the tooltip, dependent on the state machine"
|
|
8559
|
+
},
|
|
8560
|
+
{
|
|
8561
|
+
"kind": "field",
|
|
8562
|
+
"name": "coords",
|
|
8563
|
+
"type": {
|
|
8564
|
+
"text": "[number, number]"
|
|
8565
|
+
},
|
|
8566
|
+
"privacy": "private",
|
|
8567
|
+
"default": "[0, 0]"
|
|
8538
8568
|
},
|
|
8539
8569
|
{
|
|
8540
8570
|
"kind": "field",
|
|
@@ -8580,6 +8610,19 @@
|
|
|
8580
8610
|
"attribute": "delay",
|
|
8581
8611
|
"reflects": true
|
|
8582
8612
|
},
|
|
8613
|
+
{
|
|
8614
|
+
"kind": "method",
|
|
8615
|
+
"name": "handleTransition",
|
|
8616
|
+
"privacy": "private",
|
|
8617
|
+
"parameters": [
|
|
8618
|
+
{
|
|
8619
|
+
"name": "prevState",
|
|
8620
|
+
"type": {
|
|
8621
|
+
"text": "TooltipStates"
|
|
8622
|
+
}
|
|
8623
|
+
}
|
|
8624
|
+
]
|
|
8625
|
+
},
|
|
8583
8626
|
{
|
|
8584
8627
|
"kind": "field",
|
|
8585
8628
|
"name": "updatePosition",
|
|
@@ -8588,18 +8631,22 @@
|
|
|
8588
8631
|
},
|
|
8589
8632
|
{
|
|
8590
8633
|
"kind": "field",
|
|
8591
|
-
"name": "
|
|
8634
|
+
"name": "hideTooltip",
|
|
8635
|
+
"privacy": "private"
|
|
8636
|
+
},
|
|
8637
|
+
{
|
|
8638
|
+
"kind": "field",
|
|
8639
|
+
"name": "reposition",
|
|
8592
8640
|
"privacy": "private"
|
|
8593
8641
|
},
|
|
8594
8642
|
{
|
|
8595
8643
|
"kind": "field",
|
|
8596
|
-
"name": "
|
|
8597
|
-
"privacy": "private"
|
|
8598
|
-
"description": "Show and hide the tooltip using inline styles"
|
|
8644
|
+
"name": "handleShow",
|
|
8645
|
+
"privacy": "private"
|
|
8599
8646
|
},
|
|
8600
8647
|
{
|
|
8601
8648
|
"kind": "field",
|
|
8602
|
-
"name": "
|
|
8649
|
+
"name": "handleHide",
|
|
8603
8650
|
"privacy": "private"
|
|
8604
8651
|
},
|
|
8605
8652
|
{
|
|
@@ -8621,291 +8668,115 @@
|
|
|
8621
8668
|
"attributes": [
|
|
8622
8669
|
{
|
|
8623
8670
|
"name": "position",
|
|
8624
|
-
"type": {
|
|
8625
|
-
"text": "\"bottom\" | \"top\" | \"left\" | \"right\" | undefined"
|
|
8626
|
-
},
|
|
8627
|
-
"default": "\"top\"",
|
|
8628
|
-
"description": "Control the position of the tooltip component.\nWhen set to \"none\", the tooltip will be shown above\nbut accommodate for browser boundaries.",
|
|
8629
|
-
"fieldName": "position"
|
|
8630
|
-
},
|
|
8631
|
-
{
|
|
8632
|
-
"name": "role",
|
|
8633
|
-
"type": {
|
|
8634
|
-
"text": "string"
|
|
8635
|
-
},
|
|
8636
|
-
"default": "\"tooltip\"",
|
|
8637
|
-
"description": "The tooltip role, set on the component by default.",
|
|
8638
|
-
"fieldName": "role"
|
|
8639
|
-
},
|
|
8640
|
-
{
|
|
8641
|
-
"name": "id",
|
|
8642
|
-
"type": {
|
|
8643
|
-
"text": "string"
|
|
8644
|
-
},
|
|
8645
|
-
"default": "\"\"",
|
|
8646
|
-
"description": "The id for the active element to reference via aria-describedby.",
|
|
8647
|
-
"fieldName": "id"
|
|
8648
|
-
},
|
|
8649
|
-
{
|
|
8650
|
-
"name": "delay",
|
|
8651
|
-
"type": {
|
|
8652
|
-
"text": "number"
|
|
8653
|
-
},
|
|
8654
|
-
"default": "300",
|
|
8655
|
-
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
8656
|
-
"fieldName": "delay"
|
|
8657
|
-
}
|
|
8658
|
-
],
|
|
8659
|
-
"superclass": {
|
|
8660
|
-
"name": "LitElement",
|
|
8661
|
-
"package": "lit"
|
|
8662
|
-
},
|
|
8663
|
-
"status": "ready",
|
|
8664
|
-
"category": "overlay",
|
|
8665
|
-
"tagName": "nord-tooltip",
|
|
8666
|
-
"customElement": true
|
|
8667
|
-
}
|
|
8668
|
-
],
|
|
8669
|
-
"exports": [
|
|
8670
|
-
{
|
|
8671
|
-
"kind": "js",
|
|
8672
|
-
"name": "default",
|
|
8673
|
-
"declaration": {
|
|
8674
|
-
"name": "Tooltip",
|
|
8675
|
-
"module": "src/tooltip/Tooltip.ts"
|
|
8676
|
-
}
|
|
8677
|
-
},
|
|
8678
|
-
{
|
|
8679
|
-
"kind": "custom-element-definition",
|
|
8680
|
-
"name": "nord-tooltip",
|
|
8681
|
-
"declaration": {
|
|
8682
|
-
"name": "Tooltip",
|
|
8683
|
-
"module": "src/tooltip/Tooltip.ts"
|
|
8684
|
-
}
|
|
8685
|
-
}
|
|
8686
|
-
],
|
|
8687
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a tooltip if an interactive element requires more explanation.\n- Use a tooltip to provide additional information, such as UI shortcuts.\n- Use the `label` attribute on icons used for shortcuts for accessability.\n- Use clear and accurate phrasing.\n- Be consistent with positioning of tooltips in the user interface.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use interactive elements such as links or buttons inside a tooltip.\n- Don’t rely on tooltips when you have room to provide more explanation.\n- Don’t depend on tooltips for vital information.\n\n</div>\n\n-------\n\n## Content guidelines\n\nTooltips should be clear and informative, but not imperative to using the interface they refer to. They should not contain interactive elements such as buttons or links.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data as a CSV, <u>more information on CSVs</u></div>\n\nTooltips should provide useful information and not repeat information that is already present.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data</div>\n\nWhen writing tooltips, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export Data As a Spreadsheet</div>\n\nUse tooltips sparingly. If your UI is requiring a lot of tooltips, consider revising the interface to provide better explanations and better labelling.\n\n-------\n\n## Additional considerations\n\n- Always provide a tooltip for icon-only buttons or a button with an associated keyboard shortcut.\n- Don’t use tooltip to communicate critical information, including errors.\n- Use sparingly. If you’re building something that requires a lot of tooltips, take a step back and work on clarifying the design and the language used instead.\n"
|
|
8688
|
-
},
|
|
8689
|
-
{
|
|
8690
|
-
"kind": "javascript-module",
|
|
8691
|
-
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
8692
|
-
"declarations": [
|
|
8693
|
-
{
|
|
8694
|
-
"kind": "class",
|
|
8695
|
-
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
8696
|
-
"name": "VisuallyHidden",
|
|
8697
|
-
"slots": [
|
|
8698
|
-
{
|
|
8699
|
-
"description": "The visually hidden content.",
|
|
8700
|
-
"name": ""
|
|
8701
|
-
}
|
|
8702
|
-
],
|
|
8703
|
-
"members": [],
|
|
8704
|
-
"superclass": {
|
|
8705
|
-
"name": "LitElement",
|
|
8706
|
-
"package": "lit"
|
|
8707
|
-
},
|
|
8708
|
-
"status": "ready",
|
|
8709
|
-
"category": "text",
|
|
8710
|
-
"tagName": "nord-visually-hidden",
|
|
8711
|
-
"customElement": true
|
|
8712
|
-
}
|
|
8713
|
-
],
|
|
8714
|
-
"exports": [
|
|
8715
|
-
{
|
|
8716
|
-
"kind": "js",
|
|
8717
|
-
"name": "default",
|
|
8718
|
-
"declaration": {
|
|
8719
|
-
"name": "VisuallyHidden",
|
|
8720
|
-
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
8721
|
-
}
|
|
8722
|
-
},
|
|
8723
|
-
{
|
|
8724
|
-
"kind": "custom-element-definition",
|
|
8725
|
-
"name": "nord-visually-hidden",
|
|
8726
|
-
"declaration": {
|
|
8727
|
-
"name": "VisuallyHidden",
|
|
8728
|
-
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
8729
|
-
}
|
|
8730
|
-
}
|
|
8731
|
-
],
|
|
8732
|
-
"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"
|
|
8733
|
-
},
|
|
8734
|
-
{
|
|
8735
|
-
"kind": "javascript-module",
|
|
8736
|
-
"path": "src/common/directives/cond.ts",
|
|
8737
|
-
"declarations": [
|
|
8738
|
-
{
|
|
8739
|
-
"kind": "variable",
|
|
8740
|
-
"name": "cond"
|
|
8741
|
-
}
|
|
8742
|
-
],
|
|
8743
|
-
"exports": [
|
|
8744
|
-
{
|
|
8745
|
-
"kind": "js",
|
|
8746
|
-
"name": "cond",
|
|
8747
|
-
"declaration": {
|
|
8748
|
-
"name": "cond",
|
|
8749
|
-
"module": "src/common/directives/cond.ts"
|
|
8750
|
-
}
|
|
8751
|
-
}
|
|
8752
|
-
]
|
|
8753
|
-
},
|
|
8754
|
-
{
|
|
8755
|
-
"kind": "javascript-module",
|
|
8756
|
-
"path": "src/common/directives/wrapIf.ts",
|
|
8757
|
-
"declarations": [
|
|
8758
|
-
{
|
|
8759
|
-
"kind": "function",
|
|
8760
|
-
"name": "wrapIf",
|
|
8761
|
-
"return": {
|
|
8762
|
-
"type": {
|
|
8763
|
-
"text": "TInner"
|
|
8764
|
-
}
|
|
8765
|
-
},
|
|
8766
|
-
"parameters": [
|
|
8767
|
-
{
|
|
8768
|
-
"name": "condition",
|
|
8769
|
-
"type": {
|
|
8770
|
-
"text": "false"
|
|
8771
|
-
}
|
|
8772
|
-
},
|
|
8773
|
-
{
|
|
8774
|
-
"name": "inner",
|
|
8775
|
-
"type": {
|
|
8776
|
-
"text": "() => TInner"
|
|
8777
|
-
}
|
|
8778
|
-
},
|
|
8779
|
-
{
|
|
8780
|
-
"name": "wrapper",
|
|
8781
|
-
"type": {
|
|
8782
|
-
"text": "(inner: TInner) => TWrapper"
|
|
8783
|
-
}
|
|
8784
|
-
}
|
|
8785
|
-
]
|
|
8786
|
-
},
|
|
8787
|
-
{
|
|
8788
|
-
"kind": "function",
|
|
8789
|
-
"name": "wrapIf",
|
|
8790
|
-
"return": {
|
|
8791
|
-
"type": {
|
|
8792
|
-
"text": "TWrapper"
|
|
8793
|
-
}
|
|
8794
|
-
},
|
|
8795
|
-
"parameters": [
|
|
8796
|
-
{
|
|
8797
|
-
"name": "condition",
|
|
8798
|
-
"type": {
|
|
8799
|
-
"text": "true"
|
|
8800
|
-
}
|
|
8801
|
-
},
|
|
8802
|
-
{
|
|
8803
|
-
"name": "inner",
|
|
8804
|
-
"type": {
|
|
8805
|
-
"text": "() => TInner"
|
|
8806
|
-
}
|
|
8807
|
-
},
|
|
8808
|
-
{
|
|
8809
|
-
"name": "wrapper",
|
|
8810
|
-
"type": {
|
|
8811
|
-
"text": "(inner: TInner) => TWrapper"
|
|
8812
|
-
}
|
|
8813
|
-
}
|
|
8814
|
-
]
|
|
8815
|
-
},
|
|
8816
|
-
{
|
|
8817
|
-
"kind": "function",
|
|
8818
|
-
"name": "wrapIf",
|
|
8819
|
-
"return": {
|
|
8820
|
-
"type": {
|
|
8821
|
-
"text": "TInner | TWrapper"
|
|
8822
|
-
}
|
|
8823
|
-
},
|
|
8824
|
-
"parameters": [
|
|
8825
|
-
{
|
|
8826
|
-
"name": "condition",
|
|
8827
|
-
"type": {
|
|
8828
|
-
"text": "unknown"
|
|
8829
|
-
}
|
|
8830
|
-
},
|
|
8831
|
-
{
|
|
8832
|
-
"name": "inner",
|
|
8833
|
-
"type": {
|
|
8834
|
-
"text": "() => TInner"
|
|
8835
|
-
}
|
|
8836
|
-
},
|
|
8837
|
-
{
|
|
8838
|
-
"name": "wrapper",
|
|
8839
|
-
"type": {
|
|
8840
|
-
"text": "(inner: TInner) => TWrapper"
|
|
8841
|
-
}
|
|
8842
|
-
}
|
|
8843
|
-
]
|
|
8844
|
-
},
|
|
8845
|
-
{
|
|
8846
|
-
"kind": "function",
|
|
8847
|
-
"name": "wrapIf",
|
|
8848
|
-
"parameters": [
|
|
8671
|
+
"type": {
|
|
8672
|
+
"text": "\"bottom\" | \"top\" | \"left\" | \"right\" | undefined"
|
|
8673
|
+
},
|
|
8674
|
+
"default": "\"top\"",
|
|
8675
|
+
"description": "Control the position of the tooltip component.\nWhen set to \"none\", the tooltip will be shown above\nbut accommodate for browser boundaries.",
|
|
8676
|
+
"fieldName": "position"
|
|
8677
|
+
},
|
|
8849
8678
|
{
|
|
8850
|
-
"name": "
|
|
8679
|
+
"name": "role",
|
|
8851
8680
|
"type": {
|
|
8852
|
-
"text": "
|
|
8853
|
-
}
|
|
8681
|
+
"text": "string"
|
|
8682
|
+
},
|
|
8683
|
+
"default": "\"tooltip\"",
|
|
8684
|
+
"description": "The tooltip role, set on the component by default.",
|
|
8685
|
+
"fieldName": "role"
|
|
8854
8686
|
},
|
|
8855
8687
|
{
|
|
8856
|
-
"name": "
|
|
8688
|
+
"name": "id",
|
|
8857
8689
|
"type": {
|
|
8858
|
-
"text": "
|
|
8859
|
-
}
|
|
8690
|
+
"text": "string"
|
|
8691
|
+
},
|
|
8692
|
+
"default": "\"\"",
|
|
8693
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
8694
|
+
"fieldName": "id"
|
|
8860
8695
|
},
|
|
8861
8696
|
{
|
|
8862
|
-
"name": "
|
|
8697
|
+
"name": "delay",
|
|
8863
8698
|
"type": {
|
|
8864
|
-
"text": "
|
|
8865
|
-
}
|
|
8699
|
+
"text": "number"
|
|
8700
|
+
},
|
|
8701
|
+
"default": "300",
|
|
8702
|
+
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
8703
|
+
"fieldName": "delay"
|
|
8866
8704
|
}
|
|
8867
8705
|
],
|
|
8868
|
-
"
|
|
8869
|
-
"
|
|
8870
|
-
|
|
8871
|
-
|
|
8872
|
-
|
|
8706
|
+
"superclass": {
|
|
8707
|
+
"name": "LitElement",
|
|
8708
|
+
"package": "lit"
|
|
8709
|
+
},
|
|
8710
|
+
"status": "ready",
|
|
8711
|
+
"category": "overlay",
|
|
8712
|
+
"tagName": "nord-tooltip",
|
|
8713
|
+
"customElement": true
|
|
8873
8714
|
}
|
|
8874
8715
|
],
|
|
8875
8716
|
"exports": [
|
|
8876
8717
|
{
|
|
8877
8718
|
"kind": "js",
|
|
8878
|
-
"name": "
|
|
8719
|
+
"name": "default",
|
|
8879
8720
|
"declaration": {
|
|
8880
|
-
"name": "
|
|
8881
|
-
"module": "src/
|
|
8721
|
+
"name": "Tooltip",
|
|
8722
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
8882
8723
|
}
|
|
8883
8724
|
},
|
|
8884
8725
|
{
|
|
8885
|
-
"kind": "
|
|
8886
|
-
"name": "
|
|
8726
|
+
"kind": "custom-element-definition",
|
|
8727
|
+
"name": "nord-tooltip",
|
|
8887
8728
|
"declaration": {
|
|
8888
|
-
"name": "
|
|
8889
|
-
"module": "src/
|
|
8729
|
+
"name": "Tooltip",
|
|
8730
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
8890
8731
|
}
|
|
8891
|
-
}
|
|
8732
|
+
}
|
|
8733
|
+
],
|
|
8734
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a tooltip if an interactive element requires more explanation.\n- Use a tooltip to provide additional information, such as UI shortcuts.\n- Use the `label` attribute on icons used for shortcuts for accessability.\n- Use clear and accurate phrasing.\n- Be consistent with positioning of tooltips in the user interface.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use interactive elements such as links or buttons inside a tooltip.\n- Don’t rely on tooltips when you have room to provide more explanation.\n- Don’t depend on tooltips for vital information.\n\n</div>\n\n-------\n\n## Content guidelines\n\nTooltips should be clear and informative, but not imperative to using the interface they refer to. They should not contain interactive elements such as buttons or links.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data as a CSV, <u>more information on CSVs</u></div>\n\nTooltips should provide useful information and not repeat information that is already present.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data</div>\n\nWhen writing tooltips, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export Data As a Spreadsheet</div>\n\nUse tooltips sparingly. If your UI is requiring a lot of tooltips, consider revising the interface to provide better explanations and better labelling.\n\n-------\n\n## Additional considerations\n\n- Always provide a tooltip for icon-only buttons or a button with an associated keyboard shortcut.\n- Don’t use tooltip to communicate critical information, including errors.\n- Use sparingly. If you’re building something that requires a lot of tooltips, take a step back and work on clarifying the design and the language used instead.\n"
|
|
8735
|
+
},
|
|
8736
|
+
{
|
|
8737
|
+
"kind": "javascript-module",
|
|
8738
|
+
"path": "src/visually-hidden/VisuallyHidden.ts",
|
|
8739
|
+
"declarations": [
|
|
8740
|
+
{
|
|
8741
|
+
"kind": "class",
|
|
8742
|
+
"description": "Visually hidden is used when an element needs to be available\nto assistive technologies like screen readers, but be otherwise\nhidden.",
|
|
8743
|
+
"name": "VisuallyHidden",
|
|
8744
|
+
"slots": [
|
|
8745
|
+
{
|
|
8746
|
+
"description": "The visually hidden content.",
|
|
8747
|
+
"name": ""
|
|
8748
|
+
}
|
|
8749
|
+
],
|
|
8750
|
+
"members": [],
|
|
8751
|
+
"superclass": {
|
|
8752
|
+
"name": "LitElement",
|
|
8753
|
+
"package": "lit"
|
|
8754
|
+
},
|
|
8755
|
+
"status": "ready",
|
|
8756
|
+
"category": "text",
|
|
8757
|
+
"tagName": "nord-visually-hidden",
|
|
8758
|
+
"customElement": true
|
|
8759
|
+
}
|
|
8760
|
+
],
|
|
8761
|
+
"exports": [
|
|
8892
8762
|
{
|
|
8893
8763
|
"kind": "js",
|
|
8894
|
-
"name": "
|
|
8764
|
+
"name": "default",
|
|
8895
8765
|
"declaration": {
|
|
8896
|
-
"name": "
|
|
8897
|
-
"module": "src/
|
|
8766
|
+
"name": "VisuallyHidden",
|
|
8767
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
8898
8768
|
}
|
|
8899
8769
|
},
|
|
8900
8770
|
{
|
|
8901
|
-
"kind": "
|
|
8902
|
-
"name": "
|
|
8771
|
+
"kind": "custom-element-definition",
|
|
8772
|
+
"name": "nord-visually-hidden",
|
|
8903
8773
|
"declaration": {
|
|
8904
|
-
"name": "
|
|
8905
|
-
"module": "src/
|
|
8774
|
+
"name": "VisuallyHidden",
|
|
8775
|
+
"module": "src/visually-hidden/VisuallyHidden.ts"
|
|
8906
8776
|
}
|
|
8907
8777
|
}
|
|
8908
|
-
]
|
|
8778
|
+
],
|
|
8779
|
+
"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"
|
|
8909
8780
|
},
|
|
8910
8781
|
{
|
|
8911
8782
|
"kind": "javascript-module",
|
|
@@ -8972,10 +8843,221 @@
|
|
|
8972
8843
|
"exports": [
|
|
8973
8844
|
{
|
|
8974
8845
|
"kind": "js",
|
|
8975
|
-
"name": "DirectionController",
|
|
8846
|
+
"name": "DirectionController",
|
|
8847
|
+
"declaration": {
|
|
8848
|
+
"name": "DirectionController",
|
|
8849
|
+
"module": "src/common/controllers/DirectionController.ts"
|
|
8850
|
+
}
|
|
8851
|
+
}
|
|
8852
|
+
]
|
|
8853
|
+
},
|
|
8854
|
+
{
|
|
8855
|
+
"kind": "javascript-module",
|
|
8856
|
+
"path": "src/common/controllers/EventController.ts",
|
|
8857
|
+
"declarations": [
|
|
8858
|
+
{
|
|
8859
|
+
"kind": "class",
|
|
8860
|
+
"description": "",
|
|
8861
|
+
"name": "EventController",
|
|
8862
|
+
"members": [
|
|
8863
|
+
{
|
|
8864
|
+
"kind": "field",
|
|
8865
|
+
"name": "listeners",
|
|
8866
|
+
"type": {
|
|
8867
|
+
"text": "Array<() => void>"
|
|
8868
|
+
},
|
|
8869
|
+
"privacy": "private",
|
|
8870
|
+
"default": "[]"
|
|
8871
|
+
},
|
|
8872
|
+
{
|
|
8873
|
+
"kind": "method",
|
|
8874
|
+
"name": "hostDisconnected"
|
|
8875
|
+
},
|
|
8876
|
+
{
|
|
8877
|
+
"kind": "method",
|
|
8878
|
+
"name": "listen",
|
|
8879
|
+
"return": {
|
|
8880
|
+
"type": {
|
|
8881
|
+
"text": "void"
|
|
8882
|
+
}
|
|
8883
|
+
},
|
|
8884
|
+
"parameters": [
|
|
8885
|
+
{
|
|
8886
|
+
"name": "window",
|
|
8887
|
+
"type": {
|
|
8888
|
+
"text": "Window"
|
|
8889
|
+
}
|
|
8890
|
+
},
|
|
8891
|
+
{
|
|
8892
|
+
"name": "type",
|
|
8893
|
+
"type": {
|
|
8894
|
+
"text": "K"
|
|
8895
|
+
}
|
|
8896
|
+
},
|
|
8897
|
+
{
|
|
8898
|
+
"name": "listener",
|
|
8899
|
+
"type": {
|
|
8900
|
+
"text": "(this: Window, ev: WindowEventMap[K]) => any"
|
|
8901
|
+
}
|
|
8902
|
+
},
|
|
8903
|
+
{
|
|
8904
|
+
"name": "options",
|
|
8905
|
+
"optional": true,
|
|
8906
|
+
"type": {
|
|
8907
|
+
"text": "boolean | AddEventListenerOptions"
|
|
8908
|
+
}
|
|
8909
|
+
}
|
|
8910
|
+
]
|
|
8911
|
+
},
|
|
8912
|
+
{
|
|
8913
|
+
"kind": "method",
|
|
8914
|
+
"name": "listen",
|
|
8915
|
+
"return": {
|
|
8916
|
+
"type": {
|
|
8917
|
+
"text": "void"
|
|
8918
|
+
}
|
|
8919
|
+
},
|
|
8920
|
+
"parameters": [
|
|
8921
|
+
{
|
|
8922
|
+
"name": "document",
|
|
8923
|
+
"type": {
|
|
8924
|
+
"text": "Document"
|
|
8925
|
+
}
|
|
8926
|
+
},
|
|
8927
|
+
{
|
|
8928
|
+
"name": "type",
|
|
8929
|
+
"type": {
|
|
8930
|
+
"text": "K"
|
|
8931
|
+
}
|
|
8932
|
+
},
|
|
8933
|
+
{
|
|
8934
|
+
"name": "listener",
|
|
8935
|
+
"type": {
|
|
8936
|
+
"text": "(this: Document, ev: DocumentEventMap[K]) => any"
|
|
8937
|
+
}
|
|
8938
|
+
},
|
|
8939
|
+
{
|
|
8940
|
+
"name": "options",
|
|
8941
|
+
"optional": true,
|
|
8942
|
+
"type": {
|
|
8943
|
+
"text": "boolean | AddEventListenerOptions"
|
|
8944
|
+
}
|
|
8945
|
+
}
|
|
8946
|
+
]
|
|
8947
|
+
},
|
|
8948
|
+
{
|
|
8949
|
+
"kind": "method",
|
|
8950
|
+
"name": "listen",
|
|
8951
|
+
"return": {
|
|
8952
|
+
"type": {
|
|
8953
|
+
"text": "void"
|
|
8954
|
+
}
|
|
8955
|
+
},
|
|
8956
|
+
"parameters": [
|
|
8957
|
+
{
|
|
8958
|
+
"name": "element",
|
|
8959
|
+
"type": {
|
|
8960
|
+
"text": "HTMLElement"
|
|
8961
|
+
}
|
|
8962
|
+
},
|
|
8963
|
+
{
|
|
8964
|
+
"name": "type",
|
|
8965
|
+
"type": {
|
|
8966
|
+
"text": "K"
|
|
8967
|
+
}
|
|
8968
|
+
},
|
|
8969
|
+
{
|
|
8970
|
+
"name": "listener",
|
|
8971
|
+
"type": {
|
|
8972
|
+
"text": "(this: HTMLElement, ev: HTMLElementEventMap[K]) => any"
|
|
8973
|
+
}
|
|
8974
|
+
},
|
|
8975
|
+
{
|
|
8976
|
+
"name": "options",
|
|
8977
|
+
"optional": true,
|
|
8978
|
+
"type": {
|
|
8979
|
+
"text": "boolean | AddEventListenerOptions"
|
|
8980
|
+
}
|
|
8981
|
+
}
|
|
8982
|
+
]
|
|
8983
|
+
},
|
|
8984
|
+
{
|
|
8985
|
+
"kind": "method",
|
|
8986
|
+
"name": "listen",
|
|
8987
|
+
"return": {
|
|
8988
|
+
"type": {
|
|
8989
|
+
"text": "void"
|
|
8990
|
+
}
|
|
8991
|
+
},
|
|
8992
|
+
"parameters": [
|
|
8993
|
+
{
|
|
8994
|
+
"name": "element",
|
|
8995
|
+
"type": {
|
|
8996
|
+
"text": "ShadowRoot"
|
|
8997
|
+
}
|
|
8998
|
+
},
|
|
8999
|
+
{
|
|
9000
|
+
"name": "type",
|
|
9001
|
+
"type": {
|
|
9002
|
+
"text": "K"
|
|
9003
|
+
}
|
|
9004
|
+
},
|
|
9005
|
+
{
|
|
9006
|
+
"name": "listener",
|
|
9007
|
+
"type": {
|
|
9008
|
+
"text": "(this: ShadowRoot, ev: ShadowRootEventMap[K]) => any"
|
|
9009
|
+
}
|
|
9010
|
+
},
|
|
9011
|
+
{
|
|
9012
|
+
"name": "options",
|
|
9013
|
+
"optional": true,
|
|
9014
|
+
"type": {
|
|
9015
|
+
"text": "boolean | AddEventListenerOptions"
|
|
9016
|
+
}
|
|
9017
|
+
}
|
|
9018
|
+
]
|
|
9019
|
+
},
|
|
9020
|
+
{
|
|
9021
|
+
"kind": "method",
|
|
9022
|
+
"name": "listen",
|
|
9023
|
+
"parameters": [
|
|
9024
|
+
{
|
|
9025
|
+
"name": "element",
|
|
9026
|
+
"type": {
|
|
9027
|
+
"text": "Window | Document | HTMLElement | ShadowRoot"
|
|
9028
|
+
}
|
|
9029
|
+
},
|
|
9030
|
+
{
|
|
9031
|
+
"name": "type",
|
|
9032
|
+
"type": {
|
|
9033
|
+
"text": "string"
|
|
9034
|
+
}
|
|
9035
|
+
},
|
|
9036
|
+
{
|
|
9037
|
+
"name": "listener",
|
|
9038
|
+
"type": {
|
|
9039
|
+
"text": "(ev: any) => any"
|
|
9040
|
+
}
|
|
9041
|
+
},
|
|
9042
|
+
{
|
|
9043
|
+
"name": "options",
|
|
9044
|
+
"optional": true,
|
|
9045
|
+
"type": {
|
|
9046
|
+
"text": "boolean | AddEventListenerOptions"
|
|
9047
|
+
}
|
|
9048
|
+
}
|
|
9049
|
+
]
|
|
9050
|
+
}
|
|
9051
|
+
]
|
|
9052
|
+
}
|
|
9053
|
+
],
|
|
9054
|
+
"exports": [
|
|
9055
|
+
{
|
|
9056
|
+
"kind": "js",
|
|
9057
|
+
"name": "EventController",
|
|
8976
9058
|
"declaration": {
|
|
8977
|
-
"name": "
|
|
8978
|
-
"module": "src/common/controllers/
|
|
9059
|
+
"name": "EventController",
|
|
9060
|
+
"module": "src/common/controllers/EventController.ts"
|
|
8979
9061
|
}
|
|
8980
9062
|
}
|
|
8981
9063
|
]
|
|
@@ -8990,12 +9072,17 @@
|
|
|
8990
9072
|
"name": "FormDataController",
|
|
8991
9073
|
"members": [
|
|
8992
9074
|
{
|
|
8993
|
-
"kind": "
|
|
8994
|
-
"name": "
|
|
9075
|
+
"kind": "field",
|
|
9076
|
+
"name": "events",
|
|
9077
|
+
"type": {
|
|
9078
|
+
"text": "EventController"
|
|
9079
|
+
},
|
|
9080
|
+
"privacy": "private",
|
|
9081
|
+
"default": "new EventController(host)"
|
|
8995
9082
|
},
|
|
8996
9083
|
{
|
|
8997
9084
|
"kind": "method",
|
|
8998
|
-
"name": "
|
|
9085
|
+
"name": "hostConnected"
|
|
8999
9086
|
},
|
|
9000
9087
|
{
|
|
9001
9088
|
"kind": "field",
|
|
@@ -9045,12 +9132,17 @@
|
|
|
9045
9132
|
"default": "new ShortcutController(this.host, { Escape: this.handleEsc })"
|
|
9046
9133
|
},
|
|
9047
9134
|
{
|
|
9048
|
-
"kind": "
|
|
9049
|
-
"name": "
|
|
9135
|
+
"kind": "field",
|
|
9136
|
+
"name": "events",
|
|
9137
|
+
"type": {
|
|
9138
|
+
"text": "EventController"
|
|
9139
|
+
},
|
|
9140
|
+
"privacy": "private",
|
|
9141
|
+
"default": "new EventController(host)"
|
|
9050
9142
|
},
|
|
9051
9143
|
{
|
|
9052
9144
|
"kind": "method",
|
|
9053
|
-
"name": "
|
|
9145
|
+
"name": "hostConnected"
|
|
9054
9146
|
},
|
|
9055
9147
|
{
|
|
9056
9148
|
"kind": "field",
|
|
@@ -9171,11 +9263,7 @@
|
|
|
9171
9263
|
},
|
|
9172
9264
|
{
|
|
9173
9265
|
"kind": "method",
|
|
9174
|
-
"name": "hostDisconnected"
|
|
9175
|
-
"inheritedFrom": {
|
|
9176
|
-
"name": "SlotController",
|
|
9177
|
-
"module": "src/common/controllers/SlotController.ts"
|
|
9178
|
-
}
|
|
9266
|
+
"name": "hostDisconnected"
|
|
9179
9267
|
},
|
|
9180
9268
|
{
|
|
9181
9269
|
"kind": "field",
|
|
@@ -9204,6 +9292,19 @@
|
|
|
9204
9292
|
"name": "options",
|
|
9205
9293
|
"default": "options"
|
|
9206
9294
|
},
|
|
9295
|
+
{
|
|
9296
|
+
"kind": "field",
|
|
9297
|
+
"name": "events",
|
|
9298
|
+
"type": {
|
|
9299
|
+
"text": "EventController"
|
|
9300
|
+
},
|
|
9301
|
+
"privacy": "private",
|
|
9302
|
+
"default": "new EventController(host)",
|
|
9303
|
+
"inheritedFrom": {
|
|
9304
|
+
"name": "SlotController",
|
|
9305
|
+
"module": "src/common/controllers/SlotController.ts"
|
|
9306
|
+
}
|
|
9307
|
+
},
|
|
9207
9308
|
{
|
|
9208
9309
|
"kind": "field",
|
|
9209
9310
|
"name": "hasContent",
|
|
@@ -9420,12 +9521,17 @@
|
|
|
9420
9521
|
"name": "SlotController",
|
|
9421
9522
|
"members": [
|
|
9422
9523
|
{
|
|
9423
|
-
"kind": "
|
|
9424
|
-
"name": "
|
|
9524
|
+
"kind": "field",
|
|
9525
|
+
"name": "events",
|
|
9526
|
+
"type": {
|
|
9527
|
+
"text": "EventController"
|
|
9528
|
+
},
|
|
9529
|
+
"privacy": "private",
|
|
9530
|
+
"default": "new EventController(host)"
|
|
9425
9531
|
},
|
|
9426
9532
|
{
|
|
9427
9533
|
"kind": "method",
|
|
9428
|
-
"name": "
|
|
9534
|
+
"name": "hostConnected"
|
|
9429
9535
|
},
|
|
9430
9536
|
{
|
|
9431
9537
|
"kind": "field",
|
|
@@ -9492,16 +9598,16 @@
|
|
|
9492
9598
|
"members": [
|
|
9493
9599
|
{
|
|
9494
9600
|
"kind": "field",
|
|
9495
|
-
"name": "
|
|
9601
|
+
"name": "events",
|
|
9496
9602
|
"type": {
|
|
9497
|
-
"text": "
|
|
9603
|
+
"text": "EventController"
|
|
9498
9604
|
},
|
|
9499
9605
|
"privacy": "private",
|
|
9500
|
-
"default": "host"
|
|
9606
|
+
"default": "new EventController(host)"
|
|
9501
9607
|
},
|
|
9502
9608
|
{
|
|
9503
9609
|
"kind": "field",
|
|
9504
|
-
"name": "
|
|
9610
|
+
"name": "hadFirstUpdate",
|
|
9505
9611
|
"type": {
|
|
9506
9612
|
"text": "boolean"
|
|
9507
9613
|
},
|
|
@@ -9528,26 +9634,12 @@
|
|
|
9528
9634
|
},
|
|
9529
9635
|
{
|
|
9530
9636
|
"kind": "field",
|
|
9531
|
-
"name": "
|
|
9532
|
-
"type": {
|
|
9533
|
-
"text": "() => HTMLElement"
|
|
9534
|
-
},
|
|
9535
|
-
"privacy": "private"
|
|
9536
|
-
},
|
|
9537
|
-
{
|
|
9538
|
-
"kind": "field",
|
|
9539
|
-
"name": "onSwipeEnd",
|
|
9637
|
+
"name": "options",
|
|
9540
9638
|
"type": {
|
|
9541
|
-
"text": "SwipeControllerOptions
|
|
9639
|
+
"text": "SetRequired<SwipeControllerOptions, \"target\">"
|
|
9542
9640
|
},
|
|
9543
|
-
"privacy": "private"
|
|
9544
|
-
|
|
9545
|
-
{
|
|
9546
|
-
"kind": "field",
|
|
9547
|
-
"name": "matchesGesture",
|
|
9548
|
-
"type": {
|
|
9549
|
-
"text": "SwipeControllerOptions[\"matchesGesture\"]"
|
|
9550
|
-
}
|
|
9641
|
+
"privacy": "private",
|
|
9642
|
+
"default": "{\n target: () => host,\n ...options,\n }"
|
|
9551
9643
|
},
|
|
9552
9644
|
{
|
|
9553
9645
|
"kind": "method",
|
|
@@ -9621,6 +9713,182 @@
|
|
|
9621
9713
|
}
|
|
9622
9714
|
]
|
|
9623
9715
|
},
|
|
9716
|
+
{
|
|
9717
|
+
"kind": "javascript-module",
|
|
9718
|
+
"path": "src/common/directives/cond.ts",
|
|
9719
|
+
"declarations": [
|
|
9720
|
+
{
|
|
9721
|
+
"kind": "variable",
|
|
9722
|
+
"name": "cond"
|
|
9723
|
+
}
|
|
9724
|
+
],
|
|
9725
|
+
"exports": [
|
|
9726
|
+
{
|
|
9727
|
+
"kind": "js",
|
|
9728
|
+
"name": "cond",
|
|
9729
|
+
"declaration": {
|
|
9730
|
+
"name": "cond",
|
|
9731
|
+
"module": "src/common/directives/cond.ts"
|
|
9732
|
+
}
|
|
9733
|
+
}
|
|
9734
|
+
]
|
|
9735
|
+
},
|
|
9736
|
+
{
|
|
9737
|
+
"kind": "javascript-module",
|
|
9738
|
+
"path": "src/common/directives/wrapIf.ts",
|
|
9739
|
+
"declarations": [
|
|
9740
|
+
{
|
|
9741
|
+
"kind": "function",
|
|
9742
|
+
"name": "wrapIf",
|
|
9743
|
+
"return": {
|
|
9744
|
+
"type": {
|
|
9745
|
+
"text": "TInner"
|
|
9746
|
+
}
|
|
9747
|
+
},
|
|
9748
|
+
"parameters": [
|
|
9749
|
+
{
|
|
9750
|
+
"name": "condition",
|
|
9751
|
+
"type": {
|
|
9752
|
+
"text": "false"
|
|
9753
|
+
}
|
|
9754
|
+
},
|
|
9755
|
+
{
|
|
9756
|
+
"name": "inner",
|
|
9757
|
+
"type": {
|
|
9758
|
+
"text": "() => TInner"
|
|
9759
|
+
}
|
|
9760
|
+
},
|
|
9761
|
+
{
|
|
9762
|
+
"name": "wrapper",
|
|
9763
|
+
"type": {
|
|
9764
|
+
"text": "(inner: TInner) => TWrapper"
|
|
9765
|
+
}
|
|
9766
|
+
}
|
|
9767
|
+
]
|
|
9768
|
+
},
|
|
9769
|
+
{
|
|
9770
|
+
"kind": "function",
|
|
9771
|
+
"name": "wrapIf",
|
|
9772
|
+
"return": {
|
|
9773
|
+
"type": {
|
|
9774
|
+
"text": "TWrapper"
|
|
9775
|
+
}
|
|
9776
|
+
},
|
|
9777
|
+
"parameters": [
|
|
9778
|
+
{
|
|
9779
|
+
"name": "condition",
|
|
9780
|
+
"type": {
|
|
9781
|
+
"text": "true"
|
|
9782
|
+
}
|
|
9783
|
+
},
|
|
9784
|
+
{
|
|
9785
|
+
"name": "inner",
|
|
9786
|
+
"type": {
|
|
9787
|
+
"text": "() => TInner"
|
|
9788
|
+
}
|
|
9789
|
+
},
|
|
9790
|
+
{
|
|
9791
|
+
"name": "wrapper",
|
|
9792
|
+
"type": {
|
|
9793
|
+
"text": "(inner: TInner) => TWrapper"
|
|
9794
|
+
}
|
|
9795
|
+
}
|
|
9796
|
+
]
|
|
9797
|
+
},
|
|
9798
|
+
{
|
|
9799
|
+
"kind": "function",
|
|
9800
|
+
"name": "wrapIf",
|
|
9801
|
+
"return": {
|
|
9802
|
+
"type": {
|
|
9803
|
+
"text": "TInner | TWrapper"
|
|
9804
|
+
}
|
|
9805
|
+
},
|
|
9806
|
+
"parameters": [
|
|
9807
|
+
{
|
|
9808
|
+
"name": "condition",
|
|
9809
|
+
"type": {
|
|
9810
|
+
"text": "unknown"
|
|
9811
|
+
}
|
|
9812
|
+
},
|
|
9813
|
+
{
|
|
9814
|
+
"name": "inner",
|
|
9815
|
+
"type": {
|
|
9816
|
+
"text": "() => TInner"
|
|
9817
|
+
}
|
|
9818
|
+
},
|
|
9819
|
+
{
|
|
9820
|
+
"name": "wrapper",
|
|
9821
|
+
"type": {
|
|
9822
|
+
"text": "(inner: TInner) => TWrapper"
|
|
9823
|
+
}
|
|
9824
|
+
}
|
|
9825
|
+
]
|
|
9826
|
+
},
|
|
9827
|
+
{
|
|
9828
|
+
"kind": "function",
|
|
9829
|
+
"name": "wrapIf",
|
|
9830
|
+
"parameters": [
|
|
9831
|
+
{
|
|
9832
|
+
"name": "condition",
|
|
9833
|
+
"type": {
|
|
9834
|
+
"text": "any"
|
|
9835
|
+
}
|
|
9836
|
+
},
|
|
9837
|
+
{
|
|
9838
|
+
"name": "inner",
|
|
9839
|
+
"type": {
|
|
9840
|
+
"text": "() => TInner"
|
|
9841
|
+
}
|
|
9842
|
+
},
|
|
9843
|
+
{
|
|
9844
|
+
"name": "wrapper",
|
|
9845
|
+
"type": {
|
|
9846
|
+
"text": "(innards: TInner) => TWrapper"
|
|
9847
|
+
}
|
|
9848
|
+
}
|
|
9849
|
+
],
|
|
9850
|
+
"return": {
|
|
9851
|
+
"type": {
|
|
9852
|
+
"text": ""
|
|
9853
|
+
}
|
|
9854
|
+
}
|
|
9855
|
+
}
|
|
9856
|
+
],
|
|
9857
|
+
"exports": [
|
|
9858
|
+
{
|
|
9859
|
+
"kind": "js",
|
|
9860
|
+
"name": "wrapIf",
|
|
9861
|
+
"declaration": {
|
|
9862
|
+
"name": "wrapIf",
|
|
9863
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9864
|
+
}
|
|
9865
|
+
},
|
|
9866
|
+
{
|
|
9867
|
+
"kind": "js",
|
|
9868
|
+
"name": "wrapIf",
|
|
9869
|
+
"declaration": {
|
|
9870
|
+
"name": "wrapIf",
|
|
9871
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9872
|
+
}
|
|
9873
|
+
},
|
|
9874
|
+
{
|
|
9875
|
+
"kind": "js",
|
|
9876
|
+
"name": "wrapIf",
|
|
9877
|
+
"declaration": {
|
|
9878
|
+
"name": "wrapIf",
|
|
9879
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9880
|
+
}
|
|
9881
|
+
},
|
|
9882
|
+
{
|
|
9883
|
+
"kind": "js",
|
|
9884
|
+
"name": "wrapIf",
|
|
9885
|
+
"declaration": {
|
|
9886
|
+
"name": "wrapIf",
|
|
9887
|
+
"module": "src/common/directives/wrapIf.ts"
|
|
9888
|
+
}
|
|
9889
|
+
}
|
|
9890
|
+
]
|
|
9891
|
+
},
|
|
9624
9892
|
{
|
|
9625
9893
|
"kind": "javascript-module",
|
|
9626
9894
|
"path": "src/common/mixins/DraftComponentMixin.ts",
|