@samitouri / QOSami-HFS / commits / 554205b4

doc: HFS.dialogLib and HFS.misc

Massimo Melina committed Mar 13, 2024 at 23:06 UTC 554205b482d30de605376371fff782dd56d923e4
1 file changed +2
dev-plugins.md
+2
@@ -206,6 +206,8 @@ The HFS objects contains many properties:
206 - `h` shortcut for React.createElement
207 - `t` [translator function](https://github.com/rejetto/hfs/blob/main/frontend/src/i18n.ts)
208 - `_` [lodash library](https://lodash.com/docs/)
209 +- `dialogLib` this exposes all functions available in [dialog.ts](https://github.com/rejetto/hfs/blob/main/frontend/src/dialog.ts), for example alertDialog and newDialog. These are not documented yet, and subject to change without notification, but you can study the sources if you are interested in using them.
210 +- `misc` many functions and constants available in [cross.ts](https://github.com/rejetto/hfs/blob/main/src/cross.ts). These are not documented, probably never will, and are subject to change without notifications, but you can study the sources if you are interested in using them.
211 - `navigate: (uri: string): void` use this if you have to change the page address without causing reload
212 - `emit: (name: string, params?: object) => any[]` use this to emit a custom event. Prefix name with your plugin name to avoid conflicts.
213 - `Icon: ReactComponent` Properties: