From 7c231c536f561232a3bcc74b91640b64a8966bed Mon Sep 17 00:00:00 2001 From: Andrei Lesnitsky Date: Fri, 1 Sep 2023 16:16:44 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Russell Wheatley --- packages/firebase_ui_storage/doc/grid-view.md | 6 +++--- packages/firebase_ui_storage/doc/list-view.md | 6 +++--- .../firebase_ui_storage/doc/paginated-loading-controller.md | 4 ++-- packages/firebase_ui_storage/doc/storage-image.md | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/firebase_ui_storage/doc/grid-view.md b/packages/firebase_ui_storage/doc/grid-view.md index 63e79c3e..1ee64e5d 100644 --- a/packages/firebase_ui_storage/doc/grid-view.md +++ b/packages/firebase_ui_storage/doc/grid-view.md @@ -2,7 +2,7 @@ When loading large amounts of objects from Firebase Storage, it makes sense to load them in batches, but requires handling of the pagination logic. -`StorageGridView` implements pagination logic for you, and allows to load objects from the Firebase Storage in batches while scrolling. +`StorageGridView` implements pagination logic for you, and allows to load objects from Firebase Storage in batches while scrolling. ## Usage @@ -39,7 +39,7 @@ StorageGridView( ### Custom inital page loading state -When the first page of objects is loading, `StorageGridView` will show a `CircularProgressIndicator` under `MaterialApp` and `CupertinoActivityIndicator` under `CupertinoApp`. +When the first page of objects is loading, `StorageGridView` will show a `CircularProgressIndicator` under `MaterialApp`, and `CupertinoActivityIndicator` under `CupertinoApp`. You can pass `loadingBuilder` to customize the loading state: @@ -79,7 +79,7 @@ StorageGridView( ### Custom scroll views with pagination logic -If you need something more customizable, but stil have pagination logic handled for you, you can use +If you need something more customizable, but still want pagination logic handled for you, you can use [`PaginatedLoadingController`](https://github.com/firebase/FirebaseUI-Flutter/tree/main/packages/firebase_ui_storage/doc/paginated-loading-controller.md) --- diff --git a/packages/firebase_ui_storage/doc/list-view.md b/packages/firebase_ui_storage/doc/list-view.md index 6fac110b..1e46c770 100644 --- a/packages/firebase_ui_storage/doc/list-view.md +++ b/packages/firebase_ui_storage/doc/list-view.md @@ -2,7 +2,7 @@ When loading large amounts of objects from the Firebase Storage, it makes sense to load them in batches, but requires handling of the pagination logic. -`StorageListView` implements pagination logic for you, and allows to load objects from the Firebase Storage in batches while scrolling. +`StorageListView` implements pagination logic for you, and allows to load objects from Firebase Storage in batches while scrolling. ## Usage @@ -20,7 +20,7 @@ StorageListView( ### Custom inital page loading state -When the first page of objects is loading, `StorageListView` will show a `CircularProgressIndicator` under `MaterialApp` and `CupertinoActivityIndicator` under `CupertinoApp`. +When the first page of objects is loading, `StorageListView` will show a `CircularProgressIndicator` under `MaterialApp`, and `CupertinoActivityIndicator` under `CupertinoApp`. You can pass `loadingBuilder` to customize the loading state: @@ -60,7 +60,7 @@ StorageListView( ### Custom scroll views with pagination logic -If you need something more customizable, but stil have pagination logic handled for you, you can use +If you need something more customizable, but still want pagination logic handled for you, you can use [`PaginatedLoadingController`](https://github.com/firebase/FirebaseUI-Flutter/tree/main/packages/firebase_ui_storage/doc/paginated-loading-controller.md) --- diff --git a/packages/firebase_ui_storage/doc/paginated-loading-controller.md b/packages/firebase_ui_storage/doc/paginated-loading-controller.md index b6d8e977..139d8aea 100644 --- a/packages/firebase_ui_storage/doc/paginated-loading-controller.md +++ b/packages/firebase_ui_storage/doc/paginated-loading-controller.md @@ -1,8 +1,8 @@ # PaginatedLoadingController -When loading large amounts of objects from the Firebase Storage, it makes sense to load them in batches, but requires handling of the pagination logic. +When loading large amounts of objects from Firebase Storage, it makes sense to load them in batches, but requires handling of the pagination logic. -Firebase UI Storage provides [`StorageListView`] and [`StorageGridView`] widgets that implement pagination logic for you, and allow to load objects from the Firebase Storage in batches while scrolling. +Firebase UI Storage provides [`StorageListView`] and [`StorageGridView`] widgets that implement pagination logic for you, and allows objects to be loaded from Firebase Storage in batches while scrolling. In cases where you want to build a completely custom scroll view, but still have pagination logic handled – you can use `PaginatedLoadingController`. diff --git a/packages/firebase_ui_storage/doc/storage-image.md b/packages/firebase_ui_storage/doc/storage-image.md index 65ff17c2..77e54084 100644 --- a/packages/firebase_ui_storage/doc/storage-image.md +++ b/packages/firebase_ui_storage/doc/storage-image.md @@ -1,6 +1,6 @@ # StorageImage -A widget that loads and displays an image from the Firebase Storage. +A widget that loads and displays an image from Firebase Storage. ## Usage @@ -38,7 +38,7 @@ StorageImage( ### Loading indicator -Loading indicator placeholder will show a `CircularProgressIndicator` under `MaterialApp` and `CupertinoActivityIndicator` under `CupertinoApp`. +Loading indicator placeholder will show a `CircularProgressIndicator` under `MaterialApp`, and `CupertinoActivityIndicator` under `CupertinoApp`. You can customize `size`, `color` and `strokeWidth` of the loading indicator: