Skip to content

feat(ui_firestore)!: Expose index to FirestoreItemBuilder #497

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.

Sign up for GitHub

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

Open
jt274 wants to merge 12 commits into
base: main
Choose a base branch
from
Open

feat(ui_firestore)!: Expose index to FirestoreItemBuilder #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
942002b
Expose index to FirestoreItemBuilder
jt274 Apr 30, 2025
55fa64c
Fix tests, doc, example
jt274 Apr 30, 2025
bac0f03
Merge branch 'main' into main
russellwheatley Jun 30, 2025
767edde
Bump cloud_firestore and firebase_core versions
jt274 Jul 28, 2025
6eab3a9
Merge remote-tracking branch 'upstream/main'
jt274 Jul 28, 2025
6d64c0a
Dependency updates, remove deprecated code
jt274 Jul 28, 2025
0a4cca3
Merge remote-tracking branch 'upstream/main'
jt274 Nov 18, 2025
b3d0e98
Fix conflicts
jt274 Nov 18, 2025
34a0407
Update docs
jt274 Nov 28, 2025
d7630f6
Merge branch 'main' into main
russellwheatley Jan 6, 2026
96fbef2
Merge branch 'main' into main
jt274 Jul 7, 2026
89c5151
Update query_builder.dart
jt274 Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/firebase-ui-firestore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ final usersQuery = FirebaseFirestore.instance.collection('users').orderBy('name'

FirestoreListView<Map<String, dynamic>>(
query: usersQuery,
itemBuilder: (context, snapshot) {
itemBuilder: (context, snapshot, index) {
Map<String, dynamic> user = snapshot.data();

return Text('User name is ${user['name']}');
Expand Down Expand Up @@ -109,7 +109,7 @@ final usersQuery = FirebaseFirestore.instance.collection('users')

FirestoreListView<User>(
query: usersQuery,
itemBuilder: (context, snapshot) {
itemBuilder: (context, snapshot, index) {
// Data is now typed!
User user = snapshot.data();

Expand Down
2 changes: 1 addition & 1 deletion packages/firebase_ui_firestore/example/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class FirebaseUIFirestoreExample extends StatelessWidget {
body: FirestoreListView<User>(
query: collection,
padding: const EdgeInsets.all(8.0),
itemBuilder: (context, snapshot) {
itemBuilder: (context, snapshot, index) {
final user = snapshot.data();
return Column(
children: [
Expand Down
17 changes: 10 additions & 7 deletions packages/firebase_ui_firestore/lib/src/query_builder.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,11 @@ class _Sentinel {
}

/// A type representing the function passed to [FirestoreListView] for its `itemBuilder`.
typedef FirestoreItemBuilder<Document> =
Widget Function(BuildContext context, QueryDocumentSnapshot<Document> doc);
typedef FirestoreItemBuilder<Document> = Widget Function(
BuildContext context,
QueryDocumentSnapshot<Document> doc,
int index,
);

/// A type representing the function passed to [FirestoreListView] for its `loadingBuilder`.
typedef FirestoreLoadingBuilder = Widget Function(BuildContext context);
Expand Down Expand Up @@ -414,7 +417,7 @@ typedef FirestoreEmptyBuilder = Widget Function(BuildContext context);
/// ```dart
/// FirestoreListView<Movie>(
/// query: moviesCollection.orderBy('title'),
/// itemBuilder: (context, snapshot) {
/// itemBuilder: (context, snapshot, index) {
/// Movie movie = snapshot.data();
/// return Text(movie.title);
/// },
Expand Down Expand Up @@ -499,7 +502,7 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
itemBuilder(context, doc),
itemBuilder(context, doc, index),
if (isLastItem && snapshot.hasMore)
fetchingIndicatorBuilder?.call(context) ??
const Padding(
Expand All @@ -516,7 +519,7 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
],
),
)
: itemBuilder(context, doc);
: itemBuilder(context, doc, index);
},
scrollDirection: scrollDirection,
reverse: reverse,
Expand Down Expand Up @@ -611,7 +614,7 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
itemBuilder(context, doc),
itemBuilder(context, doc, index),
if (isLastItem && snapshot.hasMore)
fetchingIndicatorBuilder?.call(context) ??
const Padding(
Expand All @@ -628,7 +631,7 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
],
),
)
: itemBuilder(context, doc);
: itemBuilder(context, doc, index);
},
separatorBuilder: separatorBuilder,
scrollDirection: scrollDirection,
Expand Down
77 changes: 43 additions & 34 deletions tests/integration_test/firebase_ui_firestore/firestore_list_view_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ void main() {
body: FirestoreListView<Map>(
query: collection.orderBy('value'),
loadingBuilder: (context) => const Text('loading...'),
itemBuilder: (context, snapshot) => throw UnimplementedError(),
itemBuilder: (context, snapshot, index) =>
throw UnimplementedError(),
),
),
),
Expand All @@ -77,12 +78,14 @@ void main() {
) async {
final collection = db.collection('flutter-tests/list-view-builder/works');

await tester.pumpWidget(
MaterialApp(
home: Scaffold(
body: FirestoreListView<Map>(
query: collection.orderBy('value'),
itemBuilder: (context, snapshot) => throw UnimplementedError(),
await tester.pumpWidget(
MaterialApp(
home: Scaffold(
body: FirestoreListView<Map>(
query: collection.orderBy('value'),
itemBuilder: (context, snapshot, index) =>
throw UnimplementedError(),
),
),
),
),
Expand All @@ -102,7 +105,8 @@ void main() {
body: FirestoreListView<Map>(
query: collection,
cacheExtent: 0,
itemBuilder: (context, snapshot) => throw UnimplementedError(),
itemBuilder: (context, snapshot, index) =>
throw UnimplementedError(),
),
),
),
Expand Down Expand Up @@ -130,31 +134,32 @@ void main() {
await tester.pumpWidget(
MaterialApp(
home: Material(
child: Builder(
builder: (context) {
final mq = MediaQuery.of(context);
final h = mq.size.height;
size = h / 5;

return FirestoreListView<Map>(
physics: const ClampingScrollPhysics(),
query: ref.orderBy('value'),
cacheExtent: 0,
pageSize: 5,
itemExtent: size,
itemBuilder: (context, snapshot) {
final v = snapshot.data()['value'] as int;

return Container(
alignment: Alignment.center,
color: Colors.black.withAlpha(v % 2 == 0 ? 50 : 100),
key: ValueKey(v.toString()),
child: Text(v.toString(), textAlign: TextAlign.center),
);
},
);
},
),
child: Builder(builder: (context) {
final mq = MediaQuery.of(context);
final h = mq.size.height;
size = h / 5;

return FirestoreListView<Map>(
physics: const ClampingScrollPhysics(),
query: ref.orderBy('value'),
cacheExtent: 0,
pageSize: 5,
itemExtent: size,
itemBuilder: (context, snapshot, index) {
final v = snapshot.data()['value'] as int;

return Container(
alignment: Alignment.center,
color: Colors.black.withAlpha(v % 2 == 0 ? 50 : 100),
key: ValueKey(v.toString()),
child: Text(
v.toString(),
textAlign: TextAlign.center,
),
);
},
);
}),
),
),
);
Expand Down Expand Up @@ -201,7 +206,11 @@ void main() {
}

class ListViewBuilderSpy<T> extends Mock {
Widget call(BuildContext? context, T? snapshot) {
Widget call(
BuildContext? context,
T? snapshot,
int? index,
) {
return super.noSuchMethod(
Invocation.method(#call, [context, snapshot]),
returnValueForMissingStub: Container(),
Expand Down
Loading