Icon used needs to be square. Icon size is 24px by 24px.

All Nav variants' navItems accept our global Spacing (padding, margin) props for custom spacing requirements. This example uses paddingY="xxs" and margin="none" on the bold variant to show this in action!

All Nav variants' navItems accept the following props for customizing font:

  • fontSize / font_size defaults to normal, also accepts small
  • fontWeight / font_weight defaults to regular, also accepts bold and bolder

The collapsible prop allows users to create a nested, collapsible nav. Pass collapsible to any NavItem and pass that navItem any number of NavItems as children to create a collapsible nav.

The optional collapsed prop can also be used to set the default state for the collapsed nav on first render of the page. collapsed takes a boolean value that is set to true (meaning nav is collapsed) by default. Set it to false as shown here to have the nav open on first render.

Collapsible Navs optionally accept the following props:

  • collapsibleTrail / collapsible_trail, enables a vertical guideline to the left of the collapsible nav's children
  • iconRight optionally accepts an array of 2 icon values; the first is used as the default icon when the node is collapsed, the second is toggled when the node is expanded. If only 1 icon value is passed, the icon will not toggle between collapsible states.

Optionally remove the expand/collapse icon(s) from any collapsible nav item by passing "none" to the icon_right prop on that nav item.

Horizontal Nav With Extended Underline


The optional extendedUnderline/extended_underline prop can be used with the default normal variant of the horizontal orientation of the nav to extend the underline to take up the full width of the container.

Horizontal Nav With Disabled Item

Default Variant
Subtle Variant
Bold Variant

Use the disabled prop on a navItem/nav_item within a horizontal nav to set it as disabled. This will render the UI as disabled, prevent clicks and not allow for tabIndex to access the item.

Vertical Nav With Disabled Item


Use the disabled prop on a navItem/nav_item within a vertical nav to set it as disabled. This will render the UI as disabled, prevent clicks and not allow for tabIndex to access the item.

Tab Nav

This is about!
This is case studies!
This is service!
This is contacts!

The Nav kit can also be used to create dynamic tabbing. To do so, use the boolean tabbing prop as shown here.

All divs you want to use as tabs MUST have an id attached to them. To link the tab to the nav, use the required data attribute pb_tab_target on each nav/item and pass it the id of the tab you want linked to that specific nav/item. See code example below to see this in action.



Available Props

Props Type Values

align_content

enum | responsive
start
end
center
spaceBetween
spaceAround
spaceEvenly

align_items

enum | responsive
start
end
center

border_radius

enum
none
xs
sm
md
lg
xl
rounded

cursor

enum
auto
default
none
contextMenu
help
pointer
progress
wait
cell

dark

boolean
true
false

flex

enum | responsive
auto
initial
0
1
2
3
4
5
6
7
8
9
10
11
12
none

flex_direction

enum | responsive
row
column
rowReverse
columnReverse

flex_wrap

enum | responsive
wrap
nowrap
wrapReverse

justify_content

enum | responsive
start
end
center
spaceBetween
spaceAround
spaceEvenly

line_height

enum
loosest
looser
loose
normal
tight
tighter
tightest

margin_right

array
none
xxs
xs
sm
md
lg
xl

margin_left

array
none
xxs
xs
sm
md
lg
xl

margin_top

array
none
xxs
xs
sm
md
lg
xl

margin_bottom

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

margin

array
none
xxs
xs
sm
md
lg
xl

width

string

min_width

string

max_width

string

gap

string | responsive

column_gap

string | responsive

row_gap

string | responsive

number_spacing

enum
tabular

order

enum | responsive
none
first
1
2
3
4
5
6
7
8
9
10
11
12

overflow_x

enum
scroll
visible
hidden
auto

overflow_y

enum
scroll
visible
hidden
auto

overflow

enum
scroll
visible
hidden
auto

padding_right

array
none
xxs
xs
sm
md
lg
xl

padding_left

array
none
xxs
xs
sm
md
lg
xl

padding_top

array
none
xxs
xs
sm
md
lg
xl

padding_bottom

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

padding

array
none
xxs
xs
sm
md
lg
xl

position

enum
relative
absolute
fixed
sticky
static

shadow

enum
none
deep
deeper
deepest

text_align

enum | responsive
start
end
left
right
center
justify
justifyAll
matchParent

truncate

enum
none
1
2
3
4
5

vertical_align

enum | responsive
baseline
super
top
middle
bottom
sub
text-top
text-bottom

z_index

enum | responsive
1
2
3
4
5
6
7
8
9
10
max

top

enum | object
xxs
xs
sm
md
lg
xl
xxl

inset

boolean
true
false

right

enum | object
xxs
xs
sm
md
lg
xl
xxl

bottom

enum | object
xxs
xs
sm
md
lg
xl
xxl

left

enum | object
xxs
xs
sm
md
lg
xl
xxl

height

string

max_height

string

min_height

string

hover

object

group_hover

boolean
true
false
Props Type Values Default

borderless

boolean
true
false
false

extended_underline

boolean
true
false
false

highlight

boolean
true
false
true

on_click

function

orientation

enum
vertical
horizontal
vertical

link

string
#

title

string

variant

enum
normal
subtle
normal

item_spacing

spacingobject

tabbing

boolean
true
false
false