How do I install react-native-shared-preferences in React Native 0.60+?

For React Native 0.60 and above, you must manually link the module since auto-linking isn't supported. Follow the README steps to edit settings.gradle, build.gradle, and MainApplication.java, but be aware of potential compatibility issues with newer versions.

Can I use react-native-shared-preferences on iOS?

No, this module is specific to Android's SharedPreferences. For iOS storage in React Native, you'll need alternatives like AsyncStorage or platform-specific libraries such as react-native-mmkv.

react-native-shared-preferences vs AsyncStorage: which is better?

Use react-native-shared-preferences for Android-only apps needing native performance and reliability. AsyncStorage is cross-platform but may have slower performance; this module is ideal if you're prioritizing Android optimization.

How to store JSON objects with react-native-shared-preferences?

You need to serialize JSON objects to strings before storage, as the module only handles strings. Use JSON.stringify() when setting items and JSON.parse() when retrieving them to manage complex data.

Is react-native-shared-preferences secure for sensitive data like tokens?

No, SharedPreferences is not encrypted by default, so it's not secure for sensitive information. For better security, consider using libraries like react-native-keychain or implementing encryption before storage.

Does react-native-shared-preferences work with Expo?

No, it requires native module linking, which is incompatible with Expo's managed workflow. You'd need to eject from Expo or use a different storage solution like AsyncStorage within Expo.

Open-Awesome

react-native-shared-preferences

Javav1.0.2

A React Native module that provides access to Android's native key-value storage system (SharedPreferences).

GitHub

125 stars54 forks0 contributors

What is react-native-shared-preferences?

React Native Shared Preferences is a React Native module that provides a JavaScript interface to Android's native SharedPreferences system. It allows developers to store and retrieve small amounts of persistent key-value data in React Native apps, using the same underlying storage mechanism as native Android apps. This solves the need for a simple, reliable, and performant storage solution in React Native applications targeting Android.

Target Audience

React Native developers building Android applications who need a straightforward, native-backed solution for persistent key-value storage, such as for user preferences, settings, or small cached data.

Value Proposition

Developers choose this module because it directly leverages Android's built-in SharedPreferences API, ensuring reliability, performance, and compatibility without the overhead of third-party storage libraries. It offers a minimal, easy-to-use JavaScript API that mirrors native Android patterns.

Overview

Android's Native key value storage system in React Native

Use Cases

Best For

Storing user preferences and settings in React Native Android apps
Caching small amounts of persistent data like authentication tokens
Managing simple app state that needs to survive app restarts
Implementing lightweight data persistence without external dependencies
Android-only React Native projects needing native storage integration
Migrating native Android storage logic to React Native

Not Ideal For

Cross-platform React Native applications needing storage on both Android and iOS
Projects requiring large-scale or complex data storage beyond simple key-value pairs
Modern React Native setups using Expo or relying on auto-linking for native modules

Pros & Cons

Pros

Native Android Integration

Directly accesses Android's SharedPreferences API for high performance and compatibility, as emphasized in the project description as a bridge module.

Simple Key-Value API

Provides intuitive methods like setItem and getItem, mirroring web storage patterns for easy adoption, as shown in the usage examples.

Batch Operations Support

Includes getItems and getAllKeys functions for efficient data retrieval, allowing multiple items to be fetched at once, per the README.

Customizable Storage Files

Allows setting a custom preferences file name via setName, enabling organized data separation for different app components.

Cons

Manual Native Setup

Requires manual editing of Android files like settings.gradle and MainApplication.java, which is complex and error-prone compared to auto-linking in newer React Native versions.

Android-Only Limitation

Exclusively supports Android, making it unsuitable for iOS or cross-platform apps, forcing separate storage implementations for other platforms.

Basic Feature Set

Limited to simple key-value storage without built-in encryption or support for complex data types, which may require additional work for advanced use cases.

Frequently Asked Questions

Related Projects

react-native-vector-icons

Customizable Icons for React Native with support for image source and full styling.

Stars17,917

Forks2,105

Last commit21 hours ago

lottie-react-native

Lottie wrapper for React Native.

Stars17,211

Forks1,801

Last commit5 days ago

react-native-maps

React Native Mapview component for iOS + Android

Material Design for React Native (Android & iOS)

Stars14,457

Forks2,244

Last commit16 hours ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub