v1.11.2 provider

Read-only v1.11.2 archive

Reconstructed from the published 1.11.2 tag, not copied from v2 documentation. This is a fixed historical snapshot, not coverage of every v1 minor release or a promise of ongoing v1 maintenance. New projects should use current v2 docs. Version scope and migration.

The context provider shares one hook connection and result with its descendants. It does not create a different transport or add persistence.

import { BroadcastProvider, useBroadcastProvider } from 'react-broadcast-sync';

export default function App() {
  return (
    <BroadcastProvider channelName="notifications" options={{ telemetry: false }}>
      <NotificationBar />
    </BroadcastProvider>
  );
}

function NotificationBar() {
  const { messages } = useBroadcastProvider();
  return (
    <div>
      {messages.map(msg => (
        <p key={msg.id}>{msg.message.text}</p>
      ))}
    </div>
  );
}

Prop	Required	Meaning
channelName	yes	Shared channel name.
options	no	V1.11.2 BroadcastOptions, including the historical telemetry opt-out.
children	yes	Descendant components.

useBroadcastProvider() outside a BroadcastProvider throws. Consumers under the same provider share state; separate providers or standalone hooks own separate connections. The v1 message API semantics still apply.

Historical sources

• Tagged README
• Tagged runtime and types

The archive keeps version-specific behavior but corrects misleading prose against that version’s code. It is not a verbatim reproduction of the historical README.