Skip to content

Commit 0f0bdad

Browse files
authored
Add png requirements to icon guide (tauri-apps#1113)
* Add png requirements to icon guide * Update docs/guides/features/icons.md
1 parent 5a9b11e commit 0f0bdad

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/guides/features/icons.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ USAGE:
3131
cargo tauri icon [OPTIONS] [INPUT]
3232

3333
ARGS:
34-
<INPUT> Path to the source icon (png, 1240x1240px with transparency) [default: ./app-icon.png]
34+
<INPUT> Path to the source icon (png, 1024x1024px with transparency) [default: ./app-icon.png]
3535

3636
OPTIONS:
3737
-h, --help Print help information
@@ -60,8 +60,11 @@ By default, the icons will be placed in your `src-tauri/icons` folder where they
6060

6161
## Creating the icons manually
6262

63-
If you prefer to build these icons yourself (if you want to have a simpler design for small sizes or because you don't want to depend on the CLI's internal image resizing), the required layer sizes and names for the [`icns`] file are described [in the Tauri repo] and the [`ico`] file must include layers for 16, 24, 32, 48, 64 and 256 pixels.
64-
For an optimal display of the ICO image _in development_, the 32px layer should be the first layer.
63+
If you prefer to build these icons yourself, for example if you want to have a simpler design for small sizes or because you don't want to depend on the CLI's internal image resizing, you must make sure your icons meet some requirements:
64+
65+
- `icon.icns`: The required layer sizes and names for the [`icns`] file are described [in the Tauri repo]
66+
- `icon.ico`: The [`ico`] file must include layers for 16, 24, 32, 48, 64 and 256 pixels. For an optimal display of the ICO image _in development_, the 32px layer should be the first layer.
67+
- `png`: The requirements for the png icons are: width == height, RGBA (RGB + Transparency), and 32bit per pixel (8bit per channel). Commonly expected sizes are 32, 128, 256, and 512 pixels. We recommend to at least match the output of `tauri icon`: `32x32.png`, `128x128.png`, `[email protected]`, and `icon.png`.
6568

6669
[`tauricon`]: https://github.com/tauri-apps/tauricon
6770
[in the tauri repo]: https://github.com/tauri-apps/tauri/blob/dev/tooling/cli/src/helpers/icns.json

0 commit comments

Comments
 (0)