Simplify your stack and build anything. Or everything.
Build tomorrow’s web with a modern solution you truly own.
Code-based nature means you can build on top of it to power anything.
It’s time to take back your content infrastructure.

Hamburger

The Hamburger component displays the icon used to represent open and closed navigation states in the Payload Admin Panel.

Import

1
import { Hamburger } from '@payloadcms/ui'

States

Loading component example…

Hamburger renders the visual state only. Place it inside the button that controls your navigation and manage isActive from that control's state.

Common props

These are the props most commonly used with this component. See its exported types in @payloadcms/ui for the complete list.

Prop

Type

Default

Description

isActive

boolean

false

Switches from the menu icon to a close icon.

closeIcon

'x' | 'collapse'

'x'

Selects the icon displayed in the active state.

Was this page helpful?

Next

Link