Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinresol/react-native-default-preference
Use SharedPreference (Android) and UserDefaults (iOS) with React Native over a unified interface
https://github.com/kevinresol/react-native-default-preference
android ios react-native sharedpreferences userdefaults
Last synced: 14 days ago
JSON representation
Use SharedPreference (Android) and UserDefaults (iOS) with React Native over a unified interface
- Host: GitHub
- URL: https://github.com/kevinresol/react-native-default-preference
- Owner: kevinresol
- License: mit
- Created: 2016-12-08T04:14:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T04:03:51.000Z (7 months ago)
- Last Synced: 2024-04-23T09:31:30.804Z (7 months ago)
- Topics: android, ios, react-native, sharedpreferences, userdefaults
- Language: Java
- Homepage:
- Size: 112 KB
- Stars: 216
- Watchers: 6
- Forks: 76
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/react-native-default-preference)
# react-native-default-preference
Use `SharedPreferences` (Android) and `UserDefaults` (iOS) with React Native over a unified interface.
All data is stored as a string. If you need to support more complex data structures, use serialization/deserialization (e.g. JSON).
## Getting started
`$ npm install react-native-default-preference --save`
### React Native >= 0.60
`$ cd ios && pod install`
### React Native <= 0.59
`$ react-native link react-native-default-preference`
### Manual installation
#### iOS
1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
2. Go to `node_modules` ➜ `react-native-default-preference` and add `RNDefaultPreference.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRNDefaultPreference.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
4. Run your project (`Cmd+R`)<
#### Android
1. Open up `android/app/src/main/java/[...]/MainApplication.java`
- Add `import com.kevinresol.react_native_default_preference.RNDefaultPreferencePackage;` to the imports at the top of the file
- Add `new RNDefaultPreferencePackage()` to the list returned by the `getPackages()` method
2. Append the following lines to `android/settings.gradle`:
```
include ':react-native-default-preference'
project(':react-native-default-preference').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-default-preference/android')
```
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
```
compile project(':react-native-default-preference')
```
## Usage
```javascript
import DefaultPreference from 'react-native-default-preference';
DefaultPreference.get('my key').then(function(value) {console.log(value)});
DefaultPreference.set('my key', 'my value').then(function() {console.log('done')});
```
## API
```typescript
function get(key: string): Promise;
function set(key: string, value: string): Promise;
function clear(key: string): Promise;
function getMultiple(keys: string[]): Promise;
function setMultiple(data: {[key: string]: string}): Promise;
function clearMultiple(keys: string[]): Promise;
function getAll(): Promise<{[key: string]: string}>;
function clearAll(): Promise;
/** Gets and sets the current preferences file name (android) or user default suite name (ios) **/
function getName(): Promise;
function setName(name: string): Promise;
```
## Cordova Native Storage Compatibility
This module is compatible with cordova-plugin-native-storage.
### Android
You need to use the same SharedPreference as in the cordova plugin, to do so add
the following line:
```js
import { Platform } from 'react-native';
// ...
if (Platform.OS === 'android') DefaultPreference.setName('NativeStorage');
```
### iOS
You don't need to change the name, as cordova-plugin-native-storage uses the default
value.