mirror of
https://github.com/flipperdevices/flipperzero-firmware.git
synced 2025-12-12 20:59:50 +04:00
d34ff3310d
* 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>
33 lines
692 B
Markdown
33 lines
692 B
Markdown
# GUI Icons {#js_gui__icon}
|
|
|
|
Retrieves and loads icons for use with GUI views such as [Dialog](#js_gui__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.
|
|
|
|
<br>
|
|
|
|
## 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.
|