Button

<wa-button>

Stable

Buttons represent actions the user can take, such as submitting a form, opening a dialog, or navigating to another page.

Save

<wa-button>Save</wa-button>

Examples

Link to This Section

Variant

Link to This Section

Use the variant attribute to set the button's semantic variant.

  Neutral
  Brand
  Success
  Warning
  Danger

                  
                

<div class="wa-cluster wa-gap-2xs">
  <wa-button variant="neutral">Neutral</wa-button>
  <wa-button variant="brand">Brand</wa-button>
  <wa-button variant="success">Success</wa-button>
  <wa-button variant="warning">Warning</wa-button>
  <wa-button variant="danger">Danger</wa-button>
</div>

Appearance

Link to This Section

Use the appearance attribute to change the button's visual appearance. Pair it with any variant for the full matrix.

    Accent
    Filled-Outlined
    Filled
    Outlined
    Plain
  

    Accent
    Filled-Outlined
    Filled
    Outlined
    Plain
  

    Accent
    Filled-Outlined
    Filled
    Outlined
    Plain
  

    Accent
    Filled-Outlined
    Filled
    Outlined
    Plain
  

    Accent
    Filled-Outlined
    Filled
    Outlined
    Plain
  

                  
                

<div class="wa-stack">
  <div class="wa-cluster wa-gap-2xs">
    <wa-button appearance="accent" variant="neutral">Accent</wa-button>
    <wa-button appearance="filled-outlined" variant="neutral">Filled-Outlined</wa-button>
    <wa-button appearance="filled" variant="neutral">Filled</wa-button>
    <wa-button appearance="outlined" variant="neutral">Outlined</wa-button>
    <wa-button appearance="plain" variant="neutral">Plain</wa-button>
  </div>
  <div class="wa-cluster wa-gap-2xs">
    <wa-button appearance="accent" variant="brand">Accent</wa-button>
    <wa-button appearance="filled-outlined" variant="brand">Filled-Outlined</wa-button>
    <wa-button appearance="filled" variant="brand">Filled</wa-button>
    <wa-button appearance="outlined" variant="brand">Outlined</wa-button>
    <wa-button appearance="plain" variant="brand">Plain</wa-button>
  </div>
  <div class="wa-cluster wa-gap-2xs">
    <wa-button appearance="accent" variant="success">Accent</wa-button>
    <wa-button appearance="filled-outlined" variant="success">Filled-Outlined</wa-button>
    <wa-button appearance="filled" variant="success">Filled</wa-button>
    <wa-button appearance="outlined" variant="success">Outlined</wa-button>
    <wa-button appearance="plain" variant="success">Plain</wa-button>
  </div>
  <div class="wa-cluster wa-gap-2xs">
    <wa-button appearance="accent" variant="warning">Accent</wa-button>
    <wa-button appearance="filled-outlined" variant="warning">Filled-Outlined</wa-button>
    <wa-button appearance="filled" variant="warning">Filled</wa-button>
    <wa-button appearance="outlined" variant="warning">Outlined</wa-button>
    <wa-button appearance="plain" variant="warning">Plain</wa-button>
  </div>
  <div class="wa-cluster wa-gap-2xs">
    <wa-button appearance="accent" variant="danger">Accent</wa-button>
    <wa-button appearance="filled-outlined" variant="danger">Filled-Outlined</wa-button>
    <wa-button appearance="filled" variant="danger">Filled</wa-button>
    <wa-button appearance="outlined" variant="danger">Outlined</wa-button>
    <wa-button appearance="plain" variant="danger">Plain</wa-button>
  </div>
</div>

Size

Link to This Section

Use the size attribute to change a button's size.

  Extra Small
  Small
  Medium
  Large
  Extra Large

                  
                

<div class="wa-cluster wa-gap-2xs">
  <wa-button size="xs">Extra Small</wa-button>
  <wa-button size="s">Small</wa-button>
  <wa-button size="m">Medium</wa-button>
  <wa-button size="l">Large</wa-button>
  <wa-button size="xl">Extra Large</wa-button>
