Skip to content

Note the recommended menu icon dimensions #88

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.

Sign up for GitHub

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

Open
hellcp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Note the recommended menu icon dimensions #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions source/_guides/app-resources/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,18 @@ their watchapps and watchfaces.
</div>
</div>

You can add a 25x25 `png` to the `resources.media` section of the`package.json`
file, and set `"menuIcon": true`. Please note that icons that are larger will be
rejected by the SDK.
The recommended properties of the menuIcon depend on the platform and type of
an app. An icon for a watchapp should always have the size of **25x25**. For
watchfaces on rectangular watches the icon should have the dimensions of
**24x28**, and on round watches the icon should be **25x25**.

On watches with a color display the watchface icons can be colorful! Watchapp
icons will be translated into a 4 color grayscale icon with transparency,
which is a great opportunity for black and white icon with antialiasing.
Copy link
Member

@Sorixelle Sorixelle Dec 7, 2025

Choose a reason for hiding this comment

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

Not quite sure what this last line means "a great opportunity for black and white icon with antialiasing", seems a bit grammatically odd and I'm not sure what it's referring to either. Does the watch automatically translate coloured icons to dithered ones? If so, how does it do that?

Copy link
Member Author

@hellcp hellcp Dec 7, 2025

Choose a reason for hiding this comment

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

Colour watches have 4 shades of gray: White, Light Gray, Dark Gray and Black. There's no dithering involved, the watch uses the colours in the icon to translate to those 4 colours based on the colours brightness. In typical pebble icon you would see the two grays to be mostly used for antialiasing, even if that's not the only use of this feature


You can add the icon in `png` format to the `resources.media` section of the
`package.json` file, and set `"menuIcon": true`. Please note that watchapp icons
that are larger than 25x25 will be rejected by the SDK.

```js
"resources": {
Expand Down