react-native-shared-data

A React Native module for shared data management using Nitro Modules.

Features

• Cross-platform: Works on both iOS and Android
• Persistent storage: Optional data persistence across app sessions
• Type-safe: Full TypeScript support with generated native bindings
• High performance: Built with Nitro Modules for optimal performance

Installation

npm install react-native-shared-data
npm install react-native-nitro-modules
# or
yarn add react-native-shared-data
yarn add react-native-nitro-modules

Usage

import { SharedData } from 'react-native-shared-data'

// Set data with optional persistence
SharedData.setData('userName', 'John Doe', { persist: true })
SharedData.setData('tempData', 'temporary value')

// Get data
const userName = SharedData.getData('userName') // 'John Doe'
const tempData = SharedData.getData('tempData') // 'temporary value'

// Remove specific data
SharedData.removeData('tempData')

// Get all stored keys
const allKeys = SharedData.getAllKeys() // ['userName']

// Clear all data
SharedData.clearAllData()

API Reference

setData(key: string, value: string | null, options?: SharedDataOptions): void

Stores data with the given key.

• key: Unique identifier for the data
• value: Data to store (string or null)
• options.persist: Whether to persist data across app sessions (default: false)

getData(key: string): string | null

Retrieves data by key.

• key: The key to retrieve data for
• Returns: The stored value or null if not found

removeData(key: string): void

Removes data by key.

• key: The key to remove

clearAllData(): void

Removes all stored data.

getAllKeys(): string[]

Returns all stored keys.

• Returns: Array of all stored keys

Development

Building

# Install dependencies
npm install

# Build TypeScript
npm run typescript

# Generate native bindings
npm run specs

# Clean build artifacts
npm run clean

Project Structure

• android/: Android-specific implementations
  • build.gradle: Gradle build configuration with Kotlin and CMake setup
  • CMakeLists.txt: CMake configuration for C++ build
  • src/main/java/com/margelo/nitro/shareddata/: Kotlin implementations
    • HybridSharedData.kt: Main SharedData implementation
    • NitroSharedDataPackage.kt: React Native package registration
• ios/: iOS-specific implementations
  • HybridSharedData.swift: Main SharedData implementation for iOS
• src/: TypeScript source code
  • index.ts: Main module export
  • specs/SharedData.nitro.ts: SharedData interface definition
• nitrogen/: Generated native bindings (auto-generated, commit to git)
• nitro.json: Nitro configuration file
• NitroSharedData.podspec: iOS CocoaPods specification

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT © Nghi-NV