Skip to main content

AI chat widget for Gatsby

Add an AI chatbot to your Gatsby site using Biel.ai's React components. The integration works with any Gatsby version and automatically adapts to your site's styling.

This guide shows you how to install the package via NPM and add the chat widget to your Gatsby components in minutes.

Prerequisites​

Before starting, ensure you have:

  • A Biel.ai account. If you don't have one, sign up for free.
  • A project created in your Biel.ai dashboard. Follow the Quickstart guide to create one.
  • A Gatsby application ready to install Biel.ai.
  • Node.js installed.

Installation​

The Biel.AI chat widget enables a conversational chat powered by AI in your site.

Chatbot widget for docs

To integrate the Biel.AI chat widget into your Gatsby site:

  1. Open your terminal or command prompt. Navigate to your project's root directory using the cd command:

    cd path/to/your/project

    Replace path/to/your/project with your project's actual directory path.

  2. With your terminal still open, run the following command to install Biel.ai:

    npm install biel-react
    info

    If you're using yarn as your package manager, run yarn add biel-react instead of the npm command above.

  3. In the main component where you wish to place the chatbot (often src/pages/index.js), embed the Biel.ai button:

    import React, { useEffect } from 'react';

    import { BielButton } from 'biel-react';
    import { defineCustomElements } from 'biel-search/loader';
    import 'biel-search/dist/biel-search/biel-search.css';

    const IndexPage = () => {
        
        useEffect(() => {
            if (typeof window !== 'undefined') {
                defineCustomElements(window);
            }
        }, []);

        return (
            <div className="page-layout">
                {/* Other components and content */}
                <BielButton project="<YOUR_PROJECT_ID>" 
                    header-title="Biel.ai chatbot"
                    button-position="bottom-right"
                    modal-position="bottom-right"
                    button-style="dark">Ask AI
                </BielButton>
            </div>
        );
    }

    export default IndexPage;

    Replace <YOUR_PROJECT_ID> with your project's ID from the Biel.ai dashboard.

  4. Start your Gatsby app by running gatsby develop in your terminal. Once it compiles successfully, verify that the chatbot appears and functions correctly on your site.

Next steps​

For more about customization and additional features exploration, check out the customization section.

Need assistance? We're here to help! Reach out to us at Biel.ai Support.