typebot.io/packages/embeds/react
2025-11-12 09:07:50 +01:00
..
src 🐛 Fix bot crash on second load in builder 2025-09-15 11:24:16 +02:00
.npmignore 🧑‍💻 Make react package ssr compatible and deprecate nextjs package 2025-05-22 12:05:40 +02:00
package.json 🚑️ Fix invalid chat container class names 2025-11-12 09:07:50 +01:00
README.md 📝 Update installation commands to remove unnecessary peer dep install 2024-10-19 09:07:37 +02:00
tsconfig.json Revert "build: add ts references for better DX" 2025-01-29 17:44:06 +01:00
tsup.config.ts 🧑‍💻 Make react package ssr compatible and deprecate nextjs package 2025-05-22 12:05:40 +02:00

Install

npm install @typebot.io/react

Standard

import { Standard } from "@typebot.io/react";

const App = () => {
  return (
    <Standard
      typebot="lead-generation-copy-3luzm6b"
      style={{ width: "100%", height: "600px" }}
    />
  );
};

This code is creating a container with a 100% width (will match parent width) and 600px height.

Popup

import { Popup } from "@typebot.io/react";

const App = () => {
  return <Popup typebot="lead-generation-copy-3luzm6b" autoShowDelay={3000} />;
};

This code will automatically trigger the popup window after 3 seconds.

Open or Close a popup

You can use these commands:

import { open } from "@typebot.io/react";

open();
import { close } from "@typebot.io/react";

close();
import { toggle } from "@typebot.io/react";

toggle();

Bubble

import { Bubble } from "@typebot.io/react";

const App = () => {
  return (
    <Bubble
      typebot="lead-generation-copy-3luzm6b"
      previewMessage={{
        message: "I have a question for you!",
        autoShowDelay: 5000,
        avatarUrl: "https://avatars.githubusercontent.com/u/16015833?v=4",
      }}
      theme={{
        button: { backgroundColor: "#0042DA", iconColor: "#FFFFFF" },
        previewMessage: { backgroundColor: "#ffffff", textColor: "black" },
      }}
    />
  );
};

This code will show the bubble and let a preview message appear after 5 seconds.

Open or close the preview message

You can use these commands:

import { showPreviewMessage } from "@typebot.io/react";

Typebot.showPreviewMessage();
import { hidePreviewMessage } from "@typebot.io/react";

Typebot.hidePreviewMessage();

Open or close the chat window

You can use these commands:

import { open } from "@typebot.io/react";

open();
import { close } from "@typebot.io/react";

close();
import { toggle } from "@typebot.io/react";

toggle();

Additional configuration

You can prefill the bot variable values in your embed code by adding the prefilledVariables option. Here is an example:

import { Standard } from "@typebot.io/react";

const App = () => {
  return (
    <Standard
      typebot="lead-generation-copy-3luzm6b"
      style={{ width: "100%", height: "600px" }}
      prefilledVariables={{
        "Current URL": "https://my-site/account",
        "User name": "John Doe",
      }}
    />
  );
};

It will prefill the Current URL variable with "https://my-site/account" and the User name variable with "John Doe". More info about variables: here.

Note that if your site URL contains query params (i.e. https://typebot.io?User%20name=John%20Doe), the variables will automatically be injected to the typebot. So you don't need to manually transfer query params to the bot embed configuration.