This is only for development purposes, and it could be used as a basis for own vis-2 widget's development.
This example consists of two projects: JavaScript (src-widgets-js) and TypeScript (src-widgets-ts).
It is suggested to develop the widgets with TypeScript.
After all entries with vis-2-widgets-react-template are replaced to your adapter name in package.json, io-package.json
and file admin/vis-2-widgets-react-template.svg renamed too, you can start with renaming of widgets. (You can use PNG files too)
Some important places:
io-package.json=>common.visWidgetssrc-widgets-ts/vite.config.tsfrom line 13- File
DemoWidget.tsx - Check existence of attribute
"bundlerType": "module"inio-package.json
File in directory src-widgets-ts/index.html src-widgets-ts/src/index.tsx and is only to satisfy the compiler and will not be used in production.
For debugging, please see Debugging
It is not suggested to develop the widgets with JavaScript and CRA, but it is possible.
After all entries with vis-2-widgets-react-template are replaced to your adapter name in package.json, io-package.json
and file admin/vis-2-widgets-react-template.png renamed too, you can start with renaming of widgets.
Some important places:
io-package.json=>common.visWidgetssrc-widgets-js/modulefederation.config.jsfrom line 4- File
DemoWidget.jsx - Check that attribute
bundlerTypeinio-package.jsonis not set. (Important!)
File in directory src-widgets-js/src/index.jsx is only to satisfy the compiler and will not be used in production.
By development, you can start the script from src-widgets-js folder with npm run start command,
and then on port 4173 you will see the demo widget.
For faster development, you can:
- start dev-server with installed web and vis-2 adapter with the following command
dev-server watch --noStart. If your adapter contains adapter backend logic, start your adapter with a suitable launch configuration. - start in src-widgets-js:
npm run start - write in object
system.adapter.vis-2-widgets-react-template.0=>common.visWidgets.vis2DemoWidget.urltohttp://localhost:4173/customWidgets.js - Press F5 in
iobroker.vis-2web page
It is suggested to develop the widgets with TypeScript. Compared to the solution JavaScript + CRA, vite is much faster and more resource-efficient in the build process
After all entries with vis-2-widgets-react-template are replaced to your adapter name in package.json, io-package.json
and file admin/vis-2-widgets-react-template.svg renamed too, you can start with renaming of widgets. (You can use PNG files too)
Some important places:
io-package.json=>common.visWidgetssrc-widgets-jsvite/vite.config.tsfrom line 13- File
DemoWidget.jsx - Check existence of attribute
"bundlerType": "module"inio-package.json
File in directory src-widgets-jsvite/index.html src-widgets-jsvite/src/index.jsx is only to satisfy the compiler and will not be used in production.
For debugging, please see Debugging
To be able to debug with vite and TypeScript/JavaScript, vis-2 and the vis-2-react-widget adapter to be developed must each be running in vite dev mode.
To do this, perform the following steps:
- Install vis-2 according to the following description: https://github.com/ioBroker/ioBroker.vis-2?tab=readme-ov-file#development-and-debugging
- As a result, the vis-2 adapter is running, but cannot be called at this point, as this requires a running instance of ioBroker.
- Open another window of a development environment (e.g., VS Code)
- Then set up the vis-2-react-widgets project/repository according to the description in this README.
- Then set up the iobroker dev server according to the following description: https://github.com/ioBroker/dev-server?tab=readme-ov-file#installation
- To start the iobroker dev-server, I recommend the following command for the vis-2-widgets adapter:
dev-server watch --noStart- write in object
system.adapter.vis-2-widgets-react-template.0=>common.visWidgets.vis2DemoWidget.urltohttp://localhost:4173/customWidgets.js, with dev-server you have to upload the adapter with thedev-server uploadcommand - Start the widgets adapter in the widgets-src directory in vite dev mode with the following command:
npm run start- You can then open a browser instance using one of the two launch configurations. Breakpoints can be set in vscode, which will then also stop vscode.
Adjust the webroot path to match your widget source. This launch configuration is only valid for debugging with vite.
{
"type": "chrome",
"request": "launch",
"name": "vis-2 editor",
"url": "http://localhost:3000/#default",
"webRoot": "${workspaceFolder}/src-widgets-ts"
},
{
"type": "chrome",
"request": "launch",
"name": "vis-2 runtime",
"url": "http://localhost:3000/?main&runtime=true#default",
"webRoot": "${workspaceFolder}/src-widgets-ts"
}- (oweitman) add js/vite support
- (oweitman) improve documentation
- (oweitman) small fixes
- (oweitman) debugging description for vite
- (@German) Finished TypeScript project
- (oweitman) changed the node version from 16 to 20 in test and release workflow
- (bluefox) updated packages
- (bluefox) updated packages
- (bluefox) update packages
- (bluefox) Added CI tests
- (bluefox) update packages
- (bluefox) Packages were updated
- (bluefox) Initial commit
The MIT License (MIT)
Copyright (c) 2022-2025 bluefox dogafox@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.