</div>

Pill

Link to This Section

Use the pill attribute to give buttons rounded edges.

Pill Button

<wa-button pill>Pill Button</wa-button>

Link Button

Link to This Section

Set the href attribute to render the button as an <a> under the hood. Provides all the browser's native link behavior (e.g. CMD/CTRL/SHIFT + CLICK) plus the rel, target, and download attributes.

  Link
  New Window
  Download

<div class="wa-cluster wa-gap-2xs">
  <wa-button href="https://example.com/">Link</wa-button>
  <wa-button href="https://example.com/" target="_blank">New Window</wa-button>
  <wa-button href="/assets/images/logo.svg" download="shoelace.svg">Download</wa-button>
</div>

Icon Button

Link to This Section

When an icon is the only thing slotted into the label, the button becomes an icon button. Icon buttons work with any appearance or variant.

<div class="wa-cluster wa-gap-2xs">
  <wa-button variant="neutral" appearance="accent"><wa-icon name="house" label="Home"></wa-icon></wa-button>
  <wa-button variant="neutral" appearance="outlined"><wa-icon name="house" label="Home"></wa-icon></wa-button>
  <wa-button variant="neutral" appearance="filled"><wa-icon name="house" label="Home"></wa-icon></wa-button>
  <wa-button variant="neutral" appearance="plain"><wa-icon name="house" label="Home"></wa-icon></wa-button>
</div>

Give icon-only buttons a label.
With no text to announce, a screen reader has nothing to read. Add label to the icon (<wa-icon name="house" label="Home">) so the button has an accessible name.

Start & End Decorations

Link to This Section

Use the start and end slots to add presentational elements like <wa-icon> beside the button label.

  
    Settings
  
    Refresh
  
    Open

<div class="wa-cluster wa-gap-2xs">
  <wa-button>
    <wa-icon slot="start" name="gear"></wa-icon>
    Settings
  </wa-button>

  <wa-button>
    <wa-icon slot="end" name="undo"></wa-icon>
    Refresh
  </wa-button>

  <wa-button>
    <wa-icon slot="start" name="link"></wa-icon>
    <wa-icon slot="end" name="arrow-up-right-from-square"></wa-icon>
    Open
  </wa-button>
</div>

Caret

Link to This Section

Use the with-caret attribute to add a dropdown indicator when a button triggers a dropdown, menu, or popover.

Options

<wa-button with-caret>Options</wa-button>

Loading

Link to This Section

Use the loading attribute to put a button in a busy state. Its width stays the same, so adjacent elements don't shift.

  Brand
  Success
  Neutral
  Warning
  Danger

                  
                

<div class="wa-cluster wa-gap-2xs">
  <wa-button variant="brand" loading>Brand</wa-button>
  <wa-button variant="success" loading>Success</wa-button>
  <wa-button variant="neutral" loading>Neutral</wa-button>
  <wa-button variant="warning" loading>Warning</wa-button>
  <wa-button variant="danger" loading>Danger</wa-button>
</div>

Disabled

Link to This Section

Use the disabled attribute to disable a button. It works on link buttons too.

    Brand
    Success
    Neutral
    Warning
    Danger
  
    Link
    New Window
    Download

<div class="wa-stack">
  <div class="wa-cluster wa-gap-2xs">
    <wa-button variant="brand" disabled>Brand</wa-button>
    <wa-button variant="success" disabled>Success</wa-button>
    <wa-button variant="neutral" disabled>Neutral</wa-button>
    <wa-button variant="warning" disabled>Warning</wa-button>
    <wa-button variant="danger" disabled>Danger</wa-button>
  </div>

  <div class="wa-cluster wa-gap-2xs">
    <wa-button href="https://example.com/" disabled>Link</wa-button>
    <wa-button href="https://example.com/" target="_blank" disabled>New Window</wa-button>
    <wa-button href="/assets/images/logo.svg" download="shoelace.svg" disabled>Download</wa-button>
  </div>
