PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update tools page docs
All checks were successful
Build and Deploy MkDocs / build-next (push) Successful in 1m56s
Details

Browse Source
This commit is contained in:
Skylar Ittner 2026-03-28 17:08:03 -06:00
parent a703139760
commit 027121ca6a
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Plugin API/ui.md
View File

@ -32,7 +32,7 @@ will be run as a function and will not be expected to return a page component.
| --- | --- | --- | --- | | --- | --- | --- | --- |
| page | <code>string</code> \| <code>function</code> | | Page content as a Framework7 component page. If `page` is a string ending in `.f7` it is treated as a file path and the page content will be loaded from disk. If `page` is any other string, it is treated as the page content. If `page` is a function, it will be called and must return the page content (unless `type` is set to `"function"`, see examples) | | page | <code>string</code> \| <code>function</code> | | Page content as a Framework7 component page. If `page` is a string ending in `.f7` it is treated as a file path and the page content will be loaded from disk. If `page` is any other string, it is treated as the page content. If `page` is a function, it will be called and must return the page content (unless `type` is set to `"function"`, see examples) |
| title | <code>string</code> | | Page title. | | title | <code>string</code> | | Page title. |
| id | <code>string</code> | | Page ID. Make it unique, or pass an empty string to be assigned a random ID. | | id | <code>string</code> | | Page ID. Make it unique, or pass an empty string to be assigned a random ID. Tools with a random ID are not pinnable to the program's main navigation bar. |
| description | <code>string</code> | | Description of this tool for its card on the Tools screen. | | description | <code>string</code> | | Description of this tool for its card on the Tools screen. |
| cardTitle | <code>string</code> | | Title of the card for this page on the Tools screen. | | cardTitle | <code>string</code> | | Title of the card for this page on the Tools screen. |
| icon | <code>string</code> | | FontAwesome icon class, for example, "fa-solid fa-globe". FontAwesome Pro solid, regular, light, and duotone icons are available. | | icon | <code>string</code> | | FontAwesome icon class, for example, "fa-solid fa-globe". FontAwesome Pro solid, regular, light, and duotone icons are available. |