Mon. Dec 30th, 2024

Buttons Design

Buttons allow users to take actions, and make choices, with a single tap

New buttons have updated shape, typography, and color mappings, dynamic color compatibility, and 3 additional types (elevated, filled, and filled tonal)—replacing the contained button

Usage

Buttons communicate actions that users can take. They are typically placed throughout your UI, in places like:

  • Dialogs
  • Modal windows
  • Forms
  • Cards
  • Toolbars

1. Text button (low emphasis)
Text buttons are typically used for less important actions.

2. Outlined Button (medium emphasis)
Outlined buttons are used for more emphasis than text buttons due to the stroke.

3. Contained button (high emphasis)
Contained buttons have more emphasis, as they use a color fill and shadow.

4. Toggle button
Toggle buttons group a set of actions using layout and spacing. They’re used less often than other button types.

Anatomylink

Buttons contain one required element and four optional elements

1. Text button
A. Text label
C. Icon (optional)

2. Outlined button
A. Text label
B. Container
C. Icon (optional)

3. Contained button
A. Text label
B. Container
C. Icon (optional)

4. Toggle button
A. Text label
C. Icon (optional)

Buttons Implementation

Using buttonslink

Before you can use Material buttons, you need to add a dependency to the Material Components for Android library. For more information, go to the Getting started page.

Note:<Button> is auto-inflated as <com.google.android.material.button.MaterialButton> via MaterialComponentsViewInflater when using a non-Bridge Theme.MaterialComponents.* theme.

Making buttons accessible

Buttons support content labeling for accessibility and are readable by most screen readers, such as TalkBack. Text rendered in buttons is automatically provided to accessibility services. Additional content labels are usually unnecessary.

For more information on content labels, go to the Android accessibility help guide.

Types

There are four types of buttons: 1. Text button, 2. Outlined button, 3. Contained button, 4. Toggle button

Text buttonlink

Text buttons are typically used for less-pronounced actions, including those located in dialogs and cards. In cards, text buttons help maintain an emphasis on card content.

Text button examples

API and source code:

The following example shows a text button with a text label.

"Text button with purple text 'Text button' over a white background."

In the layout:

<Button
    android:id="@+id/textButton"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="Text button"
    style="@style/Widget.MaterialComponents.Button.TextButton"
/>

Adding an icon to a text button

The following example shows a text button with an icon.

"Text button with purple text 'Text button' and '+' icon over a white
background."

In the layout:

<Button
    ...
    app:icon="@drawable/ic_add_24dp"
    style="@style/Widget.MaterialComponents.Button.TextButton.Icon"
/>

Anatomy and key properties

A text button has a text label, a transparent container and an optional icon.

Text button anatomy diagram
  1. Text label
  2. Icon

Text label attributes

ElementAttributeRelated method(s)Default value
Text labelandroid:textsetText
getText
null
Colorandroid:textColorsetTextColor
getTextColor
?attr/colorPrimary (see all states)
Typographyandroid:textAppearancesetTextAppearance?attr/textAppearanceButton

Container attributes

ElementAttributeRelated method(s)Default value
Colorapp:backgroundTintsetBackgroundColor
setBackgroundTintList
getBackgroundTintList
@android:color/transparent (see all states)
Stroke colorapp:strokeColorsetStrokeColor
setStrokeColorResource
getStrokeColor
null
Stroke widthapp:strokeWidthsetStrokeWidth
setStrokeWidthResource
getStrokeWidth
0dp
Shapeapp:shapeAppearancesetShapeAppearanceModel
getShapeAppearanceModel
?attr/shapeAppearanceSmallComponent
Elevationapp:elevationsetElevation
getElevation
0dp
Ripple colorapp:rippleColorsetRippleColor
setRippleColorResource
getRippleColor
?attr/colorPrimary at 12% opacity (see all states)

Icon attributes

ElementAttributeRelated method(s)Default value
Iconapp:iconsetIcon
setIconResource
getIcon
null
Colorapp:iconTintsetIconTint
setIconTintResource
getIconTint
?attr/colorPrimary (see all states)
Sizeapp:iconSizesetIconSize
getIconSize
wrap_content
Gravity (position relative to text label)app:iconGravitysetIconGravity
getIconGravity
start
Padding (space between icon and text label)app:iconPaddingsetIconPadding
getIconPadding
4dp

Styles

ElementStyle
Default styleWidget.MaterialComponents.Button.TextButton
Icon styleWidget.MaterialComponents.Button.TextButton.Icon
Full Width ButtonsWidget.MaterialComponents.Button.TextButton.Dialog.FullWidth

Outlined button

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

Outlined button examples

API and source code:

The following example shows an outlined button with a text label and stroked container.

"Outlined button with purple text 'Outlined button' and grey border over a
white background."

In the layout:

<Button
    android:id="@+id/outlinedButton"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="Outlined button"
    style="?attr/materialButtonOutlinedStyle"
/>

Adding an icon to an outlined button

The following example shows an outlined button with an icon.

"Outlined button with purple text 'Outlined button', grey border and '+' icon
over a white background."

In the layout:

<Button
    ...
    app:icon="@drawable/ic_add_24dp"
    style="@style/Widget.MaterialComponents.Button.OutlinedButton.Icon"
/>

Anatomy and key properties

An outlined button has a text label, a stroked container and an optional icon.

