Faqs
Troubleshooting
Copy page
Can't find an answer? Reach out to support@inkeep.com.
Add to your:
Support Team Tools
Analytics
Projects
Sources
Portal
UI Components
AI API
MCP Server
Analytics API
Copy page
Can't find an answer? Reach out to support@inkeep.com.
If you're having trouble loading the Inkeep UI components, try checking the below.
Inkeep components are loaded into a "Shadow" DOM. This is done so that they don't affect your pages styles or vice versa. Use your browser's developer tools to check if there's an HTML element with an ID that contains inkeep-shadow. If you don't see an element that matches that description, that means there is an issue instantiating the component. This is typically due to an issue with loading the JavaScript.
If you're using the @inkeep/cxkit-js package, there are two scripts that need to be loaded:
<script id="inkeep-script" type="module" src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@^<someversion>/dist/embed.js"></script>Inkeep.<ComponentType>({...}) to instantiate the UI components.Inspect your DOM to see if both of these scripts were successfully loaded. Sometimes, the issue is that script #2 loads before script #1. To prevent this, you can add an id to script #1 and use the "load" event to execute script #2.
The UI components are designed to not display until custom stylesheets have been fetched. If you specify a link type style in the styles array in the widget configurations' theme object but any of the provided paths are invalid, this can cause the widget to not render. Please ensure that the URL is an absolute URL (like for a CDN); or, if using a relative URL, ensure it's relative to your site's root.
If you see the inkeep-shadow element, the issue might be that the Search Bar or Chat Button components are not being properly displayed in your page. Find all the elements with id inkeep-widget-root and inspect whether they are being rendered off the page or hidden by other elements.
By default, UI components use same-domain cookies in the browser to keep track of what "mode" a user last had open so that they are taken to that same mode when they next open the Inkeep Modal.
To disable this "remember" behavior, you can set baseSettings.optOutFunctionalCookies = true or use the forceInitialDefaultView prop in modalSettings which will open the modal in the defaultView regardless of which view was last opened.
New users will see the default search or chat experience based on your component type or if you customize modalSettings.defaultView.
The Inkeep UI components and related scripts are loaded asynchronously so they don't affect page performance.