@cloudquery/plugin-config-ui-connector
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

@cloudquery/plugin-config-ui-connector

Plugin configuration UI connector for CloudQuery Cloud App.

Description

@cloudquery/plugin-config-ui-connector is a library designed to establish communication between CloudQuery Cloud App form and Plugin UI.

Installation

To install the library, you can use npm:

npm install @cloudquery/plugin-config-ui-connector

Usage

Below is an example of how to use the getPluginUiMessageHandler function provided by the library.

Example

import { getPluginUiMessageHandler } from '@cloudquery/plugin-config-ui-connector';

// Create a message handler instance
const messageHandler = getPluginUiMessageHandler();

// Example of sending a message to the CloudQuery Cloud App form
messageHandler.sendMessage('height_changed', { height: 200 });

// Example of receiving a message from the CloudQuery Cloud App form
messageHandler.subscribeToMessage('init', function (payload) {
  customCallback(payload);
});

Development

Building the Library

To build the library, run:

npm run build

Running Tests

To run the test suite, execute:

npm test

Contributing

If you encounter any issues or have feature requests, please feel free to open an issue on the GitHub repository.

License

This project is licensed under the Mozilla Public License..

Package Sidebar

Install

npm i @cloudquery/plugin-config-ui-connector

Weekly Downloads

954

Version

1.0.0

License

MPL-2.0

Unpacked Size

37.3 kB

Total Files

5

Last publish

Collaborators

  • cq-bot
  • jackcloudquery
  • erezro