mirror of
https://github.com/flutter/samples.git
synced 2025-11-08 13:58:47 +00:00
821422fa25
This adds a sample Flutter project that demonstrates a soon-to-be-released feature, asset transformation[^1]. [PR for flutter.dev documentation](https://github.com/flutter/website/pull/10471). This feature isn't the easiest to explain using documentation, so I think augmenting that documentation with a sample is appropriate. This sample demonstrates 1) how to use an existing Dart package (that is compatible with the feature) as an asset transformer and 2) how to write a Dart package that is compatible with this feature. This should be clear from the README.md. **Advice for reviewing this PR.** The goal here is that most users that read the documentation and follow the link from there to this sample should be able to figure out what the feature does and how to use it. Try to imagine yourself in this position and follow this story. If the feature is still unclear, then there is probably something we can do to improve this sample or the docs. Said more simply, follow these steps: 1) Start at the new section to be added to Flutter.dev (https://flutter-docs-prod--pr10471-document-asset-transformers-cc21qf01.web.app/ui/assets/assets-and-images#automatic-transformation-of-asset-files-at-build-time). It should naturally link you to the sample project. Start with the README and see if things make sense. ## Pre-launch Checklist - [X] I read the [Flutter Style Guide] _recently_, and have followed its advice. - [X] I signed the [CLA]. - [X] I read the [Contributors Guide]. - [X] I updated/added relevant documentation (doc comments with `///`). - [X] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-devrel channel on [Discord]. <!-- Links --> [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo [CLA]: https://cla.developers.google.com/ [Discord]: https://github.com/flutter/flutter/wiki/Chat [Contributors Guide]: https://github.com/flutter/samples/blob/main/CONTRIBUTING.md [^1]: If you are super curious about this feature, see [the tracking issue for its implementation](https://github.com/flutter/flutter/issues/143348). --------- Co-authored-by: Eric Windmill <eric@ericwindmill.com>
Flutter samples
A collection of open source samples that illustrate best practices for Flutter.
Visual samples index
The easiest way to browse through the samples in this repo (as well as a few others!) is the visual samples index.
Tip: minimize download size
As this repository is quite big, you can use svn to download a single example. For example:
svn co https://github.com/flutter/samples/trunk/provider_shopper
You can also use a partial clone to skip blob objects that aren't currently checked out, while including the full commit history:
git clone --filter=blob:none https://github.com/flutter/samples.git
Interested in contributing?
See the contributor's guide!
Questions or issues?
If you have a general question about one of these samples or how to adapt its techniques for one of your own apps, try one of these resources:
If you run into a bug in one of the samples, please file an issue in the
flutter/samples issue tracker.