Use to display monetary amounts, typically on dashboards or other layouts to show an overview or summary. User understanding increase when paired with labels.
Cents is automatically ".00" unless other wise overwritten (i.e. unit prop).
<%= pb_rails("currency", props: { amount: "2,000.50", emphasized: false, label: "Emphasized False", margin_bottom: "md", size: "sm", }) %> <%= pb_rails("currency", props: { amount: "342", label: "Light", margin_bottom: "md", size: "sm", symbol: "€", variant: "light", emphasized: false, }) %> <%= pb_rails("currency", props: { amount: "45", label: "Bold", size: "sm", unit: "/mo", variant: "bold", }) %>
<%= pb_rails("currency", props: { amount: "2,000.50", label: "Small", margin_bottom: "md", size: "sm", }) %> <%= pb_rails("currency", props: { amount: "342", label: "Medium", margin_bottom: "md", size: "md", symbol: "€", }) %> <%= pb_rails("currency", props: { amount: "45", label: "Large", size: "lg", unit: "/mo", }) %>
<%= pb_rails("currency", props: { amount: "2,000.50", label: "Left", size: "sm", }) %> <%= pb_rails("currency", props: { align: "center", amount: "342", label: "Center", size: "sm", symbol: "€", }) %> <%= pb_rails("currency", props: { align: "right", amount: "45", label: "Right", unit: "/mo", size: "sm", }) %>
<%= pb_rails("currency", props: { abbreviate: true, amount: "2,200.50", label: "Thousands (with Unit)", margin_bottom: "md", unit: "/mo", }) %> <%= pb_rails("currency", props: { abbreviate: true, amount: "3424123", label: "Millions", margin_bottom: "md", }) %> <%= pb_rails("currency", props: { abbreviate: true, amount: "45,300,000,000", label: "Billions", margin_bottom: "md", }) %> <%= pb_rails("currency", props: { abbreviate: true, amount: "983,200,000,000,000", label: "Trillions", }) %>
<%= pb_rails("currency", props: { amount: "372.12", decimals: "matching", label: "Small", margin_bottom: "md", size: "sm", unit: "/day", }) %> <%= pb_rails("currency", props: { amount: "30,327.43", decimals: "matching", label: "Medium", margin_bottom: "md", size: "md", symbol: "€", }) %> <%= pb_rails("currency", props: { amount: "621,953.99", decimals: "matching", label: "Large", size: "lg", }) %>
For alternative typography styles, you can pass a boolean prop called unstyled
to the Currency
kit and wrap it in any of our typography kits (Title
, Body
, Caption
, etc.). This will allow the Currency
kit to inherit any of our typography styles.
<%= pb_rails("currency", props: { amount: "2,000.50", label: "Basic unstyled example", margin_bottom: "md", unstyled: true }) %> <%= pb_rails("title", props: { size: 1 }) do %> <%= pb_rails("currency", props: { amount: "2,000.50", label: "Example with wrapping typography kit", unstyled: true }) %> <% end %>
The optional commaSeparator
can be used to auto-format the use of commas as a thousands separator.
NOTE: If the value passed into the amount
prop is already comma-dilineated, it will not add additional commas.
Props | Type | Values |
---|---|---|
max_width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
min_width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
z_index |
array
|
1
2
3
4
5
6
7
8
9
10
|
number_spacing |
array
|
tabular
|
shadow |
array
|
none
deep
deeper
deepest
|
line_height |
array
|
tightest
tighter
tight
normal
loose
looser
loosest
|
display |
array
|
block
inline_block
inline
flex
inline_flex
none
|
cursor |
array
|
auto
default
none
contextMenu
help
pointer
progress
wait
cell
crosshair
text
verticalText
alias
copy
move
noDrop
notAllowed
grab
grabbing
eResize
nResize
neResize
nwResize
sResize
seResize
swResize
wResize
ewResize
nsResize
neswResize
nwseResize
colResize
rowResize
allScroll
zoomIn
zoomOut
|
flex_direction |
array
|
row
column
rowReverse
columnReverse
|
flex_wrap |
array
|
wrap
nowrap
wrapReverse
|
justify_content |
array
|
start
end
center
spaceBetween
spaceAround
spaceEvenly
|
justify_self |
array
|
auto
start
end
center
stretch
|
align_items |
array
|
flexStart
flexEnd
start
end
center
baseline
stretch
|
align_content |
array
|
start
end
center
spaceBetween
spaceAround
spaceEvenly
|
align_self |
array
|
auto
start
end
center
stretch
baseline
|
flex |
array
|
auto
initial
0
1
2
3
4
5
6
7
8
9
10
11
12
none
|
flex_grow |
array
|
1
0
|
flex_shrink |
array
|
1
0
|
order |
array
|
1
2
3
4
5
6
7
8
9
10
11
12
|
position |
array
|
relative
absolute
fixed
sticky
|
hover |
array
|
|
border_radius |
array
|
none
xs
sm
md
lg
xl
rounded
|
text_align |
array
|
start
end
left
right
center
justify
justify-all
match-parent
|
overflow |
array
|
visible
hidden
scroll
auto
|
truncate |
array
|
1
2
3
4
5
|
left |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
top |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
right |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
bottom |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
vertical_align |
array
|
baseline
super
top
middle
bottom
sub
text-top
text-bottom
|
height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
min_height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
max_height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
overflow_x |
array
|
visible
hidden
scroll
auto
|
overflow_y |
array
|
visible
hidden
scroll
auto
|
margin |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_bottom |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_left |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_right |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_top |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_x |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_y |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_bottom |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_left |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_right |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_top |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_x |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_y |
array
|
none
xxs
xs
sm
md
lg
xl
|
classname |
string
|
|
group_hover |
boolean
|
|
id |
string
|
|
data |
hashprop
|
|
aria |
hashprop
|
|
html_options |
hashprop
|
|
children |
proc
|
|
style |
hashprop
|
Props | Type | Values | Default |
---|---|---|---|
dark |
boolean
|
false
|
|
align |
enum
|
left
center
right
|
left
|
size |
enum
|
lg
md
sm
|
md
|
label |
string
|
||
symbol |
string
|
$
|
|
amount |
string
|
||
unit |
string
|
||
emphasized |
boolean
|
true
|
|
variant |
enum
|
default
light
bold
|
default
|
abbreviate |
boolean
|
false
|
|
decimals |
enum
|
default
matching
|
default
|
unstyled |
boolean
|
false
|
|
comma_separator |
boolean
|
false
|