README.md

Resubscribe React SDK

The official React SDK for Resubscribe.

Setup

Install

npm install resubscribe-react-sdk

Usage

Mount the component and then trigger the Resubscribe modal with the openWithConsent method. Replace the placeholders with your own values.

import Resubscribe from 'resubscribe-react-sdk';

export default function Home() {
  const onTrigger = () => {
    Resubscribe.openWithConsent({
      slug: '{organization-slug}',
      apiKey: '{api-key}',
      aiType: '{ai-type}',
      userId: '{uid}',
      userEmail: '{optionalEmail}',
      colors: {
        primary: 'blue',
        background: '#eee',
        text: '#333',
      },
      onClose: (via) => {
        //
      },
    });
  };

  return (
    <main>
      ...
      <Resubscribe.Component />
    </main>
  )
}

Headless

You can alternatively use the headless version of the SDK.

import Resubscribe, { ResubscribeOptions } from 'resubscribe-react-sdk';

export default function Home() {
  const onOpenConsent = async () => {
    Resubscribe.headless.setOptions({
      slug: '{organization-slug}',
      apiKey: '{api-key}',
      aiType: '{ai-type}',
      userId: '{uid}',
      userEmail: '{optionalEmail}',
    });
    Resubscribe.headless.registerConsentRequest();
    // Open your own consent modal here 👇
    const confirmed = await confirm(...);

    if (confirmed) {
      Resubscribe.headless.openChat({
        onClose: (via: any) => {
          console.log('onClose', via);
        },
        classNames: {
          overlay: styles.overlay,
        },
      });
    }
  };

  return (
    <main>
      ...
      <Resubscribe.Component />
    </main>
  )
}