@this-is-not-a-drill/react-core v1.0.14

This is Not A Drill! Client SDKs -- Core

Purpose

This is the core SDK for This Is Not A Drill! (TINAD). It uses SWR to poll the TINAD service for notifications to show your users.

Separately, the React-UI SDK provides a drop-in React component for adding TINAD to your site.

If you are developing a BFF or mobile application, see the API docs for more detailed information on how to connect with the API directly, without the use of this SDK.

Installation Guide for Using the TINAD SDK

Normally, you'll want to use the version of the SDK in the npm repo.

npm install @this-is-not-a-drill/react-core @this-is-not-a-drill/react-ui

Then, you can import the core and the UI SDK into your React project like so:

import { initTinadSDK } from '@thisisnotadrill/react-core';
import { TinadComponent, TinadTemplateProps } from '@thisisnotadrill/react-ui';

Installation Guide for Using a Local copy of the SDKs (Less Common)

If you're developing against the SDK, you may wish to use it locally via this monorepo.

First, run yarn at the top level of the monorepo. Then:

cd packages/sdk/react-core
yarn build

The monorepo's package.json lists react-core as a workspace, so you can list it as a dependency in your own package.json like this:

"@thisisnotadrill/react-core": "1.0.0",

You can then import it with this line:

import { initTinadSDK } from '@thisisnotadrill/react-core';

If you want to use TINAD's UI components, you should also install "@thisisnotadrill/react-ui": "1.0.0",

and then you can include the UI component and its properties with:

import { TinadComponent, TinadTemplateProps } from '@thisisnotadrill/react-ui';

Troubleshooting

See the website https://www.this-is-not-a-drill.com for support options.