Add Search Bar to Framer

What is Framer

Framer is a tool for creating interactive websites.

Get an API key

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

Connect the script

Open Site Settings in the drop-down menu
Click on the Open Settings tab
Go to the General section
Add the below to the Start of <head> tag section

<script
  id="inkeep-script"
  type="module"
  src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js"
  defer
></script>

Creating the container

Add a widget container to the page using the built-in Framer functionality.

Select an area to add a container
Select the Embed item in the Utility section

Add an html element to the page

Specify the ID of the container to be inkeepSearchBar

Next, paste the script below into the End of <body> tag section:

<script defer>
  const inkeepScript = document.getElementById("inkeep-script");
 
  // configure and initialize the widget
  const addInkeepWidget = () => {
    const inkeepWidget = Inkeep.SearchBar("#inkeepSearchBar", {
      baseSettings: {
        apiKey: "INKEEP_API_KEY", // required
        primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
        organizationDisplayName: "Inkeep",
        // ...optional settings,
        theme: {
          styles: [
            {
              key: "main",
              type: "link",
              value: "/path/to/stylesheets",
            },
          ],
          // ...optional settings,
        },
      },
      modalSettings: {
        // optional settings
      },
      searchSettings: {
        // optional settings
      },
      aiChatSettings: {
        // optional settings
        aiAssistantAvatar: "https://mydomain.com/mylogo", // use your own AI assistant avatar
        exampleQuestions: [
          "Example question 1?",
          "Example question 2?",
          "Example question 3?",
        ],
      },
    });
  };
 
  const observer = new MutationObserver((mutationsList, observer) => {
    const inkeepPortals = document.getElementsByTagName("inkeep-portal");
 
    Array.from(inkeepPortals)?.forEach((inkeepPortal) => {
      inkeepPortal.remove();
    });
 
    addInkeepWidget(); // initialize the widget
  });
 
  observer.observe(document.head, { attributes: true, subtree: true });
</script>

Save custom code

Click on the Save button. Navigate to your web application and reload the page, to make sure the widget is installed correctly.

For a full list of customizations, check out the Search Bar documentation.