State

Use state for rendering the status of an item.

Beta
Not reviewed for accessibility

On this page

Use State for rendering the status of an item.

Arguments

Name	Type	Default	Description
`title`	`String`	N/A	`title` HTML attribute.
`scheme`	`Symbol`	`:default`	Background color. One of `:closed`, `:default`, `:green`, `:merged`, `:open`, `:purple`, or `:red`.
`tag`	`Symbol`	`:span`	HTML tag for element. One of `:div` or `:span`.
`size`	`Symbol`	`:default`	One of `:default` or `:small`.
`system_arguments`	`Hash`	N/A	System arguments

Examples

Default

State

<%= render(Primer::Beta::State.new(title: "title")) { "State" } %>

Schemes

DefaultOpenClosedMerged

<%= render(Primer::Beta::State.new(title: "title")) { "Default" } %>
<%= render(Primer::Beta::State.new(title: "title", scheme: :open)) { "Open" } %>
<%= render(Primer::Beta::State.new(title: "title", scheme: :closed)) { "Closed" } %>
<%= render(Primer::Beta::State.new(title: "title", scheme: :merged)) { "Merged" } %>

Sizes

DefaultSmall

<%= render(Primer::Beta::State.new(title: "title")) { "Default" } %>
<%= render(Primer::Beta::State.new(title: "title", size: :small)) { "Small" } %>

Edit this page on GitHub