Android-MaterialPreference is deprecated. No more development will be taking place.
If you need some assistance in building a fully Material Design settings screen, here is a great series of blog articles on this topic:
Building an Android Settings Screen (Part 1) - How to Create and Fix the Overview Screen
Building an Android Settings Screen (Part 2) - How to Create and Fix the Dialogs
Building an Android Settings Screen (Part 3) - How to Create Custom Preferences
Building an Android Settings Screen (Part 4) - How to Use a Custom Layout for the Preference Fragment
Android - MaterialPreference
- A simple backward-compatible implementation of a Material Design Preference aka settings item
- XML layouts are taken from Android Platform Framework Base
- Here's a side-by-side comparison with a native Lollipop preference:
In your settings XML file that describes your preferences (must be located in
just use the custom implementations like this:
<com.jenzz.materialpreference.PreferenceCategory android:title="Material Category"> <com.jenzz.materialpreference.Preference android:title="Material Preference" android:summary="Material Summary" /> <com.jenzz.materialpreference.CheckBoxPreference android:title="Material CheckBoxPreference" android:summaryOn="Material CheckBox Summary On" android:summaryOff="Material CheckBox Summary Off" /> </com.jenzz.materialpreference.PreferenceCategory>
That's it. You can use all the attributes you know from the original preferences.
You're probably wondering why there are only Material Design versions
I don't use them. Instead I just show a simple
and display a Material Design dialog when the user selects it.
I highly recommend using the material-dialogs library for that.
- On Lollipop, the preference color is derived from the
android:colorAccentattribute of your app theme.
- If you're using AppCompat, it is inherited from the
- If you want a totally different color for your preferences (why would you?), you can still override it in your app theme like this:
<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar"> <item name="mp_colorAccent">#bada55</item> </style>
Also note that the
Activity hosting your preferences screen must extend
ActionBarActivity in order for the
CheckBox tinting to work.
The easiest solution to accomplish that is to delegate all your preferences logic (including the inflation) to a
just like it is done in the sample project.
Check out the sample project for an example implementation.
Grab it via Gradle:
This project is licensed under the MIT License.