@koala-live/react

@koala-live/react

Koala SDK hooks for React.

Install

yarn add @koala-live/react

# install peer dependencies if not already installed
yarn add react react-dom

Usage

import React from "react";
import ReactDOM from "react-dom";
import { KoalaProvider, useKoala } from "@koala-live/react";

function App() {
  // You can start using `koala` immediately, but it will asynchronously
  // load in the background. The `ready` flag will indicate when it has
  // it has loaded, if you need to do something after.
  // While loading, `koala` will buffer method calls and execute them
  // after it has finished loaded.
  const { koala, ready } = useKoala();

  // Pseudocode to exemplify getting the logged-in user
  const user = useCurrentUser();

  React.useEffect(() => {
    if (user) {
      koala.identify({ email: user.email, name: user.name });
    }
  }, [koala, user]);

  return <div>{ready ? "Ready" : "Loading"}</div>;
}

ReactDOM.render(
  <KoalaProvider project="<your Koala project slug>">
    <App />
  </KoalaProvider>,
  document.getElementById("root")
);