https://github.com/flotiq/flotiq-ui-plugin-templates-plain-js
A plain js example of Flotiq plugin. This plugin changes the rendering of some data in the grid. It renders colorful text properties, bold numbers, and relations as text.
https://github.com/flotiq/flotiq-ui-plugin-templates-plain-js
flotiq flotiq-plugin
Last synced: 3 months ago
JSON representation
A plain js example of Flotiq plugin. This plugin changes the rendering of some data in the grid. It renders colorful text properties, bold numbers, and relations as text.
- Host: GitHub
- URL: https://github.com/flotiq/flotiq-ui-plugin-templates-plain-js
- Owner: flotiq
- License: mit
- Created: 2024-04-25T14:35:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-14T10:18:23.000Z (4 months ago)
- Last Synced: 2025-03-20T13:42:04.527Z (4 months ago)
- Topics: flotiq, flotiq-plugin
- Language: JavaScript
- Homepage:
- Size: 115 KB
- Stars: 11
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Plain JS Plugin template
## Quick start
1. `yarn` - to install dependencies
2. `yarn start` - to start development mode - rebuild on file modifications
3. update your `plugin-manifest.json` file to contain the production URL and other plugin information
4. `yarn build` - to build plugins
## Dev environment
Dev environment is configured to use:
- `prettier` - best used with automatic format on save in IDE, remember to run `yarn format` before commiting changes
- `eslint` - it is built into both `start` and `build` commands
## Output
The plugins are built into a single `dist/index.js` file. The manifest is copied to `dist/plugin-manifest.json` file.
## Deployment
## Loading the plugin
**Warning:** While developing, you can use `https://localhost:3053/plugin-manifest.json` address to load the plugin manifest. Make sure your browser trusts the local certificate on the latter, to be able to use it e.g. with `https://editor.flotiq.com`
### URL
**Hint**: You can use localhost url from development mode `https://localhost:3053/index.js`
1. Open Flotiq editor
2. Open Chrome Dev console
3. Execute the following script
```javascript
FlotiqPlugins.loadPlugin('plugin-id', '');
```
4. Navigate to the view that is modified by the plugin
### Directly
1. Open Flotiq editor
2. Open Chrome Dev console
3. Paste the content of `dist/index.js`
4. Navigate to the view that is modified by the plugin
### Deployment
**Hint**: You can use localhost url from development mode `https://localhost:3053/plugin-manifest.json`
1. Open Flotiq editor
2. Add a new plugin and paste the URL to the hosted `plugin-manifest.json` file
3. Navigate to the view that is modified by the plugin
## Collaborating
If you wish to talk with us about this project, feel free to hop on our [](https://discord.gg/FwXcHnX).
If you found a bug, please report it in [issues](https://github.com/flotiq/flotiq-ui-plugin-templates-plain-js/issues).