1
mirror of https://github.com/flipperdevices/flipperzero-firmware.git synced 2025-12-12 12:51:22 +04:00
Files
flipperzero-firmware/documentation/js/js_gui__icon.md
WillyJL d34ff3310d JS: Update and fix docs, fix Number.toString() with decimals (#4168)
* Update and fix JS docs

This could really use some automation, atleast for API reference
There are TypeScript definitions and typedocs, we don't need to be monkeys copying and reformatting this to API reference by hand

* Fix bugged character

* JS: Fix Number.toString() with decimals

* Fix

* Forgot this one

* docs: mention per-view child format

* Added @portasynthinca3 to docs' codeowners

* Updated CODEOWNERS

---------

Co-authored-by: Anna Antonenko <portasynthinca3@gmail.com>
Co-authored-by: hedger <hedger@nanode.su>
Co-authored-by: hedger <hedger@users.noreply.github.com>
2025-04-01 15:02:12 +04:00

692 B

GUI Icons

Retrieves and loads icons for use with GUI views such as Dialog.

Example

For an example, refer to the gui.js example script.

API reference

getBuiltin()

Gets a built-in firmware icon by its name. Not all icons are supported, currently only "DolphinWait_59x54" and "js_script_10px" are available.

Parameters

  • icon: name of the icon

Returns

An IconData object.


loadFxbm()

Loads a .fxbm icon (XBM Flipper sprite, from flipperzero-game-engine) from file. It will be automatically unloaded when the script exits.

Parameters

  • path: path to the .fxbm file

Returns

An IconData object.