https://github.com/camus-design/simple_shared_preferences
A simple wrapper for [SharedPreferences] that supports string, int, double, bool, List<String>, and Map<String, dynamic> types.
https://github.com/camus-design/simple_shared_preferences
android dart dartlang flutter flutter-plugin flutter-widget ios linux localstorage plugin sharedpreference sharedpreferences web widget windows
Last synced: 11 months ago
JSON representation
A simple wrapper for [SharedPreferences] that supports string, int, double, bool, List<String>, and Map<String, dynamic> types.
- Host: GitHub
- URL: https://github.com/camus-design/simple_shared_preferences
- Owner: camus-design
- License: mit
- Created: 2023-02-06T08:59:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-05T13:14:31.000Z (almost 3 years ago)
- Last Synced: 2025-04-23T19:52:15.107Z (about 1 year ago)
- Topics: android, dart, dartlang, flutter, flutter-plugin, flutter-widget, ios, linux, localstorage, plugin, sharedpreference, sharedpreferences, web, widget, windows
- Language: Dart
- Homepage: https://pub.dev/packages/simple_shared_preferences
- Size: 231 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Shared Preferences
[](https://pub.dev/packages/simple_shared_preferences)
A simple wrapper for [SharedPreferences](https://pub.dev/packages/shared_preferences)
Supported data types are `int`, `double`, `bool`, `String` and `List`.
| | Android | iOS | Linux | macOS | Web | Windows |
|-------------|---------|------|-------|--------|-----|-------------|
| **Support** | SDK 16+ | 9.0+ | Any | 10.11+ | Any | Any |
## Usage
To use this package, add `simple_shared_preferences` as a dependency in your pubspec.yaml file.
### Examples
Here are small examples that show you how to use the API.
```dart
import 'package:simple_shared_preferences/simple_shared_preferences.dart';
final simplePreference = await SimpleSharedPreferences.getInstance();
await simplePreference.set('name': 'simple shared preferences');
await simplePreference.set('age': 1);
await simplePreference.set('isDeveloper': true);
await simplePreference.set('height': 1.75);
await simplePreference.set('list': [1, 2, 3]);
await simplePreference.set('map': {'name': 'simple shared preferences'});
final String name = simplePreference.get('name');
final int age = simplePreference.get('age');
final bool isDeveloper = simplePreference.get('isDeveloper');
final double height = simplePreference.get('height');
final List list = simplePreference.get('list');
final Map map = simplePreference.get('map');
```
### Use like SharedPreferences
[SharedPreferences Doc](https://pub.dev/packages/shared_preferences)
#### Write data
```dart
// Obtain shared preferences.
final simplePreference = await SimpleSharedPreferences.getInstance();
// Save an integer value to 'counter' key.
await simplePreference.setValue('counter', 10);
// Save an boolean value to 'repeat' key.
await simplePreference.setValue('repeat', true);
// Save an double value to 'decimal' key.
await simplePreference.setValue('decimal', 1.5);
// Save an String value to 'action' key.
await simplePreference.setValue('action', 'Start');
// Save an list of strings to 'items' key.
await simplePreference.setValue>('items', ['Earth', 'Moon', 'Sun']);
// Save an map - simple preference
await simplePreference.setValue>('map', {
'name': 'simple shared preferences',
'age': 1,
'isDeveloper': true,
'height': 1.75,
'list': [1, 2, 3],
});
```
#### Read data
```dart
// Try reading data from the 'counter' key. If it doesn't exist, returns null.
final int? counter = simplePreference.getValue('counter');
// Try reading data from the 'repeat' key. If it doesn't exist, returns null.
final bool? repeat = simplePreference.getValue('repeat');
// Try reading data from the 'decimal' key. If it doesn't exist, returns null.
final double? decimal = simplePreference.getValue('decimal');
// Try reading data from the 'action' key. If it doesn't exist, returns null.
final String? action = simplePreference.getValue('action');
// Try reading data from the 'items' key. If it doesn't exist, returns null.
final List? items = simplePreference.getValue>('items');
// Try reading data from the 'map' key. If it doesn't exist, returns null
final Map? map = simplePreference.getValue>('map');
```
#### Remove an entry
```dart
// Remove data for the 'counter' key.
final success = await simplePreference.remove('counter');
```