comet-widget

Comet drop-in widgets library

This is an npm package

Use

You can install comet by running

npm i comet-widget

Then imported as:

import { Comet } from 'comet-widget';

Finally drop it in any page you want:

<Comet context={<context>} entityId={<entityId>} relatedEntities={<entityId[]>} />

where:

• context is the scope on which you want to add a comment to an entity
• entityId is the main entity to which you want to add the comment, eg: policy-administration, motor-certificates, bonus-malus-ownership, ...
• relatedEntities are entities closer to the main one that are used to build the "magic links" jira, confluence, ...

You can also import the modal and button component separately from the widget:

import { Trigger, Modal } from 'comet-widget'

These are useful when you want to handle some states in the parent service, e.g: building a button that spawns many modals, but you only want one modal open at a time.

Development

Local development requires a bit of npm magic to make it work.

For example to run a local version of Comet against Heimdall we need to do the following:

• In memo-widget run npm link to create a local version of the package and npm run watch to rebuild the library after changes
• If you are using Vite you need to run vite --force, so in Heimdall run npm link comet-widget && npm run start:force, this will force re-optimization of dependencies and pick up the local one
• If not run npm link comet-widget && npm run start

Publishing

At the moment, publishing is a manual task. For that, you have to:

• Run npm login. Credentials can be found in Integrations 1Password Vault
• Bump the version with npm version <patch|mintor|major>
• Publish the package with npm publish