@athrok/react-storage

React Storage Persistence Providers for Athrok State Management Library

Introduction

@athrok/react-storage is a utility package that provides persistence providers for managing storage in React applications using Athrok state management library. This package offers a convenient way to persist application state using local storage and session storage.

Features

• Provides persistence providers for local storage and session storage.
• Integrates seamlessly with Athrok's StorageManager for managing application state persistence.
• Offers a simple and straightforward API for initializing storage providers.

Installation

You can install @athrok/react-storage via npm or yarn:

npm install @athrok/react-storage

or

yarn add @athrok/react-storage

Usage

To use @athrok/react-storage, follow these steps:

1. Import the necessary modules:

import React from "react";
import { PersistenceProvider } from "@athrok/react-storage";

2. Wrap your application's components with the desired persistence provider:

For local storage:

export default function App() {
  return (
    <PersistenceProvider.LocalStorage>
      {
        // Place your application's child components and data here
      }
    </PersistenceProvider.LocalStorage>
  );
}

For session storage:

export default function App() {
  return (
    <PersistenceProvider.SessionStorage>
      {
        // Place your application's child components and data here
      }
    </PersistenceProvider.SessionStorage>
  );
}

In these examples, the PersistenceProvider components ensure that Athrok's storage persistence is initialized and ready for use throughout the application. You can place your application's child components and data inside the appropriate PersistenceProvider component to manage the persistence of the application state using either local storage or session storage.

Contributing

Contributions to @athrok/react-storage are welcome! Feel free to submit bug reports, feature requests, or pull requests on GitHub.

License

This project is licensed under the MIT License.