Getting started

The React Evy SDK is a complete set of UI components and helpers to build a complete Evy integration using React.

📘

Browser support

The Evy SDK supports the next versions of the most popular browsers: Chrome(>=67), Firefox(>=60), Edge(>=17), Safari(>=11.1), and Internet Explorer (version 11 only).

Install the package

You can install the Evy SDK package using a package manager like NPM or Yarn.

npm install @getevy/js-sdk

yarn add @getevy/js-sdk

Add the root component

First we need to add the Evy SDK root component. This component allows us to provide the credentials to access the EVY API.

The other components must be children of this root component.

import { EvyRoot } from "@getevy/react-sdk";

const API_KEY = process.env.EVY_API_KEY!;
const API_URL = process.env.EVY_API_URL;

const App = ({children}) => {
  return (
    <EvyRoot apiKey={API_KEY} apiUrl={API_URL}>
      {children}
    </EvyRoot>
  );
};

⚠

️ Note on using SSR

As of now, the library is not compatible with static site generation (SSG), or server side rendering (SSR) more generally. However it is possible to dynamically load. For example, with NextJS you can use the dynamic fuction to defer the components loading.