Skip to content

Primer/Interface guidelines

Design
Interface guidelinesOcticonsDesktopMobileCLI
Build
CSSReactReact BrandViewComponents
ContributeAbout

Counter label

Counter label is a button with a numbered label accompanied by text.

On this page
Work in progressWe are currently transferring the Rails documentation for Counter from a different site to this page. To view the original documentation, please visit the Primer ViewComponents documentation for Counter.
v0.1.5BetaNot reviewed for accessibility

Description

Use Counter to add a count to navigational elements and buttons.

Arguments

NameDefaultDescription
count

0

Integer, Float::INFINITY, nil

The number to be displayed (e.x. # of issues, pull requests)

scheme

:default

Symbol

Color scheme. One of :default, :primary, or :secondary.

limit

5_000

Integer, nil

Maximum value to display. Pass nil for no limit. (e.x. if count == 6,000 and limit == 5000, counter will display "5,000+")

hide_if_zero

false

Boolean

If true, a hidden attribute is added to the counter if count is zero.

text

""

String

Text to display instead of count.

round

false

Boolean

Whether to apply our standard rounding logic to value.

system_arguments

N/A

Hash

System arguments

Examples

View in Lookbook