Use SharedPreference (Android) and UserDefaults (iOS) with React Native over a unified interface
MIT License
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).
$ npm install react-native-default-preference --save
$ cd ios && pod install
$ react-native link react-native-default-preference
Libraries
➜ Add Files to [your project's name]
node_modules
➜ react-native-default-preference
and add RNDefaultPreference.xcodeproj
libRNDefaultPreference.a
to your project's Build Phases
➜ Link Binary With Libraries
Cmd+R
)<android/app/src/main/java/[...]/MainApplication.java
import com.kevinresol.react_native_default_preference.RNDefaultPreferencePackage;
to the imports at the top of the filenew RNDefaultPreferencePackage()
to the list returned by the getPackages()
methodandroid/settings.gradle
:
include ':react-native-default-preference'
project(':react-native-default-preference').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-default-preference/android')
android/app/build.gradle
:
compile project(':react-native-default-preference')
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')});
function get(key: string): Promise<string | undefined | null>;
function set(key: string, value: string): Promise<void>;
function clear(key: string): Promise<void>;
function getMultiple(keys: string[]): Promise<string[]>;
function setMultiple(data: {[key: string]: string}): Promise<void>;
function clearMultiple(keys: string[]): Promise<void>;
function getAll(): Promise<{[key: string]: string}>;
function clearAll(): Promise<void>;
/** Gets and sets the current preferences file name (android) or user default suite name (ios) **/
function getName(): Promise<string>;
function setName(name: string): Promise<void>;
This module is compatible with cordova-plugin-native-storage.
You need to use the same SharedPreference as in the cordova plugin, to do so add the following line:
import { Platform } from 'react-native';
// ...
if (Platform.OS === 'android') DefaultPreference.setName('NativeStorage');
You don't need to change the name, as cordova-plugin-native-storage uses the default value.