Class: Primer::PopoverComponent

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/popover_component.rb

Overview

Use ‘Popover` to bring attention to specific user interface elements, typically to suggest an action or to guide users through a new experience.

By default, the popover renders with absolute positioning, meaning it should usually be wrapped in an element with a relative position in order to be positioned properly. To render the popover with relative positioning, use the relative property.

Constant Summary collapse

CARET_DEFAULT = 
:top
CARET_MAPPINGS = 
{
  CARET_DEFAULT => "",
  :bottom => "Popover-message--bottom",
  :bottom_right => "Popover-message--bottom-right",
  :bottom_left => "Popover-message--bottom-left",
  :left => "Popover-message--left",
  :left_bottom => "Popover-message--left-bottom",
  :left_top => "Popover-message--left-top",
  :right => "Popover-message--right",
  :right_bottom => "Popover-message--right-bottom",
  :right_top => "Popover-message--right-top",
  :top_left => "Popover-message--top-left",
  :top_right => "Popover-message--top-right"
}.freeze
DEFAULT_HEADING_TAG = 
:h4

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(**system_arguments) ⇒ PopoverComponent

Returns a new instance of PopoverComponent.

Examples:

Default

<%= render Primer::PopoverComponent.new do |component| %>
  <% component.heading do %>
    Activity feed
  <% end %>
  <% component.body do %>
    This is the Popover body.
  <% end %>
<% end %>

Large

<%= render Primer::PopoverComponent.new do |component| %>
  <% component.heading do %>
    Activity feed
  <% end %>
  <% component.body(large: true) do %>
    This is the large Popover body.
  <% end %>
<% end %>

Caret position

<%= render Primer::PopoverComponent.new do |component| %>
  <% component.heading do %>
    Activity feed
  <% end %>
  <% component.body(caret: :left) do %>
    This is the Popover body.
  <% end %>
<% end %>

With multiple elements in the body

<%= render Primer::PopoverComponent.new do |component| %>
  <% component.heading do %>
    Activity feed
  <% end %>
  <% component.body(caret: :left) do %>
    <p>This is the Popover body.</p>
    <%= render Primer::ButtonComponent.new(type: :submit) do %>
      Got it!
    <% end %>
  <% end %>
<% end %>

Parameters:

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



105
106
107
108
109
110
111
112
113
114
115
 
# File 'app/components/primer/popover_component.rb', line 105

def initialize(**system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :div
  @system_arguments[:classes] = class_names(
    system_arguments[:classes],
    "Popover"
  )
  @system_arguments[:position] ||= :relative
  @system_arguments[:right] = false unless @system_arguments.delete(:right)
  @system_arguments[:left] = false unless @system_arguments.delete(:left)
end

Instance Method Details

#body_component ⇒ Object 



121
122
123
 
# File 'app/components/primer/popover_component.rb', line 121

def body_component
  Primer::BoxComponent.new(**@body_arguments)
end

#render? ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'app/components/primer/popover_component.rb', line 117

def render?
  body.present?
end