material-web/docs/components/button.md
2023-09-25 21:32:35 +00:00

24 KiB
Raw Blame History

Buttons

This documentation is fully rendered on the Material Web catalog.

Buttons help people initiate actions, from sending an email, to sharing a document, to liking a post.

There are five types of common buttons: elevated, filled, filled tonal, outlined, and text.

A phone showing a payment screen with a green filled button that says 'Make
payment'

Types

The 5 types of common buttons

  1. Elevated button
  2. Filled button
  3. Filled tonal button
  4. Outlined button
  5. Text button

Usage

Buttons have label text that describes the action that will occur if a user taps a button.

An outlined button with the text "Back" next to a filled button with the text
"Complete"

<md-outlined-button>Back</md-outlined-button>
<md-filled-button>Complete</md-filled-button>

Icon

An icon may optionally be added to a button to help communicate the button's action and help draw attention.

A tonal button with a right arrow send icon with text 'send' and a text button
with the text 'open' with a trailing icon arrow
box

<md-filled-tonal-button>
  Send
  <svg slot="icon" viewBox="0 0 48 48"><path d="M6 40V8l38 16Zm3-4.65L36.2 24 9 12.5v8.4L21.1 24 9 27Zm0 0V12.5 27Z"/></svg>
</md-filled-tonal-button>

<md-text-button trailing-icon>
  Open
  <svg slot="icon" viewBox="0 0 48 48"><path d="M9 42q-1.2 0-2.1-.9Q6 40.2 6 39V9q0-1.2.9-2.1Q7.8 6 9 6h13.95v3H9v30h30V25.05h3V39q0 1.2-.9 2.1-.9.9-2.1.9Zm10.1-10.95L17 28.9 36.9 9H25.95V6H42v16.05h-3v-10.9Z"/></svg>
</md-text-button>

Accessibility

Add an aria-label attribute to buttons whose labels need a more descriptive label.

<md-elevated-button aria-label="Add a new contact">Add</md-elevated-button>

Elevated button

Elevated buttons are essentially filled tonal buttons with a shadow. To prevent shadow creep, only use them when absolutely necessary, such as when the button requires visual separation from a patterned background.

An elevated button

<md-elevated-button>Elevated</md-elevated-button>

Filled button

Filled buttons have the most visual impact after the FAB, and should be used for important, final actions that complete a flow, like Save, Join now, or Confirm.

<md-filled-button>Filled</md-filled-button>

Filled tonal button

A filled tonal button is an alternative middle ground between filled and outlined buttons. They're useful in contexts where a lower-priority button requires slightly more emphasis than an outline would give, such as "Next" in an onboarding flow.

A filled tonal button

<md-filled-tonal-button>Tonal</md-filled-tonal-button>

Outlined button

Outlined buttons are medium-emphasis buttons. They contain actions that are important, but arent the primary action in an app.

An outlined button

<md-outlined-button>Outlined</md-outlined-button>

Text button

Text buttons are used for the lowest priority actions, especially when presenting multiple options.

A text button

<md-text-button>Text</md-text-button>

Theming

Button supports Material theming and can be customized in terms of color, typography, and shape.

Elevated button tokens

Token Default value
--md-elevated-button-container-color --md-sys-color-surface
--md-elevated-button-container-shape 9999px
--md-elevated-button-label-text-color --md-sys-color-on-surface
--md-elevated-button-label-text-font --md-sys-typescale-label-large-font

Elevated button example

Image of an elevated button with a different theme applied

<style>
:root {
  --md-elevated-button-container-shape: 0px;
  --md-elevated-button-label-text-font: system-ui;
  --md-sys-color-surface-container-low: #FAFDFC;
  --md-sys-color-primary: #191C1C;
}
</style>

<md-elevated-button>Elevated</md-elevated-button>

Filled button tokens

Token Default value
--md-filled-button-container-color --md-sys-color-primary
--md-filled-button-container-shape 9999px
--md-filled-button-label-text-color --md-sys-color-on-primary
--md-filled-button-label-text-font --md-sys-typescale-label-large-font

Filled button example

Image of a filled button with a different theme applied

<style>
:root {
  --md-filled-button-container-shape: 0px;
  --md-filled-button-label-text-font: system-ui;
  --md-sys-color-primary: #006A6A;
  --md-sys-color-on-primary: #FFFFFF;
}
</style>

<md-filled-button>Filled</md-filled-button>

Filled tonal button tokens

