@primer/view-components 0.4.0-rc.26cca393 → 0.4.0-rc.5f73084c

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.
@@ -1,4 +1,187 @@
1
1
  [
2
+ {
3
+ "fully_qualified_name": "Primer::Alpha::ActionBar",
4
+ "description": "Add a general description of component here\nAdd additional usage considerations or best practices that may aid the user to use the component correctly.",
5
+ "is_form_component": false,
6
+ "is_published": true,
7
+ "requires_js": false,
8
+ "component": "ActionBar",
9
+ "status": "alpha",
10
+ "a11y_reviewed": false,
11
+ "short_name": "ActionBar",
12
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar.rb",
13
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/default/",
14
+ "parameters": [
15
+ {
16
+ "name": "size",
17
+ "type": "Symbol",
18
+ "default": "`:medium`",
19
+ "description": "One of `:large`, `:medium`, or `:small`."
20
+ },
21
+ {
22
+ "name": "overflow_menu",
23
+ "type": "Boolean",
24
+ "default": "`true`",
25
+ "description": "Whether to render the overflow menu."
26
+ },
27
+ {
28
+ "name": "system_arguments",
29
+ "type": "Hash",
30
+ "default": "N/A",
31
+ "description": "{{link_to_system_arguments_docs}}"
32
+ }
33
+ ],
34
+ "slots": [
35
+ {
36
+ "name": "items",
37
+ "description": null,
38
+ "parameters": [
39
+
40
+ ]
41
+ }
42
+ ],
43
+ "methods": [
44
+
45
+ ],
46
+ "previews": [
47
+ {
48
+ "preview_path": "primer/alpha/action_bar/default",
49
+ "name": "default",
50
+ "snapshot": "true",
51
+ "skip_rules": {
52
+ "wont_fix": [
53
+ "region"
54
+ ],
55
+ "will_fix": [
56
+ "color-contrast"
57
+ ]
58
+ }
59
+ },
60
+ {
61
+ "preview_path": "primer/alpha/action_bar/inline",
62
+ "name": "inline",
63
+ "snapshot": "false",
64
+ "skip_rules": {
65
+ "wont_fix": [
66
+ "region"
67
+ ],
68
+ "will_fix": [
69
+ "color-contrast"
70
+ ]
71
+ }
72
+ },
73
+ {
74
+ "preview_path": "primer/alpha/action_bar/playground",
75
+ "name": "playground",
76
+ "snapshot": "false",
77
+ "skip_rules": {
78
+ "wont_fix": [
79
+ "region"
80
+ ],
81
+ "will_fix": [
82
+ "color-contrast"
83
+ ]
84
+ }
85
+ },
86
+ {
87
+ "preview_path": "primer/alpha/action_bar/small",
88
+ "name": "small",
89
+ "snapshot": "false",
90
+ "skip_rules": {
91
+ "wont_fix": [
92
+ "region"
93
+ ],
94
+ "will_fix": [
95
+ "color-contrast"
96
+ ]
97
+ }
98
+ },
99
+ {
100
+ "preview_path": "primer/alpha/action_bar/medium",
101
+ "name": "medium",
102
+ "snapshot": "false",
103
+ "skip_rules": {
104
+ "wont_fix": [
105
+ "region"
106
+ ],
107
+ "will_fix": [
108
+ "color-contrast"
109
+ ]
110
+ }
111
+ },
112
+ {
113
+ "preview_path": "primer/alpha/action_bar/large",
114
+ "name": "large",
115
+ "snapshot": "false",
116
+ "skip_rules": {
117
+ "wont_fix": [
118
+ "region"
119
+ ],
120
+ "will_fix": [
121
+ "color-contrast"
122
+ ]
123
+ }
124
+ }
125
+ ],
126
+ "subcomponents": [
127
+ {
128
+ "fully_qualified_name": "Primer::Alpha::ActionBar::Item",
129
+ "description": "ActionBar::Item is an internal component that wraps the items in a div with the `ActionBar-item` class.",
130
+ "is_form_component": false,
131
+ "is_published": true,
132
+ "requires_js": false,
133
+ "component": "ActionBar::Item",
134
+ "status": "alpha",
135
+ "a11y_reviewed": false,
136
+ "short_name": "ActionBarItem",
137
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/item.rb",
138
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/item/default/",
139
+ "parameters": [
140
+
141
+ ],
142
+ "slots": [
143
+
144
+ ],
145
+ "methods": [
146
+
147
+ ],
148
+ "previews": [
149
+
150
+ ],
151
+ "subcomponents": [
152
+
153
+ ]
154
+ },
155
+ {
156
+ "fully_qualified_name": "Primer::Alpha::ActionBar::Divider",
157
+ "description": "ActionBar::Item is an internal component that wraps the items in a div with the `ActionBar-item` class.",
158
+ "is_form_component": false,
159
+ "is_published": true,
160
+ "requires_js": false,
161
+ "component": "ActionBar::Divider",
162
+ "status": "alpha",
163
+ "a11y_reviewed": false,
164
+ "short_name": "ActionBarDivider",
165
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/divider.rb",
166
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/divider/default/",
167
+ "parameters": [
168
+
169
+ ],
170
+ "slots": [
171
+
172
+ ],
173
+ "methods": [
174
+
175
+ ],
176
+ "previews": [
177
+
178
+ ],
179
+ "subcomponents": [
180
+
181
+ ]
182
+ }
183
+ ]
184
+ },
2
185
  {
3
186
  "fully_qualified_name": "Primer::Alpha::ActionList",
4
187
  "description": "An ActionList is a styled list of links. It acts as the base component for many\nother menu-type components, including `ActionMenu` and `SelectPanel`, as well as\nthe navigational component `NavList`.\n\nEach item in an action list can be augmented by specifying corresponding leading\nand/or trailing visuals.",
@@ -412,6 +595,45 @@
412
595
  }
413
596
  ],
