Skip to content

Button

Buttons initiate events or actions within a page, informing users of what to expect next.

React

released

Vue

released

Elements

released

Android

released

iOS

released

Example

Usage

Design Guidelines

See Figma: Warp - Components / Button

Accessibility

If the button doesn't have visible text content, such as when used with only an icon, an aria-label prop must be provided for accessibility.

Questions?

Feel free to ask any questions on usage in the Warp DS Slack channel: #nmp-warp-design-system

Frameworks

Import

You can import the component like so:

js
import { Button } from '@warp-ds/react';

or import it individually to optimize your JS bundle size by adding only the components you need:

js
import { Button } from '@warp-ds/react/components/button';

Syntax

jsx
<Button>Save</Button>

Visual options

Primary

The primary button is a call to action. As a general rule, there should only be one of them on the screen. This guides the user towards the happy path.

jsx
<Button primary>Save</Button>

Negative

Used for destructive actions, like deletion. Shouldn't be used on the same screen as a primary button.

jsx
<Button negative>Delete</Button>

Secondary

Secondary buttons are without background, and are often used for secondary actions. This is the default, so you may simply omit the secondary property unless you want to use it with quiet variation.

jsx
<div className="flex space-x-32">
  <Button secondary>Save</Button>
  <Button>Save</Button>
</div>

Loading/In progress

Used for visual feedback that the action the user triggered is loading.

jsx
<Button loading>Save</Button>

Small

jsx
<Button small>Small</Button>

Utility

The utility button combined with quiet replaces the deprecated button pill prop.

jsx
<Button utility quiet><IconShare16 /></Button>

Buttons will be rendered as an anchor (a tag) if they use an href attribute.

jsx
<Button href="https://google.no">Link</Button>

But if you need a button to look like a link, use the link property.

jsx
<Button link>Link</Button>

However, it is not recommended to use link property in combination with the href attribute. If there is a need to have an anchor (a tag) that should still look like a link, the recommendation is to instead use the <a> HTML element.

Disabled

Disabled is an anti-pattern and is not supported. There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.

Full width

The fullWidth prop sets the button's width to its parent's width.

jsx
<Button fullWidth primary>Full width</Button>

Props

Optional Props

nametypedefaultnotes

className

string

Additional classes to include

style

CSSProperties

CSS styles to inline on the component

type

"button"|"submit"|"reset"

button

Button type, only applied when href is not set.

primary

boolean

false

Set the button to be a primary, call to action button. Can be combined with small.

secondary

boolean

false

Set the button to be a secondary button. Can be combined with quiet and small.

negative

boolean

false

Set the button to be a negative, destructive style button. Can be combined with quiet and small.

utility

boolean

false

Set the button to be a utility style button. Can be combined with small and quiet.

quiet

boolean

false

Quieten down the button, can be combined with other button types.

small

boolean

false

Set the button to be a small size, can be combined with other button types.

link

boolean

false

Set the button to look like a link. Can be combined with small. Should not be combined with href

pill

boolean

false

Set the button to look like a pill style button. @deprecated use utility together with quiet instead.

loading

boolean

false

Set the button to look like it is in progress, can be combined with other button types. Can be combined with any button type.

href

string

Set the href for the location where clicking the button will take you to. Uses an a tag instead of a button tag for the underlying implementation. Should not be combined with link

target

string

Anchor target, see The Anchor element / MDN Web Docs.

rel

string

The relationship of the linked URL.

fullWidth

boolean

Sets the button's width to its parent's width. Useful especially on mobile when button should take full width.