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 remote_fetch(open_on_load: false, selected_items: "Phaser")
render_with_template(locals: { open_on_load: open_on_load, selected_items: selected_items })
end | @label Remote fetch
@snapshot interactive
@param open_on_load toggle
@param selected_items text | remote_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 custom_loading_label(open_on_load: false, selected_items: "Phaser")
render_with_template(locals: { open_on_load: open_on_load, selected_items: selected_items })
end | @label Custom loading label
@snapshot interactive
@param open_on_load toggle
@param selected_items text | custom_loading_label | 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 custom_loading_description(open_on_load: false, selected_items: "Phaser")
render_with_template(locals: { open_on_load: open_on_load, selected_items: selected_items })
end | @label Custom loading description
@snapshot interactive
@param open_on_load toggle
@param selected_items text | custom_loading_description | 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_no_results(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label Local fetch (no results)
@snapshot interactive
@param open_on_load toggle | local_fetch_no_results | 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_no_results(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label Eventually local fetch (no results)
@snapshot interactive
@param open_on_load toggle | eventually_local_fetch_no_results | 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 remote_fetch_no_results(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label Remote fetch (no results)
@snapshot interactive
@param open_on_load toggle | remote_fetch_no_results | 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 single_select(dynamic_label: false, open_on_load: false)
render_with_template(locals: { dynamic_label: dynamic_label, open_on_load: open_on_load })
end | @label Single select
@snapshot interactive
@param dynamic_label toggle
@param open_on_load toggle | single_select | 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 multiselect(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label Multiselect
@snapshot interactive
@param open_on_load toggle | multiselect | 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 with_dynamic_label(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @!group Dynamic label
@label With dynamic label
@snapshot interactive
@param open_on_load toggle | with_dynamic_label | 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 with_dynamic_label_and_aria_prefix(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label With dynamic label and aria prefix
@snapshot interactive
@param open_on_load toggle | with_dynamic_label_and_aria_prefix | 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 footer_buttons(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @!endgroup
@label Footer buttons
@snapshot interactive
@param open_on_load toggle | footer_buttons | 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 with_avatar_items(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label With avatar items
@snapshot interactive
@param open_on_load toggle | with_avatar_items | 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 with_leading_icons(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @!group With icons
@label With leading icons
@snapshot interactive
@param open_on_load toggle | with_leading_icons | 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 with_trailing_icons(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label With trailing icons
@snapshot interactive
@param open_on_load toggle | with_trailing_icons | 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 with_subtitle(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @!endgroup
@label With subtitle
@snapshot interactive
@param open_on_load toggle | with_subtitle | 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 remote_fetch_initial_failure(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label Remote fetch initial failure
@snapshot interactive
@param open_on_load toggle | remote_fetch_initial_failure | 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 remote_fetch_filter_failure(
open_on_load: false,
banner_scheme: :danger,
show_results: true
)
render_with_template(locals: {
open_on_load: open_on_load,
show_results: show_results,
system_arguments: {
# .to_sym workaround for https://github.com/lookbook-hq/lookbook/issues/640
banner_scheme: banner_scheme.to_sym
}
})
end | @label Remote fetch filter failure
@snapshot interactive
@param open_on_load toggle
@param banner_scheme [Symbol] select [danger, warning]
@param show_results toggle | remote_fetch_filter_failure | 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_initial_failure(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label Eventually local fetch initial failure
@snapshot interactive
@param open_on_load toggle | eventually_local_fetch_initial_failure | 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 single_select_form(open_on_load: false, route_format: :html)
render_with_template(locals: { open_on_load: open_on_load, route_format: route_format })
end | @label Single-select form
@snapshot interactive
@param open_on_load toggle | single_select_form | 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 remote_fetch_form(open_on_load: false, selected_items: "Phaser", route_format: :html)
render_with_template(locals: { open_on_load: open_on_load, selected_items: selected_items, route_format: route_format })
end | @label Remote fetch form
@snapshot interactive
@param open_on_load toggle
@param selected_items text | remote_fetch_form | 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 multiselect_form(open_on_load: false, route_format: :html)
render_with_template(locals: { open_on_load: open_on_load, route_format: route_format })
end | @label Multi-select form
@snapshot interactive
@param open_on_load toggle | multiselect_form | 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 list_of_links(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label List of links
@snapshot interactive
@param open_on_load toggle | list_of_links | 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 no_values(open_on_load: false)
render_with_template(locals: { open_on_load: open_on_load })
end | @label No values
@snapshot interactive
@param open_on_load toggle | no_values | 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 playground(
name: "my-select-list",
id: "my-select-list",
label: "Favorite place to visit",
caption: "They're all good",
required: false,
multiple: false,
visually_hide_label: false,
size: Primer::Forms::Dsl::Input::DEFAULT_SIZE.to_s,
full_width: true,
disabled: false,
invalid: false,
validation_message: nil
)
system_arguments = {
name: name,
id: id,
label: label,
caption: caption,
required: required,
multiple: multiple,
visually_hide_label: visually_hide_label,
size: size,
full_width: full_width,
disabled: disabled,
invalid: invalid,
validation_message: validation_message
}
render(Primer::Alpha::Select.new(**system_arguments)) do |component|
component.option(label: "Lopez Island", value: "lopez")
component.option(label: "Shaw Island", value: "shaw")
component.option(label: "Orcas Island", value: "orcas")
component.option(label: "San Juan Island", value: "san_juan")
end
end | @label Playground
@param name text
@param id text
@param label text
@param caption text
@param required toggle
@param multiple toggle
@param visually_hide_label toggle
@param size [Symbol] select [small, medium, large]
@param full_width toggle
@param disabled toggle
@param invalid toggle
@param validation_message text | playground | ruby | primer/view_components | previews/primer/alpha/select_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/select_preview.rb | MIT |
def with_caption
render(Primer::Alpha::Select.new(caption: "With a caption", name: "my-select-list-1", label: "Favorite place to visit")) do |component|
component.option(label: "Lopez Island", value: "lopez")
component.option(label: "Shaw Island", value: "shaw")
component.option(label: "Orcas Island", value: "orcas")
component.option(label: "San Juan Island", value: "san_juan")
end
end | @!group Options
@label With caption
@snapshot | with_caption | ruby | primer/view_components | previews/primer/alpha/select_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/select_preview.rb | MIT |
def playground(
tag: Primer::Alpha::StackItem::DEFAULT_TAG,
grow: Primer::Alpha::StackItem::GrowArg::DEFAULT,
grow_narrow: Primer::Alpha::StackItem::GrowArg::DEFAULT,
grow_regular: Primer::Alpha::StackItem::GrowArg::DEFAULT,
grow_wide: Primer::Alpha::StackItem::GrowArg::DEFAULT
)
render_with_template(locals: {
system_arguments: {
tag: tag,
grow: control_values_for(grow, grow_narrow, grow_regular, grow_wide)
}
})
end | @label Playground
@param tag text
@param grow toggle
@param grow_narrow toggle
@param grow_regular toggle
@param grow_wide toggle | playground | ruby | primer/view_components | previews/primer/alpha/stack_item_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/stack_item_preview.rb | MIT |
def playground(
tag: Primer::Alpha::StackItem::DEFAULT_TAG,
justify: Primer::Alpha::Stack::JustifyArg::DEFAULT,
justify_narrow: nil,
justify_regular: nil,
justify_wide: nil,
gap: Primer::Alpha::Stack::GapArg::DEFAULT,
gap_narrow: nil,
gap_regular: nil,
gap_wide: nil,
direction: Primer::Alpha::Stack::DirectionArg::DEFAULT,
direction_narrow: nil,
direction_regular: nil,
direction_wide: nil,
align: Primer::Alpha::Stack::AlignArg::DEFAULT,
align_narrow: nil,
align_regular: nil,
align_wide: nil,
wrap: Primer::Alpha::Stack::WrapArg::DEFAULT,
wrap_narrow: nil,
wrap_regular: nil,
wrap_wide: nil,
padding: Primer::Alpha::Stack::PaddingArg::DEFAULT,
padding_narrow: nil,
padding_regular: nil,
padding_wide: nil
)
render_with_template(locals: {
system_arguments: {
tag: tag,
justify: control_values_for(justify, justify_narrow, justify_regular, justify_wide),
gap: control_values_for(gap, gap_narrow, gap_regular, gap_wide),
direction: control_values_for(direction, direction_narrow, direction_regular, direction_wide),
wrap: control_values_for(wrap, wrap_narrow, wrap_regular, wrap_wide),
padding: control_values_for(padding, padding_narrow, padding_regular, padding_wide),
align: control_values_for(align, align_narrow, align_regular, align_wide),
}
})
end | @label Playground
@param tag text
@param justify [Symbol] select {{ Primer::Alpha::Stack::JustifyArg::OPTIONS }}
@param justify_narrow [Symbol] select {{ Primer::Alpha::Stack::JustifyArg::OPTIONS }}
@param justify_regular [Symbol] select {{ Primer::Alpha::Stack::JustifyArg::OPTIONS }}
@param justify_wide [Symbol] select {{ Primer::Alpha::Stack::JustifyArg::OPTIONS }}
@param gap [Symbol] select {{ Primer::Alpha::Stack::GapArg::OPTIONS }}
@param gap_narrow [Symbol] select {{ Primer::Alpha::Stack::GapArg::OPTIONS }}
@param gap_regular [Symbol] select {{ Primer::Alpha::Stack::GapArg::OPTIONS }}
@param gap_wide [Symbol] select {{ Primer::Alpha::Stack::GapArg::OPTIONS }}
@param direction [Symbol] select {{ Primer::Alpha::Stack::DirectionArg::OPTIONS }}
@param direction_narrow [Symbol] select {{ Primer::Alpha::Stack::DirectionArg::OPTIONS }}
@param direction_regular [Symbol] select {{ Primer::Alpha::Stack::DirectionArg::OPTIONS }}
@param direction_wide [Symbol] select {{ Primer::Alpha::Stack::DirectionArg::OPTIONS }}
@param align [Symbol] select {{ Primer::Alpha::Stack::AlignArg::OPTIONS }}
@param align_narrow [Symbol] select {{ Primer::Alpha::Stack::AlignArg::OPTIONS }}
@param align_regular [Symbol] select {{ Primer::Alpha::Stack::AlignArg::OPTIONS }}
@param align_wide [Symbol] select {{ Primer::Alpha::Stack::AlignArg::OPTIONS }}
@param wrap [Symbol] select {{ Primer::Alpha::Stack::WrapArg::OPTIONS }}
@param wrap_narrow [Symbol] select {{ Primer::Alpha::Stack::WrapArg::OPTIONS }}
@param wrap_regular [Symbol] select {{ Primer::Alpha::Stack::WrapArg::OPTIONS }}
@param wrap_wide [Symbol] select {{ Primer::Alpha::Stack::WrapArg::OPTIONS }}
@param padding [Symbol] select {{ Primer::Alpha::Stack::PaddingArg::OPTIONS }}
@param padding_narrow [Symbol] select {{ Primer::Alpha::Stack::PaddingArg::OPTIONS }}
@param padding_regular [Symbol] select {{ Primer::Alpha::Stack::PaddingArg::OPTIONS }}
@param padding_wide [Symbol] select {{ Primer::Alpha::Stack::PaddingArg::OPTIONS }} | playground | ruby | primer/view_components | previews/primer/alpha/stack_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/stack_preview.rb | MIT |
def playground(number_of_tabs: 3, with_icons: false, with_counters: false)
render(Primer::Alpha::TabNav.new(label: "label")) do |component|
Array.new(number_of_tabs&.to_i || 3) do |i|
component.with_tab(selected: i.zero?, href: "##{i + 1}") do |tab|
tab.with_icon(icon: :star) if with_icons
tab.with_text { "Tab #{i + 1}" }
tab.with_counter(count: 10) if with_counters
end
end
end
end | @label Playground
@param number_of_tabs [Integer] number
@param with_icons [Boolean] toggle
@param with_counters [Boolean] toggle | playground | ruby | primer/view_components | previews/primer/alpha/tab_nav_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tab_nav_preview.rb | MIT |
def with_icons_and_counters
render(Primer::Alpha::TabNav.new(label: "With icons and counters")) do |component|
component.with_tab(href: "#1", selected: true) do |tab|
tab.with_icon(icon: :star)
tab.with_text { "Stars" }
tab.with_counter(count: 10)
end
component.with_tab(href: "#2") do |tab|
tab.with_icon(icon: :heart)
tab.with_text { "Sponsors" }
tab.with_counter(count: 14)
end
component.with_tab(href: "#3") do |tab|
tab.with_icon(icon: :bookmark)
tab.with_text { "Bookmarks" }
tab.with_counter(count: 7)
end
end
end | @label With icons and counters
@snapshot | with_icons_and_counters | ruby | primer/view_components | previews/primer/alpha/tab_nav_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tab_nav_preview.rb | MIT |
def with_extra(align: :right)
render_with_template(locals: { align: align })
end | @param align [Symbol] select [left, right]
@snapshot | with_extra | ruby | primer/view_components | previews/primer/alpha/tab_nav_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tab_nav_preview.rb | MIT |
def playground(number_of_panels: 3, align: :left)
render(Primer::Alpha::TabPanels.new(label: "label", align: align)) do |component|
Array.new(number_of_panels&.to_i || 3) do |i|
component.with_tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
tab.with_panel { "Panel #{i + 1}" }
tab.with_text { "Tab #{i + 1}" }
end
end
end
end | @label Playground
@param number_of_panels [Integer] number
@param align [Symbol] select [left, right] | playground | ruby | primer/view_components | previews/primer/alpha/tab_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tab_panels_preview.rb | MIT |
def default(number_of_panels: 3, align: :left)
render(Primer::Alpha::TabPanels.new(label: "label", align: align)) do |component|
Array.new(number_of_panels&.to_i || 3) do |i|
component.with_tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
tab.with_panel { "Panel #{i + 1}" }
tab.with_text { "Tab #{i + 1}" }
end
end
end
end | @label Default options
@param number_of_panels [Integer] number
@param align [Symbol] select [left, right]
@snapshot | default | ruby | primer/view_components | previews/primer/alpha/tab_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tab_panels_preview.rb | MIT |
def with_extra(align: :right)
render_with_template(locals: { align: align })
end | @param align [Symbol] select [left, right] | with_extra | ruby | primer/view_components | previews/primer/alpha/tab_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tab_panels_preview.rb | MIT |
def playground(
name: "my-text-area",
id: "my-text-area",
label: "Tell me about yourself",
caption: "You can trust me, I'm a website",
required: false,
visually_hide_label: false,
full_width: true,
disabled: false,
invalid: false,
validation_message: nil
)
system_arguments = {
name: name,
id: id,
label: label,
caption: caption,
required: required,
visually_hide_label: visually_hide_label,
full_width: full_width,
disabled: disabled,
invalid: invalid,
validation_message: validation_message
}
render(Primer::Alpha::TextArea.new(**system_arguments))
end | @label Playground
@param name text
@param id text
@param label text
@param caption text
@param required toggle
@param visually_hide_label toggle
@param full_width toggle
@param disabled toggle
@param invalid toggle
@param validation_message text | playground | ruby | primer/view_components | previews/primer/alpha/text_area_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_area_preview.rb | MIT |
def with_caption
render(Primer::Alpha::TextArea.new(caption: "With a caption", name: "my-text-area", label: "Tell me about yourself"))
end | @!group Options
@label With caption
@snapshot | with_caption | ruby | primer/view_components | previews/primer/alpha/text_area_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_area_preview.rb | MIT |
def playground(
name: "my-text-field",
id: "my-text-field",
label: "My text field",
caption: "My text field",
required: false,
visually_hide_label: false,
size: Primer::Forms::Dsl::Input::DEFAULT_SIZE.to_s,
show_clear_button: false,
clear_button_id: "my-text-field-clear-button",
full_width: true,
disabled: false,
invalid: false,
validation_message: nil,
placeholder: nil,
inset: false,
monospace: false,
leading_visual_icon: nil,
leading_spinner: false
)
system_arguments = {
name: name,
id: id,
label: label,
caption: caption,
required: required,
visually_hide_label: visually_hide_label,
size: size,
show_clear_button: show_clear_button,
clear_button_id: clear_button_id,
full_width: full_width,
disabled: disabled,
invalid: invalid,
validation_message: validation_message,
placeholder: placeholder,
inset: inset,
monospace: monospace,
leading_spinner: leading_spinner
}
if leading_visual_icon
system_arguments[:leading_visual] = {
icon: leading_visual_icon,
size: :small
}
end
# You're required to specify a leading visual if a leading spinner is requested
if leading_spinner && !leading_visual_icon
system_arguments[:leading_visual] = {
icon: :search,
size: :small
}
end
render(Primer::Alpha::TextField.new(**system_arguments))
end | @label Playground
@param name text
@param id text
@param label text
@param caption text
@param required toggle
@param visually_hide_label toggle
@param size [Symbol] select [small, medium, large]
@param show_clear_button toggle
@param clear_button_id text
@param full_width toggle
@param disabled toggle
@param invalid toggle
@param validation_message text
@param placeholder text
@param inset toggle
@param monospace toggle
@param leading_visual_icon octicon
@param leading_spinner toggle | playground | ruby | primer/view_components | previews/primer/alpha/text_field_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_field_preview.rb | MIT |
def with_caption
render(Primer::Alpha::TextField.new(caption: "With a caption", name: "my-text-field-1", label: "My text field"))
end | @!endgroup
@!group Options
@label With caption
@snapshot | with_caption | ruby | primer/view_components | previews/primer/alpha/text_field_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_field_preview.rb | MIT |
def with_trailing_long_text
render(Primer::Alpha::TextField.new(trailing_visual: { text: { text: "Long trailing text" } }, name: "my-text-field-13", label: "My text field"))
end | @label With trailing long text
@snapshot | with_trailing_long_text | ruby | primer/view_components | previews/primer/alpha/text_field_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_field_preview.rb | MIT |
def with_auto_check_ok
render(Primer::Alpha::TextField.new(auto_check_src: UrlHelpers.primer_view_components.example_check_ok_path, name: "my-text-field-18", label: "My text field"))
end | @!endgroup
@!group Auto check
@label Auto check request ok | with_auto_check_ok | ruby | primer/view_components | previews/primer/alpha/text_field_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_field_preview.rb | MIT |
def with_data_target
render(Primer::Alpha::TextField.new(name: "my-text-field", label: "My text field", data: { target: "custom-component.inputElement" }))
end | @!endgroup
@label With data target attribute | with_data_target | ruby | primer/view_components | previews/primer/alpha/text_field_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_field_preview.rb | MIT |
def input_group_leading_action_menu(route_format: :html)
render_with_template(locals: { route_format: route_format })
end | @label Input group with ActionMenu
@snapshot | input_group_leading_action_menu | ruby | primer/view_components | previews/primer/alpha/text_field_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/text_field_preview.rb | MIT |
def playground(direction: :s, tooltip_text: "You can press a button")
render(Primer::Beta::Button.new(id: "button-with-tooltip")) do |component|
component.with_tooltip(text: tooltip_text, direction: direction)
"Button"
end
end | @param direction select [s, n, e, w, ne, nw, se, sw]
@param tooltip_text text | playground | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def default(direction: :s, tooltip_text: "You can press a button")
render(Primer::Beta::Button.new(id: "button-with-tooltip")) do |component|
component.with_tooltip(text: tooltip_text, direction: direction)
"Button"
end
end | @param direction select [s, n, e, w, ne, nw, se, sw]
@param tooltip_text text | default | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def description_tooltip_on_button_with_existing_describedby(direction: :s, tooltip_text: "You can press a button")
render(Primer::Beta::Button.new(id: "button-with-existing-description", "aria-describedby": "existing-description-id")) do |component|
component.with_tooltip(text: tooltip_text, direction: direction)
"Button"
end
end | @param direction select [s, n, e, w, ne, nw, se, sw]
@param tooltip_text text | description_tooltip_on_button_with_existing_describedby | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def with_right_most_position(type: :description, direction: :s, tooltip_text: "A tooltip with very very very very long description that is not very concise...")
render_with_template(
locals: {
type: type,
direction: direction,
tooltip_text: tooltip_text
}
)
end | @param direction select [s, n, e, w, ne, nw, se, sw]
@param tooltip_text text | with_right_most_position | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def with_multiple_on_a_page(direction: :s, tooltip_text: "You can press a button")
render_with_template(
locals: {
direction: direction,
tooltip_text: tooltip_text
}
)
end | @param direction select [s, n, e, w, ne, nw, se, sw]
@param tooltip_text text | with_multiple_on_a_page | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def tooltip_with_button(direction: :s, tooltip_text: "You can press a button")
render(Primer::Beta::Button.new(id: "button-with-tooltip")) do |component|
component.with_tooltip(text: tooltip_text, direction: direction)
"Button"
end
end | @!group Tooltip enabled elements
@label Tooltip with Primer::Beta::Button | tooltip_with_button | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def tooltip_with_link(direction: :s, tooltip_text: "You can press a button")
render(Primer::Beta::Link.new(href: "#link-with-tooltip", id: "link-with-tooltip", underline: true)) do |component|
component.with_tooltip(text: tooltip_text, direction: direction)
"Button"
end
end | @label Tooltip with Primer::Beta::Link | tooltip_with_link | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def tooltip_inside_primer_overlay
render_with_template(
locals: {}
)
end | @!endgroup
@label Tooltip inside Primer::Alpha::Overlay | tooltip_inside_primer_overlay | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def tooltip_with_dialog_moving_focus_to_input
render_with_template(locals: {})
end | @label Tooltip with button moving focus to input | tooltip_with_dialog_moving_focus_to_input | ruby | primer/view_components | previews/primer/alpha/tooltip_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/tooltip_preview.rb | MIT |
def playground(label: "Default with nav element", tag: :nav, align: :left, number_of_panels: 3)
render_with_template(locals: {
label: label,
tag: tag,
align: align,
number_of_panels: number_of_panels.to_i,
})
end | @label Playground
@param label [String] text
@param tag [Symbol] select [div, nav]
@param align [Symbol] select [left, right]
@param number_of_panels [Integer] number | playground | ruby | primer/view_components | previews/primer/alpha/underline_nav_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_nav_preview.rb | MIT |
def default(label: "Default with nav element", tag: :nav, align: :left, number_of_panels: 3)
render_with_template(locals: {
label: label,
tag: tag,
align: align,
number_of_panels: number_of_panels.to_i,
})
end | @label Default options
@snapshot
@param label [String] text
@param tag [Symbol] select [div, nav]
@param align [Symbol] select [left, right]
@param number_of_panels [Integer] number | default | ruby | primer/view_components | previews/primer/alpha/underline_nav_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_nav_preview.rb | MIT |
def with_icons_and_counters(label: "With icons and counters", number_of_panels: 3, align: :left, tag: :nav)
render(Primer::Alpha::UnderlineNav.new(label: label, tag: tag, align: align)) do |component|
Array.new(number_of_panels.to_i || 3) do |i|
component.with_tab(href: "#", selected: i.zero?) do |tab|
tab.with_icon(icon: :star)
tab.with_text { "Item #{i + 1}" }
tab.with_counter(count: (i + 1) * 5)
end
end
end
end | @label With icons and counters
@snapshot
@param label [String] text
@param tag [Symbol] select [div, nav]
@param align [Symbol] select [left, right]
@param number_of_panels [Integer] number | with_icons_and_counters | ruby | primer/view_components | previews/primer/alpha/underline_nav_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_nav_preview.rb | MIT |
def playground(number_of_panels: 3, align: :left)
render(Primer::Alpha::UnderlinePanels.new(label: "Test navigation", align: align)) do |component|
Array.new(number_of_panels || 3) do |i|
component.with_tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
tab.with_panel { "Panel #{i + 1}" }
tab.with_text { "Tab #{i + 1}" }
end
end
end
end | @label Playground
@param number_of_panels [Integer] number
@param align [Symbol] select [left, right] | playground | ruby | primer/view_components | previews/primer/alpha/underline_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_panels_preview.rb | MIT |
def default(number_of_panels: 3, align: :left)
render(Primer::Alpha::UnderlinePanels.new(label: "Test navigation", align: align)) do |component|
Array.new(number_of_panels&.to_i || 3) do |i|
component.with_tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
tab.with_panel { "Panel #{i + 1}" }
tab.with_text { "Tab #{i + 1}" }
end
end
end
end | @label Default options
@snapshot
@param number_of_panels [Integer] number
@param align [Symbol] select [left, right] | default | ruby | primer/view_components | previews/primer/alpha/underline_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_panels_preview.rb | MIT |
def with_icons_and_counters(number_of_panels: 3, align: :left)
render(Primer::Alpha::UnderlinePanels.new(label: "Test navigation", align: align)) do |component|
Array.new(number_of_panels || 3) do |i|
component.with_tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
tab.with_panel { "Panel #{i + 1}" }
tab.with_text { "Tab #{i + 1}" }
tab.with_icon(icon: :star)
tab.with_counter(count: (i + 1) * 5)
end
end
end
end | @label With Icons and Counters
@snapshot
@param number_of_panels [Integer] number
@param align [Symbol] select [left, right] | with_icons_and_counters | ruby | primer/view_components | previews/primer/alpha/underline_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_panels_preview.rb | MIT |
def with_actions(number_of_panels: 3, align: :right)
render(Primer::Alpha::UnderlinePanels.new(label: "Test navigation", align: align)) do |component|
Array.new(number_of_panels || 3) do |i|
component.with_tab(selected: i.zero?, id: "tab-#{i + 1}") do |tab|
tab.with_panel { "Panel #{i + 1}" }
tab.with_text { "Tab #{i + 1}" }
end
end
component.with_actions do
"Actions Content"
end
end
end | @label With Actions
@snapshot
@param number_of_panels [Integer] number
@param align [Symbol] select [left, right] | with_actions | ruby | primer/view_components | previews/primer/alpha/underline_panels_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/alpha/underline_panels_preview.rb | MIT |
def playground(value: "", selected: false, disabled: false)
render_with_template(
locals: {
selected: selected,
disabled: disabled,
value: value
}
)
end | @label Playground
@param selected toggle
@param disabled toggle
@param value text | playground | ruby | primer/view_components | previews/primer/beta/auto_complete_item_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_item_preview.rb | MIT |
def default(value: "", selected: false, disabled: false)
render_with_template(
locals: {
selected: selected,
disabled: disabled,
value: value
}
)
end | @label Default
@param selected toggle
@param disabled toggle
@param value text
@snapshot | default | ruby | primer/view_components | previews/primer/beta/auto_complete_item_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_item_preview.rb | MIT |
def with_description(description_variant: "block", value: "", selected: false, disabled: false)
description_variant = description_variant.to_sym
render_with_template(
locals: {
description_variant: description_variant,
selected: selected,
disabled: disabled,
value: value
}
)
end | @label WithDescription
@param description_variant select [block, inline]
@param selected toggle
@param disabled toggle
@param value text
@snapshot | with_description | ruby | primer/view_components | previews/primer/beta/auto_complete_item_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_item_preview.rb | MIT |
def playground(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id", inset: false, monospace: false)
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name, inset: inset, monospace: monospace)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @label Playground
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text
@param inset toggle
@param monospace toggle | playground | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def default(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id", inset: false, monospace: false)
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name, inset: inset, monospace: monospace)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @label Default
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text
@param inset toggle
@param monospace toggle | default | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def leading_visual(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @label Leading visual
@snapshot
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text | leading_visual | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def trailing_action(label_text: "Select a fruit", show_clear_button: true, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name))
end | @label Trailing action
@snapshot
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text | trailing_action | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def full_width(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: true, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @label Full width
@snapshot
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text | full_width | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def visually_hide_label(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: true, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @label Visually hide label
@snapshot
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text | visually_hide_label | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def small(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :small, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id-1", list_id: "list-id-1", input_name: "input-id-1")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @!group Sizes
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text
@snapshot | small | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def medium(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id-2", list_id: "list-id-2", input_name: "input-id-2")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text
@snapshot | medium | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def large(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :large, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id-3", list_id: "list-id-3", input_name: "input-id-3")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path, show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name)) do |component|
component.with_leading_visual_icon(icon: :search)
end
end | @param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text
@snapshot | large | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def leading_visual_in_results(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path(visual: "leading"), show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name))
end | @!endgroup
@label Leading visual in results
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text | leading_visual_in_results | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def trailing_visual_in_results(label_text: "Select a fruit", show_clear_button: false, visually_hide_label: false, placeholder: "Placeholder text", size: :medium, full_width: false, width: :auto, disabled: false, invalid: false, input_id: "input-id", list_id: "list-id", input_name: "input-id")
render(Primer::Beta::AutoComplete.new(label_text: label_text, input_id: input_id, list_id: list_id, src: UrlHelpers.primer_view_components.autocomplete_index_path(visual: "trailing"), show_clear_button: show_clear_button, visually_hide_label: visually_hide_label, placeholder: placeholder, size: size, full_width: full_width, width: width, disabled: disabled, invalid: invalid, input_name: input_name))
end | @label Trailing visual in results
@param label_text text
@param show_clear_button toggle
@param visually_hide_label toggle
@param placeholder text
@param size select [small, medium, large]
@param full_width toggle
@param width select [auto, small, medium, large, xlarge, xxlarge]
@param disabled toggle
@param invalid toggle
@param input_id text
@param list_id text
@param input_name text | trailing_visual_in_results | ruby | primer/view_components | previews/primer/beta/auto_complete_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/auto_complete_preview.rb | MIT |
def playground(size: 24, shape: :circle, href: nil)
render(Primer::Beta::Avatar.new(src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser", size: size, shape: shape, href: href))
end | @label Playground
@param size [Integer] select [16, 20, 24, 32, 40, 48, 80]
@param shape [Symbol] select [circle, square]
@param href [String] text | playground | ruby | primer/view_components | previews/primer/beta/avatar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/avatar_preview.rb | MIT |
def as_link(href: "#")
render(Primer::Beta::Avatar.new(href: href, src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser"))
end | @label As link
@param href [String] text | as_link | ruby | primer/view_components | previews/primer/beta/avatar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/avatar_preview.rb | MIT |
def shape_circle
render(Primer::Beta::Avatar.new(shape: :circle, src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser"))
end | @!endgroup
@!group Shape
@label Circle
@snapshot | shape_circle | ruby | primer/view_components | previews/primer/beta/avatar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/avatar_preview.rb | MIT |
def playground(number_of_avatars: 1, tag: :div, align: :left, tooltipped: false, tooltip_label: "This is a tooltip!")
render(Primer::Beta::AvatarStack.new(tag: tag, align: align, tooltipped: tooltipped, body_arguments: { label: tooltip_label })) do |component|
Array.new(number_of_avatars&.to_i || 1) do
component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser")
end
end
end | @label Playground
@param number_of_avatars [Integer] number
@param tag select [["div", div], ["span", span]]
@param align select [["Left", left], ["Right", right]]
@param tooltipped toggle
@param tooltip_label text | playground | ruby | primer/view_components | previews/primer/beta/avatar_stack_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/avatar_stack_preview.rb | MIT |
def align_right
render(Primer::Beta::AvatarStack.new(align: :right)) do |component|
component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser")
component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser")
component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "@kittenuser")
end
end | @!endgroup
@!group More options
@label Align right | align_right | ruby | primer/view_components | previews/primer/beta/avatar_stack_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/avatar_stack_preview.rb | MIT |
def playground(narrow: false, spacious: false, border: false)
render Primer::Beta::Blankslate.new(narrow: narrow, spacious: spacious, border: border) do |component|
component.with_heading(tag: :h2).with_content("Title")
component.with_description { "Description" }
end
end | @label Playground
@param narrow [Boolean] toggle
@param spacious [Boolean] toggle
@param border [Boolean] toggle | playground | ruby | primer/view_components | previews/primer/beta/blankslate_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/blankslate_preview.rb | MIT |
def with_icon(narrow: false, spacious: false, border: false)
render Primer::Beta::Blankslate.new(narrow: narrow, spacious: spacious, border: border) do |component|
component.with_visual_icon(icon: :shield)
component.with_heading(tag: :h2).with_content("It looks like we have discovered a vulnerability")
end
end | @!endgroup
@param narrow [Boolean] toggle
@param spacious [Boolean] toggle
@param border [Boolean] toggle
@snapshot | with_icon | ruby | primer/view_components | previews/primer/beta/blankslate_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/blankslate_preview.rb | MIT |
def with_image(narrow: false, spacious: false, border: false)
render Primer::Beta::Blankslate.new(narrow: narrow, spacious: spacious, border: border) do |component|
component.with_heading(tag: :h2).with_content("Millions of teams trust GitHub to keep their work safe")
component.with_visual_image(src: Primer::ExampleImage::BASE64_SRC, alt: "Security - secure vault")
end
end | @param narrow [Boolean] toggle
@param spacious [Boolean] toggle
@param border [Boolean] toggle
@snapshot | with_image | ruby | primer/view_components | previews/primer/beta/blankslate_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/blankslate_preview.rb | MIT |
def playground(padding: :default, scheme: :default)
render(Primer::Beta::BorderBox.new(padding: padding)) do |component|
component.with_header { "Header" }
component.with_body { "Body" }
component.with_row(scheme: scheme) { "#{scheme.to_s.capitalize} row one" }
component.with_row(scheme: scheme) { "#{scheme.to_s.capitalize} row two" }
component.with_row(scheme: scheme) { "#{scheme.to_s.capitalize} row three" }
component.with_footer { "Footer" }
end
end | @label Playground
@param padding [Symbol] select [default, condensed, spacious]
@param scheme [Symbol] select [default, neutral, info, warning] | playground | ruby | primer/view_components | previews/primer/beta/border_box_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/border_box_preview.rb | MIT |
def default(number_of_links: 2)
render(Primer::Beta::Breadcrumbs.new) do |component|
Array.new(number_of_links&.to_i || 3) do |i|
component.with_item(href: "##{i}") { "Breadcrumb Item #{i + 1}" }
end
end
end | @label Default options
@param number_of_links [Integer] number
@snapshot | default | ruby | primer/view_components | previews/primer/beta/breadcrumbs_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/breadcrumbs_preview.rb | MIT |
def playground(size: :medium, scheme: :default)
render(Primer::Beta::ButtonGroup.new(size: size, scheme: scheme)) do |component|
component.with_button { "Button 1" }
component.with_button { "Button 2" }
component.with_button { "Button 3" }
end
end | @label Playground
@param size [Symbol] select [small, medium, large]
@param scheme [Symbol] select [default, primary, secondary, danger, invisible] | playground | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def default(size: :medium)
render(Primer::Beta::ButtonGroup.new(size: size)) do |component|
component.with_button { "Button 1" }
component.with_button { "Button 2" }
component.with_button { "Button 3" }
end
end | @label Default options
@param size [Symbol] select [medium, small]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def split_button(size: :medium)
render(Primer::Beta::ButtonGroup.new(size: size)) do |component|
component.with_button { "Button 1" }
component.with_button(icon: "triangle-down", "aria-label": "menu")
end
end | @label Split button
@param size [Symbol] select [medium, small]
@snapshot | split_button | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def with_menu_button(scheme: :default, size: :medium)
render_with_template(locals: {
scheme: scheme,
size: size
})
end | @label With menu button
@param scheme [Symbol] select [default, primary, secondary, danger, invisible]
@param size [Symbol] select [medium, small]
@snapshot | with_menu_button | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def icon_buttons(size: :medium)
render(Primer::Beta::ButtonGroup.new(size: size)) do |component|
component.with_button(icon: :note, "aria-label": "button 1")
component.with_button(icon: :rows, "aria-label": "button 2")
component.with_button(icon: "sort-desc", "aria-label": "button 3")
end
end | @label Icon buttons
@param size [Symbol] select [medium, small]
@snapshot | icon_buttons | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def multiple_tags
render(Primer::Beta::ButtonGroup.new) do |component|
component.with_button(id: "button-1", tag: :button) do |button|
button.with_tooltip(text: "Button Tooltip")
"Button 1"
end
component.with_button(id: "button-2", tag: :a, href: "#") do |button|
button.with_tooltip(text: "Button Tooltip")
"Button 2"
end
end
end | @label Button group with multiple tags
@snapshot | multiple_tags | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def with_clipboard_copy_button(size: :medium, scheme: :default)
render(Primer::Beta::ButtonGroup.new(size: size, scheme: scheme)) do |component|
component.with_button { "Button 1" }
component.with_clipboard_copy_button(id: "button-2", value: "Copyable value", aria: { label: "Copy some text" }) do |button|
button.with_tooltip(text: "Copy some text")
end
end
end | @label With clipboard copy button
@snapshot | with_clipboard_copy_button | ruby | primer/view_components | previews/primer/beta/button_group_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_group_preview.rb | MIT |
def playground(
scheme: :default,
size: :medium,
block: false,
id: "button-preview",
align_content: :center,
tag: :button,
disabled: false,
inactive: false,
label_wrap: false,
href: nil
)
# Sets default href to `a`, to ensure it's keyboard interactive and proper markup
if tag == :a && href.nil?
href = "#"
end
render(Primer::Beta::Button.new(
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content,
tag: tag,
disabled: disabled,
inactive: inactive,
label_wrap: label_wrap,
href: href
)) do |_c|
"Button"
end
end | Upgrade guide to Primer::Beta::Button
| old param | new param | options |
| -- | -- | -- |
| variant | size | :small, :medium (default), :large |
| :outline | :default or :invisible | option for :scheme |
| dropdown | trailing action icon slot | see trailing action preview for markup |
@label Playground
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium, large]
@param block toggle
@param disabled toggle
@param inactive toggle
@param align_content select [center, start]
@param tag select [a, button]
@param label_wrap toggle | playground | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def default(
block: false,
id: "button-preview",
tag: :button,
disabled: false
)
render(Primer::Beta::Button.new(
scheme: :default,
size: :medium,
block: block,
id: id,
tag: tag,
disabled: disabled
)) do |_c|
"Button"
end
end | @label Default
@param block toggle
@param disabled toggle | default | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def primary(
id: "button-preview",
block: false,
tag: :button,
disabled: false
)
render(Primer::Beta::Button.new(
scheme: :primary,
size: :medium,
block: block,
id: id,
tag: tag,
disabled: disabled
)) do |_c|
"Button"
end
end | @label Primary
@param block toggle
@param disabled toggle | primary | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def danger(
id: "button-preview",
block: false,
tag: :button,
disabled: false
)
render(Primer::Beta::Button.new(
scheme: :danger,
size: :medium,
block: block,
id: id,
tag: tag,
disabled: disabled
)) do |_c|
"Button"
end
end | @label Danger
@param block toggle
@param disabled toggle | danger | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def invisible(
id: "button-preview",
block: false,
tag: :button,
disabled: false
)
render(Primer::Beta::Button.new(
scheme: :invisible,
size: :medium,
block: block,
id: id,
tag: tag,
disabled: disabled
)) do |_c|
"Button"
end
end | @label Invisible
@param block toggle
@param disabled toggle | invisible | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def link(
id: "button-preview",
block: false,
tag: :button,
disabled: false
)
render(Primer::Beta::Button.new(
scheme: :link,
size: :medium,
block: block,
id: id,
tag: tag,
disabled: disabled
)) do |_c|
"Button"
end
end | @label Link
@param block toggle
@param disabled toggle
@snapshot | link | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def all_schemes(
disabled: false
)
render_with_template(locals: {
disabled: disabled
})
end | @label All schemes
@snapshot
@param disabled toggle | all_schemes | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def full_width(
id: "button-preview",
tag: :button,
disabled: false
)
render(Primer::Beta::Button.new(
scheme: :default,
size: :medium,
block: true,
id: id,
tag: tag,
disabled: disabled
)) do |_c|
"Button"
end
end | @label Full width
@param disabled toggle
@snapshot | full_width | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def label_wrap(
scheme: :default,
size: :medium,
block: false,
label_wrap: true
)
render_with_template(locals: {
scheme: scheme,
size: size,
block: block,
label_wrap: label_wrap
})
end | @label Label wrap
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param label_wrap toggle
@snapshot | label_wrap | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def link_as_button(
scheme: :default,
size: :medium,
block: false,
id: "button-preview",
align_content: :center,
tag: :a,
href: "#"
)
render(Primer::Beta::Button.new(
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content,
tag: tag,
href: href
)) do |_c|
"Button"
end
end | @label Link as button
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param align_content select [center, start]
@param href
@snapshot | link_as_button | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def summary_as_button(
scheme: :default,
size: :medium,
block: false,
id: "button-preview",
align_content: :center,
tag: :summary
)
render_with_template(locals: {
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content,
tag: tag
})
end | @label Summary as button
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param align_content select [center, start]
@snapshot | summary_as_button | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def trailing_visual(
scheme: :default,
size: :medium,
block: false,
id: "button-preview",
align_content: :center,
tag: :button
)
render_with_template(locals: {
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content,
tag: tag
})
end | @label Trailing visual
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param align_content select [center, start]
@snapshot | trailing_visual | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.