@toloka-dev/tb-external-client

@toloka-dev/tb-external-client is a JavaScript/TypeScript library designed to facilitate communication and configuration management between Template Builder and an external component.

Features

• Initialization Handling: Easily handle initial configuration events with the onInit method.
• Configuration Change Handling: Respond to changes in configuration with the onConfigChange method.
• Output Management: Trigger and manage output changes.
• Height Management: Manage and broadcast height changes for flexible UI adjustments.
• Event-driven Architecture: Uses an event-emitter architecture to handle various workspace events.

Installation

npm install @toloka-dev/tb-external-client

Usage

import { TbExternalClient } from '@toloka-dev/tb-external-client';

const client = new TbExternalClient({
    onInit: (config) => {
        console.log('Initialized with config:', config);
    },
    onConfigChange: (config) => {
        console.log('Config changed:', config);
    }
});

// Triggering output and height change
client.setOutputData({ key: 'value' });
client.setHeight(200);

// Cleanup
client.destroy();

Options

• onInit: Callback that is triggered when the workspace is initialized.
• onConfigChange: Callback that is triggered when the configuration changes.

Methods

• setOutputData(output: Output): Triggers an event to signal an output change.
• setHeight(height: number): Triggers an event to signal a height change in the workspace.
• destroy(): Cleans up event listeners.

Properties

• isReady: Returns whether the workspace is ready to accept events.

License

MIT License