https://github.com/gregkorossy/android-support-preference-v7-fix
Android androidx.preference support library has some issues, this lib tries to fix them.
https://github.com/gregkorossy/android-support-preference-v7-fix
android android-library preference-v7 support-library
Last synced: 8 months ago
JSON representation
Android androidx.preference support library has some issues, this lib tries to fix them.
- Host: GitHub
- URL: https://github.com/gregkorossy/android-support-preference-v7-fix
- Owner: gregkorossy
- License: apache-2.0
- Created: 2015-08-20T22:55:09.000Z (almost 11 years ago)
- Default Branch: androidx
- Last Pushed: 2022-02-21T00:13:19.000Z (over 4 years ago)
- Last Synced: 2025-09-28T20:54:04.334Z (9 months ago)
- Topics: android, android-library, preference-v7, support-library
- Language: Java
- Homepage: https://discord.gg/87NVsSK
- Size: 1.8 MB
- Stars: 495
- Watchers: 28
- Forks: 45
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#extra-types) available, such as `RingtonePreference`, `DatePickerPreference`, and `TimePickerPreference`.
[](https://search.maven.org/search?q=g:%22com.takisoft.preferencex%22%20AND%20a:%preferencex%22)
### Donation
If you would like to support me, you may donate some small amount via PayPal.
[ ](https://www.paypal.me/korossyg/0eur)
---
## How to use the library?
### 1. Add gradle dependency
**Add** this to your gradle file:
```gradle
implementation "androidx.preference:preference:$androidxVersion"
implementation 'com.takisoft.preferencex:preferencex:1.1.0'
```
### 2. Use the appropriate class as your fragment's base
```java
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`](https://github.com/Gericop/Android-Support-Preference-V7-Fix/wiki/Preference-types#ringtonepreference) | `implementation 'com.takisoft.preferencex:preferencex-ringtone:1.1.0'` | 
[`DatePickerPreference`](https://github.com/Gericop/Android-Support-Preference-V7-Fix/wiki/Preference-types#datepickerpreference) | `implementation 'com.takisoft.preferencex:preferencex-datetimepicker:1.1.0'` | 
[`TimePickerPreference`](https://github.com/Gericop/Android-Support-Preference-V7-Fix/wiki/Preference-types#timepickerpreference) | `implementation 'com.takisoft.preferencex:preferencex-datetimepicker:1.1.0'` | 
[`ColorPickerPreference`](https://github.com/Gericop/Android-Support-Preference-V7-Fix/wiki/Preference-types#colorpickerpreference) | `implementation 'com.takisoft.preferencex:preferencex-colorpicker:1.1.0'` | 
[`SimpleMenuPreference`](https://github.com/Gericop/Android-Support-Preference-V7-Fix/wiki/Preference-types#simplemenupreference) | `implementation 'com.takisoft.preferencex:preferencex-simplemenu:1.1.0'` (can be used independent of `preferencex`) | 
---
## 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`:
```xml
```
```java
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](https://github.com/Gericop/Android-Support-Preference-V7-Fix/pull/66))
---
## Version
The current stable version is **1.1.0**.
## Notes #
This demo / bugfix is set to work on API level 14+.
---
## Sample
_Material design - everywhere._
API 15 | API 21 | API 26
-|-|-
 |  | 
---
### Changelog
See the separate CHANGELOG.md file.
**2019-11-26**
New version: 1.1.0 (based on v1.1.0)
- introduced `PreferenceFragmentCompatMasterSwitch` that can be used as a switch's additional screen for settings; see the sample for details
- Added `pref_disableMessagePaddingFix` attribute to the `EditTextPreference` that can be used to disable the dialog message padding fix.
- `EditText` does not receive all attributes from `EditTextPreference` from now, only the following: `inputType`, `textAllCaps`, `lines`, `minLines`, `maxLines`, `ems`, `minEms`, `maxEms`
- `AutoSummaryEditTextPreference` is now deprecated, use an appropriate `SummaryProvider` with the `EditTextPreference`
> For older changelogs, check out the [CHANGELOG](CHANGELOG.md) file.
Feel free to ask / suggest anything on this page by creating a ticket (*issues*)!
# License notes #
Apache v2