{
    "componentChunkName": "component---src-layouts-rails-component-layout-tsx",
    "path": "/components/overlay/rails/alpha",
    "result": {"data":{"primerRailsVersion":{"version":"0.26.0"},"sitePage":{"path":"/components/overlay","context":{"frontmatter":{"title":"Overlay","description":"Overlay components codify design patterns related to floating surfaces such as dialogs and menus.","reactId":"overlay","railsIds":["Primer::Alpha::Overlay"],"figmaId":null,"cssId":null}}},"allRailsComponent":{"nodes":[{"railsId":"Primer::Alpha::ActionBar","status":"alpha"},{"railsId":"Primer::Alpha::ActionList","status":"alpha"},{"railsId":"Primer::Alpha::ActionMenu","status":"alpha"},{"railsId":"Primer::Alpha::AutoComplete","status":"deprecated"},{"railsId":"Primer::Alpha::Banner","status":"alpha"},{"railsId":"Primer::Alpha::ButtonMarketing","status":"alpha"},{"railsId":"Primer::Alpha::CheckBox","status":"alpha"},{"railsId":"Primer::Alpha::CheckBoxGroup","status":"alpha"},{"railsId":"Primer::Alpha::Dialog","status":"alpha"},{"railsId":"Primer::Alpha::Dropdown","status":"alpha"},{"railsId":"Primer::Alpha::FormButton","status":"alpha"},{"railsId":"Primer::Alpha::FormControl","status":"alpha"},{"railsId":"Primer::Alpha::HellipButton","status":"alpha"},{"railsId":"Primer::Alpha::HiddenTextExpander","status":"alpha"},{"railsId":"Primer::Alpha::Image","status":"alpha"},{"railsId":"Primer::Alpha::ImageCrop","status":"alpha"},{"railsId":"Primer::Alpha::Layout","status":"alpha"},{"railsId":"Primer::Alpha::Menu","status":"alpha"},{"railsId":"Primer::Alpha::MultiInput","status":"alpha"},{"railsId":"Primer::Alpha::NavList","status":"deprecated"},{"railsId":"Primer::Alpha::Navigation::Tab","status":"alpha"},{"railsId":"Primer::Alpha::OcticonSymbols","status":"alpha"},{"railsId":"Primer::Alpha::Overlay","status":"alpha"},{"railsId":"Primer::Alpha::RadioButton","status":"alpha"},{"railsId":"Primer::Alpha::RadioButtonGroup","status":"alpha"},{"railsId":"Primer::Alpha::SegmentedControl","status":"alpha"},{"railsId":"Primer::Alpha::Select","status":"alpha"},{"railsId":"Primer::Alpha::SubmitButton","status":"alpha"},{"railsId":"Primer::Alpha::TabContainer","status":"alpha"},{"railsId":"Primer::Alpha::TabNav","status":"alpha"},{"railsId":"Primer::Alpha::TabPanels","status":"alpha"},{"railsId":"Primer::Alpha::TextArea","status":"alpha"},{"railsId":"Primer::Alpha::TextField","status":"alpha"},{"railsId":"Primer::Alpha::ToggleSwitch","status":"alpha"},{"railsId":"Primer::Alpha::Tooltip","status":"alpha"},{"railsId":"Primer::Alpha::UnderlineNav","status":"alpha"},{"railsId":"Primer::Alpha::UnderlinePanels","status":"alpha"},{"railsId":"Primer::Beta::AutoComplete","status":"beta"},{"railsId":"Primer::Beta::Avatar","status":"beta"},{"railsId":"Primer::Beta::AvatarStack","status":"beta"},{"railsId":"Primer::Beta::BaseButton","status":"beta"},{"railsId":"Primer::Beta::Blankslate","status":"beta"},{"railsId":"Primer::Beta::BorderBox","status":"beta"},{"railsId":"Primer::Beta::Breadcrumbs","status":"beta"},{"railsId":"Primer::Beta::Button","status":"beta"},{"railsId":"Primer::Beta::ButtonGroup","status":"beta"},{"railsId":"Primer::Beta::ClipboardCopy","status":"beta"},{"railsId":"Primer::Beta::ClipboardCopyBaseButton","status":"beta"},{"railsId":"Primer::Beta::ClipboardCopyButton","status":"beta"},{"railsId":"Primer::Beta::CloseButton","status":"beta"},{"railsId":"Primer::Beta::Counter","status":"beta"},{"railsId":"Primer::Beta::Details","status":"beta"},{"railsId":"Primer::Beta::Flash","status":"deprecated"},{"railsId":"Primer::Beta::Heading","status":"beta"},{"railsId":"Primer::Beta::IconButton","status":"beta"},{"railsId":"Primer::Beta::Label","status":"beta"},{"railsId":"Primer::Beta::Link","status":"beta"},{"railsId":"Primer::Beta::Markdown","status":"beta"},{"railsId":"Primer::Beta::NavList","status":"beta"},{"railsId":"Primer::Beta::Octicon","status":"beta"},{"railsId":"Primer::Beta::Popover","status":"beta"},{"railsId":"Primer::Beta::ProgressBar","status":"beta"},{"railsId":"Primer::Beta::RelativeTime","status":"beta"},{"railsId":"Primer::Beta::Spinner","status":"beta"},{"railsId":"Primer::Beta::State","status":"beta"},{"railsId":"Primer::Beta::Subhead","status":"beta"},{"railsId":"Primer::Beta::Text","status":"beta"},{"railsId":"Primer::Beta::TimelineItem","status":"beta"},{"railsId":"Primer::Beta::Truncate","status":"beta"},{"railsId":"Primer::BlankslateComponent","status":"deprecated"},{"railsId":"Primer::Box","status":"stable"},{"railsId":"Primer::ButtonComponent","status":"deprecated"},{"railsId":"Primer::ConditionalWrapper","status":"alpha"},{"railsId":"Primer::Content","status":"stable"},{"railsId":"Primer::IconButton","status":"deprecated"},{"railsId":"Primer::LayoutComponent","status":"deprecated"},{"railsId":"Primer::Navigation::TabComponent","status":"deprecated"},{"railsId":"Primer::Tooltip","status":"deprecated"},{"railsId":"Primer::Truncate","status":"deprecated"},{"railsId":"Primer::BaseComponent","status":null}]},"railsComponent":{"name":"Overlay","railsId":"Primer::Alpha::Overlay","description":"Overlay components codify design patterns related to floating surfaces such\nas dialogs and menus. They are private components intended to be used by\nspecialized components, and mostly contain presentational logic and\nbehavior.","status":"alpha","a11y_reviewed":false,"short_name":"Overlay","is_form_component":false,"accessibility_docs":"- **Overlay Accessible Name**: An overlay should have an accessible name,\nso screen readers are aware of the purpose of the Overlay when it opens.\nGive an accessible name setting `:title`. The accessible name will be\nused as the main heading inside the Overlay.\n- **Overlay unique id**: A Overlay should be unique. Give a unique id\nsetting `:id`. If no `:id` is given, a default randomize hex id is\ngenerated.\n\nThe combination of both `:title` and `:id` establishes an\n`aria-labelledby` relationship between the title and the unique id\nof the Overlay.","props":[{"name":"id","type":"String","description":"The id of the Overlay.","default":"`self.class.generate_id`"},{"name":"title","type":"String","description":"Describes the content of the Overlay.","default":"N/A"},{"name":"subtitle","type":"String","description":"Provides dditional context for the Overlay, also setting the `aria-describedby` attribute.","default":"`nil`"},{"name":"popover","type":"Symbol","description":"The popover behaviour. One of `:auto` or `:manual`.","default":"`:auto`"},{"name":"size","type":"Symbol","description":"The size of the Overlay. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.","default":"`:auto`"},{"name":"padding","type":"Symbol","description":"The padding given to the Overlay body. One of `:condensed`, `:none`, or `:normal`.","default":"`:normal`"},{"name":"anchor","type":"String","description":"An ID of the element to anchor onto. Defaults to the `show_button`.","default":"`nil`"},{"name":"anchor_align","type":"Symbol","description":"The anchor alignment of the Overlay. One of `:center`, `:end`, or `:start`.","default":"`:start`"},{"name":"anchor_side","type":"Symbol","description":"The side to anchor the Overlay to. One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.","default":"`:outside_bottom`"},{"name":"anchor_offset","type":"Symbol","description":"The anchor offset to give the Overlay. One of `:normal` or `:spacious`.","default":"`:normal`"},{"name":"allow_out_of_bounds","type":"Boolean","description":"Allow the Overlay to overflow its container.","default":"`false`"},{"name":"visually_hide_title","type":"Boolean","description":"If true will hide the heading title, while still making it available to Screen Readers.","default":"`false`"},{"name":"role","type":"String","description":"The ARIA role. One of `nil`, `:dialog`, or `:menu`.","default":"`nil`"},{"name":"system_arguments","type":"Hash","description":"{{link_to_system_arguments_docs}}","default":"N/A"}],"slots":[{"description":"Optional button to open the Overlay.","name":"show_button","parameters":[{"default":"N/A","description":"Name of {{link_to_octicons}} to use instead of text. If provided, a {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}} will be rendered. Otherwise a {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} will be rendered.","name":"icon","type":"String"},{"default":"N/A","description":"The ID of the menu this button controls. Used internally.","name":"controls","type":"String"},{"default":"N/A","description":"The arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} or {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}} depending on the presence of the `icon:` argument.","name":"button_arguments","type":"Hash"}]},{"description":"Header content.","name":"header","parameters":[{"default":"N/A","description":"Show a divider between the header and body.","name":"divider","type":"Boolean"},{"default":"N/A","description":"One of One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`..","name":"size","type":"Symbol"},{"default":"N/A","description":"Visually hide the `title` while maintaining a label for assistive technologies.","name":"visually_hide_title","type":"Boolean"},{"default":"N/A","description":"{{link_to_system_arguments_docs}}","name":"system_arguments","type":"Hash"}]},{"description":"Required body content.","name":"body","parameters":[{"default":"N/A","description":"The padding. One of `:condensed`, `:none`, or `:normal`.","name":"padding","type":"Symbol"},{"default":"N/A","description":"{{link_to_system_arguments_docs}}","name":"system_arguments","type":"Hash"}]},{"description":"Footer content.","name":"footer","parameters":[{"default":"N/A","description":"Show a divider between the footer and body.","name":"show_divider","type":"Boolean"},{"default":"N/A","description":"{{link_to_system_arguments_docs}}","name":"system_arguments","type":"Hash"}]}],"methods":[],"previews":[{"name":"playground","preview_path":"primer/alpha/overlay/playground"},{"name":"default","preview_path":"primer/alpha/overlay/default"},{"name":"menu_no_header","preview_path":"primer/alpha/overlay/menu_no_header"},{"name":"middle_of_page","preview_path":"primer/alpha/overlay/middle_of_page"},{"name":"middle_of_page_with_relative_container","preview_path":"primer/alpha/overlay/middle_of_page_with_relative_container"},{"name":"in_an_action_menu","preview_path":"primer/alpha/overlay/in_an_action_menu"},{"name":"dialog_with_header_footer","preview_path":"primer/alpha/overlay/dialog_with_header_footer"},{"name":"overlay_with_header_filter","preview_path":"primer/alpha/overlay/overlay_with_header_filter"},{"name":"overlay_with_header_subtitle","preview_path":"primer/alpha/overlay/overlay_with_header_subtitle"},{"name":"in_a_sticky_container","preview_path":"primer/alpha/overlay/in_a_sticky_container"}],"subcomponents":[{"name":"Overlay::Header","railsId":"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}}.","status":"alpha","a11y_reviewed":false,"short_name":"OverlayHeader","accessibility_docs":null,"props":[{"name":"title","type":"String","description":"Describes the content of the Overlay.","default":"N/A"},{"name":"subtitle","type":"String","description":"Provides additional context for the Overlay, also setting the `aria-describedby` attribute.","default":"`nil`"},{"name":"overlay_id","type":"String","description":"Provides the id of the overlay element so the close button can close it","default":"`nil`"},{"name":"size","type":"Symbol","description":"The size of the Header. One of `:large` or `:medium`.","default":"`:medium`"},{"name":"divider","type":"Boolean","description":"Show a divider between the header and body.","default":"`false`"},{"name":"visually_hide_title","type":"Boolean","description":"Visually hide the `title` while maintaining a label for assistive technologies.","default":"`false`"},{"name":"system_arguments","type":"Hash","description":"{{link_to_system_arguments_docs}}","default":"N/A"}],"slots":[{"description":"Optional filter slot for adding a filter input to the header.","name":"filter","parameters":[{"default":"N/A","description":"{{link_to_system_arguments_docs}}","name":"system_arguments","type":"Hash"}]},{"description":"Optional subtitle slot for adding a subtitle to the header.","name":"subtitle","parameters":[{"default":"N/A","description":"{{link_to_system_arguments_docs}}","name":"system_arguments","type":"Hash"}]}],"methods":[]},{"name":"Overlay::Footer","railsId":"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}}.","status":"alpha","a11y_reviewed":false,"short_name":"OverlayFooter","accessibility_docs":null,"props":[{"name":"show_divider","type":"Boolean","description":"Show a divider between the footer and body.","default":"`false`"},{"name":"align_content","type":"Symbol","description":"The alginment of contents. One of `:center`, `:end`, or `:start`.","default":"`DEFAULT_ALIGN_CONTENT`"},{"name":"system_arguments","type":"Hash","description":"{{link_to_system_arguments_docs}}","default":"N/A"}],"slots":[],"methods":[]},{"name":"Overlay::Body","railsId":"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}}.","status":"alpha","a11y_reviewed":false,"short_name":"OverlayBody","accessibility_docs":null,"props":[{"name":"system_arguments","type":"Hash","description":"{{link_to_system_arguments_docs}}","default":"N/A"}],"slots":[],"methods":[]}]}},"pageContext":{"componentId":"Primer::Alpha::Overlay","parentPath":"/components/overlay"}},
    "staticQueryHashes": ["1056354862","2102389209","2745756513","2790671566","2939673985","3235046957","3907230164"]}