shared_preferences_plus #

A Flutter plugin for reading and writing key-value pairs to persistent storage with support for isolated named containers.

Features #

• 🔑 Simple key-value storage — Read and write standard data types (String, int, double, bool, List<String>) with a clean, intuitive API.
• 📦 Container support — Create isolated namespaces using named containers to keep data organized and separated.
• 🌐 Cross-platform — Works on Android (SharedPreferences), iOS & macOS (NSUserDefaults), Web (localStorage), and Windows & Linux (local JSON file).

Installation #

dependencies:
  shared_preferences_plus: ^1.0.0

Usage #

Basic #

Call SharedPreferencesPlus.getInstance() before any reads to initialize the in-memory cache. Reads are synchronous and will throw StateError if the cache has not been loaded.

import 'package:shared_preferences_plus/shared_preferences_plus.dart';

final prefs = await SharedPreferencesPlus.getInstance();

// Write values
await prefs.setString('key', 'value');
await prefs.setInt('counter', 10);
await prefs.setBool('is_active', true);

// Read values
final value = prefs.getString('key'); // 'value'
final counter = prefs.getInt('counter'); // 10
final isActive = prefs.getBool('is_active'); // true

// Read all values
final allPrefs = prefs.getAll(); // {'key': 'value', 'counter': 10, 'is_active': true}

Named Containers #

Use SharedPreferencesPlusOptions to create isolated namespaces:

final userPrefs = await SharedPreferencesPlus.getInstance(
  options: SharedPreferencesPlusOptions(name: 'user_settings'),
);

final appPrefs = await SharedPreferencesPlus.getInstance(
  options: SharedPreferencesPlusOptions(name: 'app_config'),
);

// Data is stored in separate, isolated containers
await userPrefs.setString('theme', 'dark');
await appPrefs.setString('theme', 'v2');

final userTheme = userPrefs.getString('theme'); // 'dark'
final appTheme = appPrefs.getString('theme');   // 'v2'

If no name is provided, the default container name SharedPreferencesPlus is used.

Support #

If you like this package, consider supporting it by:

1. Starring the repository on GitHub ⭐️
2. Liking the package on pub.dev 👍