Skip to content

Commit 6d43dcc

Browse files
C-D-LewisSorixelle
authored andcommitted
Document menuIcon in the guides
Signed-off-by: C-D-Lewis <[email protected]>
1 parent 06f390c commit 6d43dcc

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

source/_guides/app-resources/images.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,4 +177,43 @@ Destroy both the ``GBitmap`` and ``BitmapLayer`` when the app exits:
177177
```c
178178
gbitmap_destroy(s_bitmap);
179179
bitmap_layer_destroy(s_bitmap_layer);
180-
```
180+
```
181+
182+
## Menu Icon in the Launcher
183+
184+
The new launcher in firmware 4.0+ allows developers to provide a custom icon for
185+
their watchapps and watchfaces.
186+
187+
<div class="pebble-dual-image">
188+
<div class="panel">
189+
{% markdown %}
190+
![Launcher Icon](/images/blog/2016-08-19-pikachu-icon.png)
191+
{% endmarkdown %}
192+
</div>
193+
<div class="panel">
194+
{% markdown %}
195+
![Launcher >{pebble-screenshot,pebble-screenshot--time-red}](/images/blog/2016-08-19-pikachu-launcher.png)
196+
{% endmarkdown %}
197+
</div>
198+
</div>
199+
200+
You can add a 25x25 `png` to the `resources.media` section of the`package.json`
201+
file, and set `"menuIcon": true`. Please note that icons that are larger will be
202+
rejected by the SDK.
203+
204+
```js
205+
"resources": {
206+
"media": [
207+
{
208+
"type": "bitmap",
209+
"name": "MENU_ICON",
210+
"file": "images/icon.png",
211+
"menuIcon": true
212+
}
213+
]
214+
}
215+
```
216+
217+
> If your `png` file is color, we will use the luminance of the image to add
218+
> some subtle gray when rendering it in the launcher, rather than just black
219+
> and white. Transparency will be preserved.

0 commit comments

Comments
 (0)