From 542eeb37f0b013cfa5e71431e09eb4db574d3fca Mon Sep 17 00:00:00 2001 From: primer-css Date: Tue, 21 Nov 2023 22:57:03 +0000 Subject: [PATCH] Generating static files --- static/info_arch.json | 1640 ++++++++++++++++++++--------------------- 1 file changed, 820 insertions(+), 820 deletions(-) diff --git a/static/info_arch.json b/static/info_arch.json index e7063f3b6c..1748298cc1 100644 --- a/static/info_arch.json +++ b/static/info_arch.json @@ -749,146 +749,6 @@ } ], "subcomponents": [ - { - "fully_qualified_name": "Primer::Alpha::ActionList::Divider", - "description": "Separator with optional text rendered above groups or between individual items.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": false, - "component": "ActionList::Divider", - "status": "alpha", - "a11y_reviewed": false, - "short_name": "ActionListDivider", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/", - "parameters": [ - { - "name": "scheme", - "type": "Symbol", - "default": "`:subtle`", - "description": "Display a background color if scheme is `filled`." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } - ], - "slots": [ - - ], - "methods": [ - - ], - "previews": [ - - ], - "subcomponents": [ - - ] - }, - { - "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper", - "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": false, - "component": "ActionList::FormWrapper", - "status": "alpha", - "a11y_reviewed": false, - "short_name": "ActionListFormWrapper", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/", - "parameters": [ - - ], - "slots": [ - - ], - "methods": [ - - ], - "previews": [ - - ], - "subcomponents": [ - - ] - }, - { - "fully_qualified_name": "Primer::Alpha::ActionList::Heading", - "description": "Heading used to describe each sub list within an action list.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": false, - "component": "ActionList::Heading", - "status": "alpha", - "a11y_reviewed": false, - "short_name": "ActionListHeading", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/", - "parameters": [ - { - "name": "title", - "type": "String", - "default": "N/A", - "description": "Sub list title." - }, - { - "name": "heading_level", - "type": "Integer", - "default": "`3`", - "description": "Heading level. Level 2 results in an `

` tag, level 3 an `

` tag, etc." - }, - { - "name": "subtitle", - "type": "String", - "default": "`nil`", - "description": "Optional sub list description." - }, - { - "name": "scheme", - "type": "Symbol", - "default": "`:subtle`", - "description": "Display a background color if scheme is `filled`." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } - ], - "slots": [ - - ], - "methods": [ - { - "name": "title_id", - "description": "Returns the value of attribute title_id.", - "parameters": [ - - ] - }, - { - "name": "subtitle_id", - "description": "Returns the value of attribute subtitle_id.", - "parameters": [ - - ] - } - ], - "previews": [ - - ], - "subcomponents": [ - - ] - }, { "fully_qualified_name": "Primer::Alpha::ActionList::Item", "description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.", @@ -1129,112 +989,252 @@ "subcomponents": [ ] - } - ] - }, - { - "fully_qualified_name": "Primer::Alpha::ActionMenu", - "description": "ActionMenu is used for actions, navigation, to display secondary options, or single/multi select lists. They appear when\nusers interact with buttons, actions, or other controls.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. The default is `:button`.\n\n### Select variants\n\nWhile `ActionMenu`s default to a list of buttons that can link to other pages, copy text to the clipboard, etc, they also support\n`single` and `multiple` select variants. The single select variant allows a single item to be \"selected\" (i.e. marked \"active\")\nwhen clicked, which will cause a check mark to appear to the left of the item text. When the `multiple` select variant is chosen,\nmultiple items may be selected and check marks will appear next to each selected item.\n\nUse the `select_variant:` option to control which variant the `ActionMenu` uses. For more information, see the documentation on\nsupported arguments below.\n\n### Dynamic labels\n\nWhen using the `single` select variant, an optional label indicating the selected item can be displayed inside the menu button.\nDynamic labels can also be prefixed with custom text.\n\nPass `dynamic_label: true` to enable dynamic label behavior, and pass `dynamic_label_prefix: \"\"` to set a custom prefix.\nFor more information, see the documentation on supported arguments below.\n\n### `ActionMenu`s as form inputs\n\nWhen using either the `single` or `multiple` select variants, `ActionMenu`s can be used as form inputs. They behave very\nsimilarly to how HTML `` element.|\n|`inputs` |`Array` |`[]` |An array of hashes representing HTML `` elements. Must contain at least `name:` and `value:` keys. If additional key/value pairs are provided, they are emitted as HTML attributes on the `` element. This argument supercedes the `name:`, `value:`, and `:input_arguments` arguments listed above.|\n\nThe elements of the `inputs:` array will be emitted as HTML `` elements.", - "accessibility_docs": "The action for the menu item needs to be on the element with `role=\"menuitem\"`. Semantics are removed for everything\nnested inside of it. When a menu item is selected, the menu will close immediately.\n\nAdditional information around the keyboard functionality and implementation can be found on the\n[WAI-ARIA Authoring Practices](https://www.w3.org/TR/wai-aria-practices-1.2/#menu).", - "is_form_component": false, - "is_published": true, - "requires_js": true, - "component": "ActionMenu", - "status": "alpha", - "a11y_reviewed": false, - "short_name": "ActionMenu", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/", - "parameters": [ - { - "name": "menu_id", - "type": "String", - "default": "`self.class.generate_id`", - "description": "Id of the menu." - }, - { - "name": "anchor_align", - "type": "Symbol", - "default": "`:start`", - "description": "One of `:center`, `:end`, or `:start`.." - }, - { - "name": "anchor_side", - "type": "Symbol", - "default": "`:outside_bottom`", - "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.." - }, - { - "name": "size", - "type": "Symbol", - "default": "`:auto`", - "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.." - }, - { - "name": "src", - "type": "String", - "default": "`nil`", - "description": "Used with an `include-fragment` element to load menu content from the given source URL." - }, - { - "name": "preload", - "type": "Boolean", - "default": "`false`", - "description": "When true, and src is present, loads the `include-fragment` on trigger hover." }, { - "name": "dynamic_label", - "type": "Boolean", - "default": "`false`", - "description": "Whether or not to display the text of the currently selected item in the show button." - }, - { - "name": "dynamic_label_prefix", - "type": "String", - "default": "`nil`", - "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button." - }, - { - "name": "select_variant", - "type": "Symbol", - "default": "`:none`", - "description": "One of `:multiple`, `:none`, or `:single`." - }, - { - "name": "form_arguments", - "type": "Hash", - "default": "`{}`", - "description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}." - } - ], - "slots": [ - { - "name": "show_button", - "description": "Button to activate the menu.", + "fully_qualified_name": "Primer::Alpha::ActionList::Heading", + "description": "Heading used to describe each sub list within an action list.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": false, + "component": "ActionList::Heading", + "status": "alpha", + "a11y_reviewed": false, + "short_name": "ActionListHeading", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/", "parameters": [ { - "name": "system_arguments", - "type": "Hash", + "name": "title", + "type": "String", "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot." - } - ] - }, - { - "name": "items", - "description": "Adds a new item to the list.", - "parameters": [ + "description": "Sub list title." + }, { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}." + "name": "heading_level", + "type": "Integer", + "default": "`3`", + "description": "Heading level. Level 2 results in an `

` tag, level 3 an `

` tag, etc." + }, + { + "name": "subtitle", + "type": "String", + "default": "`nil`", + "description": "Optional sub list description." + }, + { + "name": "scheme", + "type": "Symbol", + "default": "`:subtle`", + "description": "Display a background color if scheme is `filled`." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}" + } + ], + "slots": [ + + ], + "methods": [ + { + "name": "title_id", + "description": "Returns the value of attribute title_id.", + "parameters": [ + + ] + }, + { + "name": "subtitle_id", + "description": "Returns the value of attribute subtitle_id.", + "parameters": [ + + ] + } + ], + "previews": [ + + ], + "subcomponents": [ + + ] + }, + { + "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper", + "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": false, + "component": "ActionList::FormWrapper", + "status": "alpha", + "a11y_reviewed": false, + "short_name": "ActionListFormWrapper", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/", + "parameters": [ + + ], + "slots": [ + + ], + "methods": [ + + ], + "previews": [ + + ], + "subcomponents": [ + + ] + }, + { + "fully_qualified_name": "Primer::Alpha::ActionList::Divider", + "description": "Separator with optional text rendered above groups or between individual items.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": false, + "component": "ActionList::Divider", + "status": "alpha", + "a11y_reviewed": false, + "short_name": "ActionListDivider", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/", + "parameters": [ + { + "name": "scheme", + "type": "Symbol", + "default": "`:subtle`", + "description": "Display a background color if scheme is `filled`." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}" + } + ], + "slots": [ + + ], + "methods": [ + + ], + "previews": [ + + ], + "subcomponents": [ + + ] + } + ] + }, + { + "fully_qualified_name": "Primer::Alpha::ActionMenu", + "description": "ActionMenu is used for actions, navigation, to display secondary options, or single/multi select lists. They appear when\nusers interact with buttons, actions, or other controls.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. The default is `:button`.\n\n### Select variants\n\nWhile `ActionMenu`s default to a list of buttons that can link to other pages, copy text to the clipboard, etc, they also support\n`single` and `multiple` select variants. The single select variant allows a single item to be \"selected\" (i.e. marked \"active\")\nwhen clicked, which will cause a check mark to appear to the left of the item text. When the `multiple` select variant is chosen,\nmultiple items may be selected and check marks will appear next to each selected item.\n\nUse the `select_variant:` option to control which variant the `ActionMenu` uses. For more information, see the documentation on\nsupported arguments below.\n\n### Dynamic labels\n\nWhen using the `single` select variant, an optional label indicating the selected item can be displayed inside the menu button.\nDynamic labels can also be prefixed with custom text.\n\nPass `dynamic_label: true` to enable dynamic label behavior, and pass `dynamic_label_prefix: \"\"` to set a custom prefix.\nFor more information, see the documentation on supported arguments below.\n\n### `ActionMenu`s as form inputs\n\nWhen using either the `single` or `multiple` select variants, `ActionMenu`s can be used as form inputs. They behave very\nsimilarly to how HTML `` element.|\n|`inputs` |`Array` |`[]` |An array of hashes representing HTML `` elements. Must contain at least `name:` and `value:` keys. If additional key/value pairs are provided, they are emitted as HTML attributes on the `` element. This argument supercedes the `name:`, `value:`, and `:input_arguments` arguments listed above.|\n\nThe elements of the `inputs:` array will be emitted as HTML `` elements.", + "accessibility_docs": "The action for the menu item needs to be on the element with `role=\"menuitem\"`. Semantics are removed for everything\nnested inside of it. When a menu item is selected, the menu will close immediately.\n\nAdditional information around the keyboard functionality and implementation can be found on the\n[WAI-ARIA Authoring Practices](https://www.w3.org/TR/wai-aria-practices-1.2/#menu).", + "is_form_component": false, + "is_published": true, + "requires_js": true, + "component": "ActionMenu", + "status": "alpha", + "a11y_reviewed": false, + "short_name": "ActionMenu", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/", + "parameters": [ + { + "name": "menu_id", + "type": "String", + "default": "`self.class.generate_id`", + "description": "Id of the menu." + }, + { + "name": "anchor_align", + "type": "Symbol", + "default": "`:start`", + "description": "One of `:center`, `:end`, or `:start`.." + }, + { + "name": "anchor_side", + "type": "Symbol", + "default": "`:outside_bottom`", + "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.." + }, + { + "name": "size", + "type": "Symbol", + "default": "`:auto`", + "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.." + }, + { + "name": "src", + "type": "String", + "default": "`nil`", + "description": "Used with an `include-fragment` element to load menu content from the given source URL." + }, + { + "name": "preload", + "type": "Boolean", + "default": "`false`", + "description": "When true, and src is present, loads the `include-fragment` on trigger hover." + }, + { + "name": "dynamic_label", + "type": "Boolean", + "default": "`false`", + "description": "Whether or not to display the text of the currently selected item in the show button." + }, + { + "name": "dynamic_label_prefix", + "type": "String", + "default": "`nil`", + "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button." + }, + { + "name": "select_variant", + "type": "Symbol", + "default": "`:none`", + "description": "One of `:multiple`, `:none`, or `:single`." + }, + { + "name": "form_arguments", + "type": "Hash", + "default": "`{}`", + "description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}." + } + ], + "slots": [ + { + "name": "show_button", + "description": "Button to activate the menu.", + "parameters": [ + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot." + } + ] + }, + { + "name": "items", + "description": "Adds a new item to the list.", + "parameters": [ + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}." } ] } @@ -1708,109 +1708,38 @@ ], "subcomponents": [ { - "fully_qualified_name": "Primer::Alpha::ActionMenu::Group", + "fully_qualified_name": "Primer::Alpha::ActionMenu::List", "description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "ActionMenu::Group", + "component": "ActionMenu::List", "status": "alpha", - "a11y_reviewed": true, - "short_name": "ActionMenuGroup", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/group.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/group/default/", + "a11y_reviewed": false, + "short_name": "ActionMenuList", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/", "parameters": [ { - "name": "id", - "type": "String", - "default": "`self.class.generate_id`", - "description": "HTML ID value." - }, - { - "name": "role", - "type": "Boolean", - "default": "`nil`", - "description": "ARIA role describing the function of the list. listbox and menu are a common values." - }, - { - "name": "item_classes", - "type": "String", - "default": "`nil`", - "description": "Additional CSS classes to attach to items." - }, - { - "name": "scheme", - "type": "Symbol", - "default": "`:full`", - "description": "One of `:full` or `:inset`. `inset` children are offset (vertically and horizontally) from list edges. `full` (default) children are flush (vertically and horizontally) with list edges." - }, - { - "name": "show_dividers", - "type": "Boolean", - "default": "`false`", - "description": "Display a divider above each item in the list when it does not follow a header or divider." - }, - { - "name": "select_variant", - "type": "Symbol", - "default": "`:none`", - "description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`." - }, - { - "name": "form_arguments", - "type": "Hash", - "default": "`{}`", - "description": "Allows an `ActionList` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission. *NOTE*: Consider using an {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} instead of using this feature directly." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } - ], - "slots": [ - { - "name": "heading", - "description": "Heading text rendered above the list of items.", - "parameters": [ - { - "name": "component_klass", - "type": "Class", - "default": "N/A", - "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by `component_klass`." - } - ] - }, + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::List{{/link_to_component}}" + } + ], + "slots": [ + + ], + "methods": [ { "name": "items", - "description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.", + "description": "Returns the value of attribute items.", "parameters": [ ] } ], - "methods": [ - { - "name": "with_heading", - "description": "Heading text rendered above the list of items.", - "parameters": [ - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::Heading{{/link_to_component}}." - } - ] - } - ], "previews": [ ], @@ -1912,35 +1841,106 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::ActionMenu::List", + "fully_qualified_name": "Primer::Alpha::ActionMenu::Group", "description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "ActionMenu::List", + "component": "ActionMenu::Group", "status": "alpha", - "a11y_reviewed": false, - "short_name": "ActionMenuList", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/", + "a11y_reviewed": true, + "short_name": "ActionMenuGroup", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/group.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/group/default/", "parameters": [ + { + "name": "id", + "type": "String", + "default": "`self.class.generate_id`", + "description": "HTML ID value." + }, + { + "name": "role", + "type": "Boolean", + "default": "`nil`", + "description": "ARIA role describing the function of the list. listbox and menu are a common values." + }, + { + "name": "item_classes", + "type": "String", + "default": "`nil`", + "description": "Additional CSS classes to attach to items." + }, + { + "name": "scheme", + "type": "Symbol", + "default": "`:full`", + "description": "One of `:full` or `:inset`. `inset` children are offset (vertically and horizontally) from list edges. `full` (default) children are flush (vertically and horizontally) with list edges." + }, + { + "name": "show_dividers", + "type": "Boolean", + "default": "`false`", + "description": "Display a divider above each item in the list when it does not follow a header or divider." + }, + { + "name": "select_variant", + "type": "Symbol", + "default": "`:none`", + "description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`." + }, + { + "name": "form_arguments", + "type": "Hash", + "default": "`{}`", + "description": "Allows an `ActionList` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission. *NOTE*: Consider using an {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} instead of using this feature directly." + }, { "name": "system_arguments", "type": "Hash", "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::List{{/link_to_component}}" + "description": "{{link_to_system_arguments_docs}}" } ], "slots": [ + { + "name": "heading", + "description": "Heading text rendered above the list of items.", + "parameters": [ + { + "name": "component_klass", + "type": "Class", + "default": "N/A", + "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by `component_klass`." + } + ] + }, + { + "name": "items", + "description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.", + "parameters": [ + ] + } ], "methods": [ { - "name": "items", - "description": "Returns the value of attribute items.", + "name": "with_heading", + "description": "Heading text rendered above the list of items.", "parameters": [ - + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::Heading{{/link_to_component}}." + } ] } ], @@ -3288,6 +3288,76 @@ } ], "subcomponents": [ + { + "fully_qualified_name": "Primer::Alpha::Dialog::Header", + "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}}.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": false, + "component": "Dialog::Header", + "status": "alpha", + "a11y_reviewed": true, + "short_name": "DialogHeader", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/", + "parameters": [ + { + "name": "id", + "type": "String", + "default": "N/A", + "description": "The HTML element's ID value." + }, + { + "name": "title", + "type": "String", + "default": "N/A", + "description": "Describes the content of the dialog." + }, + { + "name": "subtitle", + "type": "String", + "default": "`nil`", + "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute." + }, + { + "name": "show_divider", + "type": "Boolean", + "default": "`false`", + "description": "Show a divider between the header and body." + }, + { + "name": "visually_hide_title", + "type": "Boolean", + "default": "`false`", + "description": "Visually hide the `title` while maintaining a label for assistive technologies." + }, + { + "name": "variant", + "type": "Symbol", + "default": "`:medium`", + "description": "One of `:large` or `:medium`." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}" + } + ], + "slots": [ + + ], + "methods": [ + + ], + "previews": [ + + ], + "subcomponents": [ + + ] + }, { "fully_qualified_name": "Primer::Alpha::Dialog::Footer", "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}}.", @@ -3361,98 +3431,28 @@ "subcomponents": [ ] - }, - { - "fully_qualified_name": "Primer::Alpha::Dialog::Header", - "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}}.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": false, - "component": "Dialog::Header", - "status": "alpha", - "a11y_reviewed": true, - "short_name": "DialogHeader", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/", - "parameters": [ - { - "name": "id", - "type": "String", - "default": "N/A", - "description": "The HTML element's ID value." - }, - { - "name": "title", - "type": "String", - "default": "N/A", - "description": "Describes the content of the dialog." - }, - { - "name": "subtitle", - "type": "String", - "default": "`nil`", - "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute." - }, - { - "name": "show_divider", - "type": "Boolean", - "default": "`false`", - "description": "Show a divider between the header and body." - }, - { - "name": "visually_hide_title", - "type": "Boolean", - "default": "`false`", - "description": "Visually hide the `title` while maintaining a label for assistive technologies." - }, - { - "name": "variant", - "type": "Symbol", - "default": "`:medium`", - "description": "One of `:large` or `:medium`." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } - ], - "slots": [ - - ], - "methods": [ - - ], - "previews": [ - - ], - "subcomponents": [ - - ] - } - ] - }, - { - "fully_qualified_name": "Primer::Alpha::Dropdown", - "description": "`Dropdown` is a lightweight context menu for housing navigation and actions.\nThey're great for instances where you don't need the full power (and code) of the SelectMenu.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": true, - "component": "Dropdown", - "status": "alpha", - "a11y_reviewed": false, - "short_name": "Dropdown", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/default/", - "parameters": [ - { - "name": "overlay", - "type": "Symbol", - "default": "`:default`", - "description": "One of `:dark`, `:default`, or `:none`." + } + ] + }, + { + "fully_qualified_name": "Primer::Alpha::Dropdown", + "description": "`Dropdown` is a lightweight context menu for housing navigation and actions.\nThey're great for instances where you don't need the full power (and code) of the SelectMenu.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": true, + "component": "Dropdown", + "status": "alpha", + "a11y_reviewed": false, + "short_name": "Dropdown", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/default/", + "parameters": [ + { + "name": "overlay", + "type": "Symbol", + "default": "`:default`", + "description": "One of `:dark`, `:default`, or `:none`." }, { "name": "with_caret", @@ -4713,31 +4713,20 @@ ], "subcomponents": [ { - "fully_qualified_name": "Primer::Alpha::Layout::Main", - "description": "The layout's main content.", + "fully_qualified_name": "Primer::Alpha::Layout::Sidebar", + "description": "The layout's sidebar content.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "Layout::Main", + "component": "Layout::Sidebar", "status": "alpha", "a11y_reviewed": false, - "short_name": "LayoutMain", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/main.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/main/default/", + "short_name": "LayoutSidebar", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/sidebar.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/sidebar/default/", "parameters": [ - { - "name": "width", - "type": "Symbol", - "default": "`:full`", - "description": "One of `:full`, `:lg`, `:md`, or `:xl`." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } + ], "slots": [ @@ -4753,20 +4742,31 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::Layout::Sidebar", - "description": "The layout's sidebar content.", + "fully_qualified_name": "Primer::Alpha::Layout::Main", + "description": "The layout's main content.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "Layout::Sidebar", + "component": "Layout::Main", "status": "alpha", "a11y_reviewed": false, - "short_name": "LayoutSidebar", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/sidebar.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/sidebar/default/", + "short_name": "LayoutMain", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/main.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/main/default/", "parameters": [ - + { + "name": "width", + "type": "Symbol", + "default": "`:full`", + "description": "One of `:full`, `:lg`, `:md`, or `:xl`." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}" + } ], "slots": [ @@ -5134,24 +5134,42 @@ ], "subcomponents": [ { - "fully_qualified_name": "Primer::Alpha::NavList::Divider", + "fully_qualified_name": "Primer::Alpha::NavList::Item", "description": ":nodoc:", "accessibility_docs": null, "is_form_component": false, "is_published": true, - "requires_js": false, - "component": "NavList::Divider", + "requires_js": true, + "component": "NavList::Item", "status": "deprecated", "a11y_reviewed": false, - "short_name": "NavListDivider", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/", + "short_name": "NavListItem", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/", "parameters": [ { - "name": "scheme", + "name": "selected_item_id", "type": "Symbol", - "default": "`:subtle`", - "description": "Display a background color if scheme is `filled`." + "default": "`nil`", + "description": "The ID of the currently selected list item. Used internally." + }, + { + "name": "selected_by_ids", + "type": "Array", + "default": "`[]`", + "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." + }, + { + "name": "expanded", + "type": "Boolean", + "default": "`false`", + "description": "Whether this item shows (expands) or hides (collapses) its list of sub items." + }, + { + "name": "sub_item", + "type": "Boolean", + "default": "`false`", + "description": "Whether or not this item is nested under a parent item. Used internally." }, { "name": "system_arguments", @@ -5161,7 +5179,69 @@ } ], "slots": [ + { + "name": "items", + "description": null, + "parameters": [ + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}." + } + ] + }, + { + "name": "description", + "description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.", + "parameters": [ + + ] + }, + { + "name": "leading_visual", + "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.", + "parameters": [ + + ] + }, + { + "name": "trailing_visual", + "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```", + "parameters": [ + ] + }, + { + "name": "trailing_action", + "description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.", + "parameters": [ + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}." + } + ] + }, + { + "name": "tooltip", + "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.", + "parameters": [ + { + "name": "type", + "type": "Symbol", + "default": "`:description`", + "description": "One of `:description` or `:label`." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}." + } + ] + } ], "methods": [ @@ -5174,24 +5254,36 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::NavList::Group", + "fully_qualified_name": "Primer::Alpha::NavList::Heading", "description": ":nodoc:", "accessibility_docs": null, "is_form_component": false, "is_published": true, - "requires_js": true, - "component": "NavList::Group", + "requires_js": false, + "component": "NavList::Heading", "status": "deprecated", - "a11y_reviewed": true, - "short_name": "NavListGroup", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/", + "a11y_reviewed": false, + "short_name": "NavListHeading", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/", "parameters": [ { - "name": "selected_item_id", - "type": "Symbol", - "default": "`nil`", - "description": "The ID of the currently selected item. Used internally." + "name": "title", + "type": "String", + "default": "N/A", + "description": "The text content of the heading." + }, + { + "name": "id", + "type": "String", + "default": "`self.class.generate_id`", + "description": "The value of the ID HTML attribute. Auto-generated by default." + }, + { + "name": "heading_level", + "type": "Integer", + "default": "`2`", + "description": "The heading level, i.e. 2 for an `

`, 3 for an `

`, etc." }, { "name": "system_arguments", @@ -5201,66 +5293,7 @@ } ], "slots": [ - { - "name": "show_more_item", - "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.", - "parameters": [ - { - "name": "src", - "type": "String", - "default": "N/A", - "description": "The URL to query for additional pages of list items." - }, - { - "name": "pages", - "type": "Integer", - "default": "N/A", - "description": "The total number of pages in the result set." - }, - { - "name": "component_klass", - "type": "Class", - "default": "N/A", - "description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." - } - ] - }, - { - "name": "items", - "description": "Items.", - "parameters": [ - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." - } - ] - }, - { - "name": "heading", - "description": "Heading text rendered above the list of items.", - "parameters": [ - { - "name": "component_klass", - "type": "Class", - "default": "N/A", - "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by `component_klass`." - } - ] - } + ], "methods": [ @@ -5273,36 +5306,24 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::NavList::Heading", + "fully_qualified_name": "Primer::Alpha::NavList::Divider", "description": ":nodoc:", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "NavList::Heading", + "component": "NavList::Divider", "status": "deprecated", "a11y_reviewed": false, - "short_name": "NavListHeading", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/", + "short_name": "NavListDivider", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/", "parameters": [ { - "name": "title", - "type": "String", - "default": "N/A", - "description": "The text content of the heading." - }, - { - "name": "id", - "type": "String", - "default": "`self.class.generate_id`", - "description": "The value of the ID HTML attribute. Auto-generated by default." - }, - { - "name": "heading_level", - "type": "Integer", - "default": "`2`", - "description": "The heading level, i.e. 2 for an `

`, 3 for an `

`, etc." + "name": "scheme", + "type": "Symbol", + "default": "`:subtle`", + "description": "Display a background color if scheme is `filled`." }, { "name": "system_arguments", @@ -5325,42 +5346,24 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::NavList::Item", + "fully_qualified_name": "Primer::Alpha::NavList::Group", "description": ":nodoc:", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": true, - "component": "NavList::Item", + "component": "NavList::Group", "status": "deprecated", - "a11y_reviewed": false, - "short_name": "NavListItem", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/", + "a11y_reviewed": true, + "short_name": "NavListGroup", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/", "parameters": [ { "name": "selected_item_id", "type": "Symbol", "default": "`nil`", - "description": "The ID of the currently selected list item. Used internally." - }, - { - "name": "selected_by_ids", - "type": "Array", - "default": "`[]`", - "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." - }, - { - "name": "expanded", - "type": "Boolean", - "default": "`false`", - "description": "Whether this item shows (expands) or hides (collapses) its list of sub items." - }, - { - "name": "sub_item", - "type": "Boolean", - "default": "`false`", - "description": "Whether or not this item is nested under a parent item. Used internally." + "description": "The ID of the currently selected item. Used internally." }, { "name": "system_arguments", @@ -5371,65 +5374,62 @@ ], "slots": [ { - "name": "items", - "description": null, + "name": "show_more_item", + "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.", "parameters": [ + { + "name": "src", + "type": "String", + "default": "N/A", + "description": "The URL to query for additional pages of list items." + }, + { + "name": "pages", + "type": "Integer", + "default": "N/A", + "description": "The total number of pages in the result set." + }, + { + "name": "component_klass", + "type": "Class", + "default": "N/A", + "description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class." + }, { "name": "system_arguments", "type": "Hash", "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}." + "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." } ] }, { - "name": "description", - "description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.", - "parameters": [ - - ] - }, - { - "name": "leading_visual", - "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.", - "parameters": [ - - ] - }, - { - "name": "trailing_visual", - "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```", - "parameters": [ - - ] - }, - { - "name": "trailing_action", - "description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.", + "name": "items", + "description": "Items.", "parameters": [ { "name": "system_arguments", "type": "Hash", "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}." + "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." } ] }, { - "name": "tooltip", - "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.", + "name": "heading", + "description": "Heading text rendered above the list of items.", "parameters": [ { - "name": "type", - "type": "Symbol", - "default": "`:description`", - "description": "One of `:description` or `:label`." + "name": "component_klass", + "type": "Class", + "default": "N/A", + "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}." }, { "name": "system_arguments", "type": "Hash", "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}." + "description": "The arguments accepted by `component_klass`." } ] } @@ -5917,30 +5917,54 @@ ], "subcomponents": [ { - "fully_qualified_name": "Primer::Alpha::Overlay::Footer", - "description": "A `Overlay::Footer` is a compositional component, used to render the\nFooter of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.", + "fully_qualified_name": "Primer::Alpha::Overlay::Header", + "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}}.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "Overlay::Footer", + "component": "Overlay::Header", "status": "alpha", "a11y_reviewed": false, - "short_name": "OverlayFooter", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/footer.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/footer/default/", + "short_name": "OverlayHeader", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/header.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/header/default/", "parameters": [ { - "name": "show_divider", + "name": "title", + "type": "String", + "default": "N/A", + "description": "Describes the content of the Overlay." + }, + { + "name": "subtitle", + "type": "String", + "default": "`nil`", + "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute." + }, + { + "name": "overlay_id", + "type": "String", + "default": "`nil`", + "description": "Provides the id of the overlay element so the close button can close it" + }, + { + "name": "size", + "type": "Symbol", + "default": "`:medium`", + "description": "The size of the Header. One of `:large` or `:medium`." + }, + { + "name": "divider", "type": "Boolean", "default": "`false`", - "description": "Show a divider between the footer and body." + "description": "Show a divider between the header and body." }, { - "name": "align_content", - "type": "Symbol", - "default": "`DEFAULT_ALIGN_CONTENT`", - "description": "The alginment of contents. One of `:center`, `:end`, or `:start`." + "name": "visually_hide_title", + "type": "Boolean", + "default": "`false`", + "description": "Visually hide the `title` while maintaining a label for assistive technologies." }, { "name": "system_arguments", @@ -5963,19 +5987,31 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::Overlay::Body", - "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}}.", + "fully_qualified_name": "Primer::Alpha::Overlay::Footer", + "description": "A `Overlay::Footer` is a compositional component, used to render the\nFooter of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "Overlay::Body", + "component": "Overlay::Footer", "status": "alpha", "a11y_reviewed": false, - "short_name": "OverlayBody", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/", + "short_name": "OverlayFooter", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/footer.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/footer/default/", "parameters": [ + { + "name": "show_divider", + "type": "Boolean", + "default": "`false`", + "description": "Show a divider between the footer and body." + }, + { + "name": "align_content", + "type": "Symbol", + "default": "`DEFAULT_ALIGN_CONTENT`", + "description": "The alginment of contents. One of `:center`, `:end`, or `:start`." + }, { "name": "system_arguments", "type": "Hash", @@ -5997,55 +6033,19 @@ ] }, { - "fully_qualified_name": "Primer::Alpha::Overlay::Header", - "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}}.", + "fully_qualified_name": "Primer::Alpha::Overlay::Body", + "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}}.", "accessibility_docs": null, "is_form_component": false, "is_published": true, "requires_js": false, - "component": "Overlay::Header", + "component": "Overlay::Body", "status": "alpha", "a11y_reviewed": false, - "short_name": "OverlayHeader", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/header.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/header/default/", + "short_name": "OverlayBody", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/", "parameters": [ - { - "name": "title", - "type": "String", - "default": "N/A", - "description": "Describes the content of the Overlay." - }, - { - "name": "subtitle", - "type": "String", - "default": "`nil`", - "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute." - }, - { - "name": "overlay_id", - "type": "String", - "default": "`nil`", - "description": "Provides the id of the overlay element so the close button can close it" - }, - { - "name": "size", - "type": "Symbol", - "default": "`:medium`", - "description": "The size of the Header. One of `:large` or `:medium`." - }, - { - "name": "divider", - "type": "Boolean", - "default": "`false`", - "description": "Show a divider between the header and body." - }, - { - "name": "visually_hide_title", - "type": "Boolean", - "default": "`false`", - "description": "Visually hide the `title` while maintaining a label for assistive technologies." - }, { "name": "system_arguments", "type": "Hash", @@ -13003,46 +13003,6 @@ } ], "subcomponents": [ - { - "fully_qualified_name": "Primer::Beta::NavList::Divider", - "description": "Separator with optional text rendered above groups or between individual items.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": false, - "component": "NavList::Divider", - "status": "alpha", - "a11y_reviewed": false, - "short_name": "NavListDivider", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/", - "parameters": [ - { - "name": "scheme", - "type": "Symbol", - "default": "`:subtle`", - "description": "Display a background color if scheme is `filled`." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } - ], - "slots": [ - - ], - "methods": [ - - ], - "previews": [ - - ], - "subcomponents": [ - - ] - }, { "fully_qualified_name": "Primer::Beta::NavList::Heading", "description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.", @@ -13122,111 +13082,6 @@ ] }, - { - "fully_qualified_name": "Primer::Beta::NavList::Group", - "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.", - "accessibility_docs": null, - "is_form_component": false, - "is_published": true, - "requires_js": true, - "component": "NavList::Group", - "status": "alpha", - "a11y_reviewed": true, - "short_name": "NavListGroup", - "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/", - "parameters": [ - { - "name": "selected_item_id", - "type": "Symbol", - "default": "`nil`", - "description": "The ID of the currently selected item. Used internally." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "{{link_to_system_arguments_docs}}" - } - ], - "slots": [ - { - "name": "show_more_item", - "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.", - "parameters": [ - { - "name": "src", - "type": "String", - "default": "N/A", - "description": "The URL to query for additional pages of list items." - }, - { - "name": "pages", - "type": "Integer", - "default": "N/A", - "description": "The total number of pages in the result set." - }, - { - "name": "component_klass", - "type": "Class", - "default": "N/A", - "description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." - } - ] - }, - { - "name": "items", - "description": "Items.", - "parameters": [ - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." - } - ] - }, - { - "name": "heading", - "description": "Heading text rendered above the list of items.", - "parameters": [ - { - "name": "component_klass", - "type": "Class", - "default": "N/A", - "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}." - }, - { - "name": "system_arguments", - "type": "Hash", - "default": "N/A", - "description": "The arguments accepted by `component_klass`." - } - ] - } - ], - "methods": [ - { - "name": "expand!", - "description": "Cause this group to show its list of sub items when rendered.\n:nocov:", - "parameters": [ - - ] - } - ], - "previews": [ - - ], - "subcomponents": [ - - ] - }, { "fully_qualified_name": "Primer::Beta::NavList::Item", "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.", @@ -13379,6 +13234,151 @@ ], "subcomponents": [ + ] + }, + { + "fully_qualified_name": "Primer::Beta::NavList::Divider", + "description": "Separator with optional text rendered above groups or between individual items.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": false, + "component": "NavList::Divider", + "status": "alpha", + "a11y_reviewed": false, + "short_name": "NavListDivider", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/", + "parameters": [ + { + "name": "scheme", + "type": "Symbol", + "default": "`:subtle`", + "description": "Display a background color if scheme is `filled`." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}" + } + ], + "slots": [ + + ], + "methods": [ + + ], + "previews": [ + + ], + "subcomponents": [ + + ] + }, + { + "fully_qualified_name": "Primer::Beta::NavList::Group", + "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.", + "accessibility_docs": null, + "is_form_component": false, + "is_published": true, + "requires_js": true, + "component": "NavList::Group", + "status": "alpha", + "a11y_reviewed": true, + "short_name": "NavListGroup", + "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/", + "parameters": [ + { + "name": "selected_item_id", + "type": "Symbol", + "default": "`nil`", + "description": "The ID of the currently selected item. Used internally." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "{{link_to_system_arguments_docs}}" + } + ], + "slots": [ + { + "name": "show_more_item", + "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.", + "parameters": [ + { + "name": "src", + "type": "String", + "default": "N/A", + "description": "The URL to query for additional pages of list items." + }, + { + "name": "pages", + "type": "Integer", + "default": "N/A", + "description": "The total number of pages in the result set." + }, + { + "name": "component_klass", + "type": "Class", + "default": "N/A", + "description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." + } + ] + }, + { + "name": "items", + "description": "Items.", + "parameters": [ + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}." + } + ] + }, + { + "name": "heading", + "description": "Heading text rendered above the list of items.", + "parameters": [ + { + "name": "component_klass", + "type": "Class", + "default": "N/A", + "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}." + }, + { + "name": "system_arguments", + "type": "Hash", + "default": "N/A", + "description": "The arguments accepted by `component_klass`." + } + ] + } + ], + "methods": [ + { + "name": "expand!", + "description": "Cause this group to show its list of sub items when rendered.\n:nocov:", + "parameters": [ + + ] + } + ], + "previews": [ + + ], + "subcomponents": [ + ] } ]