414
597
  "subcomponents": [
598
+ {
599
+ "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
600
+ "description": "Separator with optional text rendered above groups or between individual items.",
601
+ "is_form_component": false,
602
+ "is_published": true,
603
+ "requires_js": false,
604
+ "component": "ActionList::Divider",
605
+ "status": "alpha",
606
+ "a11y_reviewed": false,
607
+ "short_name": "ActionListDivider",
608
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
609
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
610
+ "parameters": [
611
+ {
612
+ "name": "scheme",
613
+ "type": "Symbol",
614
+ "default": "`:subtle`",
615
+ "description": "Display a background color if scheme is `filled`."
616
+ },
617
+ {
618
+ "name": "system_arguments",
619
+ "type": "Hash",
620
+ "default": "N/A",
621
+ "description": "{{link_to_system_arguments_docs}}"
622
+ }
623
+ ],
624
+ "slots": [
625
+
626
+ ],
627
+ "methods": [
628
+
629
+ ],
630
+ "previews": [
631
+
632
+ ],
633
+ "subcomponents": [
634
+
635
+ ]
636
+ },
415
637
  {
416
638
  "fully_qualified_name": "Primer::Alpha::ActionList::Item",
417
639
  "description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.",
@@ -652,6 +874,34 @@
652
874
 
653
875
  ]
654
876
  },
877
+ {
878
+ "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
879
+ "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
880
+ "is_form_component": false,
881
+ "is_published": true,
882
+ "requires_js": false,
883
+ "component": "ActionList::FormWrapper",
884
+ "status": "alpha",
885
+ "a11y_reviewed": false,
886
+ "short_name": "ActionListFormWrapper",
887
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
888
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
889
+ "parameters": [
890
+
891
+ ],
892
+ "slots": [
893
+
894
+ ],
895
+ "methods": [
896
+
897
+ ],
898
+ "previews": [
899
+
900
+ ],
901
+ "subcomponents": [
902
+
903
+ ]
904
+ },
655
905
  {
656
906
  "fully_qualified_name": "Primer::Alpha::ActionList::Heading",
657
907
  "description": "Heading used to describe each sub list within an action list.",
@@ -720,73 +970,6 @@
720
970
  ],
