@screeb/sdk-react NPM

Continuous Product Discovery, Without the Time Sink.

Screeb is the only Continuous Product Discovery platform that lets you analyse users' behaviour, ask in-app questions, recruit people for interviews and analyse data in a blink with AI.

Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

npm install @screeb/sdk-react --save

# For Yarn, use the command below.
yarn add @screeb/sdk-react

Usage

Basic usage:

import * as React from 'react';

import { ScreebProvider, useScreeb } from '@screeb/sdk-react';

const SCREEB_APP_ID = 'your-screeb-website-id';

const App = () => (
  <ScreebProvider
    autoInit
    websiteId={SCREEB_APP_ID}
    userId="dev@screeb.app"
    userProperties={{
      firstname: "John",
      lastname: "Smith",
      last_seen_at: new Date(),
      authenticated: true,
      org_size: 20,
    }}
  >
    <HomePage />
  </ScreebProvider>
);

// Anywhere in your app
const HomePage = () => {
  const { eventTrack } = useScreeb();

  const onButtonClicked = React.useCallback(
    () => eventTrack(
      "screeb-sdk-react-example started",
      { test: 123 }
    );
  );

  return (
    <button onClick={onButtonClicked}>
      Track event!
    </button>
  );
};

For a working example, see our Screeb React SDK example app.

For a more advanced usage and a complete API documentation, see documentation generated from source files.

For further information, see our developper documentation.

Support

For any issues, please contact our support team at support@screeb.com.

Contributing

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.