@primer/view-components 0.1.5-rc.fff95e52 → 0.1.5
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/app/assets/javascripts/primer_view_components.js +1 -1
- package/app/assets/javascripts/primer_view_components.js.map +1 -1
- package/app/assets/styles/primer_view_components.css +2 -2
- package/app/assets/styles/primer_view_components.css.map +1 -1
- package/app/components/primer/alpha/action_list.css +1 -1
- package/app/components/primer/alpha/action_list.css.json +4 -0
- package/app/components/primer/alpha/action_menu/action_menu_element.d.ts +22 -0
- package/app/components/primer/alpha/action_menu/action_menu_element.js +139 -0
- package/app/components/primer/alpha/overlay.css +1 -1
- package/app/components/primer/beta/button.css +1 -1
- package/app/components/primer/focus_group.d.ts +19 -0
- package/app/components/primer/focus_group.js +144 -0
- package/app/components/primer/primer.d.ts +2 -0
- package/app/components/primer/primer.js +2 -0
- package/package.json +3 -2
- package/static/arguments.json +105 -13
- package/static/audited_at.json +2 -0
- package/static/constants.json +42 -2
- package/static/info_arch.json +471 -141
- package/static/previews.json +103 -0
- package/static/statuses.json +2 -0
package/static/info_arch.json
CHANGED
|
@@ -9,10 +9,16 @@
|
|
|
9
9
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb",
|
|
10
10
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/default/",
|
|
11
11
|
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "String",
|
|
15
|
+
"default": "`self.class.generate_id`",
|
|
16
|
+
"description": "HTML ID value."
|
|
17
|
+
},
|
|
12
18
|
{
|
|
13
19
|
"name": "role",
|
|
14
20
|
"type": "Boolean",
|
|
15
|
-
"default": "
|
|
21
|
+
"default": "`nil`",
|
|
16
22
|
"description": "ARIA role describing the function of the list. listbox and menu are a common values."
|
|
17
23
|
},
|
|
18
24
|
{
|
|
@@ -33,6 +39,12 @@
|
|
|
33
39
|
"default": "`false`",
|
|
34
40
|
"description": "Display a divider above each item in the list when it does not follow a header or divider."
|
|
35
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "select_variant",
|
|
44
|
+
"type": "Symbol",
|
|
45
|
+
"default": "`:none`",
|
|
46
|
+
"description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`."
|
|
47
|
+
},
|
|
36
48
|
{
|
|
37
49
|
"name": "system_arguments",
|
|
38
50
|
"type": "Hash",
|
|
@@ -78,6 +90,20 @@
|
|
|
78
90
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Divider{{/link_to_component}}."
|
|
79
91
|
}
|
|
80
92
|
]
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "select_variant",
|
|
96
|
+
"description": "Returns the value of attribute select_variant.",
|
|
97
|
+
"parameters": [
|
|
98
|
+
|
|
99
|
+
]
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"name": "role",
|
|
103
|
+
"description": "Returns the value of attribute role.",
|
|
104
|
+
"parameters": [
|
|
105
|
+
|
|
106
|
+
]
|
|
81
107
|
}
|
|
82
108
|
],
|
|
83
109
|
"previews": [
|
|
@@ -280,7 +306,7 @@
|
|
|
280
306
|
"name": "active",
|
|
281
307
|
"type": "Boolean",
|
|
282
308
|
"default": "`false`",
|
|
283
|
-
"description": "
|
|
309
|
+
"description": "If the parent list's `select_variant` is set to `:single` or `:multiple`, causes this item to render checked."
|
|
284
310
|
},
|
|
285
311
|
{
|
|
286
312
|
"name": "on_click",
|
|
@@ -430,10 +456,10 @@
|
|
|
430
456
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
|
|
431
457
|
"parameters": [
|
|
432
458
|
{
|
|
433
|
-
"name": "
|
|
459
|
+
"name": "id",
|
|
434
460
|
"type": "String",
|
|
435
|
-
"default": "
|
|
436
|
-
"description": "The
|
|
461
|
+
"default": "`self.class.generate_id`",
|
|
462
|
+
"description": "The group's identifier (ID attribute in HTML)."
|
|
437
463
|
},
|
|
438
464
|
{
|
|
439
465
|
"name": "title",
|
|
@@ -476,7 +502,13 @@
|
|
|
476
502
|
|
|
477
503
|
],
|
|
478
504
|
"methods": [
|
|
505
|
+
{
|
|
506
|
+
"name": "id",
|
|
507
|
+
"description": "Returns the value of attribute id.",
|
|
508
|
+
"parameters": [
|
|
479
509
|
|
|
510
|
+
]
|
|
511
|
+
}
|
|
480
512
|
],
|
|
481
513
|
"previews": [
|
|
482
514
|
|
|
@@ -523,6 +555,310 @@
|
|
|
523
555
|
}
|
|
524
556
|
]
|
|
525
557
|
},
|
|
558
|
+
{
|
|
559
|
+
"fully_qualified_name": "Primer::Alpha::ActionMenu",
|
|
560
|
+
"description": "The ActionMenu should be used when a user can select a single option triggering an action from a list of items. Primer will automatically nest an `Item` within a presentational `<li>` tag.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. If one isn't selected, a fallback `:span` will be used. To add functionality, use a `.js` class to create the functionality, or an `onclick` handler.",
|
|
561
|
+
"component": "ActionMenu",
|
|
562
|
+
"status": "alpha",
|
|
563
|
+
"a11y_reviewed": false,
|
|
564
|
+
"short_name": "ActionMenu",
|
|
565
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb",
|
|
566
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/",
|
|
567
|
+
"parameters": [
|
|
568
|
+
{
|
|
569
|
+
"name": "menu_id",
|
|
570
|
+
"type": "String",
|
|
571
|
+
"default": "`self.class.generate_id`",
|
|
572
|
+
"description": "Id of the menu."
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "anchor_align",
|
|
576
|
+
"type": "Symbol",
|
|
577
|
+
"default": "`:start`",
|
|
578
|
+
"description": "One of `:center`, `:end`, or `:start`.."
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"name": "anchor_side",
|
|
582
|
+
"type": "Symbol",
|
|
583
|
+
"default": "`:outside_bottom`",
|
|
584
|
+
"description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.."
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"name": "src",
|
|
588
|
+
"type": "String",
|
|
589
|
+
"default": "`nil`",
|
|
590
|
+
"description": "Used with an `include-fragment` element to load menu content from the given source URL."
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"name": "preload",
|
|
594
|
+
"type": "Boolean",
|
|
595
|
+
"default": "`false`",
|
|
596
|
+
"description": "When true, and src is present, loads the `include-fragment` on trigger hover."
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "dynamic_label",
|
|
600
|
+
"type": "Boolean",
|
|
601
|
+
"default": "`false`",
|
|
602
|
+
"description": "Whether or not to display the text of the currently selected item in the show button."
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"name": "dynamic_label_prefix",
|
|
606
|
+
"type": "String",
|
|
607
|
+
"default": "`nil`",
|
|
608
|
+
"description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
"name": "select_variant",
|
|
612
|
+
"type": "Symbol",
|
|
613
|
+
"default": "`:none`",
|
|
614
|
+
"description": ". One of `:multiple`, `:none`, or `:single`.."
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "system_arguments",
|
|
618
|
+
"type": "Hash",
|
|
619
|
+
"default": "N/A",
|
|
620
|
+
"description": "{{link_to_system_arguments_docs}}."
|
|
621
|
+
}
|
|
622
|
+
],
|
|
623
|
+
"slots": [
|
|
624
|
+
|
|
625
|
+
],
|
|
626
|
+
"methods": [
|
|
627
|
+
{
|
|
628
|
+
"name": "list",
|
|
629
|
+
"description": "Returns the value of attribute list.",
|
|
630
|
+
"parameters": [
|
|
631
|
+
|
|
632
|
+
]
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"name": "preload",
|
|
636
|
+
"description": "Returns the value of attribute preload.",
|
|
637
|
+
"parameters": [
|
|
638
|
+
|
|
639
|
+
]
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
"name": "preload?",
|
|
643
|
+
"description": "Returns the value of attribute preload.",
|
|
644
|
+
"parameters": [
|
|
645
|
+
|
|
646
|
+
]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "with_show_button",
|
|
650
|
+
"description": "Button to activate the menu. This may be a {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}} or {{#link_to_component}}Primer::IconButton{{/link_to_component}}.",
|
|
651
|
+
"parameters": [
|
|
652
|
+
{
|
|
653
|
+
"name": "icon",
|
|
654
|
+
"type": "Symbol",
|
|
655
|
+
"default": "N/A",
|
|
656
|
+
"description": "Set this to an [Octicon name](https://primer.style/octicons/) when you want to render an `IconButton`. Otherwise, this renders as a {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}}."
|
|
657
|
+
}
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
"name": "with_item",
|
|
662
|
+
"description": "Adds a new item to the list.",
|
|
663
|
+
"parameters": [
|
|
664
|
+
{
|
|
665
|
+
"name": "system_arguments",
|
|
666
|
+
"type": "Hash",
|
|
667
|
+
"default": "N/A",
|
|
668
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
669
|
+
}
|
|
670
|
+
]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "items",
|
|
674
|
+
"description": "Retrieves the list of items.",
|
|
675
|
+
"parameters": [
|
|
676
|
+
|
|
677
|
+
]
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"name": "with_divider",
|
|
681
|
+
"description": "Adds a divider to the list.",
|
|
682
|
+
"parameters": [
|
|
683
|
+
{
|
|
684
|
+
"name": "system_arguments",
|
|
685
|
+
"type": "Hash",
|
|
686
|
+
"default": "N/A",
|
|
687
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}}'s `divider` slot."
|
|
688
|
+
}
|
|
689
|
+
]
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"previews": [
|
|
693
|
+
{
|
|
694
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/playground",
|
|
695
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/playground",
|
|
696
|
+
"name": "playground"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/default",
|
|
700
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/default",
|
|
701
|
+
"name": "default"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_icon_button",
|
|
705
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/with_icon_button",
|
|
706
|
+
"name": "with_icon_button"
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/single_select",
|
|
710
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/single_select",
|
|
711
|
+
"name": "single_select"
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/multiple_select",
|
|
715
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/multiple_select",
|
|
716
|
+
"name": "multiple_select"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/links",
|
|
720
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/links",
|
|
721
|
+
"name": "links"
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/single_selected_item",
|
|
725
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/single_selected_item",
|
|
726
|
+
"name": "single_selected_item"
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/single_select_with_internal_label",
|
|
730
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/single_select_with_internal_label",
|
|
731
|
+
"name": "single_select_with_internal_label"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/multiple_selected_items",
|
|
735
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/multiple_selected_items",
|
|
736
|
+
"name": "multiple_selected_items"
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_deferred_content",
|
|
740
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/with_deferred_content",
|
|
741
|
+
"name": "with_deferred_content"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_deferred_preloaded_content",
|
|
745
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/with_deferred_preloaded_content",
|
|
746
|
+
"name": "with_deferred_preloaded_content"
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_actions",
|
|
750
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/with_actions",
|
|
751
|
+
"name": "with_actions"
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_disabled_items",
|
|
755
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/with_disabled_items",
|
|
756
|
+
"name": "with_disabled_items"
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/opens_dialog",
|
|
760
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/opens_dialog",
|
|
761
|
+
"name": "opens_dialog"
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/align_end",
|
|
765
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/align_end",
|
|
766
|
+
"name": "align_end"
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/block_description",
|
|
770
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/block_description",
|
|
771
|
+
"name": "block_description"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/inline_description",
|
|
775
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/inline_description",
|
|
776
|
+
"name": "inline_description"
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/leading_visual",
|
|
780
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/leading_visual",
|
|
781
|
+
"name": "leading_visual"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"inspect_path": "/lookbook/inspect/primer/alpha/action_menu/leading_visual_single_select",
|
|
785
|
+
"preview_path": "/lookbook/preview/primer/alpha/action_menu/leading_visual_single_select",
|
|
786
|
+
"name": "leading_visual_single_select"
|
|
787
|
+
}
|
|
788
|
+
],
|
|
789
|
+
"subcomponents": [
|
|
790
|
+
{
|
|
791
|
+
"fully_qualified_name": "Primer::Alpha::ActionMenu::List",
|
|
792
|
+
"description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.",
|
|
793
|
+
"component": "ActionMenu::List",
|
|
794
|
+
"status": "alpha",
|
|
795
|
+
"a11y_reviewed": false,
|
|
796
|
+
"short_name": "ActionMenuList",
|
|
797
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb",
|
|
798
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/",
|
|
799
|
+
"parameters": [
|
|
800
|
+
{
|
|
801
|
+
"name": "menu_id",
|
|
802
|
+
"type": "String",
|
|
803
|
+
"default": "N/A",
|
|
804
|
+
"description": "ID of the parent menu."
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"name": "system_arguments",
|
|
808
|
+
"type": "Hash",
|
|
809
|
+
"default": "N/A",
|
|
810
|
+
"description": "{{link_to_system_arguments_docs}}"
|
|
811
|
+
}
|
|
812
|
+
],
|
|
813
|
+
"slots": [
|
|
814
|
+
{
|
|
815
|
+
"name": "heading",
|
|
816
|
+
"description": "Heading text rendered above the list of items.",
|
|
817
|
+
"parameters": [
|
|
818
|
+
{
|
|
819
|
+
"name": "system_arguments",
|
|
820
|
+
"type": "Hash",
|
|
821
|
+
"default": "N/A",
|
|
822
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
|
823
|
+
}
|
|
824
|
+
]
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"name": "items",
|
|
828
|
+
"description": "Items.",
|
|
829
|
+
"parameters": [
|
|
830
|
+
{
|
|
831
|
+
"name": "system_arguments",
|
|
832
|
+
"type": "Hash",
|
|
833
|
+
"default": "N/A",
|
|
834
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
835
|
+
}
|
|
836
|
+
]
|
|
837
|
+
}
|
|
838
|
+
],
|
|
839
|
+
"methods": [
|
|
840
|
+
{
|
|
841
|
+
"name": "with_item",
|
|
842
|
+
"description": "Adds a new item to the list.",
|
|
843
|
+
"parameters": [
|
|
844
|
+
{
|
|
845
|
+
"name": "system_arguments",
|
|
846
|
+
"type": "Hash",
|
|
847
|
+
"default": "N/A",
|
|
848
|
+
"description": "The same arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
849
|
+
}
|
|
850
|
+
]
|
|
851
|
+
}
|
|
852
|
+
],
|
|
853
|
+
"previews": [
|
|
854
|
+
|
|
855
|
+
],
|
|
856
|
+
"subcomponents": [
|
|
857
|
+
|
|
858
|
+
]
|
|
859
|
+
}
|
|
860
|
+
]
|
|
861
|
+
},
|
|
526
862
|
{
|
|
527
863
|
"fully_qualified_name": "Primer::Alpha::AutoComplete",
|
|
528
864
|
"description": "Use `AutoComplete` to provide a user with a list of selectable suggestions that appear when they type into the\ninput field. This list is populated by server search results.",
|
|
@@ -1321,20 +1657,38 @@
|
|
|
1321
1657
|
],
|
|
1322
1658
|
"subcomponents": [
|
|
1323
1659
|
{
|
|
1324
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
|
1325
|
-
"description": "A `Dialog::
|
|
1326
|
-
"component": "Dialog::
|
|
1660
|
+
"fully_qualified_name": "Primer::Alpha::Dialog::Header",
|
|
1661
|
+
"description": "A `Dialog::Header` is a compositional component, used to render the\nHeader of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
|
|
1662
|
+
"component": "Dialog::Header",
|
|
1327
1663
|
"status": "alpha",
|
|
1328
1664
|
"a11y_reviewed": true,
|
|
1329
|
-
"short_name": "
|
|
1330
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
|
1331
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
|
1665
|
+
"short_name": "DialogHeader",
|
|
1666
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
|
|
1667
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
|
|
1332
1668
|
"parameters": [
|
|
1669
|
+
{
|
|
1670
|
+
"name": "title",
|
|
1671
|
+
"type": "String",
|
|
1672
|
+
"default": "N/A",
|
|
1673
|
+
"description": "Describes the content of the dialog."
|
|
1674
|
+
},
|
|
1675
|
+
{
|
|
1676
|
+
"name": "subtitle",
|
|
1677
|
+
"type": "String",
|
|
1678
|
+
"default": "`nil`",
|
|
1679
|
+
"description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
|
|
1680
|
+
},
|
|
1333
1681
|
{
|
|
1334
1682
|
"name": "show_divider",
|
|
1335
1683
|
"type": "Boolean",
|
|
1336
1684
|
"default": "`false`",
|
|
1337
|
-
"description": "Show a divider between the
|
|
1685
|
+
"description": "Show a divider between the header and body."
|
|
1686
|
+
},
|
|
1687
|
+
{
|
|
1688
|
+
"name": "visually_hide_title",
|
|
1689
|
+
"type": "Boolean",
|
|
1690
|
+
"default": "`false`",
|
|
1691
|
+
"description": "Visually hide the `title` while maintaining a label for assistive technologies."
|
|
1338
1692
|
},
|
|
1339
1693
|
{
|
|
1340
1694
|
"name": "system_arguments",
|
|
@@ -1357,38 +1711,20 @@
|
|
|
1357
1711
|
]
|
|
1358
1712
|
},
|
|
1359
1713
|
{
|
|
1360
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
|
1361
|
-
"description": "A `Dialog::
|
|
1362
|
-
"component": "Dialog::
|
|
1714
|
+
"fully_qualified_name": "Primer::Alpha::Dialog::Footer",
|
|
1715
|
+
"description": "A `Dialog::Footer` is a compositional component, used to render the\nFooter of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
|
|
1716
|
+
"component": "Dialog::Footer",
|
|
1363
1717
|
"status": "alpha",
|
|
1364
1718
|
"a11y_reviewed": true,
|
|
1365
|
-
"short_name": "
|
|
1366
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
|
1367
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
|
1719
|
+
"short_name": "DialogFooter",
|
|
1720
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
|
|
1721
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
|
|
1368
1722
|
"parameters": [
|
|
1369
|
-
{
|
|
1370
|
-
"name": "title",
|
|
1371
|
-
"type": "String",
|
|
1372
|
-
"default": "N/A",
|
|
1373
|
-
"description": "Describes the content of the dialog."
|
|
1374
|
-
},
|
|
1375
|
-
{
|
|
1376
|
-
"name": "subtitle",
|
|
1377
|
-
"type": "String",
|
|
1378
|
-
"default": "`nil`",
|
|
1379
|
-
"description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
|
|
1380
|
-
},
|
|
1381
1723
|
{
|
|
1382
1724
|
"name": "show_divider",
|
|
1383
1725
|
"type": "Boolean",
|
|
1384
1726
|
"default": "`false`",
|
|
1385
|
-
"description": "Show a divider between the
|
|
1386
|
-
},
|
|
1387
|
-
{
|
|
1388
|
-
"name": "visually_hide_title",
|
|
1389
|
-
"type": "Boolean",
|
|
1390
|
-
"default": "`false`",
|
|
1391
|
-
"description": "Visually hide the `title` while maintaining a label for assistive technologies."
|
|
1727
|
+
"description": "Show a divider between the footer and body."
|
|
1392
1728
|
},
|
|
1393
1729
|
{
|
|
1394
1730
|
"name": "system_arguments",
|
|
@@ -2514,101 +2850,6 @@
|
|
|
2514
2850
|
}
|
|
2515
2851
|
],
|
|
2516
2852
|
"subcomponents": [
|
|
2517
|
-
{
|
|
2518
|
-
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
|
2519
|
-
"description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
|
|
2520
|
-
"component": "NavList::Group",
|
|
2521
|
-
"status": "alpha",
|
|
2522
|
-
"a11y_reviewed": false,
|
|
2523
|
-
"short_name": "NavListGroup",
|
|
2524
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
|
|
2525
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
|
|
2526
|
-
"parameters": [
|
|
2527
|
-
{
|
|
2528
|
-
"name": "selected_item_id",
|
|
2529
|
-
"type": "Symbol",
|
|
2530
|
-
"default": "`nil`",
|
|
2531
|
-
"description": "The ID of the currently selected item. Used internally."
|
|
2532
|
-
},
|
|
2533
|
-
{
|
|
2534
|
-
"name": "system_arguments",
|
|
2535
|
-
"type": "Hash",
|
|
2536
|
-
"default": "N/A",
|
|
2537
|
-
"description": "{{link_to_system_arguments_docs}}"
|
|
2538
|
-
}
|
|
2539
|
-
],
|
|
2540
|
-
"slots": [
|
|
2541
|
-
{
|
|
2542
|
-
"name": "show_more_item",
|
|
2543
|
-
"description": "A special \"show more\" list item that appears at the bottom of the group. Clicking\nthe item will fetch the next page of results from the URL passed in the `src` argument\nand append the resulting chunk of HTML to the group.",
|
|
2544
|
-
"parameters": [
|
|
2545
|
-
{
|
|
2546
|
-
"name": "src",
|
|
2547
|
-
"type": "String",
|
|
2548
|
-
"default": "N/A",
|
|
2549
|
-
"description": "The URL to query for additional pages of list items."
|
|
2550
|
-
},
|
|
2551
|
-
{
|
|
2552
|
-
"name": "pages",
|
|
2553
|
-
"type": "Integer",
|
|
2554
|
-
"default": "N/A",
|
|
2555
|
-
"description": "The total number of pages in the result set."
|
|
2556
|
-
},
|
|
2557
|
-
{
|
|
2558
|
-
"name": "component_klass",
|
|
2559
|
-
"type": "Class",
|
|
2560
|
-
"default": "N/A",
|
|
2561
|
-
"description": "A component class to use instead of the default `Primer::Alpha::NavList::Item` class."
|
|
2562
|
-
},
|
|
2563
|
-
{
|
|
2564
|
-
"name": "system_arguments",
|
|
2565
|
-
"type": "Hash",
|
|
2566
|
-
"default": "N/A",
|
|
2567
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
|
|
2568
|
-
}
|
|
2569
|
-
]
|
|
2570
|
-
},
|
|
2571
|
-
{
|
|
2572
|
-
"name": "items",
|
|
2573
|
-
"description": "Items.",
|
|
2574
|
-
"parameters": [
|
|
2575
|
-
{
|
|
2576
|
-
"name": "system_arguments",
|
|
2577
|
-
"type": "Hash",
|
|
2578
|
-
"default": "N/A",
|
|
2579
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
|
|
2580
|
-
}
|
|
2581
|
-
]
|
|
2582
|
-
},
|
|
2583
|
-
{
|
|
2584
|
-
"name": "heading",
|
|
2585
|
-
"description": "Heading text rendered above the list of items.",
|
|
2586
|
-
"parameters": [
|
|
2587
|
-
{
|
|
2588
|
-
"name": "system_arguments",
|
|
2589
|
-
"type": "Hash",
|
|
2590
|
-
"default": "N/A",
|
|
2591
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
|
2592
|
-
}
|
|
2593
|
-
]
|
|
2594
|
-
}
|
|
2595
|
-
],
|
|
2596
|
-
"methods": [
|
|
2597
|
-
{
|
|
2598
|
-
"name": "expand!",
|
|
2599
|
-
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
|
2600
|
-
"parameters": [
|
|
2601
|
-
|
|
2602
|
-
]
|
|
2603
|
-
}
|
|
2604
|
-
],
|
|
2605
|
-
"previews": [
|
|
2606
|
-
|
|
2607
|
-
],
|
|
2608
|
-
"subcomponents": [
|
|
2609
|
-
|
|
2610
|
-
]
|
|
2611
|
-
},
|
|
2612
2853
|
{
|
|
2613
2854
|
"fully_qualified_name": "Primer::Alpha::NavList::Item",
|
|
2614
2855
|
"description": "Items are rendered as styled links. They can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters. Items are selected by ID. IDs can be specified via the\n`selected_item_ids` argument, which accepts a list of valid IDs for the item. Items can also\nthemselves contain sub items. Sub items are rendered collapsed by default.",
|
|
@@ -2757,6 +2998,101 @@
|
|
|
2757
2998
|
],
|
|
2758
2999
|
"subcomponents": [
|
|
2759
3000
|
|
|
3001
|
+
]
|
|
3002
|
+
},
|
|
3003
|
+
{
|
|
3004
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
|
3005
|
+
"description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
|
|
3006
|
+
"component": "NavList::Group",
|
|
3007
|
+
"status": "alpha",
|
|
3008
|
+
"a11y_reviewed": false,
|
|
3009
|
+
"short_name": "NavListGroup",
|
|
3010
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
|
|
3011
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
|
|
3012
|
+
"parameters": [
|
|
3013
|
+
{
|
|
3014
|
+
"name": "selected_item_id",
|
|
3015
|
+
"type": "Symbol",
|
|
3016
|
+
"default": "`nil`",
|
|
3017
|
+
"description": "The ID of the currently selected item. Used internally."
|
|
3018
|
+
},
|
|
3019
|
+
{
|
|
3020
|
+
"name": "system_arguments",
|
|
3021
|
+
"type": "Hash",
|
|
3022
|
+
"default": "N/A",
|
|
3023
|
+
"description": "{{link_to_system_arguments_docs}}"
|
|
3024
|
+
}
|
|
3025
|
+
],
|
|
3026
|
+
"slots": [
|
|
3027
|
+
{
|
|
3028
|
+
"name": "show_more_item",
|
|
3029
|
+
"description": "A special \"show more\" list item that appears at the bottom of the group. Clicking\nthe item will fetch the next page of results from the URL passed in the `src` argument\nand append the resulting chunk of HTML to the group.",
|
|
3030
|
+
"parameters": [
|
|
3031
|
+
{
|
|
3032
|
+
"name": "src",
|
|
3033
|
+
"type": "String",
|
|
3034
|
+
"default": "N/A",
|
|
3035
|
+
"description": "The URL to query for additional pages of list items."
|
|
3036
|
+
},
|
|
3037
|
+
{
|
|
3038
|
+
"name": "pages",
|
|
3039
|
+
"type": "Integer",
|
|
3040
|
+
"default": "N/A",
|
|
3041
|
+
"description": "The total number of pages in the result set."
|
|
3042
|
+
},
|
|
3043
|
+
{
|
|
3044
|
+
"name": "component_klass",
|
|
3045
|
+
"type": "Class",
|
|
3046
|
+
"default": "N/A",
|
|
3047
|
+
"description": "A component class to use instead of the default `Primer::Alpha::NavList::Item` class."
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
"name": "system_arguments",
|
|
3051
|
+
"type": "Hash",
|
|
3052
|
+
"default": "N/A",
|
|
3053
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
|
|
3054
|
+
}
|
|
3055
|
+
]
|
|
3056
|
+
},
|
|
3057
|
+
{
|
|
3058
|
+
"name": "items",
|
|
3059
|
+
"description": "Items.",
|
|
3060
|
+
"parameters": [
|
|
3061
|
+
{
|
|
3062
|
+
"name": "system_arguments",
|
|
3063
|
+
"type": "Hash",
|
|
3064
|
+
"default": "N/A",
|
|
3065
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
|
|
3066
|
+
}
|
|
3067
|
+
]
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"name": "heading",
|
|
3071
|
+
"description": "Heading text rendered above the list of items.",
|
|
3072
|
+
"parameters": [
|
|
3073
|
+
{
|
|
3074
|
+
"name": "system_arguments",
|
|
3075
|
+
"type": "Hash",
|
|
3076
|
+
"default": "N/A",
|
|
3077
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
|
3078
|
+
}
|
|
3079
|
+
]
|
|
3080
|
+
}
|
|
3081
|
+
],
|
|
3082
|
+
"methods": [
|
|
3083
|
+
{
|
|
3084
|
+
"name": "expand!",
|
|
3085
|
+
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
|
3086
|
+
"parameters": [
|
|
3087
|
+
|
|
3088
|
+
]
|
|
3089
|
+
}
|
|
3090
|
+
],
|
|
3091
|
+
"previews": [
|
|
3092
|
+
|
|
3093
|
+
],
|
|
3094
|
+
"subcomponents": [
|
|
3095
|
+
|
|
2760
3096
|
]
|
|
2761
3097
|
}
|
|
2762
3098
|
]
|
|
@@ -2944,12 +3280,6 @@
|
|
|
2944
3280
|
"default": "`:auto`",
|
|
2945
3281
|
"description": "The popover behaviour. One of `:auto` or `:manual`."
|
|
2946
3282
|
},
|
|
2947
|
-
{
|
|
2948
|
-
"name": "popover",
|
|
2949
|
-
"type": "Symbol",
|
|
2950
|
-
"default": "`:auto`",
|
|
2951
|
-
"description": "The popover behaviour. One of `:auto` or `:manual`."
|
|
2952
|
-
},
|
|
2953
3283
|
{
|
|
2954
3284
|
"name": "size",
|
|
2955
3285
|
"type": "Symbol",
|
|
@@ -3001,8 +3331,8 @@
|
|
|
3001
3331
|
{
|
|
3002
3332
|
"name": "role",
|
|
3003
3333
|
"type": "String",
|
|
3004
|
-
"default": "
|
|
3005
|
-
"description": "The ARIA role. One of `:dialog
|
|
3334
|
+
"default": "`nil`",
|
|
3335
|
+
"description": "The ARIA role. One of `nil`, `:dialog`, or `:menu`."
|
|
3006
3336
|
},
|
|
3007
3337
|
{
|
|
3008
3338
|
"name": "system_arguments",
|
|
@@ -5653,7 +5983,7 @@
|
|
|
5653
5983
|
"slots": [
|
|
5654
5984
|
{
|
|
5655
5985
|
"name": "header",
|
|
5656
|
-
"description": "Optional Header.\n\nWhen using header.
|
|
5986
|
+
"description": "Optional Header.\n\nWhen using header.with_title, the recommended tag is a heading tag, such as h1, h2, h3, etc.",
|
|
5657
5987
|
"parameters": [
|
|
5658
5988
|
{
|
|
5659
5989
|
"name": "system_arguments",
|