Skip to main content

Setup

The simplest way to setup the user interface is to just import it from our CDN in a module script tag and bind to a button you want to open it from:

<script type="module">
    import { FindkitUI } from "https://cdn.findkit.com/ui/v1.1.0/esm/index.js";
    const ui = new FindkitUI({ publicToken: "<TOKEN>" });
    ui.openFrom("button.open-search");
</script>

You can find the publicToken using the findkit status command or from the project page on the Hub. The script can be placed any where on the website. This creates a simple fullscreen modal of the UI but there are many other embedding patterns for different use cases.

npm​

If you are using a bundler such as Webpack you can also install it from npm:

npm install @findkit/ui
import { FindkitUI } from "@findkit/ui";

const ui = new FindkitUI({ publicToken: "<TOKEN>" });

ui.openFrom("button.open-search");

This removes one network request from your website and gives type-safety if you are using Typescript as well.

The CDN and npm imports are completely interchangeable. In this documentation we will be using the npm import but it can be replaced with the CDN import.

WordPress​

If you happen to use WordPress you can include FindkitUI using our plugin.

Cannot use module scripts?​

If you cannot create <script type="module"> directly you can load the module from old style <script> tag with:

<script>
    const script = document.createElement("script");
    script.type = "module";
    script.innerHTML =
        'import("https://cdn.findkit.com/ui/v1.1.0/esm/index.js").then(onFindkitUIModule)';
    document.head.append(script);

    window.onFindkitUIModule = ({ FindkitUI }) => {
        const ui = new FindkitUI({ publicToken: "<TOKEN>" });
    };
</script>

See the demo here;

Try it!​

Open in a new tab view source code in Github or edit online in JSBin or Codesandbox

Typescript and npm​

Here's a version which uses npm, Typescript and modal free config:

Open in a new tab view source code in Github or edit online in Codesandbox