</div>

Custom Width

Link to This Section

Give a button a custom width to size it independently of its content — useful for making buttons span their container on smaller screens.

Save

<wa-button style="width: 100%;">Save</wa-button>

Customizing

Link to This Section

Target the base part to restyle a button from the outside. Use a custom class when you're adding a new variation; to retheme an existing one, target its variant attribute instead (e.g. wa-button[variant="brand"]).

Pink Button

<wa-button class="pink">Pink Button</wa-button>

<style>
  wa-button.pink::part(base) {
    border-radius: 6px;
    border: solid 2px;
    background: #ff1493;
    border-top-color: #ff7ac1;
    border-left-color: #ff7ac1;
    border-bottom-color: #ad005c;
    border-right-color: #ad005c;
    color: white;
    font-size: 1.125rem;
    box-shadow: 0 2px 10px #0002;
    transition: all var(--wa-transition-slow) var(--wa-transition-easing);
  }

  wa-button.pink::part(base):hover {
    transform: scale(1.05);
  }

  wa-button.pink::part(base):active {
    border-top-color: #ad005c;
    border-right-color: #ff7ac1;
    border-bottom-color: #ff7ac1;
    border-left-color: #ad005c;
    transform: translateY(1px);
  }

  wa-button.pink::part(base):focus-visible {
    outline: dashed 2px deeppink;
    outline-offset: 4px;
  }
</style>

API

Link to This Section

Importing

Link to This Section

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.

CDN

npm

Self-Hosted

React

Import this component directly from the CDN:

import 'https://ka-f.webawesome.com/[email protected]/components/button/button.js';

After installing Web Awesome via npm, import this component:

import '@awesome.me/webawesome/dist/components/button/button.js';

If you're self-hosting Web Awesome, import this component from your server:

import './webawesome/dist/components/button/button.js';

To import this component for React 18 or below, use the following code:

import WaButton from '@awesome.me/webawesome/dist/react/button/index.js';

Slots

Link to This Section

Learn more about using slots.

Name	Description
(default)	The button's label.
`end`	An element, such as `<wa-icon>`, placed after the label.
`start`	An element, such as `<wa-icon>`, placed before the label.

Attributes & Properties

Link to This Section

Learn more about attributes and properties.