721
971
  "subcomponents": [
722
972
 
723
- ]
724
- },
725
- {
726
- "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
727
- "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
728
- "is_form_component": false,
729
- "is_published": true,
730
- "requires_js": false,
731
- "component": "ActionList::FormWrapper",
732
- "status": "alpha",
733
- "a11y_reviewed": false,
734
- "short_name": "ActionListFormWrapper",
735
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
736
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
737
- "parameters": [
738
-
739
- ],
740
- "slots": [
741
-
742
- ],
743
- "methods": [
744
-
745
- ],
746
- "previews": [
747
-
748
- ],
749
- "subcomponents": [
750
-
751
- ]
752
- },
753
- {
754
- "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
755
- "description": "Separator with optional text rendered above groups or between individual items.",
756
- "is_form_component": false,
757
- "is_published": true,
758
- "requires_js": false,
759
- "component": "ActionList::Divider",
760
- "status": "alpha",
761
- "a11y_reviewed": false,
762
- "short_name": "ActionListDivider",
763
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
764
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
765
- "parameters": [
766
- {
767
- "name": "scheme",
768
- "type": "Symbol",
769
- "default": "`:subtle`",
770
- "description": "Display a background color if scheme is `filled`."
771
- },
772
- {
773
- "name": "system_arguments",
774
- "type": "Hash",
775
- "default": "N/A",
776
- "description": "{{link_to_system_arguments_docs}}"
777
- }
778
- ],
779
- "slots": [
780
-
781
- ],
782
- "methods": [
783
-
784
- ],
785
- "previews": [
786
-
787
- ],
788
- "subcomponents": [
789
-
790
973
  ]
791
974
  }
792
975
  ]