Token Default value
--md-filled-tonal-button-container-color --md-sys-color-secondary-container
--md-filled-tonal-button-container-shape 9999px
--md-filled-tonal-button-label-text-color --md-sys-color-on-secondary-container
--md-filled-tonal-button-label-text-font --md-sys-typescale-label-large-font

Filled tonal button example

Image of a filled tonal button with a different theme applied

<style>
:root {
  --md-filled-tonal-button-container-shape: 0px;
  --md-filled-tonal-button-label-text-font: system-ui;
  --md-sys-color-secondary-container: #CCE8E7;
  --md-sys-color-on-secondary-container: #051F1F;
}
</style>

<md-filled-tonal-button>Tonal</md-filled-tonal-button>

Outlined button tokens

Token Default value
--md-outlined-button-outline-color --md-sys-color-outline
--md-outlined-button-container-shape 9999px
--md-outlined-button-label-text-color --md-sys-color-primary
--md-outlined-button-label-text-font --md-sys-typescale-label-large-font

Outlined button example

Image of an outlined button with a different theme applied

<style>
:root {
  --md-outlined-button-container-shape: 0px;
  --md-outlined-button-label-text-font: system-ui;
  --md-sys-color-primary: #006A6A;
  --md-sys-color-outline: #6F7979;
}
</style>

<md-outlined-button>Outlined</md-outlined-button>

Text button tokens

Token Default value
--md-text-button-label-text-color --md-sys-color-primary
--md-text-button-label-text-font --md-sys-typescale-label-large-font

Text button example

Image of a text button with a different theme applied

<style>
:root {
  --md-text-button-label-text-font: system-ui;
  --md-sys-color-primary: #006A6A;
}
</style>

<md-text-button>Text</md-text-button>

API

MdElevatedButton <md-elevated-button>

Properties

Property Attribute Type Default Description
disabled disabled boolean false Whether or not the button is disabled.
href href string '' The URL that the link button points to.
target target string '' Where to display the linked href URL for a link button. Common options include _blank to open in a new tab.
trailingIcon trailing-icon boolean false Whether to render the icon at the inline end of the label rather than the inline start.
Note: Link buttons cannot have trailing icons.
hasIcon has-icon boolean false Whether to display the icon or not.
type type string 'submit'
value value string ''
name string undefined
form HTMLFormElement undefined

MdFilledButton <md-filled-button>

Properties

Property Attribute Type Default Description
disabled disabled boolean false Whether or not the button is disabled.
href href string '' The URL that the link button points to.
target target string '' Where to display the linked href URL for a link button. Common options include _blank to open in a new tab.
trailingIcon trailing-icon boolean false Whether to render the icon at the inline end of the label rather than the inline start.
Note: Link buttons cannot have trailing icons.
hasIcon has-icon boolean false Whether to display the icon or not.
type type string 'submit'
value value string ''
name string undefined
form HTMLFormElement undefined

MdFilledTonalButton <md-filled-tonal-button>

Properties

Property Attribute Type Default Description
disabled disabled boolean false Whether or not the button is disabled.
href href string '' The URL that the link button points to.
target target string '' Where to display the linked href URL for a link button. Common options include _blank to open in a new tab.
trailingIcon trailing-icon boolean false Whether to render the icon at the inline end of the label rather than the inline start.
Note: Link buttons cannot have trailing icons.
hasIcon has-icon boolean false Whether to display the icon or not.
type type string 'submit'
value value string ''
name string undefined
form HTMLFormElement undefined

MdOutlinedButton <md-outlined-button>

Properties

Property Attribute Type Default Description
disabled disabled boolean false Whether or not the button is disabled.
href href string '' The URL that the link button points to.
target target string '' Where to display the linked href URL for a link button. Common options include _blank to open in a new tab.
trailingIcon trailing-icon boolean false Whether to render the icon at the inline end of the label rather than the inline start.
Note: Link buttons cannot have trailing icons.
hasIcon has-icon boolean false Whether to display the icon or not.
type type string 'submit'
value value string ''
name string undefined
form HTMLFormElement undefined

MdTextButton <md-text-button>

Properties

Property Attribute Type Default Description
disabled disabled boolean false Whether or not the button is disabled.
href href string '' The URL that the link button points to.
target target string '' Where to display the linked href URL for a link button. Common options include _blank to open in a new tab.
trailingIcon trailing-icon boolean false Whether to render the icon at the inline end of the label rather than the inline start.
Note: Link buttons cannot have trailing icons.
hasIcon has-icon boolean false Whether to display the icon or not.
type type string 'submit'
value value string ''
name string undefined
form HTMLFormElement undefined