Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 2.23 KB

Switch.md

File metadata and controls

63 lines (50 loc) · 2.23 KB
Raw

Switches

A Switch represents a button with two states, on and off. Switches are most often used on mobile devices to enable and disable options in an options menu. A switch consists of a track and thumb; the thumb moves along the track to indicate its current state.

Design & API Documentation

Usage

The SwitchMaterial widget provides a complete implementation of Material Design's switch component. It extends from the support library's SwitchCompat widget, but not from the framework Switch widget. As such, it does not auto-inflate, unlike other selection controls, and must be explicitly specified in layouts.

<com.google.android.material.switchmaterial.SwitchMaterial
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  android:checked="true"
  android:text="@string/switch_text"/>

Material Styles

Using a Material Components theme with SwitchMaterial will match the color of SwitchMaterial views to your theme's palette. If you want to override this behavior, as you might with custom drawables, set the useMaterialThemeColors parameter to false.

<com.google.android.material.switchmaterial.SwitchMaterial
  xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:app="http://schemas.android.com/apk/res-auto"
  app:useMaterialThemeColors="false"
  android:text="@string/switch_text"/>

Styles

Use switchStyle for style changes.

  <item name="switchStyle">@style/Widget.MaterialComponents.CompoundButton.Switch</item>