@@ -986,7 +1169,7 @@
986
1169
  {
987
1170
  "preview_path": "primer/alpha/action_menu/default",
988
1171
  "name": "default",
989
- "snapshot": "false",
1172
+ "snapshot": "true",
990
1173
  "skip_rules": {
991
1174
  "wont_fix": [
992
1175
  "region"
@@ -2540,7 +2723,7 @@
2540
2723
  {
2541
2724
  "preview_path": "primer/alpha/dialog/default",
2542
2725
  "name": "default",
2543
- "snapshot": "false",
2726
+ "snapshot": "interactive",
2544
2727
  "skip_rules": {
2545
2728
  "wont_fix": [
2546
2729
  "region"
@@ -2644,41 +2827,23 @@
2644
2827
  ],
2645
2828
  "subcomponents": [
2646
2829
  {
2647
- "fully_qualified_name": "Primer::Alpha::Dialog::Header",
2648
- "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}}.",
2830
+ "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
2831
+ "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}}.",
2649
2832
  "is_form_component": false,
2650
2833
  "is_published": true,
2651
2834
  "requires_js": false,
2652
- "component": "Dialog::Header",
2835
+ "component": "Dialog::Footer",
2653
2836
  "status": "alpha",
2654
2837
  "a11y_reviewed": true,
2655
- "short_name": "DialogHeader",
2656
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
2657
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
2838
+ "short_name": "DialogFooter",
2839
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
2840
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
2658
2841
  "parameters": [
2659
- {
2660
- "name": "title",
2661
- "type": "String",
2662
- "default": "N/A",
2663
- "description": "Describes the content of the dialog."
2664
- },
2665
- {
2666
- "name": "subtitle",
2667
- "type": "String",
2668
- "default": "`nil`",
2669
- "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
2670
- },
2671
2842
  {
2672
2843
  "name": "show_divider",
2673
2844
  "type": "Boolean",
2674
2845
  "default": "`false`",
2675
- "description": "Show a divider between the header and body."
2676
- },
2677
- {
2678
- "name": "visually_hide_title",
2679
- "type": "Boolean",
2680
- "default": "`false`",
2681
- "description": "Visually hide the `title` while maintaining a label for assistive technologies."
2846
+ "description": "Show a divider between the footer and body."
2682
2847
  },
2683
2848
  {
2684
2849
  "name": "system_arguments",
@@ -2701,24 +2866,18 @@
2701
2866
  ]
2702
2867
  },
2703
2868
  {
2704
- "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
2705
- "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}}.",
2869
+ "fully_qualified_name": "Primer::Alpha::Dialog::Body",
2870
+ "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
2706
2871
  "is_form_component": false,
2707
2872
  "is_published": true,
2708
2873
  "requires_js": false,
2709
- "component": "Dialog::Footer",
2874
+ "component": "Dialog::Body",
2710
2875
  "status": "alpha",
2711
2876
  "a11y_reviewed": true,
2712
- "short_name": "DialogFooter",
2713
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
2714
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
2877
+ "short_name": "DialogBody",
2878
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
2879
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
2715
2880
  "parameters": [
2716
- {
2717
- "name": "show_divider",
2718
- "type": "Boolean",
2719
- "default": "`false`",
2720
- "description": "Show a divider between the footer and body."
2721
- },
2722
2881
  {
2723
2882
  "name": "system_arguments",
2724
2883
  "type": "Hash",
@@ -2740,18 +2899,42 @@
2740
2899
  ]
2741
2900
  },
2742
2901
  {
2743
- "fully_qualified_name": "Primer::Alpha::Dialog::Body",
2744
- "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
2902
+ "fully_qualified_name": "Primer::Alpha::Dialog::Header",
2903
+ "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}}.",
2745
2904
  "is_form_component": false,
2746
2905
  "is_published": true,
2747
2906
  "requires_js": false,
2748
- "component": "Dialog::Body",
2907
+ "component": "Dialog::Header",
2749
2908
  "status": "alpha",
2750
2909
  "a11y_reviewed": true,
2751
- "short_name": "DialogBody",
2752
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
2753
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
2910
+ "short_name": "DialogHeader",
2911
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
2912
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
2754
2913
  "parameters": [
2914
+ {
2915
+ "name": "title",
2916
+ "type": "String",
2917
+ "default": "N/A",
2918
+ "description": "Describes the content of the dialog."
2919
+ },
2920
+ {
2921
+ "name": "subtitle",
2922
+ "type": "String",
2923
+ "default": "`nil`",
2924
+ "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
2925
+ },
2926
+ {
2927
+ "name": "show_divider",
2928
+ "type": "Boolean",
2929
+ "default": "`false`",
2930
+ "description": "Show a divider between the header and body."
2931
+ },
2932
+ {
2933
+ "name": "visually_hide_title",
2934
+ "type": "Boolean",
2935
+ "default": "`false`",
2936
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
2937
+ },
2755
2938
  {
2756
2939
  "name": "system_arguments",
2757
2940
  "type": "Hash",
@@ -3052,34 +3235,6 @@
3052
3235
  }
3053
3236
  ],
3054
3237
  "subcomponents": [
3055
- {
3056
- "fully_qualified_name": "Primer::Alpha::Dropdown::Menu::Item",
3057
- "description": "Items to be rendered in the `Dropdown` menu.",
3058
- "is_form_component": false,
3059
- "is_published": true,
3060
- "requires_js": false,
3061
- "component": "Dropdown::Menu::Item",
3062
- "status": "alpha",
3063
- "a11y_reviewed": false,
3064
- "short_name": "DropdownMenuItem",
3065
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu/item.rb",
3066
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/item/default/",
3067
- "parameters": [
3068
-
3069
- ],
3070
- "slots": [
3071
-
3072
- ],
3073
- "methods": [
3074
-
3075
- ],
3076
- "previews": [
3077
-
3078
- ],
3079
- "subcomponents": [
3080
-
3081
- ]
3082
- },
3083
3238
  {
3084
3239
  "fully_qualified_name": "Primer::Alpha::Dropdown::Menu",
3085
3240
  "description": "This component is part of `Dropdown` and should not be\nused as a standalone component.",
@@ -3152,6 +3307,34 @@
3152
3307
  ],
3153
3308
  "subcomponents": [
3154
3309
 
3310
+ ]
3311
+ },
3312
+ {
3313
+ "fully_qualified_name": "Primer::Alpha::Dropdown::Menu::Item",
3314
+ "description": "Items to be rendered in the `Dropdown` menu.",
3315
+ "is_form_component": false,
3316
+ "is_published": true,
3317
+ "requires_js": false,
3318
+ "component": "Dropdown::Menu::Item",
3319
+ "status": "alpha",
3320
+ "a11y_reviewed": false,
3321
+ "short_name": "DropdownMenuItem",
3322
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu/item.rb",
3323
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/item/default/",
3324
+ "parameters": [
3325
+
3326
+ ],
3327
+ "slots": [
3328
+
3329
+ ],
3330
+ "methods": [
3331
+
3332
+ ],
3333
+ "previews": [
3334
+
3335
+ ],
3336
+ "subcomponents": [
3337
+
3155
3338
  ]
3156
3339
  }
3157
3340
  ]
@@ -4552,6 +4735,45 @@
4552
4735
  }
4553
4736
  ],
4554
4737
  "subcomponents": [
4738
+ {
4739
+ "fully_qualified_name": "Primer::Alpha::NavList::Divider",
4740
+ "description": "Separator with optional text rendered above groups or between individual items.",
4741
+ "is_form_component": false,
4742
+ "is_published": true,
4743
+ "requires_js": false,
4744
+ "component": "NavList::Divider",
4745
+ "status": "alpha",
4746
+ "a11y_reviewed": false,
4747
+ "short_name": "NavListDivider",
4748
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
4749
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
4750
+ "parameters": [
4751
+ {
4752
+ "name": "scheme",
4753
+ "type": "Symbol",
4754
+ "default": "`:subtle`",
4755
+ "description": "Display a background color if scheme is `filled`."
4756
+ },
4757
+ {
4758
+ "name": "system_arguments",
4759
+ "type": "Hash",
4760
+ "default": "N/A",
4761
+ "description": "{{link_to_system_arguments_docs}}"
4762
+ }
4763
+ ],
4764
+ "slots": [
4765
+
4766
+ ],
4767
+ "methods": [
4768
+
4769
+ ],
4770
+ "previews": [
4771
+
4772
+ ],
4773
+ "subcomponents": [
4774
+
4775
+ ]
4776
+ },
4555
4777
  {
4556
4778
  "fully_qualified_name": "Primer::Alpha::NavList::Heading",
4557
4779
  "description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
@@ -4602,22 +4824,120 @@
4602
4824
  ]
4603
4825
  },
4604
4826
  {
4605
- "name": "id",
4606
- "description": "Returns the value of attribute id.",
4827
+ "name": "id",
4828
+ "description": "Returns the value of attribute id.",
4829
+ "parameters": [
4830
+
4831
+ ]
4832
+ },
4833
+ {
4834
+ "name": "heading_level",
4835
+ "description": "Returns the value of attribute heading_level.",
4836
+ "parameters": [
4837
+
4838
+ ]
4839
+ },
4840
+ {
4841
+ "name": "system_arguments",
4842
+ "description": "Returns the value of attribute system_arguments.",
4843
+ "parameters": [
4844
+
4845
+ ]
4846
+ }
4847
+ ],
4848
+ "previews": [
4849
+
4850
+ ],
4851
+ "subcomponents": [
4852
+
4853
+ ]
4854
+ },
4855
+ {
4856
+ "fully_qualified_name": "Primer::Alpha::NavList::Group",
4857
+ "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.",
4858
+ "is_form_component": false,
4859
+ "is_published": true,
4860
+ "requires_js": true,
4861
+ "component": "NavList::Group",
4862
+ "status": "alpha",
4863
+ "a11y_reviewed": false,
4864
+ "short_name": "NavListGroup",
4865
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
4866
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
4867
+ "parameters": [
4868
+ {
4869
+ "name": "selected_item_id",
4870
+ "type": "Symbol",
4871
+ "default": "`nil`",
4872
+ "description": "The ID of the currently selected item. Used internally."
4873
+ },
4874
+ {
4875
+ "name": "system_arguments",
4876
+ "type": "Hash",
4877
+ "default": "N/A",
4878
+ "description": "{{link_to_system_arguments_docs}}"
4879
+ }
4880
+ ],
4881
+ "slots": [
4882
+ {
4883
+ "name": "show_more_item",
4884
+ "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.",
4885
+ "parameters": [
4886
+ {
4887
+ "name": "src",
4888
+ "type": "String",
4889
+ "default": "N/A",
4890
+ "description": "The URL to query for additional pages of list items."
4891
+ },
4892
+ {
4893
+ "name": "pages",
4894
+ "type": "Integer",
4895
+ "default": "N/A",
4896
+ "description": "The total number of pages in the result set."
4897
+ },
4898
+ {
4899
+ "name": "component_klass",
4900
+ "type": "Class",
4901
+ "default": "N/A",
4902
+ "description": "A component class to use instead of the default `Primer::Alpha::NavList::Item` class."
4903
+ },
4904
+ {
4905
+ "name": "system_arguments",
4906
+ "type": "Hash",
4907
+ "default": "N/A",
4908
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
4909
+ }
4910
+ ]
4911
+ },
4912
+ {
4913
+ "name": "items",
4914
+ "description": "Items.",
4607
4915
  "parameters": [
4608
-
4916
+ {
4917
+ "name": "system_arguments",
4918
+ "type": "Hash",
4919
+ "default": "N/A",
4920
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
4921
+ }
4609
4922
  ]
4610
4923
  },
4611
4924
  {
4612
- "name": "heading_level",
4613
- "description": "Returns the value of attribute heading_level.",
4925
+ "name": "heading",
4926
+ "description": "Heading text rendered above the list of items.",
4614
4927
  "parameters": [
4615
-
4928
+ {
4929
+ "name": "system_arguments",
4930
+ "type": "Hash",
4931
+ "default": "N/A",
4932
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
4933
+ }
4616
4934
  ]
4617
- },
4935
+ }
4936
+ ],
4937
+ "methods": [
4618
4938
  {
4619
- "name": "system_arguments",
4620
- "description": "Returns the value of attribute system_arguments.",
4939
+ "name": "expand!",
4940
+ "description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
4621
4941
  "parameters": [
4622
4942
 
4623
4943
  ]
@@ -4781,143 +5101,6 @@
4781
5101
  ],
4782
5102
  "subcomponents": [
4783
5103
 
4784
- ]
4785
- },
4786
- {
4787
- "fully_qualified_name": "Primer::Alpha::NavList::Divider",
4788
- "description": "Separator with optional text rendered above groups or between individual items.",
4789
- "is_form_component": false,
4790
- "is_published": true,
4791
- "requires_js": false,
4792
- "component": "NavList::Divider",
4793
- "status": "alpha",
4794
- "a11y_reviewed": false,
4795
- "short_name": "NavListDivider",
4796
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
4797
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
4798
- "parameters": [
4799
- {
4800
- "name": "scheme",
4801
- "type": "Symbol",
4802
- "default": "`:subtle`",
4803
- "description": "Display a background color if scheme is `filled`."
4804
- },
4805
- {
4806
- "name": "system_arguments",
4807
- "type": "Hash",
4808
- "default": "N/A",
4809
- "description": "{{link_to_system_arguments_docs}}"
4810
- }
4811
- ],
4812
- "slots": [
4813
-
4814
- ],
4815
- "methods": [
4816
-
4817
- ],
4818
- "previews": [
4819
-
4820
- ],
4821
- "subcomponents": [
4822
-
4823
- ]
4824
- },
4825
- {
4826
- "fully_qualified_name": "Primer::Alpha::NavList::Group",
4827
- "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.",
4828
- "is_form_component": false,
4829
- "is_published": true,
4830
- "requires_js": true,
4831
- "component": "NavList::Group",
4832
- "status": "alpha",
4833
- "a11y_reviewed": false,
4834
- "short_name": "NavListGroup",
4835
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
4836
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
4837
- "parameters": [
4838
- {
4839
- "name": "selected_item_id",
4840
- "type": "Symbol",
4841
- "default": "`nil`",
4842
- "description": "The ID of the currently selected item. Used internally."
4843
- },
4844
- {
4845
- "name": "system_arguments",
4846
- "type": "Hash",
4847
- "default": "N/A",
4848
- "description": "{{link_to_system_arguments_docs}}"
4849
- }
4850
- ],
4851
- "slots": [
4852
- {
4853
- "name": "show_more_item",
4854
- "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.",
4855
- "parameters": [
4856
- {
4857
- "name": "src",
4858
- "type": "String",
4859
- "default": "N/A",
4860
- "description": "The URL to query for additional pages of list items."
4861
- },
4862
- {
4863
- "name": "pages",
4864
- "type": "Integer",
4865
- "default": "N/A",
4866
- "description": "The total number of pages in the result set."
4867
- },
4868
- {
4869
- "name": "component_klass",
4870
- "type": "Class",
4871
- "default": "N/A",
4872
- "description": "A component class to use instead of the default `Primer::Alpha::NavList::Item` class."
4873
- },
4874
- {
4875
- "name": "system_arguments",
4876
- "type": "Hash",
4877
- "default": "N/A",
4878
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
4879
- }
4880
- ]
4881
- },
4882
- {
4883
- "name": "items",
4884
- "description": "Items.",
4885
- "parameters": [
4886
- {
4887
- "name": "system_arguments",
4888
- "type": "Hash",
4889
- "default": "N/A",
4890
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
4891
- }
4892
- ]
4893
- },
4894
- {
4895
- "name": "heading",
4896
- "description": "Heading text rendered above the list of items.",
4897
- "parameters": [
4898
- {
4899
- "name": "system_arguments",
4900
- "type": "Hash",
4901
- "default": "N/A",
4902
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
4903
- }
4904
- ]
4905
- }
4906
- ],
4907
- "methods": [
4908
- {
4909
- "name": "expand!",
4910
- "description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
4911
- "parameters": [
4912
-
4913
- ]
4914
- }
4915
- ],
4916
- "previews": [
4917
-
4918
- ],
4919
- "subcomponents": [
4920
-
4921
5104
  ]
4922
5105
  }
4923
5106
  ]
@@ -5351,6 +5534,39 @@
5351
5534
  }
5352
5535
  ],
5353
5536
  "subcomponents": [
5537
+ {
5538
+ "fully_qualified_name": "Primer::Alpha::Overlay::Body",
5539
+ "description": "A `Overlay::Body` is a compositional component, used to render the\nBody of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
5540
+ "is_form_component": false,
5541
+ "is_published": true,
5542
+ "requires_js": false,
5543
+ "component": "Overlay::Body",
5544
+ "status": "alpha",
5545
+ "a11y_reviewed": false,
5546
+ "short_name": "OverlayBody",
5547
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb",
5548
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/",
5549
+ "parameters": [
5550
+ {
5551
+ "name": "system_arguments",
5552
+ "type": "Hash",
5553
+ "default": "N/A",
5554
+ "description": "{{link_to_system_arguments_docs}}"
5555
+ }
5556
+ ],
5557
+ "slots": [
5558
+
5559
+ ],
5560
+ "methods": [
5561
+
5562
+ ],
5563
+ "previews": [
5564
+
5565
+ ],
5566
+ "subcomponents": [
5567
+
5568
+ ]
5569
+ },
5354
5570
  {
5355
5571
  "fully_qualified_name": "Primer::Alpha::Overlay::Header",
5356
5572
  "description": "A `Overlay::Header` is a compositional component, used to render the\nHeader of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
@@ -5463,39 +5679,6 @@
5463
5679
  ],
5464
5680
  "subcomponents": [
5465
5681
 
5466
- ]
5467
- },
5468
- {
5469
- "fully_qualified_name": "Primer::Alpha::Overlay::Body",
5470
- "description": "A `Overlay::Body` is a compositional component, used to render the\nBody of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
5471
- "is_form_component": false,
5472
- "is_published": true,
5473
- "requires_js": false,
5474
- "component": "Overlay::Body",
5475
- "status": "alpha",
5476
- "a11y_reviewed": false,
5477
- "short_name": "OverlayBody",
5478
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb",
5479
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/",
5480
- "parameters": [
5481
- {
5482
- "name": "system_arguments",
5483
- "type": "Hash",
5484
- "default": "N/A",
5485
- "description": "{{link_to_system_arguments_docs}}"
5486
- }
5487
- ],
5488
- "slots": [
5489
-
5490
- ],
5491
- "methods": [
5492
-
5493
- ],
5494
- "previews": [
5495
-
5496
- ],
5497
- "subcomponents": [
5498
-
5499
5682
  ]
5500
5683
  }
5501
5684
  ]
