-
Notifications
You must be signed in to change notification settings - Fork 101
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
docs(ui_storage): add Firebase UI Storage docs #92
Conversation
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.
Couple of nits, else LGTM
[`KeepPathUploadPolicy`]: https://pub.dev/documentation/firebase_ui_storage/latest/firebase_ui_storage/KeepPathUploadPolicy-class.html | ||
[`UuidFileUploadNamingPolicy`]: https://pub.dev/documentation/firebase_ui_storage/latest/firebase_ui_storage/UuidFileUploadNamingPolicy-class.html | ||
|
||
If you ever need to override this top-level configuration, you can do so by using `FirebaseUIStorageConfigOverride`: |
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.
Could we possibly mention the default here?
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.
|
||
In cases where you want to build a completely custom scroll view, but still have pagination logic handled – you can use [`PaginatedLoadingController`]. | ||
|
||
```dart |
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.
Could we add examples of using .load()
and .shouldLoatNextPage()
as well?
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.
|
||
## Configuration | ||
Please file Firebase UI Storage specific issues, bugs, or feature requests in our [issue tracker]. |
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.
Not sure is this is supposed to have the link.
Please file Firebase UI Storage specific issues, bugs, or feature requests in our [issue tracker]. | |
Please file Firebase UI Storage specific issues, bugs, or feature requests in our [issue tracker](https://github.com/firebase/FirebaseUI-Flutter/issues). |
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.
|
||
### macOS | ||
If you wish to contribute a change to any of the existing plugins in this repo, please review our [contribution guide] and open a [pull request]. |
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.
Also whether those are supposed to have links in this sentence.
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.
flutter pub add firebase_core firebase_storage firebase_ui_storage | ||
``` | ||
|
||
Download Firebase project config |
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.
Think this needs a little more fleshing out. For inspiration: https://firebase.google.com/docs/flutter/setup?platform=ios#configure-firebase
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.
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.
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
Co-authored-by: Russell Wheatley <[email protected]>
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.///
).melos run analyze
) does not report any problems on my PR.melos run test:unit:all
doesn't fail).Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?