Button
Buttons represent actions the user can take, such as submitting a form, opening a dialog, or navigating to another page.
Examples
Variants
Use the variant attribute to set the button's semantic variant.
Appearance
Use the appearance attribute to change the button's visual appearance.
Sizes
Use the size attribute to change a button's size.
Pill Buttons
Use the pill attribute to give buttons rounded edges.
Link Buttons
It's often helpful to have a button that works like a link. This is possible by setting the href attribute, which will make the component render an <a> under the hood. This gives you all the default link behavior the browser provides (e.g. CMD/CTRL/SHIFT + CLICK) and exposes the rel, target, and download attributes.
Icon Buttons
When only an icon is slotted into the label slot, the button becomes an icon button. In this case, it's important to give the icon a label for users with assistive devices. Icon buttons can use any appearance or variant.
Setting a Custom Width
As expected, buttons can be given a custom width by setting the width CSS property. This is useful for making buttons span the full width of their container on smaller screens.
Start & End Decorations
Use the start and end slots to add presentational elements like <wa-icon> next to the button label.
Caret
Use the with-caret attribute to add a dropdown indicator when a button will trigger a dropdown, menu, or popover.
Loading
Use the loading attribute to make a button busy. The width will remain the same as before, preventing adjacent elements from moving around.
Disabled
Use the disabled attribute to disable a button.
Styling Buttons
This example demonstrates how to style buttons using a custom class. This is the recommended approach if you need to add additional variations. To customize an existing variation, modify the selector to target the button's variant attribute instead of a class (e.g. wa-button[variant="brand"]).
Importing
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.
Import this component directly from the CDN:
import 'https://ka-f.webawesome.com/webawesome@0.17.0/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
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
Learn more about attributes and properties.
| Name | Description | Reflects |
|---|---|---|
appearanceappearance |
The button's visual appearance.
Type
'accent' | 'filled' | 'outlined' | 'filled-outlined' | 'plain'
Default
'accent'
|
|
disableddisabled |
Disables the button.
Type
boolean
Default
false
|
|
downloaddownload |
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
|
|
formActionformaction |
Used to override the form owner's
action attribute.
Type
string
|
|
formEnctypeformenctype |
Used to override the form owner's
enctype attribute.
Type
'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'
|
|
formMethodformmethod |
Used to override the form owner's
method attribute.
Type
'post' | 'get'
|
|
formNoValidateformnovalidate |
Used to override the form owner's
novalidate attribute.
Type
boolean
|
|
formTargetformtarget |
Used to override the form owner's
target attribute.
Type
'_self' | '_blank' | '_parent' | '_top' | string
|
|
hrefhref |
When set, the underlying button will be rendered as an
<a> with this href instead of a <button>.
Type
string
|
|
loadingloading |
Draws the button in a loading state.
Type
boolean
Default
false
|
|
namename |
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
|
|
pillpill |
Draws a pill-style button with rounded edges.
Type
boolean
Default
false
|
|
relrel |
When using
href, this attribute will map to the underlying link's rel attribute.
Type
string | undefined
|
|
sizesize |
The button's size.
Type
'xs' | 's' | 'm' | 'l' | 'xl' | 'small' | 'medium' | 'large'
Default
'm'
|
|
targettarget |
Tells the browser where to open the link. Only used when
href is present.
Type
'_blank' | '_parent' | '_self' | '_top'
|
|
typetype |
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
[]
|
|
valuevalue |
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
|
|
variantvariant |
The button's theme variant. Defaults to
neutral if not within another element with a variant.
Type
'neutral' | 'brand' | 'success' | 'warning' | 'danger' | 'info'
Default
'neutral'
|
|
withCaretwith-caret |
Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.
Type
boolean
Default
false
|
|
withEndwith-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
|
|
withStartwith-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
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
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
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
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
This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.