@@ -7911,6 +8094,19 @@
7911
8094
  "color-contrast"
7912
8095
  ]
7913
8096
  }
8097
+ },
8098
+ {
8099
+ "preview_path": "primer/alpha/tooltip/tooltip_inside_primer_overlay",
8100
+ "name": "tooltip_inside_primer_overlay",
8101
+ "snapshot": "false",
8102
+ "skip_rules": {
8103
+ "wont_fix": [
8104
+ "region"
8105
+ ],
8106
+ "will_fix": [
8107
+ "color-contrast"
8108
+ ]
8109
+ }
7914
8110
  }
7915
8111
  ],
7916
8112
  "subcomponents": [
@@ -11485,17 +11681,11 @@
11485
11681
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
11486
11682
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/",
11487
11683
  "parameters": [
11488
- {
11489
- "name": "tag",
11490
- "type": "String",
11491
- "default": "`:a`",
11492
- "description": "One of `:a` or `:span`."
11493
- },
11494
11684
  {
11495
11685
  "name": "href",
11496
11686
  "type": "String",
11497
11687
  "default": "`nil`",
11498
- "description": "URL to be used for the Link. Required if tag is `:a`. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
11688
+ "description": "URL to be used for the Link. Required. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
11499
11689
  },
11500
11690
  {
11501
11691
  "name": "scheme",