docs(replay_bloc): update example to follow naming conventions (#3031)

felangel · web-flow · commit 928488692ee9 · 2021-12-02T22:21:38.000-06:00
diff --git a/packages/replay_bloc/README.md b/packages/replay_bloc/README.md
@@ -96,14 +96,14 @@ class CounterCubit extends HydratedCubit<int> with ReplayCubitMixin {
 ```dart
 class CounterEvent extends ReplayEvent {}
 
-class Increment extends CounterEvent {}
+class CounterIncrementPressed extends CounterEvent {}
 
-class Decrement extends CounterEvent {}
+class CounterDecrementPressed extends CounterEvent {}
 
 class CounterBloc extends ReplayBloc<CounterEvent, int> {
   CounterBloc() : super(0) {
-    on<Increment>((event, emit) => emit(state + 1));
-    on<Decrement>((event, emit) => emit(state - 1));
+    on<CounterIncrementPressed>((event, emit) => emit(state + 1));
+    on<CounterDecrementPressed>((event, emit) => emit(state - 1));
   }
 }
 ```
@@ -113,7 +113,7 @@ class CounterBloc extends ReplayBloc<CounterEvent, int> {
 ```dart
 void main() {
   // trigger a state change
-  final bloc = CounterBloc()..add(Increment());
+  final bloc = CounterBloc()..add(CounterIncrementPressed());
 
   // wait for state to update
   await bloc.stream.first;
@@ -136,14 +136,14 @@ If you wish to be able to use a `ReplayBloc` in conjuction with a different type
 ```dart
 abstract class CounterEvent with ReplayEvent {}
 
-class Increment extends CounterEvent {}
+class CounterIncrementPressed extends CounterEvent {}
 
-class Decrement extends CounterEvent {}
+class CounterDecrementPressed extends CounterEvent {}
 
 class CounterBloc extends HydratedBloc<CounterEvent, int> with ReplayBlocMixin {
   CounterBloc() : super(0) {
-    on<Increment>((event, emit) => emit(state + 1));
-    on<Decrement>((event, emit) => emit(state - 1));
+    on<CounterIncrementPressed>((event, emit) => emit(state + 1));
+    on<CounterDecrementPressed>((event, emit) => emit(state - 1));
   }
 
   @override
diff --git a/packages/replay_bloc/example/lib/main.dart b/packages/replay_bloc/example/lib/main.dart
@@ -92,17 +92,23 @@ class CounterPage extends StatelessWidget {
         children: <Widget>[
           FloatingActionButton(
             child: const Icon(Icons.add),
-            onPressed: () => context.read<CounterBloc>().add(Increment()),
+            onPressed: () {
+              context.read<CounterBloc>().add(CounterIncrementPressed());
+            },
           ),
           const SizedBox(height: 4),
           FloatingActionButton(
             child: const Icon(Icons.remove),
-            onPressed: () => context.read<CounterBloc>().add(Decrement()),
+            onPressed: () {
+              context.read<CounterBloc>().add(CounterDecrementPressed());
+            },
           ),
           const SizedBox(height: 4),
           FloatingActionButton(
             child: const Icon(Icons.delete_forever),
-            onPressed: () => context.read<CounterBloc>().add(Reset()),
+            onPressed: () {
+              context.read<CounterBloc>().add(CounterResetPressed());
+            },
           ),
         ],
       ),
@@ -133,32 +139,35 @@ class CounterCubit extends ReplayCubit<int> {
 class CounterEvent extends ReplayEvent {}
 
 /// Notifies [CounterBloc] to increment its state.
-class Increment extends CounterEvent {
+class CounterIncrementPressed extends CounterEvent {
   @override
-  String toString() => 'Increment';
+  String toString() => 'CounterIncrementPressed';
 }
 
 /// Notifies [CounterBloc] to decrement its state.
-class Decrement extends CounterEvent {
+class CounterDecrementPressed extends CounterEvent {
   @override
-  String toString() => 'Decrement';
+  String toString() => 'CounterDecrementPressed';
 }
 
 /// Notifies [CounterBloc] to reset its state.
-class Reset extends CounterEvent {
+class CounterResetPressed extends CounterEvent {
   @override
-  String toString() => 'Reset';
+  String toString() => 'CounterResetPressed';
 }
 
 /// {@template replay_counter_bloc}
 /// A simple [ReplayBloc] which manages an `int` as its state
-/// and reacts to three events: [Increment], [Decrement], and [Reset].
+/// and reacts to three events:
+/// * [CounterIncrementPressed]
+/// * [CounterDecrementPressed]
+/// * [CounterResetPressed]
 /// {@endtemplate}
 class CounterBloc extends ReplayBloc<CounterEvent, int> {
   /// {@macro replay_counter_bloc}
   CounterBloc() : super(0) {
-    on<Increment>((event, emit) => emit(state + 1));
-    on<Decrement>((event, emit) => emit(state - 1));
-    on<Reset>((event, emit) => emit(0));
+    on<CounterIncrementPressed>((event, emit) => emit(state + 1));
+    on<CounterDecrementPressed>((event, emit) => emit(state - 1));
+    on<CounterResetPressed>((event, emit) => emit(0));
   }
 }
diff --git a/packages/replay_bloc/lib/src/replay_bloc.dart b/packages/replay_bloc/lib/src/replay_bloc.dart
@@ -30,11 +30,11 @@ class _Undo extends ReplayEvent {
 ///
 /// ```dart
 /// abstract class CounterEvent {}
-/// class Increment extends CounterEvent {}
+/// class CounterIncrementPressed extends CounterEvent {}
 ///
 /// class CounterBloc extends ReplayBloc<CounterEvent, int> {
 ///   CounterBloc() : super(0) {
-///     on<Increment>((event, emit) => emit(state + 1));
+///     on<CounterIncrementPressed>((event, emit) => emit(state + 1));
 ///   }
 /// }
 /// ```
@@ -44,7 +44,7 @@ class _Undo extends ReplayEvent {
 /// ```dart
 /// final bloc = CounterBloc();
 ///
-/// bloc.add(Increment());
+/// bloc.add(CounterIncrementPressed());
 ///
 /// bloc.undo();
 ///
