class Primer::Alpha::Dialog::Header

Header of a dialog. See <%= link_to_component(Primer::Alpha::Dialog) %>.
A ‘Dialog::Header` is a compositional component, used to render the

def initialize(

Parameters:
  • system_arguments (Hash) -- <%= link_to_system_arguments_docs %>
  • close_label (String) -- The aria-label text of the close "x" button.
  • variant (Symbol) -- <%= one_of(Primer::Alpha::Dialog::Header::VARIANT_OPTIONS) %>
  • visually_hide_title (Boolean) -- Visually hide the `title` while maintaining a label for assistive technologies.
  • show_divider (Boolean) -- Show a divider between the header and body.
  • subtitle (String) -- Provides additional context for the dialog, also setting the `aria-describedby` attribute.
  • title (String) -- Describes the content of the dialog.
  • id (String) -- The HTML element's ID value. 
def initialize(
  id:,
  title:,
  subtitle: nil,
  show_divider: false,
  visually_hide_title: false,
  variant: DEFAULT_VARIANT,
  close_label: DEFAULT_CLOSE_LABEL,
  **system_arguments
)
  @id = id
  @title = title
  @subtitle = subtitle
  @visually_hide_title = visually_hide_title
  @close_label = close_label
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :div
  @system_arguments[:classes] = class_names(
    "Overlay-header",
    VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_OPTIONS, variant, DEFAULT_VARIANT)],
    { "Overlay-header--divided": show_divider },
    system_arguments[:classes]
  )
end