Vis 2 Demo widgets

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).

Development with TypeScript

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:

1. io-package.json => common.visWidgets
2. src-widgets-ts/vite.config.ts from line 13
3. File DemoWidget.tsx

File in directory src-widgets-ts/index.tsx is only to satisfy the compiler and will not be used in production.

Actually, you cannot start the widgets in development mode.

The development process is:

• compile your widgets: npm run build
• restart vis-2 adapter: iobroker restart vis-2 or iobroker r vis-2
• Debug in Browser with F12

Development with JavaScript

It is not suggested to develop the widgets with JavaScript, 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:

1. io-package.json => common.visWidgets
2. src-widgets-js/modulefederation.config.js from line 4
3. File DemoWidget.jsx

File in directory src-widgets-js/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 in src-widgets-js: npm run start
• write in object system.adapter.vis-2-widgets-react-template.0=>common.visWidgets.vis2DemoWidget.url to http://localhost:4173/customWidgets.js
• Press F5 in iobroker.vis-2 web page

Changelog

1.1.0 (2025-05-21)

• (@German) Finished TypeScript project

1.0.1 (2024-07-13)

• (oweitman) changed the node version from 16 to 20 in test and release workflow
• (bluefox) updated packages

1.0.0 (2024-07-10)

• (bluefox) updated packages

0.2.1 (2023-07-30)

• (bluefox) update packages

0.2.0 (2023-05-18)

• (bluefox) Added CI tests

0.1.6 (2023-03-09)

• (bluefox) update packages

0.1.2 (2023-02-27)

• (bluefox) Packages were updated

0.1.1 (2022-09-07)

• (bluefox) Initial commit

License

The MIT License (MIT)

Copyright (c) 2022-2025 bluefox [email protected]

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.