riverpod_helper #

Features #

Make coding with Riverpod easier/quicker by providing some helper functions.

Getting started #

Add this package to your pubspec.yaml.

If you are using vscode, add this to your .vscode/riverpod.code-snippets:

{
  "New Pod": {
    "scope": "dart",
    "prefix": "rp_pod",
    "description": "Creates a new pod",
    "body": [
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\t@override",
      "\t$2 build() {",
      "\t\treturn ;",
      "\t}",
      "}",
    ],
  },
  "New Future Pod": {
    "scope": "dart",
    "prefix": "rp_fpod",
    "description": "Creates a new pod that returns a future",
    "body": [
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\t@override",
      "\tFuture<$2> build() async {",
      "\t\treturn ;",
      "\t}",
      "}",
    ],
  },
  "New Stream Pod": {
    "scope": "dart",
    "prefix": "rp_spod",
    "description": "Creates a new pod that returns a stream",
    "body": [
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\t@override",
      "\tStream<$2> build() {",
      "\t\treturn ;",
      "\t}",
      "}",
    ],
  },
  "Consumer Stateless Widget": {
    "scope": "dart",
    "prefix": "rp_consumer_stl",
    "description": "Create a ConsumerStatelessWidget",
    "body": [
      "import 'package:flutter/material.dart';",
      "import 'package:flutter_riverpod/flutter_riverpod.dart';",
      "",
      "// $1",
      "",
      "class ${1/(.*)/${1:/pascalcase}/} extends ConsumerWidget {",
      "\tconst ${1/(.*)/${1:/pascalcase}/}({super.key,});\n",
      "\t@override",
      "\tWidget build(BuildContext context, WidgetRef ref) {",
      "\t\treturn Container();",
      "\t}",
      "}",
    ],
  },
  "Consumer Stateful Widget": {
    "scope": "dart",
    "prefix": "rp_consumer_stf",
    "description": "Create a ConsumerStatefulWidget",
    "body": [
      "import 'package:flutter/material.dart';",
      "import 'package:flutter_riverpod/flutter_riverpod.dart';",
      "",
      "// $1",
      "",
      "class ${1/(.*)/${1:/pascalcase}/} extends ConsumerStatefulWidget {",
      "\tconst ${1/(.*)/${1:/pascalcase}/}({super.key,});\n",
      "\t@override",
      "\tConsumerState<${1/(.*)/${1:/pascalcase}/}> createState() => _${1/(.*)/${1:/pascalcase}/}State();",
      "}",
      "",
      "class _${1/(.*)/${1:/pascalcase}/}State extends ConsumerState<${1/(.*)/${1:/pascalcase}/}> {",
      "\t@override",
      "\tWidget build(BuildContext context) {",
      "\t\treturn Container();",
      "\t}",
      "}",
    ],
  },
  "Switch Po all": {
    "scope": "dart",
    "prefix": "rp_swall",
    "description": "Create other switch",
    "body": [
      "switch($1) {",
      "AsyncData(:final value) => Container(),",
      "AsyncLoading() => const Center(child: CircularProgressIndicator()),",
      "AsyncError(:final error, :final stackTrace) => RiverpodErrorView(widgetName: '$this', error: error, stackTrace: stackTrace),",
      "}",
    ],
  },
  "Switch Po Data": {
    "scope": "dart",
    "prefix": "rp_swdata",
    "description": "Create data case",
    "body": ["AsyncData(:final value) => "],
  },
}

Usage #

If you are using shared_preferences plugin, you can write your code simpler like this:

import 'package:riverpod_helper/riverpod_helper.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'my_switch.g.dart';

@riverpod
class MySwitch extends _$MySwitch {
  static const prefsKey = 'my_switch';

  @override
  Future<bool> build() => Prefs.get<bool>(prefsKey, true);

  Future setState(bool value) async =>
    state = AsyncData(await Prefs.set<bool>(prefsKey, value));

  void toggle() async => setState(!state.data);
}

Yeah, that's it. It's simple, right?

Typed prefs pods #

For a plain "one key, one value" setting you don't need to write a pod at all. There is a family per SharedPreferences type, keyed by the preference key:

