@primer/view-components 0.10.0-rc.e6e97f9f → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2921,7 +2921,7 @@
2921
2921
  "name": "system_arguments",
2922
2922
  "type": "Hash",
2923
2923
  "default": "N/A",
2924
- "description": "{{link_to_system_arguments_docs}}"
2924
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Dialog::Header{{/link_to_component}}."
2925
2925
  }
2926
2926
  ]
2927
2927
  },
@@ -3005,6 +3005,19 @@
3005
3005
  ]
3006
3006
  }
3007
3007
  },
3008
+ {
3009
+ "preview_path": "primer/alpha/dialog/with_header",
3010
+ "name": "with_header",
3011
+ "snapshot": "false",
3012
+ "skip_rules": {
3013
+ "wont_fix": [
3014
+ "region"
3015
+ ],
3016
+ "will_fix": [
3017
+ "color-contrast"
3018
+ ]
3019
+ }
3020
+ },
3008
3021
  {
3009
3022
  "preview_path": "primer/alpha/dialog/with_footer",
3010
3023
  "name": "with_footer",
@@ -3099,6 +3112,12 @@
3099
3112
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
3100
3113
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
3101
3114
  "parameters": [
3115
+ {
3116
+ "name": "id",
3117
+ "type": "String",
3118
+ "default": "N/A",
3119
+ "description": "The HTML element's ID value."
3120
+ },
3102
3121
  {
3103
3122
  "name": "title",
3104
3123
  "type": "String",
@@ -3123,6 +3142,12 @@
3123
3142
  "default": "`false`",
3124
3143
  "description": "Visually hide the `title` while maintaining a label for assistive technologies."
3125
3144
  },
3145
+ {
3146
+ "name": "variant",
3147
+ "type": "Symbol",
3148
+ "default": "`:medium`",
3149
+ "description": "One of `:large` or `:medium`."
3150
+ },
3126
3151
  {
3127
3152
  "name": "system_arguments",
3128
3153
  "type": "Hash",
@@ -4870,13 +4895,13 @@
4870
4895
  },
4871
4896
  {
4872
4897
  "fully_qualified_name": "Primer::Alpha::NavList",
4873
- "description": "`NavList` provides a simple way to render side navigation, i.e. navigation\nthat appears to the left or right side of some main content. Each group in a\nnav list is a list of links.\n\nNav list groups can contain sub items. Rather than navigating to a URL, groups\nwith sub items expand and collapse on click. To indicate this functionality, the\ngroup will automatically render with a trailing chevron icon that changes direction\nwhen the group expands and collapses.\n\nNav list items appear visually active when selected. Each nav item must have one\nor more ID values that determine which item will appear selected. Use the\n`selected_item_id` argument to select the appropriate item.",
4898
+ "description": "",
4874
4899
  "accessibility_docs": null,
4875
4900
  "is_form_component": false,
4876
4901
  "is_published": true,
4877
4902
  "requires_js": true,
4878
4903
  "component": "NavList",
4879
- "status": "alpha",
4904
+ "status": "deprecated",
4880
4905
  "a11y_reviewed": true,
4881
4906
  "short_name": "NavList",
4882
4907
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
@@ -4898,7 +4923,7 @@
4898
4923
  "slots": [
4899
4924
  {
4900
4925
  "name": "heading",
4901
- "description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Heading{{/link_to_component}}.",
4926
+ "description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Heading{{/link_to_component}}.",
4902
4927
  "parameters": [
4903
4928
 
4904
4929
  ]
@@ -4912,269 +4937,243 @@
4912
4937
  }
4913
4938
  ],
4914
4939
  "methods": [
4940
+
4941
+ ],
4942
+ "previews": [
4943
+
4944
+ ],
4945
+ "subcomponents": [
4915
4946
  {
4916
- "name": "with_item",
4917
- "description": "Adds an item to the list.",
4947
+ "fully_qualified_name": "Primer::Alpha::NavList::Item",
4948
+ "description": "",
4949
+ "accessibility_docs": null,
4950
+ "is_form_component": false,
4951
+ "is_published": true,
4952
+ "requires_js": true,
4953
+ "component": "NavList::Item",
4954
+ "status": "deprecated",
4955
+ "a11y_reviewed": false,
4956
+ "short_name": "NavListItem",
4957
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
4958
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
4918
4959
  "parameters": [
4919
4960
  {
4920
- "name": "component_klass",
4921
- "type": "Class",
4922
- "default": "`Primer::Alpha::NavList::Item`",
4923
- "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
4961
+ "name": "selected_item_id",
4962
+ "type": "Symbol",
4963
+ "default": "`nil`",
4964
+ "description": "The ID of the currently selected list item. Used internally."
4965
+ },
4966
+ {
4967
+ "name": "selected_by_ids",
4968
+ "type": "Array<Symbol>",
4969
+ "default": "`[]`",
4970
+ "description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
4971
+ },
4972
+ {
4973
+ "name": "expanded",
4974
+ "type": "Boolean",
4975
+ "default": "`false`",
4976
+ "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
4977
+ },
4978
+ {
4979
+ "name": "sub_item",
4980
+ "type": "Boolean",
4981
+ "default": "`false`",
4982
+ "description": "Whether or not this item is nested under a parent item. Used internally."
4924
4983
  },
4925
4984
  {
4926
4985
  "name": "system_arguments",
4927
4986
  "type": "Hash",
4928
4987
  "default": "N/A",
4929
- "description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
4988
+ "description": "{{link_to_system_arguments_docs}}"
4930
4989
  }
4931
- ]
4932
- },
4933
- {
4934
- "name": "with_avatar_item",
4935
- "description": "Adds an avatar item to the list. Avatar items are a convenient way to accessibly add an item with a leading avatar image.",
4936
- "parameters": [
4937
- {
4938
- "name": "src",
4939
- "type": "String",
4940
- "default": "N/A",
4941
- "description": "The source url of the avatar image."
4942
- },
4990
+ ],
4991
+ "slots": [
4943
4992
  {
4944
- "name": "username",
4945
- "type": "String",
4946
- "default": "N/A",
4947
- "description": "The username associated with the avatar."
4993
+ "name": "items",
4994
+ "description": null,
4995
+ "parameters": [
4996
+ {
4997
+ "name": "system_arguments",
4998
+ "type": "Hash",
4999
+ "default": "N/A",
5000
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
5001
+ }
5002
+ ]
4948
5003
  },
4949
5004
  {
4950
- "name": "full_name",
4951
- "type": "String",
4952
- "default": "`nil`",
4953
- "description": "Optional. The user's full name."
5005
+ "name": "description",
5006
+ "description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
5007
+ "parameters": [
5008
+
5009
+ ]
4954
5010
  },
4955
5011
  {
4956
- "name": "full_name_scheme",
4957
- "type": "Symbol",
4958
- "default": "`:block`",
4959
- "description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
5012
+ "name": "leading_visual",
5013
+ "description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
5014
+ "parameters": [
5015
+
5016
+ ]
4960
5017
  },
4961
5018
  {
4962
- "name": "component_klass",
4963
- "type": "Class",
4964
- "default": "`Primer::Alpha::NavList::Item`",
4965
- "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
5019
+ "name": "trailing_visual",
5020
+ "description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
5021
+ "parameters": [
5022
+
5023
+ ]
4966
5024
  },
4967
5025
  {
4968
- "name": "avatar_arguments",
4969
- "type": "Hash",
4970
- "default": "`{}`",
4971
- "description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
5026
+ "name": "trailing_action",
5027
+ "description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
5028
+ "parameters": [
5029
+ {
5030
+ "name": "system_arguments",
5031
+ "type": "Hash",
5032
+ "default": "N/A",
5033
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
5034
+ }
5035
+ ]
4972
5036
  },
4973
5037
  {
4974
- "name": "system_arguments",
4975
- "type": "Hash",
4976
- "default": "N/A",
4977
- "description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
5038
+ "name": "tooltip",
5039
+ "description": "`Tooltip` that appears on mouse hover or keyboard focus over the trailing action button. Use tooltips sparingly and as\na last resort. **Important:** This tooltip defaults to `type: :description`. In a few scenarios, `type: :label` may be\nmore appropriate. Consult the {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}} documentation for more information.",
5040
+ "parameters": [
5041
+ {
5042
+ "name": "type",
5043
+ "type": "Symbol",
5044
+ "default": "`:description`",
5045
+ "description": "One of `:description` or `:label`."
5046
+ },
5047
+ {
5048
+ "name": "system_arguments",
5049
+ "type": "Hash",
5050
+ "default": "N/A",
5051
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
5052
+ }
5053
+ ]
4978
5054
  }
5055
+ ],
5056
+ "methods": [
5057
+
5058
+ ],
5059
+ "previews": [
5060
+
5061
+ ],
5062
+ "subcomponents": [
5063
+
4979
5064
  ]
4980
5065
  },
4981
5066
  {
4982
- "name": "with_group",
4983
- "description": "Adds a group to the list. A group is a list of links and a (required) heading.",
5067
+ "fully_qualified_name": "Primer::Alpha::NavList::Heading",
5068
+ "description": "",
5069
+ "accessibility_docs": null,
5070
+ "is_form_component": false,
5071
+ "is_published": true,
5072
+ "requires_js": false,
5073
+ "component": "NavList::Heading",
5074
+ "status": "deprecated",
5075
+ "a11y_reviewed": false,
5076
+ "short_name": "NavListHeading",
5077
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb",
5078
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/",
4984
5079
  "parameters": [
4985
5080
  {
4986
- "name": "system_arguments",
4987
- "type": "Hash",
5081
+ "name": "title",
5082
+ "type": "String",
4988
5083
  "default": "N/A",
4989
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Group{{/link_to_component}}."
4990
- }
4991
- ]
4992
- },
4993
- {
4994
- "name": "with_divider",
4995
- "description": "Adds a divider to the list. Dividers visually separate items and groups.",
4996
- "parameters": [
5084
+ "description": "The text content of the heading."
5085
+ },
5086
+ {
5087
+ "name": "id",
5088
+ "type": "String",
5089
+ "default": "`self.class.generate_id`",
5090
+ "description": "The value of the ID HTML attribute. Auto-generated by default."
5091
+ },
5092
+ {
5093
+ "name": "heading_level",
5094
+ "type": "Integer",
5095
+ "default": "`2`",
5096
+ "description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
5097
+ },
4997
5098
  {
4998
5099
  "name": "system_arguments",
4999
5100
  "type": "Hash",
5000
5101
  "default": "N/A",
5001
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Divider{{/link_to_component}}."
5102
+ "description": "{{link_to_system_arguments_docs}}"
5002
5103
  }
5104
+ ],
5105
+ "slots": [
5106
+
5107
+ ],
5108
+ "methods": [
5109
+
5110
+ ],
5111
+ "previews": [
5112
+
5113
+ ],
5114
+ "subcomponents": [
5115
+
5003
5116
  ]
5004
5117
  },
5005
5118
  {
5006
- "name": "build_item",
5007
- "description": "Builds a new item but does not add it to the list. Use this method\ninstead of the `#with_item` slot if you need to render an item outside\nthe context of a list, eg. if rendering additional items to append to\nan existing list, perhaps via a separate HTTP request.",
5119
+ "fully_qualified_name": "Primer::Alpha::NavList::Divider",
5120
+ "description": "",
5121
+ "accessibility_docs": null,
5122
+ "is_form_component": false,
5123
+ "is_published": true,
5124
+ "requires_js": false,
5125
+ "component": "NavList::Divider",
5126
+ "status": "deprecated",
5127
+ "a11y_reviewed": false,
5128
+ "short_name": "NavListDivider",
5129
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
5130
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
5008
5131
  "parameters": [
5009
5132
  {
5010
- "name": "component_klass",
5011
- "type": "Class",
5012
- "default": "`Primer::Alpha::NavList::Item`",
5013
- "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
5133
+ "name": "scheme",
5134
+ "type": "Symbol",
5135
+ "default": "`:subtle`",
5136
+ "description": "Display a background color if scheme is `filled`."
5014
5137
  },
5015
5138
  {
5016
5139
  "name": "system_arguments",
5017
5140
  "type": "Hash",
5018
5141
  "default": "N/A",
5019
- "description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
5142
+ "description": "{{link_to_system_arguments_docs}}"
5020
5143
  }
5144
+ ],
5145
+ "slots": [
5146
+
5147
+ ],
5148
+ "methods": [
5149
+
5150
+ ],
5151
+ "previews": [
5152
+
5153
+ ],
5154
+ "subcomponents": [
5155
+
5021
5156
  ]
5022
5157
  },
5023
5158
  {
5024
- "name": "build_avatar_item",
5025
- "description": "Builds a new avatar item but does not add it to the list. Avatar items\nare a convenient way to accessibly add an item with a leading avatar\nimage. Use this method instead of the `#with_avatar_item` slot if you\nneed to render an avatar item outside the context of a list, eg. if\nrendering additional items to append to an existing list, perhaps via\na separate HTTP request.",
5026
- "parameters": [
5027
- {
5028
- "name": "src",
5029
- "type": "String",
5030
- "default": "N/A",
5031
- "description": "The source url of the avatar image."
5032
- },
5033
- {
5034
- "name": "username",
5035
- "type": "String",
5036
- "default": "N/A",
5037
- "description": "The username associated with the avatar."
5038
- },
5039
- {
5040
- "name": "full_name",
5041
- "type": "String",
5042
- "default": "`nil`",
5043
- "description": "Optional. The user's full name."
5044
- },
5045
- {
5046
- "name": "full_name_scheme",
5047
- "type": "Symbol",
5048
- "default": "`:block`",
5049
- "description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
5050
- },
5051
- {
5052
- "name": "component_klass",
5053
- "type": "Class",
5054
- "default": "`Primer::Alpha::NavList::Item`",
5055
- "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
5056
- },
5057
- {
5058
- "name": "avatar_arguments",
5059
- "type": "Hash",
5060
- "default": "`{}`",
5061
- "description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
5062
- },
5063
- {
5064
- "name": "system_arguments",
5065
- "type": "Hash",
5066
- "default": "N/A",
5067
- "description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
5068
- }
5069
- ]
5070
- },
5071
- {
5072
- "name": "render_outer_list?",
5073
- "description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
5074
- "parameters": [
5075
-
5076
- ]
5077
- }
5078
- ],
5079
- "previews": [
5080
- {
5081
- "preview_path": "primer/alpha/nav_list/playground",
5082
- "name": "playground",
5083
- "snapshot": "false",
5084
- "skip_rules": {
5085
- "wont_fix": [
5086
- "region"
5087
- ],
5088
- "will_fix": [
5089
- "color-contrast"
5090
- ]
5091
- }
5092
- },
5093
- {
5094
- "preview_path": "primer/alpha/nav_list/default",
5095
- "name": "default",
5096
- "snapshot": "true",
5097
- "skip_rules": {
5098
- "wont_fix": [
5099
- "region"
5100
- ],
5101
- "will_fix": [
5102
- "color-contrast"
5103
- ]
5104
- }
5105
- },
5106
- {
5107
- "preview_path": "primer/alpha/nav_list/top_level_items",
5108
- "name": "top_level_items",
5109
- "snapshot": "false",
5110
- "skip_rules": {
5111
- "wont_fix": [
5112
- "region"
5113
- ],
5114
- "will_fix": [
5115
- "color-contrast"
5116
- ]
5117
- }
5118
- },
5119
- {
5120
- "preview_path": "primer/alpha/nav_list/show_more_item",
5121
- "name": "show_more_item",
5122
- "snapshot": "true",
5123
- "skip_rules": {
5124
- "wont_fix": [
5125
- "region"
5126
- ],
5127
- "will_fix": [
5128
- "color-contrast"
5129
- ]
5130
- }
5131
- },
5132
- {
5133
- "preview_path": "primer/alpha/nav_list/trailing_action",
5134
- "name": "trailing_action",
5135
- "snapshot": "true",
5136
- "skip_rules": {
5137
- "wont_fix": [
5138
- "region"
5139
- ],
5140
- "will_fix": [
5141
- "color-contrast"
5142
- ]
5143
- }
5144
- }
5145
- ],
5146
- "subcomponents": [
5147
- {
5148
- "fully_qualified_name": "Primer::Alpha::NavList::Heading",
5149
- "description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
5159
+ "fully_qualified_name": "Primer::Alpha::NavList::Group",
5160
+ "description": "",
5150
5161
  "accessibility_docs": null,
5151
5162
  "is_form_component": false,
5152
5163
  "is_published": true,
5153
- "requires_js": false,
5154
- "component": "NavList::Heading",
5155
- "status": "alpha",
5156
- "a11y_reviewed": false,
5157
- "short_name": "NavListHeading",
5158
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb",
5159
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/",
5164
+ "requires_js": true,
5165
+ "component": "NavList::Group",
5166
+ "status": "deprecated",
5167
+ "a11y_reviewed": true,
5168
+ "short_name": "NavListGroup",
5169
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
5170
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
5160
5171
  "parameters": [
5161
5172
  {
5162
- "name": "title",
5163
- "type": "String",
5164
- "default": "N/A",
5165
- "description": "The text content of the heading."
5166
- },
5167
- {
5168
- "name": "id",
5169
- "type": "String",
5170
- "default": "`self.class.generate_id`",
5171
- "description": "The value of the ID HTML attribute. Auto-generated by default."
5172
- },
5173
- {
5174
- "name": "heading_level",
5175
- "type": "Integer",
5176
- "default": "`2`",
5177
- "description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
5173
+ "name": "selected_item_id",
5174
+ "type": "Symbol",
5175
+ "default": "`nil`",
5176
+ "description": "The ID of the currently selected item. Used internally."
5178
5177
  },
5179
5178
  {
5180
5179
  "name": "system_arguments",
@@ -5184,37 +5183,63 @@
5184
5183
  }
5185
5184
  ],
5186
5185
  "slots": [
5187
-
5188
- ],
5189
- "methods": [
5190
- {
5191
- "name": "title",
5192
- "description": "Returns the value of attribute title.",
5193
- "parameters": [
5194
-
5195
- ]
5196
- },
5197
5186
  {
5198
- "name": "id",
5199
- "description": "Returns the value of attribute id.",
5187
+ "name": "show_more_item",
5188
+ "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.",
5200
5189
  "parameters": [
5201
-
5190
+ {
5191
+ "name": "src",
5192
+ "type": "String",
5193
+ "default": "N/A",
5194
+ "description": "The URL to query for additional pages of list items."
5195
+ },
5196
+ {
5197
+ "name": "pages",
5198
+ "type": "Integer",
5199
+ "default": "N/A",
5200
+ "description": "The total number of pages in the result set."
5201
+ },
5202
+ {
5203
+ "name": "component_klass",
5204
+ "type": "Class",
5205
+ "default": "N/A",
5206
+ "description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
5207
+ },
5208
+ {
5209
+ "name": "system_arguments",
5210
+ "type": "Hash",
5211
+ "default": "N/A",
5212
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
5213
+ }
5202
5214
  ]
5203
5215
  },
5204
5216
  {
5205
- "name": "heading_level",
5206
- "description": "Returns the value of attribute heading_level.",
5217
+ "name": "items",
5218
+ "description": "Items.",
5207
5219
  "parameters": [
5208
-
5220
+ {
5221
+ "name": "system_arguments",
5222
+ "type": "Hash",
5223
+ "default": "N/A",
5224
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
5225
+ }
5209
5226
  ]
5210
5227
  },
5211
5228
  {
5212
- "name": "system_arguments",
5213
- "description": "Returns the value of attribute system_arguments.",
5229
+ "name": "heading",
5230
+ "description": "Heading text rendered above the list of items.",
5214
5231
  "parameters": [
5215
-
5232
+ {
5233
+ "name": "system_arguments",
5234
+ "type": "Hash",
5235
+ "default": "N/A",
5236
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
5237
+ }
5216
5238
  ]
5217
5239
  }
5240
+ ],
5241
+ "methods": [
5242
+
5218
5243
  ],
5219
5244
  "previews": [
5220
5245
 
@@ -5222,405 +5247,112 @@
5222
5247
  "subcomponents": [
5223
5248
 
5224
5249
  ]
5250
+ }
5251
+ ]
5252
+ },
5253
+ {
5254
+ "fully_qualified_name": "Primer::Alpha::Navigation::Tab",
5255
+ "description": "This component is part of navigation components such as `Primer::Alpha::TabNav`\nand `Primer::Alpha::UnderlineNav` and should not be used by itself.",
5256
+ "accessibility_docs": "`Tab` renders the selected anchor tab with `aria-current=\"page\"` by default.\n When the selected tab does not correspond to the current page, such as in a nested inner tab, make sure to use aria-current=\"true\"",
5257
+ "is_form_component": false,
5258
+ "is_published": true,
5259
+ "requires_js": false,
5260
+ "component": "Navigation::Tab",
5261
+ "status": "alpha",
5262
+ "a11y_reviewed": false,
5263
+ "short_name": "NavigationTab",
5264
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/navigation/tab.rb",
5265
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/navigation/tab/default/",
5266
+ "parameters": [
5267
+ {
5268
+ "name": "list",
5269
+ "type": "Boolean",
5270
+ "default": "`false`",
5271
+ "description": "Whether the Tab is an item in a `<ul>` list."
5225
5272
  },
5226
5273
  {
5227
- "fully_qualified_name": "Primer::Alpha::NavList::Item",
5228
- "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.",
5229
- "accessibility_docs": null,
5230
- "is_form_component": false,
5231
- "is_published": true,
5232
- "requires_js": true,
5233
- "component": "NavList::Item",
5234
- "status": "alpha",
5235
- "a11y_reviewed": false,
5236
- "short_name": "NavListItem",
5237
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
5238
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
5239
- "parameters": [
5240
- {
5241
- "name": "selected_item_id",
5242
- "type": "Symbol",
5243
- "default": "`nil`",
5244
- "description": "The ID of the currently selected list item. Used internally."
5245
- },
5246
- {
5247
- "name": "selected_by_ids",
5248
- "type": "Array<Symbol>",
5249
- "default": "`[]`",
5250
- "description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
5251
- },
5252
- {
5253
- "name": "expanded",
5254
- "type": "Boolean",
5255
- "default": "`false`",
5256
- "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
5257
- },
5258
- {
5259
- "name": "sub_item",
5260
- "type": "Boolean",
5261
- "default": "`false`",
5262
- "description": "Whether or not this item is nested under a parent item. Used internally."
5263
- },
5274
+ "name": "selected",
5275
+ "type": "Boolean",
5276
+ "default": "`false`",
5277
+ "description": "Whether the Tab is selected or not."
5278
+ },
5279
+ {
5280
+ "name": "with_panel",
5281
+ "type": "Boolean",
5282
+ "default": "`false`",
5283
+ "description": "Whether the Tab has an associated panel."
5284
+ },
5285
+ {
5286
+ "name": "panel_id",
5287
+ "type": "String",
5288
+ "default": "`\"\"`",
5289
+ "description": "Only applies if `with_panel` is `true`. Unique id of panel."
5290
+ },
5291
+ {
5292
+ "name": "icon_classes",
5293
+ "type": "Boolean",
5294
+ "default": "`\"\"`",
5295
+ "description": "Classes that must always be applied to icons."
5296
+ },
5297
+ {
5298
+ "name": "wrapper_arguments",
5299
+ "type": "Hash",
5300
+ "default": "`{}`",
5301
+ "description": "{{link_to_system_arguments_docs}} to be used in the `<li>` wrapper when the tab is an item in a list."
5302
+ },
5303
+ {
5304
+ "name": "system_arguments",
5305
+ "type": "Hash",
5306
+ "default": "N/A",
5307
+ "description": "{{link_to_system_arguments_docs}}"
5308
+ }
5309
+ ],
5310
+ "slots": [
5311
+ {
5312
+ "name": "panel",
5313
+ "description": "Panel controlled by the Tab. This will not render anything in the tab itself.\nIt will provide a accessor for the Tab's parent to call and render the panel\ncontent in the appropriate place.\nRefer to `UnderlineNav` and `TabNav` implementations for examples.",
5314
+ "parameters": [
5264
5315
  {
5265
5316
  "name": "system_arguments",
5266
5317
  "type": "Hash",
5267
5318
  "default": "N/A",
5268
5319
  "description": "{{link_to_system_arguments_docs}}"
5269
5320
  }
5270
- ],
5271
- "slots": [
5272
- {
5273
- "name": "items",
5274
- "description": null,
5275
- "parameters": [
5276
- {
5277
- "name": "system_arguments",
5278
- "type": "Hash",
5279
- "default": "N/A",
5280
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
5281
- }
5282
- ]
5283
- },
5284
- {
5285
- "name": "description",
5286
- "description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
5287
- "parameters": [
5288
-
5289
- ]
5290
- },
5291
- {
5292
- "name": "leading_visual",
5293
- "description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
5294
- "parameters": [
5295
-
5296
- ]
5297
- },
5298
- {
5299
- "name": "trailing_visual",
5300
- "description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
5301
- "parameters": [
5302
-
5303
- ]
5304
- },
5305
- {
5306
- "name": "trailing_action",
5307
- "description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
5308
- "parameters": [
5309
- {
5310
- "name": "system_arguments",
5311
- "type": "Hash",
5312
- "default": "N/A",
5313
- "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
5314
- }
5315
- ]
5316
- },
5317
- {
5318
- "name": "tooltip",
5319
- "description": "`Tooltip` that appears on mouse hover or keyboard focus over the trailing action button. Use tooltips sparingly and as\na last resort. **Important:** This tooltip defaults to `type: :description`. In a few scenarios, `type: :label` may be\nmore appropriate. Consult the {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}} documentation for more information.",
5320
- "parameters": [
5321
- {
5322
- "name": "type",
5323
- "type": "Symbol",
5324
- "default": "`:description`",
5325
- "description": "One of `:description` or `:label`."
5326
- },
5327
- {
5328
- "name": "system_arguments",
5329
- "type": "Hash",
5330
- "default": "N/A",
5331
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
5332
- }
5333
- ]
5334
- }
5335
- ],
5336
- "methods": [
5337
- {
5338
- "name": "selected_by_ids",
5339
- "description": "Returns the value of attribute selected_by_ids.",
5340
- "parameters": [
5341
-
5342
- ]
5343
- },
5344
- {
5345
- "name": "sub_item",
5346
- "description": "Returns the value of attribute sub_item.",
5347
- "parameters": [
5348
-
5349
- ]
5350
- },
5351
- {
5352
- "name": "sub_item?",
5353
- "description": "Returns the value of attribute sub_item.\nWhether or not this item is nested under a parent item.",
5354
- "parameters": [
5355
-
5356
- ]
5357
- },
5358
- {
5359
- "name": "expand!",
5360
- "description": "Cause this item to show its list of sub items when rendered.",
5361
- "parameters": [
5362
-
5363
- ]
5364
- },
5321
+ ]
5322
+ },
5323
+ {
5324
+ "name": "icon",
5325
+ "description": "Icon to be rendered in the Tab left.",
5326
+ "parameters": [
5365
5327
  {
5366
- "name": "item_active?",
5367
- "description": "Normally it would be easier to simply ask each item for its active status, eg.\nitems.any?(&:active?), but unfortunately the view context is not set on each\nitem until _after_ the parent's before_render, etc methods have been called.\nThis means helper methods like current_page? will blow up with an error, since\n`helpers` is simply an alias for the view context (i.e. an instance of\nActionView::Base). Since we know the view context for the parent object must\nbe set before `before_render` is invoked, we can call helper methods here in\nthe parent and bypass the problem entirely. Maybe not the most OO approach,\nbut it works.",
5368
- "parameters": [
5369
-
5370
- ]
5328
+ "name": "kwargs",
5329
+ "type": "Hash",
5330
+ "default": "N/A",
5331
+ "description": "The same arguments as {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}."
5371
5332
  }
5372
- ],
5373
- "previews": [
5374
-
5375
- ],
5376
- "subcomponents": [
5377
-
5378
5333
  ]
5379
5334
  },
5380
5335
  {
5381
- "fully_qualified_name": "Primer::Alpha::NavList::Divider",
5382
- "description": "Separator with optional text rendered above groups or between individual items.",
5383
- "accessibility_docs": null,
5384
- "is_form_component": false,
5385
- "is_published": true,
5386
- "requires_js": false,
5387
- "component": "NavList::Divider",
5388
- "status": "alpha",
5389
- "a11y_reviewed": false,
5390
- "short_name": "NavListDivider",
5391
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
5392
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
5336
+ "name": "text",
5337
+ "description": "The Tab's text.",
5393
5338
  "parameters": [
5394
5339
  {
5395
- "name": "scheme",
5396
- "type": "Symbol",
5397
- "default": "`:subtle`",
5398
- "description": "Display a background color if scheme is `filled`."
5399
- },
5400
- {
5401
- "name": "system_arguments",
5340
+ "name": "kwargs",
5402
5341
  "type": "Hash",
5403
5342
  "default": "N/A",
5404
- "description": "{{link_to_system_arguments_docs}}"
5343
+ "description": "The same arguments as {{#link_to_component}}Primer::Beta::Text{{/link_to_component}}."
5405
5344
  }
5406
- ],
5407
- "slots": [
5408
-
5409
- ],
5410
- "methods": [
5411
-
5412
- ],
5413
- "previews": [
5414
-
5415
- ],
5416
- "subcomponents": [
5417
-
5418
5345
  ]
5419
5346
  },
5420
5347
  {
5421
- "fully_qualified_name": "Primer::Alpha::NavList::Group",
5422
- "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.",
5423
- "accessibility_docs": null,
5424
- "is_form_component": false,
5425
- "is_published": true,
5426
- "requires_js": true,
5427
- "component": "NavList::Group",
5428
- "status": "alpha",
5429
- "a11y_reviewed": true,
5430
- "short_name": "NavListGroup",
5431
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
5432
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
5348
+ "name": "counter",
5349
+ "description": "Counter to be rendered in the Tab right.",
5433
5350
  "parameters": [
5434
5351
  {
5435
- "name": "selected_item_id",
5436
- "type": "Symbol",
5437
- "default": "`nil`",
5438
- "description": "The ID of the currently selected item. Used internally."
5439
- },
5440
- {
5441
- "name": "system_arguments",
5352
+ "name": "kwargs",
5442
5353
  "type": "Hash",
5443
5354
  "default": "N/A",
5444
- "description": "{{link_to_system_arguments_docs}}"
5445
- }
5446
- ],
5447
- "slots": [
5448
- {
5449
- "name": "show_more_item",
5450
- "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.",
5451
- "parameters": [
5452
- {
5453
- "name": "src",
5454
- "type": "String",
5455
- "default": "N/A",
5456
- "description": "The URL to query for additional pages of list items."
5457
- },
5458
- {
5459
- "name": "pages",
5460
- "type": "Integer",
5461
- "default": "N/A",
5462
- "description": "The total number of pages in the result set."
5463
- },
5464
- {
5465
- "name": "component_klass",
5466
- "type": "Class",
5467
- "default": "N/A",
5468
- "description": "A component class to use instead of the default `Primer::Alpha::NavList::Item` class."
5469
- },
5470
- {
5471
- "name": "system_arguments",
5472
- "type": "Hash",
5473
- "default": "N/A",
5474
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
5475
- }
5476
- ]
5477
- },
5478
- {
5479
- "name": "items",
5480
- "description": "Items.",
5481
- "parameters": [
5482
- {
5483
- "name": "system_arguments",
5484
- "type": "Hash",
5485
- "default": "N/A",
5486
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
5487
- }
5488
- ]
5489
- },
5490
- {
5491
- "name": "heading",
5492
- "description": "Heading text rendered above the list of items.",
5493
- "parameters": [
5494
- {
5495
- "name": "system_arguments",
5496
- "type": "Hash",
5497
- "default": "N/A",
5498
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
5499
- }
5500
- ]
5501
- }
5502
- ],
5503
- "methods": [
5504
- {
5505
- "name": "expand!",
5506
- "description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
5507
- "parameters": [
5508
-
5509
- ]
5510
- }
5511
- ],
5512
- "previews": [
5513
-
5514
- ],
5515
- "subcomponents": [
5516
-
5517
- ]
5518
- }
5519
- ]
5520
- },
5521
- {
5522
- "fully_qualified_name": "Primer::Alpha::Navigation::Tab",
5523
- "description": "This component is part of navigation components such as `Primer::Alpha::TabNav`\nand `Primer::Alpha::UnderlineNav` and should not be used by itself.",
5524
- "accessibility_docs": "`Tab` renders the selected anchor tab with `aria-current=\"page\"` by default.\n When the selected tab does not correspond to the current page, such as in a nested inner tab, make sure to use aria-current=\"true\"",
5525
- "is_form_component": false,
5526
- "is_published": true,
5527
- "requires_js": false,
5528
- "component": "Navigation::Tab",
5529
- "status": "alpha",
5530
- "a11y_reviewed": false,
5531
- "short_name": "NavigationTab",
5532
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/navigation/tab.rb",
5533
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/navigation/tab/default/",
5534
- "parameters": [
5535
- {
5536
- "name": "list",
5537
- "type": "Boolean",
5538
- "default": "`false`",
5539
- "description": "Whether the Tab is an item in a `<ul>` list."
5540
- },
5541
- {
5542
- "name": "selected",
5543
- "type": "Boolean",
5544
- "default": "`false`",
5545
- "description": "Whether the Tab is selected or not."
5546
- },
5547
- {
5548
- "name": "with_panel",
5549
- "type": "Boolean",
5550
- "default": "`false`",
5551
- "description": "Whether the Tab has an associated panel."
5552
- },
5553
- {
5554
- "name": "panel_id",
5555
- "type": "String",
5556
- "default": "`\"\"`",
5557
- "description": "Only applies if `with_panel` is `true`. Unique id of panel."
5558
- },
5559
- {
5560
- "name": "icon_classes",
5561
- "type": "Boolean",
5562
- "default": "`\"\"`",
5563
- "description": "Classes that must always be applied to icons."
5564
- },
5565
- {
5566
- "name": "wrapper_arguments",
5567
- "type": "Hash",
5568
- "default": "`{}`",
5569
- "description": "{{link_to_system_arguments_docs}} to be used in the `<li>` wrapper when the tab is an item in a list."
5570
- },
5571
- {
5572
- "name": "system_arguments",
5573
- "type": "Hash",
5574
- "default": "N/A",
5575
- "description": "{{link_to_system_arguments_docs}}"
5576
- }
5577
- ],
5578
- "slots": [
5579
- {
5580
- "name": "panel",
5581
- "description": "Panel controlled by the Tab. This will not render anything in the tab itself.\nIt will provide a accessor for the Tab's parent to call and render the panel\ncontent in the appropriate place.\nRefer to `UnderlineNav` and `TabNav` implementations for examples.",
5582
- "parameters": [
5583
- {
5584
- "name": "system_arguments",
5585
- "type": "Hash",
5586
- "default": "N/A",
5587
- "description": "{{link_to_system_arguments_docs}}"
5588
- }
5589
- ]
5590
- },
5591
- {
5592
- "name": "icon",
5593
- "description": "Icon to be rendered in the Tab left.",
5594
- "parameters": [
5595
- {
5596
- "name": "kwargs",
5597
- "type": "Hash",
5598
- "default": "N/A",
5599
- "description": "The same arguments as {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}."
5600
- }
5601
- ]
5602
- },
5603
- {
5604
- "name": "text",
5605
- "description": "The Tab's text.",
5606
- "parameters": [
5607
- {
5608
- "name": "kwargs",
5609
- "type": "Hash",
5610
- "default": "N/A",
5611
- "description": "The same arguments as {{#link_to_component}}Primer::Beta::Text{{/link_to_component}}."
5612
- }
5613
- ]
5614
- },
5615
- {
5616
- "name": "counter",
5617
- "description": "Counter to be rendered in the Tab right.",
5618
- "parameters": [
5619
- {
5620
- "name": "kwargs",
5621
- "type": "Hash",
5622
- "default": "N/A",
5623
- "description": "The same arguments as {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}."
5355
+ "description": "The same arguments as {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}."
5624
5356
  }
5625
5357
  ]
5626
5358
  }
@@ -8167,6 +7899,45 @@
8167
7899
  "color-contrast"
8168
7900
  ]
8169
7901
  }
7902
+ },
7903
+ {
7904
+ "preview_path": "primer/alpha/text_field/input_group_leading_button",
7905
+ "name": "input_group_leading_button",
7906
+ "snapshot": "true",
7907
+ "skip_rules": {
7908
+ "wont_fix": [
7909
+ "region"
7910
+ ],
7911
+ "will_fix": [
7912
+ "color-contrast"
7913
+ ]
7914
+ }
7915
+ },
7916
+ {
7917
+ "preview_path": "primer/alpha/text_field/input_group_trailing_button",
7918
+ "name": "input_group_trailing_button",
7919
+ "snapshot": "true",
7920
+ "skip_rules": {
7921
+ "wont_fix": [
7922
+ "region"
7923
+ ],
7924
+ "will_fix": [
7925
+ "color-contrast"
7926
+ ]
7927
+ }
7928
+ },
7929
+ {
7930
+ "preview_path": "primer/alpha/text_field/input_group_leading_action_menu",
7931
+ "name": "input_group_leading_action_menu",
7932
+ "snapshot": "true",
7933
+ "skip_rules": {
7934
+ "wont_fix": [
7935
+ "region"
7936
+ ],
7937
+ "will_fix": [
7938
+ "color-contrast"
7939
+ ]
7940
+ }
8170
7941
  }
8171
7942
  ],
8172
7943
  "subcomponents": [
@@ -12207,7 +11978,7 @@
12207
11978
  {
12208
11979
  "name": "underline",
12209
11980
  "type": "Boolean",
12210
- "default": "`true`",
11981
+ "default": "`false`",
12211
11982
  "description": "Whether or not to underline the link."
12212
11983
  },
12213
11984
  {
@@ -12390,6 +12161,656 @@
12390
12161
 
12391
12162
  ]
12392
12163
  },
12164
+ {
12165
+ "fully_qualified_name": "Primer::Beta::NavList",
12166
+ "description": "`NavList` provides a simple way to render side navigation, i.e. navigation\nthat appears to the left or right side of some main content. Each group in a\nnav list is a list of links.\n\nNav list groups can contain sub items. Rather than navigating to a URL, groups\nwith sub items expand and collapse on click. To indicate this functionality, the\ngroup will automatically render with a trailing chevron icon that changes direction\nwhen the group expands and collapses.\n\nNav list items appear visually active when selected. Each nav item must have one\nor more ID values that determine which item will appear selected. Use the\n`selected_item_id` argument to select the appropriate item.",
12167
+ "accessibility_docs": null,
12168
+ "is_form_component": false,
12169
+ "is_published": true,
12170
+ "requires_js": true,
12171
+ "component": "NavList",
12172
+ "status": "beta",
12173
+ "a11y_reviewed": true,
12174
+ "short_name": "NavList",
12175
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list.rb",
12176
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/default/",
12177
+ "parameters": [
12178
+ {
12179
+ "name": "selected_item_id",
12180
+ "type": "Symbol",
12181
+ "default": "`nil`",
12182
+ "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
12183
+ },
12184
+ {
12185
+ "name": "system_arguments",
12186
+ "type": "Hash",
12187
+ "default": "N/A",
12188
+ "description": "{{link_to_system_arguments_docs}}"
12189
+ }
12190
+ ],
12191
+ "slots": [
12192
+ {
12193
+ "name": "heading",
12194
+ "description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Heading{{/link_to_component}}.",
12195
+ "parameters": [
12196
+
12197
+ ]
12198
+ },
12199
+ {
12200
+ "name": "items",
12201
+ "description": "Items. Items can be individual items, dividers, or groups. See the documentation for `#with_item`, `#with_divider`, and `#with_group` respectively for more information.",
12202
+ "parameters": [
12203
+
12204
+ ]
12205
+ }
12206
+ ],
12207
+ "methods": [
12208
+ {
12209
+ "name": "with_item",
12210
+ "description": "Adds an item to the list.",
12211
+ "parameters": [
12212
+ {
12213
+ "name": "component_klass",
12214
+ "type": "Class",
12215
+ "default": "`Primer::Beta::NavList::Item`",
12216
+ "description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
12217
+ },
12218
+ {
12219
+ "name": "system_arguments",
12220
+ "type": "Hash",
12221
+ "default": "N/A",
12222
+ "description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
12223
+ }
12224
+ ]
12225
+ },
12226
+ {
12227
+ "name": "with_avatar_item",
12228
+ "description": "Adds an avatar item to the list. Avatar items are a convenient way to accessibly add an item with a leading avatar image.",
12229
+ "parameters": [
12230
+ {
12231
+ "name": "src",
12232
+ "type": "String",
12233
+ "default": "N/A",
12234
+ "description": "The source url of the avatar image."
12235
+ },
12236
+ {
12237
+ "name": "username",
12238
+ "type": "String",
12239
+ "default": "N/A",
12240
+ "description": "The username associated with the avatar."
12241
+ },
12242
+ {
12243
+ "name": "full_name",
12244
+ "type": "String",
12245
+ "default": "`nil`",
12246
+ "description": "Optional. The user's full name."
12247
+ },
12248
+ {
12249
+ "name": "full_name_scheme",
12250
+ "type": "Symbol",
12251
+ "default": "`:block`",
12252
+ "description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
12253
+ },
12254
+ {
12255
+ "name": "component_klass",
12256
+ "type": "Class",
12257
+ "default": "`Primer::Beta::NavList::Item`",
12258
+ "description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
12259
+ },
12260
+ {
12261
+ "name": "avatar_arguments",
12262
+ "type": "Hash",
12263
+ "default": "`{}`",
12264
+ "description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
12265
+ },
12266
+ {
12267
+ "name": "system_arguments",
12268
+ "type": "Hash",
12269
+ "default": "N/A",
12270
+ "description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
12271
+ }
12272
+ ]
12273
+ },
12274
+ {
12275
+ "name": "with_group",
12276
+ "description": "Adds a group to the list. A group is a list of links and a (required) heading.",
12277
+ "parameters": [
12278
+ {
12279
+ "name": "system_arguments",
12280
+ "type": "Hash",
12281
+ "default": "N/A",
12282
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Group{{/link_to_component}}."
12283
+ }
12284
+ ]
12285
+ },
12286
+ {
12287
+ "name": "with_divider",
12288
+ "description": "Adds a divider to the list. Dividers visually separate items and groups.",
12289
+ "parameters": [
12290
+ {
12291
+ "name": "system_arguments",
12292
+ "type": "Hash",
12293
+ "default": "N/A",
12294
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Divider{{/link_to_component}}."
12295
+ }
12296
+ ]
12297
+ },
12298
+ {
12299
+ "name": "build_item",
12300
+ "description": "Builds a new item but does not add it to the list. Use this method\ninstead of the `#with_item` slot if you need to render an item outside\nthe context of a list, eg. if rendering additional items to append to\nan existing list, perhaps via a separate HTTP request.",
12301
+ "parameters": [
12302
+ {
12303
+ "name": "component_klass",
12304
+ "type": "Class",
12305
+ "default": "`Primer::Beta::NavList::Item`",
12306
+ "description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
12307
+ },
12308
+ {
12309
+ "name": "system_arguments",
12310
+ "type": "Hash",
12311
+ "default": "N/A",
12312
+ "description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
12313
+ }
12314
+ ]
12315
+ },
12316
+ {
12317
+ "name": "build_avatar_item",
12318
+ "description": "Builds a new avatar item but does not add it to the list. Avatar items\nare a convenient way to accessibly add an item with a leading avatar\nimage. Use this method instead of the `#with_avatar_item` slot if you\nneed to render an avatar item outside the context of a list, eg. if\nrendering additional items to append to an existing list, perhaps via\na separate HTTP request.",
12319
+ "parameters": [
12320
+ {
12321
+ "name": "src",
12322
+ "type": "String",
12323
+ "default": "N/A",
12324
+ "description": "The source url of the avatar image."
12325
+ },
12326
+ {
12327
+ "name": "username",
12328
+ "type": "String",
12329
+ "default": "N/A",
12330
+ "description": "The username associated with the avatar."
12331
+ },
12332
+ {
12333
+ "name": "full_name",
12334
+ "type": "String",
12335
+ "default": "`nil`",
12336
+ "description": "Optional. The user's full name."
12337
+ },
12338
+ {
12339
+ "name": "full_name_scheme",
12340
+ "type": "Symbol",
12341
+ "default": "`:block`",
12342
+ "description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
12343
+ },
12344
+ {
12345
+ "name": "component_klass",
12346
+ "type": "Class",
12347
+ "default": "`Primer::Beta::NavList::Item`",
12348
+ "description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
12349
+ },
12350
+ {
12351
+ "name": "avatar_arguments",
12352
+ "type": "Hash",
12353
+ "default": "`{}`",
12354
+ "description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
12355
+ },
12356
+ {
12357
+ "name": "system_arguments",
12358
+ "type": "Hash",
12359
+ "default": "N/A",
12360
+ "description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
12361
+ }
12362
+ ]
12363
+ },
12364
+ {
12365
+ "name": "render_outer_list?",
12366
+ "description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
12367
+ "parameters": [
12368
+
12369
+ ]
12370
+ }
12371
+ ],
12372
+ "previews": [
12373
+ {
12374
+ "preview_path": "primer/beta/nav_list/playground",
12375
+ "name": "playground",
12376
+ "snapshot": "false",
12377
+ "skip_rules": {
12378
+ "wont_fix": [
12379
+ "region"
12380
+ ],
12381
+ "will_fix": [
12382
+ "color-contrast"
12383
+ ]
12384
+ }
12385
+ },
12386
+ {
12387
+ "preview_path": "primer/beta/nav_list/default",
12388
+ "name": "default",
12389
+ "snapshot": "true",
12390
+ "skip_rules": {
12391
+ "wont_fix": [
12392
+ "region"
12393
+ ],
12394
+ "will_fix": [
12395
+ "color-contrast"
12396
+ ]
12397
+ }
12398
+ },
12399
+ {
12400
+ "preview_path": "primer/beta/nav_list/top_level_items",
12401
+ "name": "top_level_items",
12402
+ "snapshot": "false",
12403
+ "skip_rules": {
12404
+ "wont_fix": [
12405
+ "region"
12406
+ ],
12407
+ "will_fix": [
12408
+ "color-contrast"
12409
+ ]
12410
+ }
12411
+ },
12412
+ {
12413
+ "preview_path": "primer/beta/nav_list/show_more_item",
12414
+ "name": "show_more_item",
12415
+ "snapshot": "true",
12416
+ "skip_rules": {
12417
+ "wont_fix": [
12418
+ "region"
12419
+ ],
12420
+ "will_fix": [
12421
+ "color-contrast"
12422
+ ]
12423
+ }
12424
+ },
12425
+ {
12426
+ "preview_path": "primer/beta/nav_list/trailing_action",
12427
+ "name": "trailing_action",
12428
+ "snapshot": "true",
12429
+ "skip_rules": {
12430
+ "wont_fix": [
12431
+ "region"
12432
+ ],
12433
+ "will_fix": [
12434
+ "color-contrast"
12435
+ ]
12436
+ }
12437
+ }
12438
+ ],
12439
+ "subcomponents": [
12440
+ {
12441
+ "fully_qualified_name": "Primer::Beta::NavList::Heading",
12442
+ "description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.",
12443
+ "accessibility_docs": null,
12444
+ "is_form_component": false,
12445
+ "is_published": true,
12446
+ "requires_js": false,
12447
+ "component": "NavList::Heading",
12448
+ "status": "alpha",
12449
+ "a11y_reviewed": false,
12450
+ "short_name": "NavListHeading",
12451
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/heading.rb",
12452
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/heading/default/",
12453
+ "parameters": [
12454
+ {
12455
+ "name": "title",
12456
+ "type": "String",
12457
+ "default": "N/A",
12458
+ "description": "The text content of the heading."
12459
+ },
12460
+ {
12461
+ "name": "id",
12462
+ "type": "String",
12463
+ "default": "`self.class.generate_id`",
12464
+ "description": "The value of the ID HTML attribute. Auto-generated by default."
12465
+ },
12466
+ {
12467
+ "name": "heading_level",
12468
+ "type": "Integer",
12469
+ "default": "`2`",
12470
+ "description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
12471
+ },
12472
+ {
12473
+ "name": "system_arguments",
12474
+ "type": "Hash",
12475
+ "default": "N/A",
12476
+ "description": "{{link_to_system_arguments_docs}}"
12477
+ }
12478
+ ],
12479
+ "slots": [
12480
+
12481
+ ],
12482
+ "methods": [
12483
+ {
12484
+ "name": "title",
12485
+ "description": "Returns the value of attribute title.",
12486
+ "parameters": [
12487
+
12488
+ ]
12489
+ },
12490
+ {
12491
+ "name": "id",
12492
+ "description": "Returns the value of attribute id.",
12493
+ "parameters": [
12494
+
12495
+ ]
12496
+ },
12497
+ {
12498
+ "name": "heading_level",
12499
+ "description": "Returns the value of attribute heading_level.",
12500
+ "parameters": [
12501
+
12502
+ ]
12503
+ },
12504
+ {
12505
+ "name": "system_arguments",
12506
+ "description": "Returns the value of attribute system_arguments.",
12507
+ "parameters": [
12508
+
12509
+ ]
12510
+ }
12511
+ ],
12512
+ "previews": [
12513
+
12514
+ ],
12515
+ "subcomponents": [
12516
+
12517
+ ]
12518
+ },
12519
+ {
12520
+ "fully_qualified_name": "Primer::Beta::NavList::Item",
12521
+ "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.",
12522
+ "accessibility_docs": null,
12523
+ "is_form_component": false,
12524
+ "is_published": true,
12525
+ "requires_js": true,
12526
+ "component": "NavList::Item",
12527
+ "status": "alpha",
12528
+ "a11y_reviewed": false,
12529
+ "short_name": "NavListItem",
12530
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/item.rb",
12531
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/item/default/",
12532
+ "parameters": [
12533
+ {
12534
+ "name": "selected_item_id",
12535
+ "type": "Symbol",
12536
+ "default": "`nil`",
12537
+ "description": "The ID of the currently selected list item. Used internally."
12538
+ },
12539
+ {
12540
+ "name": "selected_by_ids",
12541
+ "type": "Array<Symbol>",
12542
+ "default": "`[]`",
12543
+ "description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
12544
+ },
12545
+ {
12546
+ "name": "expanded",
12547
+ "type": "Boolean",
12548
+ "default": "`false`",
12549
+ "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
12550
+ },
12551
+ {
12552
+ "name": "sub_item",
12553
+ "type": "Boolean",
12554
+ "default": "`false`",
12555
+ "description": "Whether or not this item is nested under a parent item. Used internally."
12556
+ },
12557
+ {
12558
+ "name": "system_arguments",
12559
+ "type": "Hash",
12560
+ "default": "N/A",
12561
+ "description": "{{link_to_system_arguments_docs}}"
12562
+ }
12563
+ ],
12564
+ "slots": [
12565
+ {
12566
+ "name": "items",
12567
+ "description": null,
12568
+ "parameters": [
12569
+ {
12570
+ "name": "system_arguments",
12571
+ "type": "Hash",
12572
+ "default": "N/A",
12573
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
12574
+ }
12575
+ ]
12576
+ },
12577
+ {
12578
+ "name": "description",
12579
+ "description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
12580
+ "parameters": [
12581
+
12582
+ ]
12583
+ },
12584
+ {
12585
+ "name": "leading_visual",
12586
+ "description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
12587
+ "parameters": [
12588
+
12589
+ ]
12590
+ },
12591
+ {
12592
+ "name": "trailing_visual",
12593
+ "description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
12594
+ "parameters": [
12595
+
12596
+ ]
12597
+ },
12598
+ {
12599
+ "name": "trailing_action",
12600
+ "description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
12601
+ "parameters": [
12602
+ {
12603
+ "name": "system_arguments",
12604
+ "type": "Hash",
12605
+ "default": "N/A",
12606
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
12607
+ }
12608
+ ]
12609
+ },
12610
+ {
12611
+ "name": "tooltip",
12612
+ "description": "`Tooltip` that appears on mouse hover or keyboard focus over the trailing action button. Use tooltips sparingly and as\na last resort. **Important:** This tooltip defaults to `type: :description`. In a few scenarios, `type: :label` may be\nmore appropriate. Consult the {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}} documentation for more information.",
12613
+ "parameters": [
12614
+ {
12615
+ "name": "type",
12616
+ "type": "Symbol",
12617
+ "default": "`:description`",
12618
+ "description": "One of `:description` or `:label`."
12619
+ },
12620
+ {
12621
+ "name": "system_arguments",
12622
+ "type": "Hash",
12623
+ "default": "N/A",
12624
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
12625
+ }
12626
+ ]
12627
+ }
12628
+ ],
12629
+ "methods": [
12630
+ {
12631
+ "name": "selected_by_ids",
12632
+ "description": "Returns the value of attribute selected_by_ids.",
12633
+ "parameters": [
12634
+
12635
+ ]
12636
+ },
12637
+ {
12638
+ "name": "sub_item",
12639
+ "description": "Returns the value of attribute sub_item.",
12640
+ "parameters": [
12641
+
12642
+ ]
12643
+ },
12644
+ {
12645
+ "name": "sub_item?",
12646
+ "description": "Returns the value of attribute sub_item.\nWhether or not this item is nested under a parent item.",
12647
+ "parameters": [
12648
+
12649
+ ]
12650
+ },
12651
+ {
12652
+ "name": "expand!",
12653
+ "description": "Cause this item to show its list of sub items when rendered.",
12654
+ "parameters": [
12655
+
12656
+ ]
12657
+ },
12658
+ {
12659
+ "name": "item_active?",
12660
+ "description": "Normally it would be easier to simply ask each item for its active status, eg.\nitems.any?(&:active?), but unfortunately the view context is not set on each\nitem until _after_ the parent's before_render, etc methods have been called.\nThis means helper methods like current_page? will blow up with an error, since\n`helpers` is simply an alias for the view context (i.e. an instance of\nActionView::Base). Since we know the view context for the parent object must\nbe set before `before_render` is invoked, we can call helper methods here in\nthe parent and bypass the problem entirely. Maybe not the most OO approach,\nbut it works.",
12661
+ "parameters": [
12662
+
12663
+ ]
12664
+ }
12665
+ ],
12666
+ "previews": [
12667
+
12668
+ ],
12669
+ "subcomponents": [
12670
+
12671
+ ]
12672
+ },
12673
+ {
12674
+ "fully_qualified_name": "Primer::Beta::NavList::Divider",
12675
+ "description": "Separator with optional text rendered above groups or between individual items.",
12676
+ "accessibility_docs": null,
12677
+ "is_form_component": false,
12678
+ "is_published": true,
12679
+ "requires_js": false,
12680
+ "component": "NavList::Divider",
12681
+ "status": "alpha",
12682
+ "a11y_reviewed": false,
12683
+ "short_name": "NavListDivider",
12684
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb",
12685
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/",
12686
+ "parameters": [
12687
+ {
12688
+ "name": "scheme",
12689
+ "type": "Symbol",
12690
+ "default": "`:subtle`",
12691
+ "description": "Display a background color if scheme is `filled`."
12692
+ },
12693
+ {
12694
+ "name": "system_arguments",
12695
+ "type": "Hash",
12696
+ "default": "N/A",
12697
+ "description": "{{link_to_system_arguments_docs}}"
12698
+ }
12699
+ ],
12700
+ "slots": [
12701
+
12702
+ ],
12703
+ "methods": [
12704
+
12705
+ ],
12706
+ "previews": [
12707
+
12708
+ ],
12709
+ "subcomponents": [
12710
+
12711
+ ]
12712
+ },
12713
+ {
12714
+ "fully_qualified_name": "Primer::Beta::NavList::Group",
12715
+ "description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.",
12716
+ "accessibility_docs": null,
12717
+ "is_form_component": false,
12718
+ "is_published": true,
12719
+ "requires_js": true,
12720
+ "component": "NavList::Group",
12721
+ "status": "alpha",
12722
+ "a11y_reviewed": true,
12723
+ "short_name": "NavListGroup",
12724
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb",
12725
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/",
12726
+ "parameters": [
12727
+ {
12728
+ "name": "selected_item_id",
12729
+ "type": "Symbol",
12730
+ "default": "`nil`",
12731
+ "description": "The ID of the currently selected item. Used internally."
12732
+ },
12733
+ {
12734
+ "name": "system_arguments",
12735
+ "type": "Hash",
12736
+ "default": "N/A",
12737
+ "description": "{{link_to_system_arguments_docs}}"
12738
+ }
12739
+ ],
12740
+ "slots": [
12741
+ {
12742
+ "name": "show_more_item",
12743
+ "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.",
12744
+ "parameters": [
12745
+ {
12746
+ "name": "src",
12747
+ "type": "String",
12748
+ "default": "N/A",
12749
+ "description": "The URL to query for additional pages of list items."
12750
+ },
12751
+ {
12752
+ "name": "pages",
12753
+ "type": "Integer",
12754
+ "default": "N/A",
12755
+ "description": "The total number of pages in the result set."
12756
+ },
12757
+ {
12758
+ "name": "component_klass",
12759
+ "type": "Class",
12760
+ "default": "N/A",
12761
+ "description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
12762
+ },
12763
+ {
12764
+ "name": "system_arguments",
12765
+ "type": "Hash",
12766
+ "default": "N/A",
12767
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
12768
+ }
12769
+ ]
12770
+ },
12771
+ {
12772
+ "name": "items",
12773
+ "description": "Items.",
12774
+ "parameters": [
12775
+ {
12776
+ "name": "system_arguments",
12777
+ "type": "Hash",
12778
+ "default": "N/A",
12779
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
12780
+ }
12781
+ ]
12782
+ },
12783
+ {
12784
+ "name": "heading",
12785
+ "description": "Heading text rendered above the list of items.",
12786
+ "parameters": [
12787
+ {
12788
+ "name": "system_arguments",
12789
+ "type": "Hash",
12790
+ "default": "N/A",
12791
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
12792
+ }
12793
+ ]
12794
+ }
12795
+ ],
12796
+ "methods": [
12797
+ {
12798
+ "name": "expand!",
12799
+ "description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
12800
+ "parameters": [
12801
+
12802
+ ]
12803
+ }
12804
+ ],
12805
+ "previews": [
12806
+
12807
+ ],
12808
+ "subcomponents": [
12809
+
12810
+ ]
12811
+ }
12812
+ ]
12813
+ },
12393
12814
  {
12394
12815
  "fully_qualified_name": "Primer::Beta::Octicon",
12395
12816
  "description": "`Octicon` renders an {{link_to_octicons}} with {{link_to_system_arguments_docs}}.\n`Octicon` can also be rendered with the `primer_octicon` helper, which accepts the same arguments.",