ioBroker template component for Admin

This component is used for admin setting.

How to use

Build process creates files in directory build.

All files from admin/custom folder must be in adapter admin directory.

To use this component in admin, add to jsonConfig.json file:

    "myCustomAttribute": {
      "type": "custom",
      "i18n": true,
      "url": "custom/customComponents.js",
      "name": "AdminComponentTemplateSet/Components/ExampleComponent"
      "bundlerType": "module" // Written with TypeScript
    }

Explanation:

• AdminComponentTemplateSet - is unique name of this set of components (see in src/vite.config.ts => name (line 12)). It is suggested to use adapter name for it.
• Components - file name where all components are (src/Components.tsx)
• ExampleComponent - name of component in Components.tsxwhich must be used.
• i18n - if set to true, so the admin will load language files from i18ndirectory (in the same directory, where customComponents.js is), if set to a language object, it will be used directly. Example: {"easyconfig_text": {"en": "Text"}}.

Development

Start in src:

npm run start

Changelog

2.0.0 (2025-03-19)

• (bluefox) Rewritten in TypeScript with vite

1.0.2 (2025-01-21)

• (bluefox) Updated example and packages

1.0.1 (2024-07-14)

• (bluefox) Changed for Admin 7

0.1.6 (2023-05-17)

• (bluefox) Updated packages

0.1.5 (2022-12-23)

• (bluefox) Corrected issue with the version of common packages
• (bluefox) Updated packages

0.1.0 (2022-05-26)

• (bluefox) Added map files

0.0.2 (2022-05-26)

• (bluefox) Added i18n

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.