https://github.com/shimohq/react-native-preference
Manage react-native app's preference data synchronously
https://github.com/shimohq/react-native-preference
Last synced: about 2 months ago
JSON representation
Manage react-native app's preference data synchronously
- Host: GitHub
- URL: https://github.com/shimohq/react-native-preference
- Owner: shimohq
- License: mit
- Created: 2017-06-17T03:50:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-05T02:32:31.000Z (almost 4 years ago)
- Last Synced: 2025-06-28T17:42:41.893Z (4 months ago)
- Language: Java
- Size: 43.2 MB
- Stars: 23
- Watchers: 5
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-preference
Manage react-native app's preference data synchronously
# Installation
```bash
# install library from npm
npm install react-native-preference --save
```
# Usage
## Import
```javascript
import Preference from 'react-native-preference';
```
## Get
`Preference.get(key?: String)`
```javascript
// get all preferences
const preferences = Preference.get();
// get preference named `some-preference`
const preference = Preference.get('some-preference');
```
## Set
`Preference.set(key: string, value?: string): Promise`
```
// set preference
Preference.set('key', 'value');
```
## Clear
`Preference.clear(key?: string): Promise`
```
// clear all preference data
Preference.clear();
// clear preference for key 'foo'
Preference.clear('foo');
```
## White List
```
// set keys to white list, when preference value changed in white list changed, listener calls back.
Preference.setWhiteList(['a', 'b', 'c']);
Preference.addPreferenceChangedListener((changed) => {
console.log('preference has changed: changed');
});
```