Android's "androidx.preference" library has some issues, this lib tries to fix them.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
gradle/wrapper
images
preferencex-colorpicker
preferencex-datetimepicker
preferencex-ringtone
preferencex-simplemenu
preferencex
.gitignore
CHANGELOG.md
LICENSE
README.md
bintrayv.gradle
build.gradle
gradle.properties
gradlew
gradlew.bat
installv.gradle
settings.gradle

README.md

AndroidX Preference eXtended

This library is meant to fix some of the problems found in the official AndroidX preference library. Also, there are new preference types available, such as RingtonePreference, DatePickerPreference, and TimePickerPreference.

Download

Donation

If you would like to support me, you may donate some small amount via PayPal.

Buy me a coffee


How to use the library?

1. Add gradle dependency

Add this to your gradle file:

implementation "androidx.preference:preference:$androidxVersion"
implementation 'com.takisoft.preferencex:preferencex:1.0.0-alpha2'

2. Use the appropriate class as your fragment's base

import com.takisoft.preferencex.PreferenceFragmentCompat;

public class MyPreferenceFragment extends PreferenceFragmentCompat {

    @Override
    public void onCreatePreferencesFix(@Nullable Bundle savedInstanceState, String rootKey) {
        setPreferencesFromResource(R.xml.settings, rootKey);
	
	// additional setup
    }
}

Warning! Watch out for the correct package name when importing PreferenceFragmentCompat, it should come from com.takisoft.preferencex.

Now you can enjoy using preferenceX.


Extra types

There are additional preferences not part of the official support library, but decided to add them to some extra libraries. You can add them to your project using Gradle.

Preference Dependency Preview
RingtonePreference implementation 'com.takisoft.preferencex:preferencex-ringtone:1.0.0-alpha2' API 26
DatePickerPreference implementation 'com.takisoft.preferencex:preferencex-datetimepicker:1.0.0-alpha2' API 26
TimePickerPreference implementation 'com.takisoft.preferencex:preferencex-datetimepicker:1.0.0-alpha2' API 26
ColorPickerPreference implementation 'com.takisoft.preferencex:preferencex-colorpicker:1.0.0-alpha2' API 26
SimpleMenuPreference implementation 'com.takisoft.preferencex:preferencex-simplemenu:1.0.0-alpha2' (can be used independent of preferencex) API 26

Custom solutions

Hijacked EditTextPreference

The support implementation of EditTextPreference ignores many of the basic yet very important attributes as it doesn't forward them to the underlying EditText widget. In my opinion this is a result of some twisted thinking which would require someone to create custom dialog layouts for some simple tasks, like showing a numbers-only dialog. This is the main reason why the EditTextPreference gets hijacked by this lib: it replaces certain aspects of the original class in order to forward all the XML attributes set (such as inputType) on the EditTextPreference to the EditText, and also provides a getEditText() method so it can be manipulated directly.

The sample app shows an example of setting (via XML) and querying (programmatically) the input type of the EditTextPreference:

<EditTextPreference
    android:inputType="phone"
    android:key="edit_text_test" />
EditTextPreference etPref = (EditTextPreference) findPreference("edit_text_test");
if (etPref != null) {
    int inputType = etPref.getEditText().getInputType();
    // do something with inputType
}

Note! Watch out for the correct package name when importing EditTextPreference, it should come from com.takisoft.preferencex. If you import from the wrong package (i.e. androidx.preference), the getEditText() method will not be available, however, the XML attributes will still be forwarded and processed by the EditText.

Others

  • Convenience methods in PreferenceFragmentCompat;
  • PreferenceCategory with different colors;
  • AutoSummaryEditTextPreference;
  • PreferenceActivityResultListener;
  • EditTextPreference correctly calls notifyChange. (#66)

Version

The current stable version is 1.0.0-alpha2.

Notes

This demo / bugfix is set to work on API level 14+.


Sample

Material design - everywhere.

API 15 API 21 API 26
API 15 API 21 API 26

Changelog

2018-05-11

New version: 1.0.0-alpha1 (based on v27.1.1)

  • No support preferences related changes in the support library.
  • Bug fixes (#153, #149, #155, #152).

2018-04-10

New version: 27.1.1.0 (based on v27.1.1)

  • No support preferences related changes in the support library.
  • Some bug fixes (see #147 for more info).

For older changelogs, check out the CHANGELOG file.

Feel free to ask / suggest anything on this page by creating a ticket (issues)!

License notes

Apache v2