Name	Description	Reflects
`appearance` `appearance`	The button's visual appearance. Type `'accent' \| 'filled' \| 'outlined' \| 'filled-outlined' \| 'plain'` Default `'accent'`
`disabled` `disabled`	Disables the button. Type `boolean` Default `false`
`download` `download`	Tells the browser to download the linked file as this filename. Only used when `href` is present. Type `string \| undefined`
`form`	By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you to place the form control outside of a form and associate it with the form that has this `id`. The form must be in the same document or shadow root for this to work. Type `HTMLFormElement \| null`
`formAction` `formaction`	Used to override the form owner's `action` attribute. Type `string`
`formEnctype` `formenctype`	Used to override the form owner's `enctype` attribute. Type `'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'`
`formMethod` `formmethod`	Used to override the form owner's `method` attribute. Type `'post' \| 'get'`
`formNoValidate` `formnovalidate`	Used to override the form owner's `novalidate` attribute. Type `boolean`
`formTarget` `formtarget`	Used to override the form owner's `target` attribute. Type `'_self' \| '_blank' \| '_parent' \| '_top' \| string`
`href` `href`	When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`. Type `string`
`loading` `loading`	Draws the button in a loading state. Type `boolean` Default `false`
`name` `name`	The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter. This attribute is ignored when `href` is present. Type `string \| null` Default `null`
`pill` `pill`	Draws a pill-style button with rounded edges. Type `boolean` Default `false`
`rel` `rel`	When using `href`, this attribute will map to the underlying link's `rel` attribute. Type `string \| undefined`
`size` `size`	The button's size. Type `'xs' \| 's' \| 'm' \| 'l' \| 'xl' \| 'small' \| 'medium' \| 'large'` Default `'m'`
`target` `target`	Tells the browser where to open the link. Only used when `href` is present. Type `'_blank' \| '_parent' \| '_self' \| '_top'`
`type` `type`	The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native `<button>` elements behave. When the type is `submit`, the button will submit the surrounding form. Type `'button' \| 'submit' \| 'reset'` Default `'button'`
`validationTarget`	Override this to change where constraint validation popups are anchored. Type `undefined \| HTMLElement`
`validators`	Validators are static because they have `observedAttributes`, essentially attributes to "watch" for changes. Whenever these attributes change, we want to be notified and update the validator. Type `Validator[]` Default `[]`
`value` `value`	The value of the button, submitted as a pair with the button's name as part of the form data, but only when this button is the submitter. This attribute is ignored when `href` is present. Type `string`
`variant` `variant`	The button's theme variant. Defaults to `neutral` if not within another element with a variant. Type `'neutral' \| 'brand' \| 'success' \| 'warning' \| 'danger'` Default `'neutral'`
`withCaret` `with-caret`	Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior. Type `boolean` Default `false`
`withEnd` `with-end`	Only required for SSR. Set to `true` if you're slotting in an `end` element so the server-rendered markup includes the end slot before the component hydrates on the client. Type `boolean` Default `false`
`withStart` `with-start`	Only required for SSR. Set to `true` if you're slotting in a `start` element so the server-rendered markup includes the start slot before the component hydrates on the client. Type `boolean` Default `false`

Methods

Link to This Section

Learn more about methods.

Name	Description	Arguments
`blur()`	Removes focus from the button.
`click()`	Simulates a click on the button.
`focus()`	Sets focus on the button.	`options: FocusOptions`
`formStateRestoreCallback()`	Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue.	`state: string \| File \| FormData \| null, reason: 'autocomplete' \| 'restore'`
`resetValidity()`	Reset validity is a way of removing manual custom errors and native validation.
`setCustomValidity()`	Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators.	`message: string`

Events

Link to This Section

Learn more about events.

Name	Description
`blur`	Emitted when the button loses focus.
`focus`	Emitted when the button gains focus.
`wa-invalid`	Emitted when the form control has been checked for validity and its constraints aren't satisfied.

Custom States

Link to This Section

Learn more about custom states.

Name	Description	CSS selector
`disabled`	Applied when the button is disabled.	`:state(disabled)`
`icon-button`	Applied when the button contains only a `<wa-icon>` with no other content.	`:state(icon-button)`
`link`	Applied when the button is rendered as a link (i.e. `href` is set).	`:state(link)`
`loading`	Applied when the button is in the loading state.	`:state(loading)`

CSS Parts

Link to This Section

Learn more about CSS parts.

Name	Description	CSS selector
`base`	The component's base wrapper.	`::part(base)`
`caret`	The button's caret icon, a `<wa-icon>` element.	`::part(caret)`
`end`	The container that wraps the `end` slot.	`::part(end)`
`label`	The button's label.	`::part(label)`
`spinner`	The spinner that shows when the button is in the loading state.	`::part(spinner)`
`start`	The container that wraps the `start` slot.	`::part(start)`

Dependencies

Link to This Section

This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.

Need a hand?

Report a bug

Ask for help

Button

Examples

Variant

Appearance

Size

Pill

Link Button

Icon Button

Start & End Decorations

Caret

Loading

Disabled

Custom Width

Customizing

API

Importing

Slots

Attributes & Properties

Methods

Events

Custom States

CSS Parts

Dependencies

Quick Links

Recent Searches

Button

Examples

Variant

Appearance

Size

Pill

Link Button

Icon Button

Start & End Decorations

Caret

Loading

Disabled

Custom Width

Customizing

API

Importing

Slots

Attributes & Properties

Methods

Events

Custom States

CSS Parts

Dependencies

Quick Links

Recent Searches

We Have Cookies…