lite_ref 0.4.0

lite_ref: ^0.4.0 copied to clipboard

[Breaking] This now a flutter package

Add ScopedRef which is a ref that needs a context to access its instance

Add LiteRefScope which coupled withScopedRef is an alternative to Provider for classes that don't rebuild widgets.

• Wrap your app or a subtree with a LiteRefScope:

  runApp(
  LiteRefScope(
      child: MyApp(),
  ),
  );
  

• Create a ScopedRef.

  final settingsServiceRef = Ref.scoped((ctx) => SettingsService());
  

• Access the instance in the current scope:

  This can be done in a widget by using settingsServiceRef.of(context) or settingsServiceRef(context).

  class SettingsPage extends StatelessWidget {
  const SettingsPage({super.key});
  
  @override
  Widget build(BuildContext context) {
      final settingsService = settingsServiceRef.of(context);
      return Text(settingsService.getThemeMode());
  }
  }
  

• Override it for a subtree:

  You can override the instance for a subtree by using overrideWith. This is useful for testing. In the example below, all calls to settingsServiceRef.of(context) will return MockSettingsService.

  LiteRefScope(
      overrides: [
          settingsServiceRef.overrideWith((ctx) => MockSettingsService()),
      ]
      child: MyApp(),
      ),