jonbhanson / flutter_native_splash

Automatically generates native code for adding splash screens in Android and iOS. Customize with specific platform, background color and splash image.
https://pub.dev/packages/flutter_native_splash
MIT License
1.36k stars 215 forks source link

Image Size - Documentation Clarity #743

Closed rjapenga closed 1 month ago

rjapenga commented 1 month ago

In your template for the yaml you say (similar in other places):

This should be 1152×1152 pixels, and fit within a circle 768 pixels in diameter.

I am not sure how you create an image that is (for example) 1152 x 1152 pixels and fit in circle 768 pixels in diameter.

Is what you are saying? The image file should be 1152×1152 pixels, and the content in the image fit within a circle 768 pixels in diameter.

If that is true, then you should also say where the circle is located in that 1152 x 1152. I assume centered - but if you don't say it - it is not obvious.

Configuration Not applicable

Paste the flutter_native_splash section of your yaml config. Not applicable

Device (please complete the following information): Not applicable To Reproduce Not applicable Screenshots Not applicable

Additional context Not applicable

rjapenga commented 1 month ago

I see that the Android documentation is equally vague:

" 288×288 dp and fit within a circle 192 dp"

They should change their documentation as well - but no need to follow bad documentation with your own unclear documentation.

Here is what how a stack overflow entry words it:

"To fit a 288x288 dp image within a circle with a 192 dp diameter, simply ensure that the most important design elements of your image are placed within a circular area with a 192 dp diameter at the center of the 288x288 canvas" My emphasis on what is lacking in yours and their documentation.

This is a minor documentation change and would help people who have never created an app with Flutter. I have with React Native and it was much much simpler.