Commit ff3b99
2024-11-04 17:10:37 Hargata Softworks: x| /dev/null .. advanced/custom widgets.md | |
| @@ 0,0 1,28 @@ | |
| + | # Custom Widgets |
| + | |
| + | ::: warning |
| + | # Future Feature |
| + | Only available in 1.4.0 and newer |
| + | ::: |
| + | |
| + | ::: danger |
| + | # Security |
| + | This feature can expose your instance of LubeLogger to XSS and other security vulnerabilities if you don't fully understand what you are doing. We(the maintainers of LubeLogger) are not responsible for the consequences that result from utilizing this feature. Zero support will be provided. You have been warned. |
| + | ::: |
| + | |
| + | The Custom Widgets Feature allows users to craft widgets that consumes from the API within LubeLogger itself. Only the Root(SuperAdmin) user can modify custom widgets, but once configured it is visible to every user. |
| + | |
| + | ## How It Works |
| + | |
| + | When LubeLogger loads the Dashboard view, it will check if there is a `widgets.html` located within the `/data` directory. If this file exists, a button with the text `Additional Widgets` will be displayed |
| + | |
| + |  |
| + | |
| + | Clicking on this button will bring up a dialog/modal which will render everything in `widgets.html` (JavaScripts included) |
| + | |
| + | ## Configuring Custom Widgets |
| + | |
| + | This feature requires the user to be comfortable with the following paradigms: |
| + | - JavaScript and jQuery syntaxes |
| + | - Consuming JSON data from API Endpoints |
| + | - Displaying data in DOM elements |