react-deck-link/README.md

React SDK for integrating Deck Link

# react-deck-link [![npm version](https://badge.fury.io/js/react-deck-link.svg)](http://badge.fury.io/js/react-deck-link)

[React 16.8+](https://facebook.github.io/react/) hook and components for integrating
with [Deck Link](https://docs.deck.co/docs/link)

```sh
yarn add react-deck-link
```

# Usage

```js
import { useDeckLink } from 'react-deck-link';

const OpenLink = () => {
  const { open, isError, isReady } = useDeckLink({
    token: '<GENERATED_LINK_TOKEN>',
    onSuccess: ({ job_guid, public_token }) => {
      // send public_token to server
      // persist job_guid
    },
  });

  if (isError) {
    return <div>Uh oh!</div>;
  }

  return (
    <button onClick={open} disabled={!isReady}>Connect</button>
  );
}
```

# Documentation

Please refer to the [official Deck Link docs](https://docs.deck.co/docs/integrating-the-link-sdk)
for a more holistic understanding of Deck Link.

# Contributing

This project is set up using Vite.
```sh
yarn
npx vite # start dev server
```

To test a local version of this library:
```sh
yarn link
cd ../dashboard
yarn link react-deck-link
```

# Publishing

```sh
npx vite build
yarn publish
```