Skip to content

Commit 2709a7b

Browse files
committed
update docs
1 parent 1299b58 commit 2709a7b

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

packages/stream_feed_flutter_core/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,16 +108,18 @@ The package primarily contains three types of classes:
108108
These components allow you to have the maximum and lower-level control of the queries being executed.
109109
The BLoCs we provide are:
110110

111-
1) FeedBloc
111+
1) FeedBloc: manage activity and reaction streams
112+
2) UplaodController: manage upload streams (Progress,Fail,Success)
112113

113114
### Core Components
114115

115116
Core components usually are an easy way to fetch data associated with Stream Feed which are decoupled from UI and often expose UI builders.
116117
Data fetching can be controlled with the controllers of the respective core components.
117118

118-
1) FlatFeedCore (Fetch a list of activities)
119-
2) ReactionListCore (Fetch a list of reactions)
120-
3) FeedProvider (Inherited widget providing bloc to the widget tree)
119+
1) FlatFeedCore : given an Activity Widget builder render a reactive list of activities
120+
2) ReactionListCore: given an Reaction Widget builder render a reactive list of reactions
121+
3) UploadListCore: expose a reactive list of uploads via a callback
122+
4) FeedProvider: an Inherited widget providing access to FeedBloc in the widget tree
121123

122124
## Contributing
123125

packages/stream_feed_flutter_core/lib/src/upload_core.dart renamed to packages/stream_feed_flutter_core/lib/src/upload_list_core.dart

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import 'package:stream_feed_flutter_core/src/upload/upload_controller.dart';
55

66
import 'package:stream_feed_flutter_core/stream_feed_flutter_core.dart';
77

8+
/// {@template uploadListCore}
89
/// A widget to easily display and manage uploads and their current state.
910
///
1011
/// Usage:
@@ -96,8 +97,9 @@ import 'package:stream_feed_flutter_core/stream_feed_flutter_core.dart';
9697
/// }
9798
/// }
9899
/// ```
100+
/// {@endtemplate}
99101
class UploadListCore extends StatelessWidget {
100-
/// Widget to easily display and manage a list of uploads and their state.
102+
/// {@macro uploadListCore}
101103
const UploadListCore({
102104
Key? key,
103105
required this.uploadController,

packages/stream_feed_flutter_core/lib/stream_feed_flutter_core.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ export 'src/reactions_list_core.dart';
99
export 'src/states/states.dart';
1010
export 'src/typedefs.dart';
1111
export 'src/upload/upload.dart';
12-
export 'src/upload_core.dart';
12+
export 'src/upload_list_core.dart';

packages/stream_feed_flutter_core/test/upload_core_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import 'package:stream_feed/stream_feed.dart' show AttachmentFile;
77
import 'package:stream_feed_flutter_core/src/media.dart';
88
import 'package:stream_feed_flutter_core/src/upload/states.dart';
99
import 'package:stream_feed_flutter_core/src/upload/widgets.dart';
10-
import 'package:stream_feed_flutter_core/src/upload_core.dart';
10+
import 'package:stream_feed_flutter_core/src/upload_list_core.dart';
1111

1212
import 'mocks.dart';
1313
import 'utils.dart';

0 commit comments

Comments
 (0)