Add Chat Button to Remix

What is Remix

Remix is a modern web framework for building web applications based on React.

Get an API key

Follow these steps to create an API key for your web assistant.

Copy and add the apiKey to your environment variables:

.env

INKEEP_API_KEY="INKEEP_API_KEY"

Get the environment variables

Use loader/action to access your environment variables:

root.tsx

// ...
export const loader = async () => {
  return json({
    ENV: {
      API_KEY: process.env.INKEEP_API_KEY!,
      INTEGRATION_ID: process.env.INKEEP_INTEGRATION_ID!,
      ORGANIZATION_ID: process.env.INKEEP_ORGANIZATION_ID!,
    },
  });
};

Install the component library

Customize your settings

Define your Inkeep settings.

Define the component

Next, create an InkeepChatButton.tsx file for the Chat Button component.

For a full list of customizations, check out the Chat Button documentation.

Positioning

We support customization of styles via custom css in baseSettings, you can style "Ask AI" button by targetting it's class as so:

const baseSettings = {
  theme: {
    //...Other base Settings

    // Custom styles injection
    styles: [
      {
        key: "custom-theme",
        type: "style",
        value: `
         .ikp-chat-button__container {
           // Position the Ask-AI button on the left
           left: 1.5rem;
         }
       `,
      },
    ],
  },
};

You can find more information in the Custom Styles documentation.