Outlined button anatomy diagram
  1. Text label
  2. Container
  3. Icon

Text label attributes

ElementAttributeRelated method(s)Default value
Text labelandroid:textsetText
getText
null
Colorandroid:textColorsetTextColor
getTextColor
?attr/colorPrimary (see all states)
Typographyandroid:textAppearancesetTextAppearance?attr/textAppearanceButton

Container attributes

ElementAttributeRelated method(s)Default value
Colorapp:backgroundTintsetBackgroundColor
setBackgroundTintList
getBackgroundTintList
@android:color/transparent (see all states)
Stroke colorapp:strokeColorsetStrokeColor
setStrokeColorResource
getStrokeColor
?attr/colorOnSurface at 12% opacity (see all states)
Stroke widthapp:strokeWidthsetStrokeWidth
setStrokeWidthResource
getStrokeWidth
1dp
Shapeapp:shapeAppearancesetShapeAppearanceModel
getShapeAppearanceModel
?attr/shapeAppearanceSmallComponent
Elevationapp:elevationsetElevation
getElevation
0dp
Ripple colorapp:rippleColorsetRippleColor
setRippleColorResource
getRippleColor
?attr/colorPrimary at 12% opacity (see all states)

Icon attributes

ElementAttributeRelated method(s)Default value
Iconapp:iconsetIcon
setIconResource
getIcon
null
Colorapp:iconTintsetIconTint
setIconTintResource
getIconTint
?attr/colorPrimary (see all states)
Sizeapp:iconSizesetIconSize
getIconSize
wrap_content
Gravity (position relative to text label)app:iconGravitysetIconGravity
getIconGravity
start
Padding (space between icon and text label)app:iconPaddingsetIconPadding
getIconPadding
4dp

Styles

ElementStyle
Default styleWidget.MaterialComponents.Button.OutlinedButton
Icon styleWidget.MaterialComponents.Button.OutlinedButton.Icon

Contained button

Contained buttons are high-emphasis, distinguished by their use of elevation and fill. They contain actions that are primary to your app.

Note The contained button is the default style if the style is not set.

Contained button examples

API and source code:

The following example shows a contained button with a text label and a filled container.

"Contained button with white text 'Contained button' and purple container over
a white background."

In the layout:

<Button
    android:id="@+id/containedButton"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="Contained button"
/>

Note: Since this is the default type, you don’t need to specify a style tag as long as you are using a Material Components Theme. If not, set the style to @style/Widget.MaterialComponents.Button.

Adding an icon to a contained button

The following example shows a contained button with an icon.

"Contained button with white text 'Contained button', purple container and '+'
icon over a white background."

In the layout:

<Button
    ...
    app:icon="@drawable/ic_add_24dp"
    style="@style/Widget.MaterialComponents.Button.Icon"
/>

Anatomy and key properties

A contained button has a text label, a filled container and an optional icon.

Contained button anatomy diagram
  1. Text label
  2. Container
  3. Icon

Text label attributes

ElementAttributeRelated method(s)Default value
Text labelandroid:textsetText
getText
null
Colorandroid:textColorsetTextColor
getTextColor
?attr/colorOnPrimary (see all states)
Typographyandroid:textAppearancesetTextAppearance?attr/textAppearanceButton

Container attributes

ElementAttributeRelated method(s)Default value
Colorapp:backgroundTintsetBackgroundColor
setBackgroundTintList
getBackgroundTintList
?attr/colorPrimary (see all states)
Stroke colorapp:strokeColorsetStrokeColor
setStrokeColorResource
getStrokeColor
null
Stroke widthapp:strokeWidthsetStrokeWidth
setStrokeWidthResource
getStrokeWidth
0dp
Shapeapp:shapeAppearancesetShapeAppearanceModel
getShapeAppearanceModel
?attr/shapeAppearanceSmallComponent
Elevationapp:elevationsetElevation
getElevation
2dp
Ripple colorapp:rippleColorsetRippleColor
setRippleColorResource
getRippleColor
?attr/colorOnPrimary at 24% opacity (see all states)

Icon attributes

ElementAttributeRelated method(s)Default value
Iconapp:iconsetIcon
setIconResource
getIcon
null
Colorapp:iconTintsetIconTint
setIconTintResource
getIconTint
?attr/colorOnPrimary (see all states)
Sizeapp:iconSizesetIconSize
getIconSize
wrap_content
Gravity (position relative to text label)app:iconGravitysetIconGravity
getIconGravity
start
Padding (space between icon and text label)app:iconPaddingsetIconPadding
getIconPadding
4dp

Styles

ElementStyle
Default styleWidget.MaterialComponents.Button
Icon styleWidget.MaterialComponents.Button.Icon
Unelevated styleWidget.MaterialComponents.Button.UnelevatedButton
Unelevated icon styleWidget.MaterialComponents.Button.UnelevatedButton.Icon

By Rajashekar

I’m (Rajashekar) a core Android developer with complimenting skills as a web developer from India. I cherish taking up complex problems and turning them into beautiful interfaces. My love for decrypting the logic and structure of coding keeps me pushing towards writing elegant and proficient code, whether it is Android, PHP, Flutter or any other platforms. You would find me involved in cuisines, reading, travelling during my leisure hours.

Leave a Reply

Your email address will not be published. Required fields are marked *