code
stringlengths 26
124k
| docstring
stringlengths 23
125k
| func_name
stringlengths 1
98
| language
stringclasses 1
value | repo
stringlengths 5
53
| path
stringlengths 7
151
| url
stringlengths 50
211
| license
stringclasses 7
values |
|---|---|---|---|---|---|---|---|
def call(args = {})
style = nil
classes = [].tap do |result|
args.each do |key, val|
case key
when :classes
# insert :classes first to avoid huge doc diffs
result.unshift(val) unless val.blank?
next
when :style
style = val
next
end
next unless LOOKUP[key]
if val.is_a?(Array)
# A while loop is ~3.5x faster than Array#each.
brk = 0
while brk < val.size
item = val[brk]
if item.nil?
brk += 1
next
end
# Believe it or not, three calls to Hash#[] and an inline rescue
# are about 30% faster than Hash#dig. It also ensures validate is
# only called when necessary, i.e. when the class can't be found
# in the lookup table.
found = (LOOKUP[key][item][brk] rescue nil) || validate(key, item, brk)
# rubocop:enable Style/RescueModifier
result << found if found
brk += 1
end
else
next if val.nil?
# rubocop:disable Style/RescueModifier
found = (LOOKUP[key][val][0] rescue nil) || validate(key, val, 0)
# rubocop:enable Style/RescueModifier
result << found if found
end
end
end.join(" ")
# This is much faster than Rails' presence method.
{
class: !classes || classes.empty? ? nil : classes,
style: !style || style.empty? ? nil : style
}
# rubocop:enable Rails/Blank
end | Utility for mapping component configuration into Primer CSS class names.
**args can contain utility keys that mimic the interface used by
https://github.com/primer/components, as well as the special entries :classes
and :style.
Returns a hash containing two entries. The :classes entry is a string of
Primer CSS class names, including any classes given in the :classes entry
in **args. The :style entry is the value of the given :style entry given in
**args.
Example usage:
extract_css_attrs({ mt: 4, py: 2 }) => { classes: "mt-4 py-2", style: nil }
extract_css_attrs(classes: "d-flex", mt: 4, py: 2) => { classes: "d-flex mt-4 py-2", style: nil }
extract_css_attrs(classes: "d-flex", style: "float: left", mt: 4, py: 2) => { classes: "d-flex mt-4 py-2", style: "float: left" } | call | ruby | primer/view_components | lib/primer/classify.rb | https://github.com/primer/view_components/blob/master/lib/primer/classify.rb | MIT |
def supported_value?(key, val)
supported_key?(key) && !UTILITIES[key][val].nil?
end | Does the Utility class support the given key and value
returns Boolean | supported_value? | ruby | primer/view_components | lib/primer/classify/utilities.rb | https://github.com/primer/view_components/blob/master/lib/primer/classify/utilities.rb | MIT |
def supported_selector?(selector)
# This method is too slow to run in production
return false unless validate_class_names?
find_selector(selector).present?
end | Does the given selector exist in the utilities file
returns Boolean | supported_selector? | ruby | primer/view_components | lib/primer/classify/utilities.rb | https://github.com/primer/view_components/blob/master/lib/primer/classify/utilities.rb | MIT |
def responsive?(key, val)
supported_value?(key, val) && UTILITIES[key][val].count > 1
end | Is the key and value responsive
returns Boolean | responsive? | ruby | primer/view_components | lib/primer/classify/utilities.rb | https://github.com/primer/view_components/blob/master/lib/primer/classify/utilities.rb | MIT |
def mappings(key)
return unless supported_key?(key)
UTILITIES[key].keys
end | Get the options for the given key
returns Array or nil if key not supported | mappings | ruby | primer/view_components | lib/primer/classify/utilities.rb | https://github.com/primer/view_components/blob/master/lib/primer/classify/utilities.rb | MIT |
def classes_to_hash(classes)
obj = {}
classes = classes.split
# Loop through all classes supplied and reject ones we find a match for
# So when we're at the end of the loop we have classes left with any non-system classes.
classes.reject! do |classname|
key, value, index = find_selector(classname)
next false if key.nil?
# Create array if nil
obj[key] = Array.new(5, nil) if obj[key].nil?
# Place the arguments in the responsive array based on index mr: [nil, 2]
obj[key][index] = value
next true
end
# Transform responsive arrays into arrays without trailing nil, so `mr: [1, nil, nil, nil, nil]` becomes `mr: 1`
obj.transform_values! do |value|
value = value.reverse.drop_while(&:nil?).reverse
if value.count == 1
value.first
else
value
end
end
# Add back the non-system classes
obj[:classes] = classes.join(" ") if classes.any?
obj
end | Extract hash from classes ie. "mr-1 mb-2 foo" => { mr: 1, mb: 2, classes: "foo" } | classes_to_hash | ruby | primer/view_components | lib/primer/classify/utilities.rb | https://github.com/primer/view_components/blob/master/lib/primer/classify/utilities.rb | MIT |
def render_erb_ignoring_markdown_code_fences(markdown_str)
return view_context.render(inline: markdown_str) unless markdown_str.include?("```")
# identify all fenced code blocks in markdown string
code_ranges = find_fenced_code_ranges_in(markdown_str)
# replace code fences with placeholders
de_fenced_markdown_str = markdown_str.dup.tap do |memo|
code_ranges.reverse_each.with_index do |code_range, idx|
memo[code_range] = "<!--codefence#{idx}-->"
end
end
# Render ERB tags. The only ones left will explicitly exist _outside_ markdown code fences.
rendered_str = view_context.render(inline: de_fenced_markdown_str)
# replace placeholders with original code fences
code_ranges.reverse_each.with_index do |code_range, idx|
rendered_str.sub!("<!--codefence#{idx}-->", markdown_str[code_range])
end
rendered_str
end | Renders ERB code to a string, ignoring markdown code fences. For example, consider the
following ERB code inside a markdown document:
### Heading
```erb
<%= render(SomeComponent.new) %>
```
<%= some_func(a, b) %>
The ERB renderer does not understand that the fenced code, i.e. the part inside the triple
backticks, should not be rendered. It sees the ERB tags both inside and outside the fence
and renders them both.
This method renders ERB tags in a markdown string, ignoring any fenced code blocks, so as
to prevent rendering fenced ERB code. | render_erb_ignoring_markdown_code_fences | ruby | primer/view_components | lib/primer/static/generate_info_arch.rb | https://github.com/primer/view_components/blob/master/lib/primer/static/generate_info_arch.rb | MIT |
def correction(args)
return if args.nil?
correction = "<%= render #{self.class::COMPONENT}.new"
correction += "(#{args})" if args.present?
"#{correction} %>"
end | Overriding the basic correction since this component does not uses content blocks. | correction | ruby | primer/view_components | lib/primer/view_components/linters/close_button_component_migration_counter.rb | https://github.com/primer/view_components/blob/master/lib/primer/view_components/linters/close_button_component_migration_counter.rb | MIT |
def add_correction(tag, tag_tree)
offense_loc = tag.loc.with(end_pos: tag_tree[:closing].loc.to_range.last)
add_offense(offense_loc, tag_tree[:message], tag_tree[:correction])
end | Overriding the basic correction since this component will rewrite the whole tag block. | add_correction | ruby | primer/view_components | lib/primer/view_components/linters/close_button_component_migration_counter.rb | https://github.com/primer/view_components/blob/master/lib/primer/view_components/linters/close_button_component_migration_counter.rb | MIT |
def aria_label_from_octicon(kwargs)
return if kwargs.blank? || kwargs.type != :hash || kwargs.pairs.blank?
aria_label = kwargs.pairs.find { |x| x.key.value == :"aria-label" }
return aria_label.value.source if aria_label
aria_hash = kwargs.pairs.find { |x| x.key.value == :aria }
return if aria_hash.blank?
aria_label = aria_hash.value.pairs.find { |x| x.key.value == :label }
aria_label&.value&.source
end | Extracts the aria-label value from the octicon kwargs.
It can either be in `"aria-label": "value"`` or `aria: { label: "value" } }`. | aria_label_from_octicon | ruby | primer/view_components | lib/primer/view_components/linters/close_button_component_migration_counter.rb | https://github.com/primer/view_components/blob/master/lib/primer/view_components/linters/close_button_component_migration_counter.rb | MIT |
def build_tag_tree(processed_source)
nodes = processed_source.ast.children
tag_tree = {}
tags = []
current_opened_tag = nil
nodes.each do |node|
if node.type == :tag
# get the tag from previously calculated list so the references are the same
tag = BetterHtml::Tree::Tag.from_node(node)
tags << tag
if tag.closing?
if current_opened_tag && tag.name == current_opened_tag.name
tag_tree[current_opened_tag][:closing] = tag
current_opened_tag = tag_tree[current_opened_tag][:parent]
end
next
end
self_closing = self_closing?(tag)
tag_tree[tag] = {
tag: tag,
closing: self_closing ? tag : nil,
parent: current_opened_tag,
children: []
}
tag_tree[current_opened_tag][:children] << tag_tree[tag] if current_opened_tag
current_opened_tag = tag unless self_closing
elsif current_opened_tag
tag_tree[current_opened_tag][:children] << node
end
end
[tags, tag_tree]
end | This assumes that the AST provided represents valid HTML, where each tag has a corresponding closing tag.
From the tags, we build a structured tree which represents the tag hierarchy.
With this, we are able to know where the tags start and end. | build_tag_tree | ruby | primer/view_components | lib/primer/view_components/linters/tag_tree_helpers.rb | https://github.com/primer/view_components/blob/master/lib/primer/view_components/linters/tag_tree_helpers.rb | MIT |
def classes_to_args(classes)
{ classes: classes }
end | Override this with your component's mappings, it should return a hash with the component's arguments,
including a `classes` key that will contain all classes that the mapper couldn't handle.
@return { classes: Array, ... } | classes_to_args | ruby | primer/view_components | lib/primer/view_components/linters/argument_mappers/base.rb | https://github.com/primer/view_components/blob/master/lib/primer/view_components/linters/argument_mappers/base.rb | MIT |
def generate_node_offense(klass, processed_source, node, message = nil)
message ||= klass::MESSAGE
offense = ["#{klass.name}:#{message}", node.loc.source].join("\n")
add_offense(processed_source.to_source_range(node.loc), offense)
end | Generate offense for ERB node tag | generate_node_offense | ruby | primer/view_components | lib/primer/view_components/linters/helpers/rule_helpers.rb | https://github.com/primer/view_components/blob/master/lib/primer/view_components/linters/helpers/rule_helpers.rb | MIT |
def link_to_component(component)
backend = Primer::Yard::LookbookPagesBackend.new(Primer::Yard::Registry.make, nil)
component_ref = Primer::Yard::ComponentManifest.ref_for(component)
page = backend.page_for(component_ref)
# If the page_path method is available, we're being rendered into HTML by Lookbook
# and should emit an HTML <a> tag. No page_path means we're being rendered into
# markdown by LookbookPagesBackend and should emit a markdown + ERB link that
# Lookbook will eventually render on page load.
if respond_to?(:page_path)
link_to(page.docs.short_name, page_path(page.page_id.to_sym.inspect))
else
# rubocop:disable Rails/OutputSafety
"[#{page.docs.short_name}](<%= page_path(#{page.page_id.to_sym.inspect}) %>)".html_safe
# rubocop:enable Rails/OutputSafety
end
end | Adheres to the same signature as Primer::Yard::DocsHelper#link_to_component so link_to_component
may be used in a Gatsby or Lookbook context and produce the correct link for each platform.
@param component [Class] The component class to link to.
@return [String] The link, either in HTML or markdown format. | link_to_component | ruby | primer/view_components | lib/primer/yard/lookbook_docs_helper.rb | https://github.com/primer/view_components/blob/master/lib/primer/yard/lookbook_docs_helper.rb | MIT |
def valid_node?(node)
return false if node.nil?
view_helpers.include?(node.method_name) || (node.method_name == :new && !node.receiver.nil? && ::Primer::ViewComponents::STATUSES.key?(node.receiver.const_name))
end | We only verify SystemArguments if it's a `.new` call on a component or
a ViewHeleper call. | valid_node? | ruby | primer/view_components | lib/rubocop/cop/primer/base_cop.rb | https://github.com/primer/view_components/blob/master/lib/rubocop/cop/primer/base_cop.rb | MIT |
def pattern(component)
Parser::CurrentRuby.parse(component)
.to_s
.gsub("nil", "nil?")
.delete("\n")
.gsub(" ", " ")
end | Converts a string to acceptable rubocop-ast pattern syntax | pattern | ruby | primer/view_components | lib/rubocop/cop/primer/deprecated_components.rb | https://github.com/primer/view_components/blob/master/lib/rubocop/cop/primer/deprecated_components.rb | MIT |
def playground(content: "Playground")
render(Primer::Box.new) { content }
end | @label Playground
@param content [String] text | playground | ruby | primer/view_components | previews/primer/box_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/box_preview.rb | MIT |
def playground(size: :medium, overflow_menu: true)
render(Primer::Alpha::ActionBar.new(size: size, overflow_menu: overflow_menu)) do |component|
component.with_item_icon_button(icon: :search, label: "Search")
component.with_item_icon_button(icon: :pencil, label: "Edit")
component.with_item_icon_button(icon: :archive, label: "Archive")
component.with_item_divider
component.with_item_icon_button(icon: :heart, label: "Heart")
component.with_item_icon_button(icon: :bookmark, label: "Bookmark")
component.with_item_icon_button(icon: :mention, label: "Mention")
component.with_item_divider
component.with_item_icon_button(icon: :paperclip, label: "Attach")
end
end | @label Playground
@param size [Symbol] select [[Small, small], [Medium, medium], [Large, large]]
@param overflow_menu [Boolean] | playground | ruby | primer/view_components | previews/primer/alpha/action_bar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_bar_preview.rb | MIT |
def playground(
role: Primer::Alpha::ActionList::DEFAULT_ROLE,
scheme: Primer::Alpha::ActionList::DEFAULT_SCHEME,
show_dividers: false
)
render(Primer::Alpha::ActionList.new(
role: role,
scheme: scheme,
show_dividers: show_dividers
)) do |component|
component.with_heading(title: "Action List")
component.with_item(label: "Item one", href: "/") do |item|
item.with_leading_visual_icon(icon: :gear)
end
component.with_item(label: "Item two", href: "/") do |item|
item.with_leading_visual_icon(icon: :star)
end
component.with_item(label: "Item three", href: "/") do |item|
item.with_leading_visual_icon(icon: :heart)
end
end
end | @label Playground
@param role text
@param scheme [Symbol] select [full, inset]
@param show_dividers toggle | playground | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def default(
role: Primer::Alpha::ActionList::DEFAULT_ROLE,
scheme: Primer::Alpha::ActionList::DEFAULT_SCHEME,
show_dividers: false
)
render(Primer::Alpha::ActionList.new(
role: role,
scheme: scheme,
show_dividers: show_dividers
)) do |component|
component.with_heading(title: "Action List")
component.with_item(label: "Item one", href: "/") do |item|
item.with_leading_visual_icon(icon: :gear)
end
component.with_item(label: "Item two", href: "/") do |item|
item.with_leading_visual_icon(icon: :star)
end
component.with_item(label: "Item three", href: "/") do |item|
item.with_leading_visual_icon(icon: :heart)
end
end
end | @label Default
@param role text
@param scheme [Symbol] select [full, inset]
@param show_dividers toggle
@snapshot | default | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def leading_visuals(
role: Primer::Alpha::ActionList::DEFAULT_ROLE,
scheme: Primer::Alpha::ActionList::DEFAULT_SCHEME,
show_dividers: false
)
render(Primer::Alpha::ActionList.new(
role: role,
scheme: scheme,
show_dividers: show_dividers
)) do |component|
component.with_heading(title: "Action List")
component.with_item(label: "Leading SVG visual", href: "/") do |item|
item.with_leading_visual_svg do
'<path d="M8 16a2 2 0 001.985-1.75c.017-.137-.097-.25-.235-.25h-3.5c-.138 0-.252.113-.235.25A2 2 0 008 16z"></path><path fill-rule="evenodd" d="M8 1.5A3.5 3.5 0 004.5 5v2.947c0 .346-.102.683-.294.97l-1.703 2.556a.018.018 0 00-.003.01l.001.006c0 .002.002.004.004.006a.017.017 0 00.006.004l.007.001h10.964l.007-.001a.016.016 0 00.006-.004.016.016 0 00.004-.006l.001-.007a.017.017 0 00-.003-.01l-1.703-2.554a1.75 1.75 0 01-.294-.97V5A3.5 3.5 0 008 1.5zM3 5a5 5 0 0110 0v2.947c0 .05.015.098.042.139l1.703 2.555A1.518 1.518 0 0113.482 13H2.518a1.518 1.518 0 01-1.263-2.36l1.703-2.554A.25.25 0 003 7.947V5z"></path>'.html_safe
end
end
component.with_item(label: "Custom content", href: "/") do |item|
item.with_leading_visual_content do
'<span style="width: 16px; height: 16px; display: block; text-align: center; line-height: 16px">A</span>'.html_safe
end
end
end
end | @label Leading visuals
@param role text
@param scheme [Symbol] select [full, inset]
@param show_dividers toggle | leading_visuals | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def with_manual_dividers(
role: Primer::Alpha::ActionList::DEFAULT_ROLE,
scheme: Primer::Alpha::ActionList::DEFAULT_SCHEME,
show_dividers: false
)
render(
Primer::Alpha::ActionList.new(
role: role,
scheme: scheme,
show_dividers: show_dividers
)
) do |component|
component.with_heading(title: "Action List")
component.with_item(label: "Item one", href: "/") do |item|
item.with_leading_visual_icon(icon: :gear)
end
component.with_divider
component.with_item(label: "Item two", href: "/") do |item|
item.with_leading_visual_icon(icon: :star)
end
component.with_item(label: "Item three", href: "/") do |item|
item.with_leading_visual_icon(icon: :heart)
end
component.with_divider
component.with_item(label: "Item four", href: "/") do |item|
item.with_leading_visual_icon(icon: :bug)
end
end
end | @label With manual dividers
@param role text
@param scheme [Symbol] select [full, inset]
@param show_dividers toggle | with_manual_dividers | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def divider(
scheme: Primer::Alpha::ActionList::Divider::DEFAULT_SCHEME
)
render(Primer::Alpha::ActionList::Divider.new(scheme: scheme))
end | @label Divider
@param scheme [Symbol] select [subtle, filled] | divider | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def heading(
scheme: Primer::Alpha::ActionList::Heading::DEFAULT_SCHEME,
title: "This is a title",
list_id: "unique-id",
subtitle: "This is a subtitle"
)
render(
Primer::Alpha::ActionList::Heading.new(
scheme: scheme, list_id: list_id, title: title, subtitle: subtitle
)
)
end | @label Heading
@param scheme [Symbol] select [subtle, filled]
@param title text
@param subtitle text
@param list_id text
@snapshot | heading | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def item(
label: "Label",
truncate_label: false,
href: nil,
size: Primer::Alpha::ActionList::Item::DEFAULT_SIZE,
scheme: Primer::Alpha::ActionList::Item::DEFAULT_SCHEME,
disabled: false,
description: nil,
description_scheme: Primer::Alpha::ActionList::Item::DEFAULT_DESCRIPTION_SCHEME,
active: false,
expanded: false,
leading_visual_icon: nil,
trailing_visual_icon: nil,
trailing_visual_label: nil,
trailing_visual_counter: nil,
trailing_visual_text: nil,
private_leading_action_icon: nil,
private_trailing_action_icon: nil,
trailing_action: false,
tooltip: false
)
list = Primer::Alpha::ActionList.new(aria: { label: "Action List" })
list.with_item(
label: label,
truncate_label: truncate_label,
href: href,
size: size,
scheme: scheme,
disabled: disabled,
description_scheme: description_scheme,
active: active,
expanded: expanded,
id: "tooltip-test"
) do |item|
item.with_leading_visual_icon(icon: leading_visual_icon) if leading_visual_icon && leading_visual_icon != :none
if trailing_visual_icon && trailing_visual_icon != :none
item.with_trailing_visual_icon(icon: trailing_visual_icon)
elsif trailing_visual_label
item.with_trailing_visual_label { trailing_visual_label }
elsif trailing_visual_counter
item.with_trailing_visual_counter(count: trailing_visual_counter)
elsif trailing_visual_text
item.with_trailing_visual_text(trailing_visual_text)
end
if private_leading_action_icon && private_leading_action_icon != :none
item.with_private_leading_action_icon(icon: private_leading_action_icon)
elsif private_trailing_action_icon && private_trailing_action_icon != :none
item.with_private_trailing_action_icon(icon: private_trailing_action_icon)
end
item.with_trailing_action(icon: "plus", "aria-label": "Button tooltip", size: :medium) if trailing_action && trailing_action != :none
item.with_description { description } if description
item.with_tooltip(text: "Tooltip text", for_id: "tooltip-test", type: :description) if tooltip
end
render(list)
end | @label Item [playground]
@param label text
@param truncate_label toggle
@param href text
@param size [Symbol] select [medium, large, xlarge]
@param scheme [Symbol] select [default, danger]
@param disabled toggle
@param description text
@param description_scheme [Symbol] select [inline, block]
@param active toggle
@param leading_visual_icon [Symbol] octicon
@param trailing_visual_icon [Symbol] octicon
@param trailing_visual_label text
@param trailing_visual_counter number
@param trailing_visual_text text
@param private_leading_action_icon [Symbol] octicon
@param private_trailing_action_icon [Symbol] octicon
@param trailing_action toggle
@param tooltip toggle | item | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def avatar_item(
username: "hulk_smash",
truncate_label: false,
src: "https://avatars.githubusercontent.com/u/103004183?v=4",
shape: Primer::Beta::Avatar::DEFAULT_SHAPE,
size: Primer::Alpha::ActionList::Item::DEFAULT_SIZE,
scheme: Primer::Alpha::ActionList::Item::DEFAULT_SCHEME,
disabled: false,
full_name: "Bruce Banner",
full_name_scheme: Primer::Alpha::ActionList::Item::DEFAULT_DESCRIPTION_SCHEME,
active: false,
expanded: false,
trailing_visual_icon: nil,
trailing_visual_label: nil,
trailing_visual_counter: nil,
trailing_visual_text: nil,
private_trailing_action_icon: nil,
trailing_action: false,
tooltip: false
)
list = Primer::Alpha::ActionList.new(aria: { label: "Action List" })
list.with_avatar_item(
username: username,
truncate_label: truncate_label,
src: src,
size: size,
scheme: scheme,
disabled: disabled,
full_name: full_name,
full_name_scheme: full_name_scheme,
active: active,
expanded: expanded,
id: "tooltip-test",
avatar_arguments: { shape: shape }
) do |item|
if trailing_visual_icon && trailing_visual_icon != :none
item.with_trailing_visual_icon(icon: trailing_visual_icon)
elsif trailing_visual_label
item.with_trailing_visual_label { trailing_visual_label }
elsif trailing_visual_counter
item.with_trailing_visual_counter(count: trailing_visual_counter)
elsif trailing_visual_text
item.with_trailing_visual_text(trailing_visual_text)
end
item.with_private_trailing_action_icon(icon: private_trailing_action_icon) if private_trailing_action_icon && private_trailing_action_icon != :none
item.with_trailing_action(icon: "plus", "aria-label": "Button tooltip", size: :medium) if trailing_action && trailing_action != :none
item.with_tooltip(text: "Tooltip text", for_id: "tooltip-test", type: :description) if tooltip
end
render(list)
end | @label Avatar item [playground]
@param username text
@param truncate_label toggle
@param src text
@param shape [Symbol] select [circle, square]
@param size [Symbol] select [medium, large, xlarge]
@param scheme [Symbol] select [default, danger]
@param disabled toggle
@param full_name text
@param full_name_scheme [Symbol] select [inline, block]
@param active toggle
@param trailing_visual_icon [Symbol] octicon
@param trailing_visual_label text
@param trailing_visual_counter number
@param trailing_visual_text text
@param private_trailing_action_icon [Symbol] octicon
@param trailing_action toggle
@param tooltip toggle | avatar_item | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def item_leading_trailing_visual
render(Primer::Alpha::ActionList.new(
aria: { label: "List heading" }
)) do |component|
component.with_item(label: "Item with trailing visual", href: "/") do |item|
item.with_leading_visual_icon(icon: :heart)
item.with_trailing_visual_icon(icon: :star)
end
end
end | @label Item [leading and trailing visual]
@snapshot | item_leading_trailing_visual | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def long_label_with_tooltip(truncate_label: :show_tooltip)
render(Primer::Alpha::ActionList.new(aria: { label: "List heading" })) do |component|
component.with_item(
label: "Really really long label that may wrap, truncate, or appear as a tooltip",
truncate_label: truncate_label
)
component.with_item(
label: "Really really long label that may wrap, truncate, or appear as a tooltip",
truncate_label: truncate_label
)
component.with_item(
label: "Really really long label that may wrap, truncate, or appear as a tooltip",
truncate_label: truncate_label
)
component.with_item(
label: "Really really long label that may wrap, truncate, or appear as a tooltip",
truncate_label: truncate_label
)
end
end | @label Long label
@param truncate_label [Symbol] select [none, truncate, show_tooltip]
@snapshot | long_label_with_tooltip | ruby | primer/view_components | previews/primer/alpha/action_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_list_preview.rb | MIT |
def playground(
select_variant: Primer::Alpha::ActionMenu::DEFAULT_SELECT_VARIANT, anchor_align: Primer::Alpha::Overlay::DEFAULT_ANCHOR_ALIGN, anchor_side: Primer::Alpha::Overlay::DEFAULT_ANCHOR_SIDE,
size: Primer::Alpha::Overlay::DEFAULT_SIZE
)
render(Primer::Alpha::ActionMenu.new(select_variant: select_variant, anchor_align: anchor_align, anchor_side: anchor_side, size: size)) do |menu|
menu.with_show_button { "Menu" }
menu.with_item(label: "Copy link")
menu.with_item(label: "Quote reply")
menu.with_item(label: "Reference in new issue")
menu.with_divider
menu.with_item(label: "Edit")
menu.with_item(label: "Delete", scheme: :danger)
end
end | @label Playground
@param select_variant [Symbol] select [single, multiple, none]
@param anchor_align [Symbol] select [start, center, end]
@param anchor_side [Symbol] select [outside_bottom, outside_top, outside_left, outside_right]
@param size [Symbol] select [auto, small, medium, large, xlarge] | playground | ruby | primer/view_components | previews/primer/alpha/action_menu_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_menu_preview.rb | MIT |
def with_items_and_groups
render(Primer::Alpha::ActionMenu.new(menu_id: "menu-1")) do |menu|
menu.with_show_button do |button|
button.with_trailing_action_icon(icon: :"triangle-down")
"Meal preference"
end
menu.with_item(label: "Meat option")
menu.with_divider
menu.with_group do |group|
group.with_heading(title: "Vegetarian options")
group.with_item(label: "Grilled portbello mushroom")
group.with_item(label: "Polenta")
group.with_item(label: "Seitan")
end
menu.with_divider
menu.with_item(label: "Fish option")
end
end | @label With items and groups
@snapshot interactive | with_items_and_groups | ruby | primer/view_components | previews/primer/alpha/action_menu_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/action_menu_preview.rb | MIT |
def playground(label_text: "Select a fruit", is_label_visible: true, is_label_inline: false, with_icon: false, is_clearable: false)
# rubocop:disable Primer/ComponentNameMigration
render(
Primer::Alpha::AutoComplete.new(
label_text: label_text,
input_id: "input-id",
list_id: "test-id",
src: UrlHelpers.primer_view_components.autocomplete_index_path(version: "alpha"),
is_label_visible: is_label_visible,
is_label_inline: is_label_inline,
with_icon: with_icon,
is_clearable: is_clearable
)
)
# rubocop:enable Primer/ComponentNameMigration
end | @label Playground
@param label_text text
@param is_label_visible toggle
@param is_label_inline toggle
@param with_icon toggle
@param is_clearable toggle | playground | ruby | primer/view_components | previews/primer/alpha/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/auto_complete_preview.rb | MIT |
def default(label_text: "Select a fruit", is_label_visible: true, is_label_inline: false, with_icon: false, is_clearable: false)
# rubocop:disable Primer/ComponentNameMigration
render(
Primer::Alpha::AutoComplete.new(
label_text: label_text,
input_id: "input-id",
list_id: "test-id",
src: UrlHelpers.primer_view_components.autocomplete_index_path(version: "alpha"),
is_label_visible: is_label_visible,
is_label_inline: is_label_inline,
with_icon: with_icon,
is_clearable: is_clearable
)
)
# rubocop:enable Primer/ComponentNameMigration
end | @label Default Options
@param label_text text
@param is_label_visible toggle
@param is_label_inline toggle
@param with_icon toggle
@param is_clearable toggle
@snapshot | default | ruby | primer/view_components | previews/primer/alpha/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/auto_complete_preview.rb | MIT |
def with_non_visible_label
# rubocop:disable Primer/ComponentNameMigration
render(
Primer::Alpha::AutoComplete.new(
label_text: "Select a fruit",
input_id: "input-id-1",
list_id: "test-id-1",
src: UrlHelpers.primer_view_components.autocomplete_index_path(version: "alpha"),
is_label_visible: false
)
)
# rubocop:enable Primer/ComponentNameMigration
end | @!group More examples
@label AutoComplete with non-visible label | with_non_visible_label | ruby | primer/view_components | previews/primer/alpha/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/auto_complete_preview.rb | MIT |
def playground(full: false, full_when_narrow: false, dismiss_scheme: Primer::Alpha::Banner::DEFAULT_DISMISS_SCHEME, dismiss_label: Primer::Alpha::Banner::DEFAULT_DISMISS_LABEL, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, content: "This is a banner!", description: nil)
icon = nil if icon == :none
render(Primer::Alpha::Banner.new(full: full, full_when_narrow: full_when_narrow, dismiss_scheme: dismiss_scheme, dismiss_label: dismiss_label, icon: icon == :none ? nil : icon, scheme: scheme, description: description)) { content }
end | @label Playground
@param full toggle
@param full_when_narrow toggle
@param dismiss_scheme [Symbol] select [none, remove, hide]
@param dismiss_label text
@param icon [Symbol] octicon
@param scheme [Symbol] select [default, warning, danger, success, upsell]
@param content text
@param description text | playground | ruby | primer/view_components | previews/primer/alpha/banner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/banner_preview.rb | MIT |
def scheme_default
render(Primer::Alpha::Banner.new) { "This is a default banner." }
end | @!group Schemes
@label Default scheme
@snapshot | scheme_default | ruby | primer/view_components | previews/primer/alpha/banner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/banner_preview.rb | MIT |
def full_width
render(Primer::Alpha::Banner.new(full: true)) { "This is a full width banner." }
end | @!group Full Width
@snapshot
@label Full width | full_width | ruby | primer/view_components | previews/primer/alpha/banner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/banner_preview.rb | MIT |
def full_width_in_narrow_viewport
render(Primer::Alpha::Banner.new(full: true, full_when_narrow: true)) { "This is a full width banner in a narrow viewport." }
end | @label Full width in Narrow Viewport | full_width_in_narrow_viewport | ruby | primer/view_components | previews/primer/alpha/banner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/banner_preview.rb | MIT |
def with_action_button(full: false, dismiss_scheme: Primer::Alpha::Banner::DEFAULT_DISMISS_SCHEME, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, content: "This is a banner with an action!")
icon = nil if icon == :none
render_with_template(locals: { full: full, dismiss_scheme: dismiss_scheme, icon: icon == :none ? nil : icon, scheme: scheme, content: content })
end | @!endgroup
@label With action button
@param full toggle
@param dismiss_scheme [Symbol] select [none, remove, hide]
@param icon [Symbol] octicon
@param scheme [Symbol] select [default, warning, danger, success, upsell]
@param content text
@snapshot | with_action_button | ruby | primer/view_components | previews/primer/alpha/banner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/banner_preview.rb | MIT |
def with_action_content(full: false, dismiss_scheme: Primer::Alpha::Banner::DEFAULT_DISMISS_SCHEME, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, content: "Did you know? Comments can be edited.")
icon = nil if icon == :none
render_with_template(locals: { full: full, dismiss_scheme: dismiss_scheme, icon: icon == :none ? nil : icon, scheme: scheme, content: content })
end | @label With action content
@param full toggle
@param dismiss_scheme [Symbol] select [none, remove, hide]
@param icon [Symbol] octicon
@param scheme [Symbol] select [default, warning, danger, success, upsell]
@param content text
@snapshot | with_action_content | ruby | primer/view_components | previews/primer/alpha/banner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/banner_preview.rb | MIT |
def sizes_default
render(Primer::Alpha::ButtonMarketing.new) { "Default" }
end | @!group Size Variants
@snapshot
@label Default | sizes_default | ruby | primer/view_components | previews/primer/alpha/button_marketing_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/button_marketing_preview.rb | MIT |
def scheme_default
render(Primer::Alpha::ButtonMarketing.new) { "Default" }
end | @!endgroup
@!group Schemes
@snapshot
@label Default | scheme_default | ruby | primer/view_components | previews/primer/alpha/button_marketing_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/button_marketing_preview.rb | MIT |
def playground(
name: "my-check-group",
label: "I would go into battle with:",
caption: "Qa'pla!",
validation_message: nil,
disabled: false
)
system_arguments = {
name: name,
label: label,
caption: caption,
validation_message: validation_message,
disabled: disabled
}
render(Primer::Alpha::CheckBoxGroup.new(**system_arguments)) do |component|
component.check_box(label: "Jean-Luc Picard", value: "picard")
component.check_box(label: "Hikaru Sulu", value: "sulu")
component.check_box(label: "Kathryn Janeway", value: "janeway")
component.check_box(label: "Benjamin Sisko", value: "sisko")
end
end | @label Playground
@param name text
@param label text
@param caption text
@param validation_message text
@param disabled toggle | playground | ruby | primer/view_components | previews/primer/alpha/check_box_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/check_box_group_preview.rb | MIT |
def with_caption
render(Primer::Alpha::CheckBoxGroup.new(caption: "With a caption", name: "my-check-group", label: "I would go into battle with:")) do |component|
component.check_box(label: "Jean-Luc Picard", value: "picard1")
component.check_box(label: "Hikaru Sulu", value: "sulu1")
component.check_box(label: "Kathryn Janeway", value: "janeway1")
component.check_box(label: "Benjamin Sisko", value: "sisko1")
end
end | @!group Options
@snapshot
@label With caption | with_caption | ruby | primer/view_components | previews/primer/alpha/check_box_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/check_box_group_preview.rb | MIT |
def playground(
name: "my-check-box",
value: "picard",
label: "Jean-Luc Picard",
caption: "Make it so",
visually_hide_label: false,
disabled: false
)
system_arguments = {
name: name,
value: value,
label: label,
caption: caption,
visually_hide_label: visually_hide_label,
disabled: disabled
}
render(Primer::Alpha::CheckBox.new(**system_arguments))
end | @label Playground
@param name text
@param value text
@param label text
@param caption text
@param visually_hide_label toggle
@param disabled toggle | playground | ruby | primer/view_components | previews/primer/alpha/check_box_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/check_box_preview.rb | MIT |
def with_caption
render(Primer::Alpha::CheckBox.new(caption: "With a caption", name: "my-check-box1", label: "Jean-Luc Picard"))
end | @!group Options
@snapshot
@label With caption | with_caption | ruby | primer/view_components | previews/primer/alpha/check_box_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/check_box_preview.rb | MIT |
def playground(title: "Test Dialog", subtitle: nil, size: :medium, button_text: "Show Dialog", body_text: "Content", position: :center, position_narrow: :fullscreen, visually_hide_title: false, icon: nil, disable_button: false)
render(Primer::Alpha::Dialog.new(title: title, subtitle: subtitle, size: size, position: position, position_narrow: position_narrow, visually_hide_title: visually_hide_title)) do |d|
if icon.present? && (icon != :none)
d.with_show_button(icon: icon, "aria-label": icon.to_s, disabled: disable_button)
else
d.with_show_button(disabled: disable_button) { button_text }
end
d.with_body { body_text }
end
end | @label Playground
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position [Symbol] select [center, left, right]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param disable_button [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@param icon [Symbol] octicon | playground | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def default(title: "Test Dialog", subtitle: nil, size: :medium, button_text: "Show Dialog", body_text: "Content", position: :center, position_narrow: :fullscreen, visually_hide_title: false)
render(Primer::Alpha::Dialog.new(title: title, subtitle: subtitle, size: size, position: position, position_narrow: position_narrow, visually_hide_title: visually_hide_title)) do |d|
d.with_show_button { button_text }
d.with_body { body_text }
end
end | @label Default options
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position [Symbol] select [center, left, right]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@snapshot interactive | default | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def long_text(title: "Test Dialog", subtitle: nil, size: :medium, button_text: "Show Dialog", position: :center, position_narrow: :fullscreen)
render(Primer::Alpha::Dialog.new(title: title, subtitle: subtitle, size: size, position: position, position_narrow: position_narrow)) do |d|
d.with_show_button { button_text }
d.with_body { "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?" }
end
end | @label Long text
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position [Symbol] select [center, left, right]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right] | long_text | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def with_header(title: "Test Dialog", subtitle: nil, header_variant: :medium, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
header_variant: header_variant,
button_text: button_text,
show_divider: show_divider
})
end | @label With Header
@param title [String] text
@param subtitle [String] text
@param header_variant [Symbol] select [medium, large]
@param button_text [String] text
@param show_divider [Boolean] toggle | with_header | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def with_footer(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end | @label With Footer
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle | with_footer | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def with_form(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end | @label With a Form
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle | with_form | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def custom_header(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end | @label Custom Header
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle | custom_header | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def nested_dialog(title: "Test Dialog", subtitle: nil, position: :center, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
position: position,
button_text: button_text,
show_divider: show_divider
})
end | @label Nested dialog
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle
@param position [Symbol] select [center, left, right] | nested_dialog | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def with_text_input(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end | @label Dialog with text input
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle | with_text_input | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def with_auto_complete(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider,
url: UrlHelpers.primer_view_components.autocomplete_index_path
})
end | @label Dialog with AutoComplete text input
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle
@snapshot interactive | with_auto_complete | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def body_has_scrollbar_overflow(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end | @label Page with scrollbar and dialog
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle | body_has_scrollbar_overflow | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def autofocus_element
render_with_template(locals: {})
end | @label Autofocus element with autofocus attribute | autofocus_element | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def left_side(title: "Test Dialog", subtitle: nil, size: :medium, button_text: "Show Dialog", body_text: "Content", position: :center, position_narrow: :fullscreen, visually_hide_title: false)
render(Primer::Alpha::Dialog.new(title: title, subtitle: subtitle, size: size, position: :left, position_narrow: position_narrow, visually_hide_title: visually_hide_title)) do |d|
d.with_show_button { button_text }
d.with_body { body_text }
end
end | @label Left Side
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@snapshot interactive | left_side | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def right_side(title: "Test Dialog", subtitle: nil, size: :medium, button_text: "Show Dialog", body_text: "Content", position: :center, position_narrow: :fullscreen, visually_hide_title: false)
render(Primer::Alpha::Dialog.new(title: title, subtitle: subtitle, size: size, position: :right, position_narrow: position_narrow, visually_hide_title: visually_hide_title)) do |d|
d.with_show_button { button_text }
d.with_body { body_text }
end
end | @label Right Side
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@snapshot interactive | right_side | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def scroll_container(title: "Test Dialog", subtitle: nil, position: :center, size: :medium, button_text: "Show Dialog", body_text: "Content", position_narrow: :fullscreen, visually_hide_title: false, disable_scroll: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
position: position,
size: size,
button_text: button_text,
body_text: body_text,
position_narrow: position_narrow,
visually_hide_title: visually_hide_title,
disable_scroll: disable_scroll
})
end | @label Scroll container
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position [Symbol] select [center, right, left]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@param disable_scroll [Boolean] toggle
@snapshot interactive | scroll_container | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def dialog_inside_overlay(title: "Test Dialog", subtitle: nil, position: :center, size: :medium, button_text: "Show Dialog", body_text: "Content", position_narrow: :fullscreen, visually_hide_title: false)
render_with_template(locals: {
title: title,
subtitle: subtitle,
position: position,
size: size,
button_text: button_text,
body_text: body_text,
position_narrow: position_narrow,
visually_hide_title: visually_hide_title
})
end | @label Dialog inside Overlay
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position [Symbol] select [center, right, left]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@snapshot interactive | dialog_inside_overlay | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def initally_open(title: "Test Dialog", subtitle: nil, size: :medium, button_text: "Show Dialog", body_text: "Content", position: :center, position_narrow: :fullscreen, visually_hide_title: false, icon: nil, disable_button: false)
render(Primer::Alpha::Dialog.new(open: true, title: title, subtitle: subtitle, size: size, position: position, position_narrow: position_narrow, visually_hide_title: visually_hide_title)) do |d|
if icon.present? && (icon != :none)
d.with_show_button(icon: icon, "aria-label": icon.to_s, disabled: disable_button)
else
d.with_show_button(disabled: disable_button) { button_text }
end
d.with_body { body_text }
end
end | @label Initially Open
@param title [String] text
@param subtitle [String] text
@param size [Symbol] select [small, medium, medium_portrait, large, xlarge]
@param position [Symbol] select [center, left, right]
@param position_narrow [Symbol] select [inherit, bottom, fullscreen, left, right]
@param visually_hide_title [Boolean] toggle
@param disable_button [Boolean] toggle
@param button_text [String] text
@param body_text [String] text
@param icon [Symbol] octicon
@snapshot interactive | initally_open | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def with_header_close_button_label(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true, close_label: "Close me!")
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider,
close_label: close_label
})
end | @label With custom label for close button of header
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle
@param close_label [String] text | with_header_close_button_label | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def without_header_close_button_label(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end | @label Without custom label for close button of header
@param title [String] text
@param subtitle [String] text
@param button_text [String] text
@param show_divider [Boolean] toggle | without_header_close_button_label | ruby | primer/view_components | previews/primer/alpha/dialog_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dialog_preview.rb | MIT |
def playground(overlay: :default, with_caret: false)
render(Primer::Alpha::Dropdown.new(overlay: overlay, with_caret: with_caret)) do |component|
component.with_button { "Dropdown" }
component.with_menu(header: "Header") do |menu|
menu.with_item { "Item 1" }
menu.with_item { "Item 2" }
menu.with_item(divider: true)
menu.with_item { "Item 3" }
menu.with_item { "Item 4" }
end
end
end | @label Playground
@param with_caret [Boolean] toggle
@param overlay [Symbol] select [none, default, dark] | playground | ruby | primer/view_components | previews/primer/alpha/dropdown_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dropdown_preview.rb | MIT |
def menu(as: :default, direction: :se, scheme: :default)
render(Primer::Alpha::Dropdown::Menu.new(as: as, direction: direction, scheme: scheme, header: "Header")) do |menu|
menu.with_item { "Item 1" }
menu.with_item { "Item 2" }
menu.with_item(divider: true)
menu.with_item { "Item 3" }
menu.with_item { "Item 4" }
end
end | @label Menu
@param as [Symbol] select [list, default]
@param direction [Symbol] select [se, sw, w, e, ne, s]
@param scheme [Symbol] select [default, dark] | menu | ruby | primer/view_components | previews/primer/alpha/dropdown_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dropdown_preview.rb | MIT |
def options_with_caret
render(Primer::Alpha::Dropdown.new(with_caret: true)) do |component|
component.with_button { "Dropdown" }
component.with_menu do |menu|
menu.with_item { "Item 1" }
menu.with_item { "Item 2" }
menu.with_item { "Item 3" }
end
end
end | @!endgroup
@!group Options
@label With caret | options_with_caret | ruby | primer/view_components | previews/primer/alpha/dropdown_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/dropdown_preview.rb | MIT |
def playground(
label: "Best character",
caption: "May the force be with you",
validation_message: "Something went wrong",
required: false,
visually_hide_label: false,
full_width: false
)
render_with_template(
locals: {
system_arguments: {
label: label,
caption: caption,
validation_message: validation_message,
required: required,
visually_hide_label: visually_hide_label,
full_width: full_width
}
}
)
end | @label Playground
@param label text
@param caption text
@param validation_message text
@param required toggle
@param visually_hide_label toggle
@param full_width toggle | playground | ruby | primer/view_components | previews/primer/alpha/form_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/form_control_preview.rb | MIT |
def default(inline: false, aria_label: "No effect")
render(Primer::Alpha::HellipButton.new(inline: inline, "aria-label": aria_label))
end | @label Default Options
@param aria_label [String]
@param inline [Boolean]
@snapshot | default | ruby | primer/view_components | previews/primer/alpha/hellip_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/hellip_button_preview.rb | MIT |
def playground(inline: false, aria_label: "No effect", disabled: false)
render(Primer::Alpha::HellipButton.new(inline: inline, "aria-label": aria_label, disabled: disabled))
end | @label Playground
@param aria_label [String]
@param inline [Boolean]
@param disabled [Boolean] | playground | ruby | primer/view_components | previews/primer/alpha/hellip_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/hellip_button_preview.rb | MIT |
def playground(label: "No effect", inline: false)
render(Primer::Alpha::HiddenTextExpander.new(inline: inline, "aria-label": label))
end | @label Playground
@param label [String] text
@param inline [Boolean] toggle | playground | ruby | primer/view_components | previews/primer/alpha/hidden_text_expander_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/hidden_text_expander_preview.rb | MIT |
def default(label: "No effect", inline: false)
render(Primer::Alpha::HiddenTextExpander.new(inline: inline, "aria-label": label))
end | @label Default options
@param label [String] text
@param inline [Boolean] toggle
@snapshot | default | ruby | primer/view_components | previews/primer/alpha/hidden_text_expander_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/hidden_text_expander_preview.rb | MIT |
def playground(loading: :eager)
render(Primer::Alpha::IncludeFragment.new(loading: loading, src: UrlHelpers.primer_view_components.include_fragment_deferred_path)) { "Loading..." }
end | @label Playground
@param loading select [eager, lazy] | playground | ruby | primer/view_components | previews/primer/alpha/include_fragment_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/include_fragment_preview.rb | MIT |
def playground(stacking_breakpoint: :sm, gutter: :default, first_in_source: :sidebar)
render(Primer::Alpha::Layout.new(stacking_breakpoint: stacking_breakpoint, gutter: gutter, first_in_source: first_in_source)) do |component|
component.with_main(bg: :attention, p: 6) do
"Main content"
end
component.with_sidebar(bg: :accent, p: 6) do
"Sidebar content"
end
end
end | @label Playground
@param stacking_breakpoint [Symbol] select [sm, md, lg]
@param first_in_source [Symbol] select [sidebar, main]
@param gutter [Symbol] select [default, none, condensed, spacious] | playground | ruby | primer/view_components | previews/primer/alpha/layout_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/layout_preview.rb | MIT |
def main_width_md
render(Primer::Alpha::Layout.new) do |component|
component.with_main(width: :md, bg: :attention, p: 6) { "Main content" }
component.with_sidebar(bg: :accent, p: 6) { "Sidebar content" }
end
end | @!endgroup
@!group Main width
@label Medium | main_width_md | ruby | primer/view_components | previews/primer/alpha/layout_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/layout_preview.rb | MIT |
def sidebar_width_narrow
render(Primer::Alpha::Layout.new) do |component|
component.with_main(bg: :attention, p: 6) { "Main content" }
component.with_sidebar(width: :narrow, bg: :accent, p: 6) { "Sidebar content" }
end
end | @!endgroup
@!group Sidebar width
@snapshot
@label Narrow | sidebar_width_narrow | ruby | primer/view_components | previews/primer/alpha/layout_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/layout_preview.rb | MIT |
def sidebar_col_placement_start
render(Primer::Alpha::Layout.new) do |component|
component.with_main(bg: :attention, p: 6) { "Main content" }
component.with_sidebar(col_placement: :start, bg: :accent, p: 6) { "Sidebar content" }
end
end | @!endgroup
@!group Sidebar column placement
@snapshot
@label Start | sidebar_col_placement_start | ruby | primer/view_components | previews/primer/alpha/layout_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/layout_preview.rb | MIT |
def sidebar_row_placement_start
render(Primer::Alpha::Layout.new) do |component|
component.with_main(bg: :attention, p: 6) { "Main content" }
component.with_sidebar(row_placement: :start, bg: :accent, p: 6) { "Sidebar content" }
end
end | @!endgroup
@!group Sidebar row placement
@label Start | sidebar_row_placement_start | ruby | primer/view_components | previews/primer/alpha/layout_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/layout_preview.rb | MIT |
def stacking_breakpoint_sm
render(Primer::Alpha::Layout.new(stacking_breakpoint: :sm)) do |component|
component.with_main(bg: :attention, p: 6) { "Main content" }
component.with_sidebar(bg: :accent, p: 6) { "Sidebar content" }
end
end | @!endgroup
@!group Stacking breakpoint
@label Small | stacking_breakpoint_sm | ruby | primer/view_components | previews/primer/alpha/layout_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/layout_preview.rb | MIT |
def playground(
label: "Dietary preference",
caption: "What'll ya have?",
disabled: false
)
render_with_template(
locals: {
system_arguments: {
label: label,
caption: caption,
disabled: disabled
}
}
)
end | @label Playground
@param label text
@param caption text
@param disabled toggle | playground | ruby | primer/view_components | previews/primer/alpha/multi_input_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/multi_input_preview.rb | MIT |
def playground(title: "Test Overlay", subtitle: nil, role: :dialog, size: :auto, padding: :normal, anchor_align: :center, anchor_offset: :normal, anchor_side: :outside_bottom, allow_out_of_bounds: false, visually_hide_title: false, header_size: :medium, button_text: "Show Overlay", body_text: "", icon: :none)
render(Primer::Alpha::Overlay.new(
title: title,
subtitle: subtitle,
role: role,
size: size,
padding: padding,
anchor_align: anchor_align,
anchor_offset: anchor_offset,
anchor_side: anchor_side,
allow_out_of_bounds: allow_out_of_bounds,
visually_hide_title: visually_hide_title
)) do |d|
d.with_header(title: title, size: header_size)
if icon.present? && (icon != :none)
d.with_show_button(icon: icon, "aria-label": icon.to_s)
else
d.with_show_button { button_text }
end
d.with_body { body_text }
end
end | @label Playground
@param title [String] text
@param subtitle [String] text
@param role [Symbol] select [dialog, menu]
@param size [Symbol] select [auto, small, medium, medium_portrait, large, xlarge]
@param padding [Symbol] select [normal, condensed, none]
@param anchor_align [Symbol] select [start, center, end]
@param anchor_offset [Symbol] select [normal, spacious]
@param anchor_side [Symbol] select [inside_top, inside_bottom, inside_left, inside_right, inside_center, outside_top, outside_bottom, outside_left, outside_right]
@param allow_out_of_bounds [Boolean] toggle
@param visually_hide_title [Boolean] toggle
@param header_size [Symbol] select [medium, large]
@param button_text [String] text
@param body_text [String] text
@param icon [Symbol] octicon | playground | ruby | primer/view_components | previews/primer/alpha/overlay_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/overlay_preview.rb | MIT |
def default(title: "Test Overlay", subtitle: nil, role: :dialog, size: :auto, padding: :normal, anchor_align: :center, anchor_side: :outside_bottom, allow_out_of_bounds: false, visually_hide_title: false, header_size: :medium, button_text: "Show Overlay", body_text: "")
render(Primer::Alpha::Overlay.new(
title: title,
subtitle: subtitle,
role: role,
size: size,
padding: padding,
anchor_align: anchor_align,
anchor_side: anchor_side,
allow_out_of_bounds: allow_out_of_bounds,
visually_hide_title: visually_hide_title
)) do |d|
d.with_header(title: title, size: header_size)
d.with_show_button { button_text }
d.with_body { body_text }
end
end | @label Default
@param title [String] text
@param subtitle [String] text
@param role [Symbol] select [dialog, menu]
@param size [Symbol] select [auto, small, medium, medium_portrait, large, xlarge]
@param padding [Symbol] select [normal, condensed, none]
@param anchor_align [Symbol] select [start, center, end]
@param anchor_side [Symbol] select [inside_top, inside_bottom, inside_left, inside_right, inside_center, outside_top, outside_bottom, outside_left, outside_right]
@param allow_out_of_bounds [Boolean] toggle
@param visually_hide_title [Boolean] toggle
@param header_size [Symbol] select [medium, large]
@param button_text [String] text
@param body_text [String] text | default | ruby | primer/view_components | previews/primer/alpha/overlay_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/overlay_preview.rb | MIT |
def menu_no_header(size: :auto, padding: :normal, anchor_align: :center, anchor_side: :outside_bottom, allow_out_of_bounds: false, button_text: "Show Overlay Menu", body_text: "This is a menu")
render(Primer::Alpha::Overlay.new(
title: "Menu",
role: :menu,
size: size,
padding: padding,
anchor_align: anchor_align,
anchor_side: anchor_side,
allow_out_of_bounds: allow_out_of_bounds
)) do |d|
d.with_show_button { button_text }
d.with_body { body_text }
end
end | @label Menu No Header
@param size [Symbol] select [auto, small, medium, medium_portrait, large, xlarge]
@param padding [Symbol] select [normal, condensed, none]
@param anchor_align [Symbol] select [start, center, end]
@param anchor_side [Symbol] select [inside_top, inside_bottom, inside_left, inside_right, inside_center, outside_top, outside_bottom, outside_left, outside_right]
@param allow_out_of_bounds [Boolean] toggle
@param button_text [String] text
@param body_text [String] text | menu_no_header | ruby | primer/view_components | previews/primer/alpha/overlay_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/overlay_preview.rb | MIT |
def middle_of_page(title: "Test Overlay", subtitle: nil, role: :dialog, size: :auto, placement: :anchored, anchor_align: :center, anchor_side: :outside_bottom, allow_out_of_bounds: false, visually_hide_title: false, header_size: :medium, button_text: "Show Overlay", body_text: "")
render_with_template(locals: {
title: title,
subtitle: subtitle,
role: role,
size: size,
placement: placement,
anchor_align: anchor_align,
anchor_side: anchor_side,
allow_out_of_bounds: allow_out_of_bounds,
visually_hide_title: visually_hide_title,
header_size: header_size,
button_text: button_text,
body_text: body_text
})
end | @label Middle Of Page
@param title [String] text
@param subtitle [String] text
@param role [Symbol] select [dialog, menu]
@param size [Symbol] select [auto, small, medium, medium_portrait, large, xlarge]
@param anchor_align [Symbol] select [start, center, end]
@param anchor_side [Symbol] select [inside_top, inside_bottom, inside_left, inside_right, inside_center, outside_top, outside_bottom, outside_left, outside_right]
@param allow_out_of_bounds [Boolean] toggle
@param visually_hide_title [Boolean] toggle
@param header_size [Symbol] select [medium, large]
@param button_text [String] text
@param body_text [String] text | middle_of_page | ruby | primer/view_components | previews/primer/alpha/overlay_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/overlay_preview.rb | MIT |
def middle_of_page_with_relative_container(title: "Test Overlay", subtitle: nil, role: :dialog, size: :auto, placement: :anchored, anchor_align: :center, anchor_side: :outside_bottom, allow_out_of_bounds: false, visually_hide_title: false, header_size: :medium, button_text: "Show Overlay", body_text: "")
render_with_template(locals: {
title: title,
subtitle: subtitle,
role: role,
size: size,
placement: placement,
anchor_align: anchor_align,
anchor_side: anchor_side,
allow_out_of_bounds: allow_out_of_bounds,
visually_hide_title: visually_hide_title,
header_size: header_size,
button_text: button_text,
body_text: body_text
})
end | @label Middle Of Page with relative container
@param title [String] text
@param subtitle [String] text
@param role [Symbol] select [dialog, menu]
@param size [Symbol] select [auto, small, medium, medium_portrait, large, xlarge]
@param anchor_align [Symbol] select [start, center, end]
@param anchor_side [Symbol] select [inside_top, inside_bottom, inside_left, inside_right, inside_center, outside_top, outside_bottom, outside_left, outside_right]
@param allow_out_of_bounds [Boolean] toggle
@param visually_hide_title [Boolean] toggle
@param header_size [Symbol] select [medium, large]
@param button_text [String] text
@param body_text [String] text | middle_of_page_with_relative_container | ruby | primer/view_components | previews/primer/alpha/overlay_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/overlay_preview.rb | MIT |
def playground(
name: "my-radio-group",
label: "Question: what kind of bear is best?",
caption: "There are basically two schools of thought",
validation_message: nil,
disabled: false
)
system_arguments = {
name: name,
label: label,
caption: caption,
validation_message: validation_message,
disabled: disabled
}
render(Primer::Alpha::RadioButtonGroup.new(**system_arguments)) do |component|
component.radio_button(label: "Bears", value: "bears")
component.radio_button(label: "Beets", value: "beets")
component.radio_button(label: "Battlestar Galactica", value: "bsg")
end
end | @label Playground
@param name text
@param label text
@param caption text
@param validation_message text
@param disabled toggle | playground | ruby | primer/view_components | previews/primer/alpha/radio_button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/radio_button_group_preview.rb | MIT |
def with_caption
render(Primer::Alpha::RadioButtonGroup.new(caption: "With a caption", name: "my-radio-group", label: "Question: what kind of bear is best?")) do |component|
component.radio_button(label: "Bears", value: "bears1")
component.radio_button(label: "Beets", value: "beets1")
component.radio_button(label: "Battlestar Galactica", value: "bsg1")
end
end | @!group Options
@label With caption
@snapshot | with_caption | ruby | primer/view_components | previews/primer/alpha/radio_button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/radio_button_group_preview.rb | MIT |
def playground(
name: "my-radio-button",
value: "bsg",
label: "Battlestar Galactica",
caption: "A pretty good show",
visually_hide_label: false,
disabled: false
)
system_arguments = {
name: name,
value: value,
label: label,
caption: caption,
visually_hide_label: visually_hide_label,
disabled: disabled
}
render(Primer::Alpha::RadioButton.new(**system_arguments))
end | @label Playground
@param name text
@param value text
@param label text
@param caption text
@param visually_hide_label toggle
@param disabled toggle | playground | ruby | primer/view_components | previews/primer/alpha/radio_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/radio_button_preview.rb | MIT |
def with_caption
render(Primer::Alpha::RadioButton.new(caption: "With a caption", name: "my-radio-button", label: "Battlestar Galactica", value: "bsg1"))
end | @!group Options
@label With caption
@snapshot | with_caption | ruby | primer/view_components | previews/primer/alpha/radio_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/radio_button_preview.rb | MIT |
def playground(full_width: false, hide_labels: false, size: :medium, icon: :none)
if icon == :none
icon = hide_labels ? :zap : nil
end
render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: full_width, hide_labels: hide_labels, size: size)) do |component|
component.with_item(label: "Preview", icon: icon, selected: true)
component.with_item(label: "Raw", icon: icon)
component.with_item(label: "Blame", icon: icon)
end
end | @label Playground
@param full_width [Boolean] toggle
@param hide_labels [Boolean] toggle
@param icon [Symbol] octicon
@param size select [small, medium] | playground | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def full_width_small(hide_labels: false)
render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: hide_labels, full_width: true, size: :small)) do |component|
component.with_item(label: "Preview", selected: true)
component.with_item(label: "Raw")
component.with_item(label: "Blame")
end
end | @!group Full width
@label Size small
@param hide_labels [Boolean] toggle
@snapshot | full_width_small | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def full_width_medium(hide_labels: false)
render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: hide_labels, full_width: true, size: :medium)) do |component|
component.with_item(label: "Preview", selected: true)
component.with_item(label: "Raw")
component.with_item(label: "Blame")
end
end | @label Size medium
@param hide_labels [Boolean] toggle
@snapshot | full_width_medium | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def icons_and_text_small
render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", size: :small)) do |component|
component.with_item(label: "Preview", icon: :eye, selected: true)
component.with_item(label: "Raw", icon: :"file-code")
component.with_item(label: "Blame", icon: :people)
end
end | @!endgroup
@!group Icons and text
@label Size small
@snapshot | icons_and_text_small | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def trailing_label_width_small
render(Primer::Alpha::SegmentedControl.new("aria-label": "Billing duration", size: :small)) do |component|
component.with_item(label: "Monthly")
component.with_item(label: "Yearly", selected: true) do |button|
button.with_trailing_visual_label(scheme: :accent) { "-8%" }
end
end
end | @!endgroup
@!group Trailing Label
@label Size small
@snapshot | trailing_label_width_small | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def icon_only_small
render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, size: :small)) do |component|
component.with_item(label: "Preview", icon: :eye, selected: true)
component.with_item(label: "Raw", icon: :"file-code")
component.with_item(label: "Blame", icon: :people)
end
end | @!endgroup
@!group Icons only
@label Size small
@snapshot | icon_only_small | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def with_link_as_tag
render(Primer::Alpha::SegmentedControl.new("aria-label": "File view")) do |component|
component.with_item(tag: :a, href: "#", label: "Preview", icon: :eye, selected: true)
component.with_item(tag: :a, href: "#", label: "Raw", icon: :"file-code")
component.with_item(tag: :a, href: "#", label: "Blame", icon: :people)
end
end | @!endgroup
NOTE: this preview uses a group to force it's display below the other groups
@!group With link as tag
@snapshot | with_link_as_tag | ruby | primer/view_components | previews/primer/alpha/segmented_control_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/segmented_control_preview.rb | MIT |
def playground(
title: "Sci-fi equipment",
subtitle: "Various tools from your favorite shows",
size: :auto,
simulate_failure: false,
simulate_no_results: false,
no_results_label: "No results found",
dynamic_label: false,
dynamic_label_prefix: nil,
dynamic_aria_label_prefix: nil,
open_on_load: false,
anchor_align: :start,
anchor_side: :outside_bottom,
selected_items: "Phaser"
)
render_with_template(locals: {
subtitle: subtitle,
selected_items: selected_items,
system_arguments: {
title: title,
size: size,
simulate_failure: simulate_failure,
simulate_no_results: simulate_no_results,
no_results_label: no_results_label,
dynamic_label: dynamic_label,
dynamic_label_prefix: dynamic_label_prefix,
dynamic_aria_label_prefix: dynamic_aria_label_prefix,
open_on_load: open_on_load,
anchor_align: anchor_align,
anchor_side: anchor_side
}
})
end | @label Playground
@param title text
@param size [Symbol] select [auto, small, medium, medium_portrait, large, xlarge]
@param simulate_failure toggle
@param simulate_no_results toggle
@param no_results_label text
@param dynamic_label toggle
@param dynamic_label_prefix text
@param dynamic_aria_label_prefix text
@param open_on_load toggle
@param anchor_align [Symbol] select [start, center, end]
@param anchor_side [Symbol] select [outside_bottom, outside_top, outside_left, outside_right]
@param selected_items text | playground | ruby | primer/view_components | previews/primer/alpha/select_panel_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/select_panel_preview.rb | MIT |
def default(open_on_load: false, show_filter: true)
render_with_template(template: "primer/alpha/select_panel_preview/local_fetch", locals: {
open_on_load: open_on_load,
show_filter: show_filter
})
end | @label Default
@snapshot interactive
@param open_on_load toggle
@param show_filter toggle | default | ruby | primer/view_components | previews/primer/alpha/select_panel_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/select_panel_preview.rb | MIT |
def local_fetch(open_on_load: false, show_filter: true)
render_with_template(locals: { open_on_load: open_on_load, show_filter: show_filter })
end | @label Local fetch
@snapshot interactive
@param open_on_load toggle
@param show_filter toggle | local_fetch | ruby | primer/view_components | previews/primer/alpha/select_panel_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/select_panel_preview.rb | MIT |
def eventually_local_fetch(open_on_load: false, show_filter: true)
render_with_template(locals: { open_on_load: open_on_load, show_filter: show_filter })
end | @label Eventually local fetch
@snapshot interactive
@param open_on_load toggle
@param show_filter toggle | eventually_local_fetch | ruby | primer/view_components | previews/primer/alpha/select_panel_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/select_panel_preview.rb | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.