How to call a riverpod provider outside of widget tree/widget class?

Question

I am new to using RiverPod. previously I used Provider for state management.

in case of provider I could use a provider outside widget tree to get value using syntax

Provider.of<MyModel>(context,listen:true).someFunction();

how do I do the same in RiverPod? for now I am using Consumer Builder and Consumer Widget. I was wondering if there's a way to call a riverpod provider without using Consumer.

Have you tried? ```ref.read(theProvider).someFunction();``` – Josteve Sep 04 '22 at 17:39 — Josteve, Sep 04 '22 at 17:39
@Josteve What do I assign to final Ref ref? to use this – Junaid Tariq Sep 04 '22 at 17:41 — Junaid Tariq, Sep 04 '22 at 17:41

score 3 · Accepted Answer · edited Sep 14 '22 at 13:00

You can easily call riverpord provider without using Consumer. Please check out my below extension which is very helpful to call the provider based on context where it will work for the read function without any consumer or consumer widget.

extension Context on BuildContext {
  // Custom call a provider for reading method only
  // It will be helpful for us for calling the read function
  // without Consumer,ConsumerWidget or ConsumerStatefulWidget
  // Incase if you face any issue using this then please wrap your widget
  // with consumer and then call your provider

  T read<T>(ProviderBase<T> provider) {
     return ProviderScope.containerOf(this, listen: false).read(provider);
  }
}

After then under the build method, you must call context.read(yourProviderName)

score 1 · Answer 2 · answered Sep 05 '22 at 05:17

1

let's say you have a separate class that is responsible for ui logic:

class UiController {
  UiController(this._ref);

  final Ref _ref;

  Reader get _reader => _ref.read;

  static final pr = Provider<UiController>((ref) => UiController(ref));

  void someFunction() {
    _reader(otherProvider).getValue();
  }
}

from a widget or other functions where ref is accessed, you can call:

ref.read(UiController.pr).someFunction();

answered Sep 05 '22 at 05:17

Ruble

2,589
3
6
29

can't ref.read(UiController.pr).someFunction(); be called somewhere outside a widget class? – Junaid Tariq Sep 05 '22 at 07:21
only if we have access to ref. Otherwise, you can try using [UncontrolledProviderScope](https://github.com/rrousselGit/riverpod/issues/295#issuecomment-770368500) – Ruble Sep 05 '22 at 09:51

How to call a riverpod provider outside of widget tree/widget class?

2 Answers2