class PdfScrollSwitch extends ConsumerWidget {
  const PdfScrollSwitch({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final pod = prefsBoolPodProvider('pdf_scroll_switch');
    return switch (ref.watch(pod)) {
      AsyncData(:final value) => Switch(
          value: value ?? false,
          onChanged: (v) => ref.read(pod.notifier).setValue(v),
        ),
      AsyncLoading() => const CircularProgressIndicator(),
      AsyncError(:final error, :final stackTrace) => RiverpodErrorView(
          widgetName: 'PdfScrollSwitch',
          error: error,
          stackTrace: stackTrace,
        ),
    };
  }
}

Writing through ref.read(...notifier) is safe, including from a notifier or callback that never watches the pod:

await ref.read(prefsBoolPodProvider(key).notifier).setValue(value);

ref.read does not subscribe, so an auto-dispose pod reached this way has no listener and is disposed part-way through the write. setValue and removeValue hold the pod alive for the duration of the write, so this neither throws nor drops the write. If the pod is disposed anyway — you held a notifier across an event loop turn, say — the value still reaches SharedPreferences and the next read of the pod picks it up; only the in-memory state update, which has no listener left to notify, is skipped.

A write publishes the new value directly rather than calling ref.invalidateSelf(), so a widget watching the pod does not flash through AsyncLoading every time the setting changes.

Additional features #

If you offten use prefs you can add this to your .code-snippets file.

{
  "Prefs bool": {
    "scope": "dart",
    "prefix": "rp_pfbool",
    "description": "Get bool from prefs",
    "body": [
      "import 'package:riverpod_helper/riverpod_helper.dart';",
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\tstatic const prefsKey = '$1';",
      "",
      "\t@override",
      "\tFuture<bool> build() => Prefs.get<bool>(prefsKey, $2);",
      "",
      "\tFuture setState(bool value) async =>",
      "\t\tstate = AsyncData(await Prefs.set<bool>(prefsKey, value));",
      "",
      "\tvoid toggle() async => setState(!state.data);",
      "}",
    ],
  },
  "Prefs int": {
    "scope": "dart",
    "prefix": "rp_pfint",
    "description": "Get int from prefs",
    "body": [
      "import 'package:riverpod_helper/riverpod_helper.dart';",
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\tstatic const prefsKey = '$1';",
      "",
      "\t@override",
      "\tFuture<int> build() => Prefs.get<int>(prefsKey, $2);",
      "",
      "\tFuture setState(int value) async =>",
      "\t\tstate = AsyncData(await Prefs.set<int>(prefsKey, value));",
      "",
      "\tvoid increment() async => setState(state.data + 1);",
      "}",
    ],
  },
  "Prefs double": {
    "scope": "dart",
    "prefix": "rp_pfdouble",
    "description": "Get double from prefs",
    "body": [
      "import 'package:riverpod_helper/riverpod_helper.dart';",
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\tstatic const prefsKey = '$1';",
      "",
      "\t@override",
      "\tFuture<double> build() => Prefs.get<double>(prefsKey, $2);",
      "",
      "\tFuture setState(double value) async =>",
      "\t\tstate = AsyncData(await Prefs.set<double>(prefsKey, value));",
      "",
      "\tvoid increment() async => setState(state.data + 1);",
      "}",
    ],
  },
  "Prefs string": {
    "scope": "dart",
    "prefix": "rp_pfstring",
    "description": "Get string from prefs",
    "body": [
      "import 'package:riverpod_helper/riverpod_helper.dart';",
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\tstatic const prefsKey = '$1';",
      "",
      "\t@override",
      "\tFuture<String> build() => Prefs.get<String>(prefsKey, '$2');",
      "",
      "\tFuture setState(String value) async =>",
      "\t\tstate = AsyncData(await Prefs.set<String>(prefsKey, value));",
      "",
      "\tvoid increment() async => setState(state.data + 1);",
      "}",
    ],
  },
  "Prefs list": {
    "scope": "dart",
    "prefix": "rp_pflist",
    "description": "Get list from prefs",
    "body": [
      "import 'package:riverpod_helper/riverpod_helper.dart';",
      "import 'package:riverpod_annotation/riverpod_annotation.dart';",
      "",
      "part '$1.g.dart';",
      "",
      "@riverpod",
      "class ${1/(.*)/${1:/pascalcase}/} extends _$${1/(.*)/${1:/pascalcase}/} {",
      "\tstatic const prefsKey = '$1';",
      "",
      "\t@override",
      "\tFuture<List<$2>> build() => Prefs.get<List<$2>>(prefsKey, $3);",
      "",
      "\tFuture setState(List<$2> value) async =>",
      "\t\tstate = AsyncData(await Prefs.set<List<$2>>(prefsKey, value));",
      "",
      "\tvoid increment() async => setState(state.data + 1);",
      "}",
    ],
  },
}