feat(ui_firestore)!: Expose index to FirestoreItemBuilder

[jt274]

Description

This PR exposes the itemBuilder index in FirestoreListView and FirestoreListView.separated to be consistent with flutter's ListView.builder and ListView.separated. There are situations where an index is required, such as when numbering the list of items in the list view.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
• All existing and new tests are passing.
• I updated/added relevant documentation (doc comments with ///).
• The analyzer (melos run analyze) does not report any problems on my PR.
• All unit tests pass (melos run test:unit:all doesn't fail).
• I read and followed the Flutter Style Guide.
• I signed the CLA.
• I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

• Yes, this is a breaking change.
• No, this is not a breaking change.

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[jt274]

@russellwheatley
Fix still valid.

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[jt274]

@russellwheatley can this be merged?

[russellwheatley]

@jt274 - it seems fair enough to me. I've merged with latest main branch and reran the workflow

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[jt274]

@russellwheatley I'm not sure if this is completed yet, as it didn't appear to make it into the last pub release after you merged.

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[jt274]

@russellwheatley apparently was merged, but does not seem to be released yet.

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[jt274]

@russellwheatley Still not released?

[russellwheatley]

Hey @jt274 - you need to either update this PR or create a new one. It wasn't merged with main, I just ran the CI. You need to completely remove anything not related to the exposing the index to FirestoreItemBuilder

[Hassico]

@jt274@russellwheatley, can this task be done already, please!

[jt274]

@russellwheatley branch should be fixed!

[russellwheatley]

@jt274 - thank! need to update docs here:
https://github.com/firebase/FirebaseUI-Flutter/blob/main/docs/firebase-ui-firestore.md?plain=1#L43

and here:
https://github.com/firebase/FirebaseUI-Flutter/blob/main/docs/firebase-ui-firestore.md?plain=1#L112

just add the index arg to callback and I can approve 👍

[jt274]

@russellwheatley Docs have been updated.

[russellwheatley]

@jt274 - hmmm, thinking further on this, I believe this PR ought to be marked as a breaking change consider the user facing API has now changed.

[jt274]

@russellwheatley Yes, I already did mark this as a breaking change when I created the PR.

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[github-actions]

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

[jt274]

@russellwheatley This should remain open if not yet merged.

[jt274]

@russellwheatley Please approve the workflows and merge. This has been open well over a year and it's a simple pull request. Let's wrap it up :)