Modular and customizable Material Design UI components for Android
Java
Latest commit 5919524 Jan 18, 2017 @tec27 tec27 committed with tec27 [Docs] Fix mistake in readme test command.
Fixes #18.

PiperOrigin-RevId: 144906297

README.md

Material Components for Android

Material Components for Android (MDC-Android) help developers execute Material Design. Developed by a core team of engineers and UX designers at Google, these components enable a reliable development workflow to build beautiful and functional Android apps.

Material Components for Android are based on Android’s Design support library (DesignLib) which will continue to be released as part of Android’s SDK. Development will take place on GitHub, and stable versions will be synced to Android’s SDK based on the SDK’s release schedules.

Useful Links

Getting Started

Using the support library version

For most users, the Android Design support library is the best version to use in their application. The Android SDK contains the latest stable version of this library. To use it:

  1. Make sure you've downloaded the Android Support Repository using the SDK Manager.
  2. Open the build.gradle file for your application.
  3. Add the Design support library to the dependencies section:

    dependencies {
      // ...
      compile 'com.android.support:design:25.1.0'
      // ...
    }

Building from source

If you'll be contributing to the library, or need a version newer than what has been released in the Android support libraries, Material Components for Android can also be built from source. To do so:

Clone this repository:

git clone https://github.com/material-components/material-components-android.git

Then, build an AAR using Gradle:

./gradlew assembleRelease

(the AAR file will be located in lib/build/outputs/aar/)

Running tests

Material Components for Android has JVM tests as well as Emulator tests.

To run the JVM tests, do:

./gradlew test

To run the emulator tests, ensure you have a virtual device set up and do:

./gradlew connectedAndroidTest