@storybook/channel-websocket

What is @storybook/channel-websocket?

The @storybook/channel-websocket npm package is used within the Storybook ecosystem to facilitate communication between the Storybook UI and the server or between different frames of the UI using WebSockets. This package is particularly useful for enabling real-time updates and interactions in the Storybook UI, which is a tool for developing UI components in isolation for React, Vue, Angular, and more.

What are @storybook/channel-websocket's main functionalities?

Establishing WebSocket connection

This code sample demonstrates how to establish a WebSocket connection using the WebSocketTransport class provided by @storybook/channel-websocket. This is essential for enabling real-time communication between the Storybook UI and the server.

import { WebSocketTransport } from '@storybook/channel-websocket';

const transport = new WebSocketTransport({ url: 'ws://localhost:9001' });
const channel = createChannel({ transport });

Sending messages

This code sample shows how to send messages over the established WebSocket connection. This is useful for triggering events or sending data from one part of the UI to another or to the server.

channel.emit('event-name', { payload: 'data' });

Receiving messages

This code sample illustrates how to listen for messages on the WebSocket channel. This allows the UI to react to data or events sent from the server or other parts of the UI.

channel.on('event-name', (data) => {
  console.log('Received data:', data);
});

Other packages similar to @storybook/channel-websocket

socket.io-client

Socket.IO-client is a popular WebSocket library that enables real-time, bidirectional and event-based communication. It is similar to @storybook/channel-websocket but is more general-purpose and not specifically tailored for Storybook.

ws

The 'ws' package is a simple to use, blazing fast, and thoroughly tested WebSocket client and server implementation. Unlike @storybook/channel-websocket, 'ws' provides both client and server-side capabilities, making it more versatile for different WebSocket needs.

README

Storybook Websocket Channel

Storybook Websocket Channel is a channel for Storybook that can be used when the Storybook Renderer should communicate with the Storybook Manager over the network. A channel can be created using the createChannel function.

import createChannel from '@storybook/channel-websocket';

const channel = createChannel({ url: 'ws://localhost:9001' });

For more information visit: storybook.js.org