Poool Subscribe - React SDK

The easiest way to add Poool Subscribe to your React app ✨

Installation

yarn add @poool/react-subscribe

Usage

import { SubscribeContext, SigninButton } from '@poool/react-subscribe';

export default = () => {
  // Wrap everything with our SubscribeContext component
  return (
    <SubscribeContext appId="insert_your_app_id">
      { /*
        Place your element where you want it to be displayed
      */ }
      <SigninButton styles={{ custom_css: 'body { font-family: serif; }' }} />
    </SubscribeContext>
  );
};

Documentation

<SubscribeContext />

Props

• appId {String} Your Poool App ID
• config {Object} (optional) Default paywall config (see the configuration documentation).
• events {Object} (optional) Paywall events listeners (see the events documentation).
• scriptUrl {String} (optional, default: 'https://assets.poool-subscribe.fr/subscribe.js') Default Poool Subscribe SDK url

<Element />

Props

• type {String} Element type (see the createAuthElement method documentation for available types).
• styles {Object} (optional) Custom styles for the element. Use { custom_css: '' } to add custom CSS.

<SigninButton />

Props

• styles {Object} (optional) Custom styles for the element. Use { custom_css: '' } to add custom CSS.

<SigninWithSubscribeButton />

Props

• styles {Object} (optional) Custom styles for the element. Use { custom_css: '' } to add custom CSS.
• offer {String} (optional) Offer ID used to display a Starting at X text.
• interval {Number} (optional) Offer subscription renewal interval (in months, defaults to 1).
• currency {String} (optional) Offer currency (defaults to country's own currency deduced from the request IP).

useSubscribe()

Can be used to retrieve some properties from the current subscribe context, as well as the Subscribe SDK itself.

Returns

• lib {Function} The entire Subscribe sdk
• appId {String} Current app ID
• config {Object} Current subscribe context config
• events {Object} Current subscribe context events listeners
• scriptURL {Object} Subscribe SDK url

Example

const { appId, lib: subscribe } = useSubscribe();

Contributing

Please check the CONTRIBUTING.md doc for contribution guidelines.

Development

Install dependencies:

yarn install

Run examples at http://localhost:63001/ with webpack dev server:

yarn serve

And test your code:

yarn test

License

This software is licensed under MIT.