inherited_rxdart 1.3.0+1

Inherited RxDart is a state management library that combine the power of InheritedWidget and RxDart, a simple and elegant state management solution for apps of any scale

A simple state management solution that combine the power of inherited widget and rxdart

Features

Create state management logic for your app using multitude of blocs, which internal is just stream and rxdart, you can access them anywhere in your widget tree when provided using providers.

Getting started

Started by providing blocs and service for your widget's subtree like this:

First import it:

import 'package:inherited_rxdart/inherited_rxdart.dart';

Create your bloc and state:

@immutable
class MyState {
  final int number;
  final String text;

  const MyState({required this.number, required this.text});

  MyState copyWith({int? number, String? text}) {
    return MyState(number: number ?? this.number, text: text ?? this.text);
  }
}

class CounterBloc extends RxBloc<MyState, String> {
  CounterBloc(MyState initialState) : super(initialState);

  void showDialog() {
    notify("showDialog");
  }

  void changeText(String newText) {
    state = state.copyWith(text: newText);
  }

  void increase() {
    state = state.copyWith(number: state.number + 1);
  }

  void decrease() {
    state = state.copyWith(number: state.number - 1);
  }
}

And start using it in your app:

class App extends StatelessWidget {
  const App({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
        home: RxProvider<CounterBloc>(
          create: () => CounterBloc(const MyState(text: "hi", number: 0)),
          child: MyHomePage(),
        )
    );
  }
}

Access them anywhere in your subtree with:

final bloc = RxProvider.of<CounterBloc>(context);

Usage

View documents of each API for more details. The library support multiple type of blocs and related widgets.

Bloc's Widgets

For blocs, there will be specific widget for each purpose include: rebuilding, listening,...

• RxBuilder: For building widgets based on states.
• RxListener: For listening to state changes and notifications.
• RxStateListener: For listening to state changes only.
• RxConsumer: Combination of RxListener and RxBuilder.
• RxStateConsumer: Combination of RxStateListener and RxBuilder.
• RxSelector: For selectively rebuilding widgets based on specific property of state.

RxCubit:

A simple bloc, which will emit states throughout its life-cycle and rebuild widgets when necessary. Work with:

• RxBuilder
• RxSelector
• RxStateConsumer
• RxStateListener

RxBloc:

Bloc with notification beside states, which can be listened and react accordingly. Work with:

• RxBuilder
• RxListener
• RxStateListener
• RxConsumer
• RxStateConsumer
• RxSelector

RxViewModel

For simple view model based state-management, shipped with related widget:

• RxViewModelBuilder: for handle rebuilding widget when a new state is emitted.
• RxViewModelSelector: for selectively rebuilding when state changed.
• RxViewModelListener: for a listener callback when state changed.
• RxViewModelConsumer: combination of builder and listener.

RxValue

A value for reactive state management, will cause its dependent to rebuild when its value is set.

• RxValueBuilder: build to work with RxValue.

ServiceProvider

There's also simple service provider for controller/repo or simply to inject an instance through a widget subtree.

• ServiceProvider

Additional information

To provide multiple blocs or model instance, the use of these widget is encouraged:

• RxMultiProvider
• MultiServiceProvider

To quickly access blocs/services, rather than use these function:

RxProvider.of<MyBloc>(context);
ServiceProvider.of<MyService>(context);

One can use:

context.watch<MyBloc>(); // for getting an instance of a bloc.
context.read<MyBloc>(); // for getting an instance of a bloc and subscribe to it's changes.
context.get<MyService>(); //for getting an instance of a service. 

And

final text = RxValue<String>("hello");

Is equivalent to:

final text = "hello".rx;