-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(ui_storage): add StorageListView and PaginatedLoadingController #11170
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
packages/firebase_ui_storage/example/lib/src/list_view_app.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
// Copyright 2023, the Chromium project authors. Please see the AUTHORS file | ||
// for details. All rights reserved. Use of this source code is governed by a | ||
// BSD-style license that can be found in the LICENSE file. | ||
|
||
import 'package:firebase_storage/firebase_storage.dart'; | ||
import 'package:firebase_ui_storage/firebase_ui_storage.dart'; | ||
import 'package:flutter/material.dart'; | ||
|
||
import 'apps.dart'; | ||
|
||
class StorageListViewApp extends StatelessWidget implements App { | ||
const StorageListViewApp({super.key}); | ||
|
||
@override | ||
String get name => 'StorageListView'; | ||
|
||
@override | ||
Widget build(BuildContext context) { | ||
return StorageListView( | ||
ref: FirebaseStorage.instance.ref('list'), | ||
itemBuilder: (context, ref) { | ||
return ListTile( | ||
title: FutureBuilder( | ||
future: ref.getData(), | ||
builder: (context, snapshot) { | ||
if (snapshot.hasError) { | ||
return Text(snapshot.error.toString()); | ||
} | ||
if (snapshot.hasData) { | ||
return Text(snapshot.data.toString()); | ||
} | ||
|
||
return const Text('Loading...'); | ||
}, | ||
), | ||
); | ||
}, | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
packages/firebase_ui_storage/lib/src/paginated_loading_controller.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
// Copyright 2023, the Chromium project authors. Please see the AUTHORS file | ||
// for details. All rights reserved. Use of this source code is governed by a | ||
// BSD-style license that can be found in the LICENSE file. | ||
|
||
import 'package:firebase_storage/firebase_storage.dart'; | ||
import 'package:flutter/foundation.dart'; | ||
|
||
/// A base class for loading states. | ||
sealed class PaginatedLoadingState { | ||
const PaginatedLoadingState(); | ||
} | ||
|
||
/// Indicates that the first page is loading. | ||
class InitialPageLoading extends PaginatedLoadingState { | ||
const InitialPageLoading(); | ||
} | ||
|
||
class PageLoading extends PaginatedLoadingState { | ||
final List<Reference> items; | ||
|
||
const PageLoading({required this.items}); | ||
} | ||
|
||
class PageLoadComplete extends PaginatedLoadingState { | ||
final List<Reference> pageItems; | ||
final List<Reference> items; | ||
|
||
const PageLoadComplete({ | ||
required this.pageItems, | ||
required this.items, | ||
}); | ||
} | ||
|
||
class PageLoadError extends PaginatedLoadingState { | ||
final Object? error; | ||
final List<Reference>? items; | ||
|
||
const PageLoadError({ | ||
required this.error, | ||
this.items, | ||
}); | ||
} | ||
|
||
class PaginatedLoadingController extends ChangeNotifier { | ||
int pageSize; | ||
final Reference ref; | ||
|
||
PaginatedLoadingController({ | ||
required this.ref, | ||
this.pageSize = 50, | ||
}) { | ||
load(); | ||
} | ||
|
||
PaginatedLoadingState? _state; | ||
PaginatedLoadingState get state => _state!; | ||
|
||
ListResult? _cursor; | ||
List<Reference>? _items; | ||
|
||
ListOptions get _listOptions { | ||
return ListOptions( | ||
maxResults: pageSize, | ||
pageToken: _cursor?.nextPageToken, | ||
); | ||
} | ||
|
||
Future<void> load() { | ||
_state = _state == null | ||
? const InitialPageLoading() | ||
: PageLoading(items: _items!); | ||
|
||
notifyListeners(); | ||
|
||
return ref.list(_listOptions).then((value) { | ||
_cursor = value; | ||
(_items ??= []).addAll(value.items); | ||
|
||
_state = PageLoadComplete( | ||
pageItems: value.items, | ||
items: _items!, | ||
); | ||
|
||
notifyListeners(); | ||
}).catchError((e) { | ||
_state = PageLoadError( | ||
error: e, | ||
items: _items, | ||
); | ||
|
||
notifyListeners(); | ||
}); | ||
} | ||
|
||
bool shouldLoadNextPage(int itemIndex) { | ||
return switch (state) { | ||
InitialPageLoading() => false, | ||
PageLoading() => false, | ||
PageLoadComplete(items: final items) => | ||
itemIndex == (items.length - pageSize + 1), | ||
PageLoadError() => false, | ||
}; | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the new features 😎