@inploi/plugin-collaborate

@inploi/plugin-collaborate

Plugin for enabling inploi’s Collaborate product on any website.

Installation

If you want to use it in your javascript project, you can install it via npm:

npm install @inploi/sdk @inploi/plugin-collaborate

Usage

Whenever your page is done loading you may call setupCollaborate to enable the plugin. You may pass in an optional signal parameter to abort the setup process and remove all event listeners if you want.

E.g.:

import { setupCollaborate } from '@inploi/plugin-collaborate';
import { initialiseSdk } from '@inploi/sdk';

const sdk = initialiseInploiSdk({
	publishableKey: 'your-publishable-key',
	env: 'sandbox',
});

const collaborate = sdk.register(collaboratePlugin());

window.addEventListener('DOMContentLoaded', () => {
	collaborate.setupBridge();
});

React:

import { collaboratePlugin } from '@inploi/plugin-collaborate';
import { initialiseSdk } from '@inploi/sdk';

// somewhere in your codebase
const sdk = initialiseInploiSdk({
	publishableKey: 'your-publishable-key',
	env: 'sandbox',
});
const collaborate = sdk.register(collaboratePlugin());

const App = () => {
	React.useEffect(() => {
    const abortController = new AbortController();
		collaborate.setupBridge({ signal: abortController.signal });
		return () => abortController.abort();
	}, []);

	return <div>Hello World</div>;
};

## From the CDN

You can also use the plugin from the CDN by adding the following script tag to your HTML:

```html
<script src="https://unpkg.com/@inploi/plugin-sdk@latest/cdn/index.js"></script>
<script src="https://unpkg.com/@inploi/plugin-collaborate@latest/cdn/index.js"></script>
<script>
  const collaborate = sdk.register(collaboratePlugin());
  window.addEventListener('DOMContentLoaded', () => {
	  collaborate.setupBridge();
  });
</script>
```

This will already setup the plugin when the DOM is ready.