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
wants to merge 2 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
2 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
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
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
13 changes: 7 additions & 6 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 @@ -4,10 +4,10 @@

import 'dart:async';

import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:firebase_ui_shared/firebase_ui_shared.dart';
import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:cloud_firestore/cloud_firestore.dart';

/// A function that builds a widget from a [FirestoreQueryBuilderSnapshot]
///
Expand Down Expand Up @@ -354,6 +354,7 @@ class _Sentinel {
typedef FirestoreItemBuilder<Document> = Widget Function(
BuildContext context,
QueryDocumentSnapshot<Document> doc,
int index,
);

/// A type representing the function passed to [FirestoreListView] for its `loadingBuilder`.
Expand Down Expand Up @@ -412,7 +413,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 @@ -496,7 +497,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 @@ -513,7 +514,7 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
],
),
)
: itemBuilder(context, doc);
: itemBuilder(context, doc, index);
},
scrollDirection: scrollDirection,
reverse: reverse,
Expand Down Expand Up @@ -606,7 +607,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 @@ -623,7 +624,7 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
],
),
)
: itemBuilder(context, doc);
: itemBuilder(context, doc, index);
},
separatorBuilder: separatorBuilder,
scrollDirection: scrollDirection,
Expand Down
15 changes: 10 additions & 5 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 @@ -3,10 +3,11 @@
// BSD-style license that can be found in the LICENSE file.

import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:firebase_ui_firestore/firebase_ui_firestore.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:firebase_ui_firestore/firebase_ui_firestore.dart';
import 'package:mockito/mockito.dart';

import '../utils.dart';

void main() {
Expand Down Expand Up @@ -61,7 +62,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 @@ -84,7 +86,8 @@ void main() {
home: Scaffold(
body: FirestoreListView<Map>(
query: collection.orderBy('value'),
itemBuilder: (context, snapshot) => throw UnimplementedError(),
itemBuilder: (context, snapshot, index) =>
throw UnimplementedError(),
),
),
),
Expand All @@ -105,7 +108,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 @@ -144,7 +148,7 @@ void main() {
cacheExtent: 0,
pageSize: 5,
itemExtent: size,
itemBuilder: (context, snapshot) {
itemBuilder: (context, snapshot, index) {
final v = snapshot.data()['value'] as int;

return Container(
Expand Down Expand Up @@ -208,6 +212,7 @@ class ListViewBuilderSpy<T> extends Mock {
Widget call(
BuildContext? context,
T? snapshot,
int? index,
) {
return super.noSuchMethod(
Invocation.method(#call, [context, snapshot]),
Expand Down