Skip to content
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

Merged
merged 18 commits into from
Sep 1, 2023
Merged

Conversation

lesnitsky
Copy link
Member

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.

Copy link

@exaby73 exaby73 left a 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`:
Copy link

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?

Copy link
Member Author

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
Copy link

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?

Copy link
Member Author

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].
Copy link
Member

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.

Suggested change
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).

Copy link
Member Author

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].
Copy link
Member

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.

Copy link
Member Author

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
Copy link
Member

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2023-09-01 at 14 49 40

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

packages/firebase_ui_storage/doc/getting-started.md Outdated Show resolved Hide resolved
packages/firebase_ui_storage/doc/getting-started.md Outdated Show resolved Hide resolved
packages/firebase_ui_storage/doc/storage-image.md Outdated Show resolved Hide resolved
packages/firebase_ui_storage/doc/upload-button.md Outdated Show resolved Hide resolved
packages/firebase_ui_storage/doc/upload-button.md Outdated Show resolved Hide resolved
@lesnitsky lesnitsky merged commit 4c4e353 into main Sep 1, 2023
10 checks passed
@lesnitsky lesnitsky deleted the docs/ui-storage branch September 1, 2023 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants