Method: Primer::Alpha::ActionMenu#initialize

Defined in:

app/components/primer/alpha/action_menu.rb

#initialize(menu_id: self.class.generate_id, anchor_align: Primer::Alpha::Overlay::DEFAULT_ANCHOR_ALIGN, anchor_side: Primer::Alpha::Overlay::DEFAULT_ANCHOR_SIDE, size: Primer::Alpha::Overlay::DEFAULT_SIZE, src: nil, preload: DEFAULT_PRELOAD, dynamic_label: false, dynamic_label_prefix: nil, select_variant: DEFAULT_SELECT_VARIANT, form_arguments: {}, overlay_arguments: {}, **system_arguments) ⇒ ActionMenu

Returns a new instance of ActionMenu.

Parameters:

• menu_id (String) (defaults to: self.class.generate_id) —

  Id of the menu.

• anchor_align (Symbol) (defaults to: Primer::Alpha::Overlay::DEFAULT_ANCHOR_ALIGN) —

  <%= one_of(Primer::Alpha::Overlay::ANCHOR_ALIGN_OPTIONS) %>.

• anchor_side (Symbol) (defaults to: Primer::Alpha::Overlay::DEFAULT_ANCHOR_SIDE) —

  <%= one_of(Primer::Alpha::Overlay::ANCHOR_SIDE_OPTIONS) %>.

• size (Symbol) (defaults to: Primer::Alpha::Overlay::DEFAULT_SIZE) —

  <%= one_of(Primer::Alpha::Overlay::SIZE_OPTIONS) %>.

• src (String) (defaults to: nil) —

  Used with an ‘include-fragment` element to load menu content from the given source URL.

• preload (Boolean) (defaults to: DEFAULT_PRELOAD) —

  When true, and src is present, loads the ‘include-fragment` on trigger hover.

• dynamic_label (Boolean) (defaults to: false) —

  Whether or not to display the text of the currently selected item in the show button.

• dynamic_label_prefix (String) (defaults to: nil) —

  If provided, the prefix is prepended to the dynamic label and displayed in the show button.

• select_variant (Symbol) (defaults to: DEFAULT_SELECT_VARIANT) —

  <%= one_of(Primer::Alpha::ActionMenu::SELECT_VARIANT_OPTIONS) %>

• form_arguments (Hash) (defaults to: {}) —

  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.

• overlay_arguments (Hash) (defaults to: {}) —

  Arguments to pass to the underlying <%= link_to_component(Primer::Alpha::Overlay) %>

• system_arguments (Hash) —

  <%= link_to_system_arguments_docs %>.

# File 'app/components/primer/alpha/action_menu.rb', line 199

def initialize(
  menu_id: self.class.generate_id,
  anchor_align: Primer::Alpha::Overlay::DEFAULT_ANCHOR_ALIGN,
  anchor_side: Primer::Alpha::Overlay::DEFAULT_ANCHOR_SIDE,
  size: Primer::Alpha::Overlay::DEFAULT_SIZE,
  src: nil,
  preload: DEFAULT_PRELOAD,
  dynamic_label: false,
  dynamic_label_prefix: nil,
  select_variant: DEFAULT_SELECT_VARIANT,
  form_arguments: {},
  overlay_arguments: {},
  **system_arguments
)
  @menu_id = menu_id
  @src = src
  @preload = fetch_or_fallback_boolean(preload, DEFAULT_PRELOAD)
  @system_arguments = deny_tag_argument(**system_arguments)

  @system_arguments[:preload] = true if @src.present? && preload?

  @select_variant = fetch_or_fallback(SELECT_VARIANT_OPTIONS, select_variant, DEFAULT_SELECT_VARIANT)

  @system_arguments[:tag] = :"action-menu"
  @system_arguments[:"data-select-variant"] = select_variant
  @system_arguments[:"data-dynamic-label"] = "" if dynamic_label
  @system_arguments[:"data-dynamic-label-prefix"] = dynamic_label_prefix if dynamic_label_prefix.present?

  overlay_arguments[:data] = merge_data(
    overlay_arguments, data: {
      target: "action-menu.overlay"
    }
  )

  @overlay = Primer::Alpha::Overlay.new(
    id: "#{@menu_id}-overlay",
    title: "Menu",
    visually_hide_title: true,
    anchor_align: anchor_align,
    anchor_side: anchor_side,
    size: size,
    **overlay_arguments
  )

  @list = Primer::Alpha::ActionMenu::List.new(
    menu_id: @menu_id,
    select_variant: select_variant,
    form_arguments: form_arguments
  )
end