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: about 2 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
• Created: 2024-04-25T14:35:01.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-19T11:47:23.000Z (6 months ago)
• Last Synced: 2024-06-19T21:44:29.869Z (6 months ago)
• Topics: flotiq, flotiq-plugin
• Language: JavaScript
• Homepage:
• Size: 91.8 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
[[_TOC_]]

# Plain JS Plugin

## 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

* `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