--- layout: layouts/component.njk title: Combobox description: Autocomplete input and command palette with a list of suggestions. toc: - label: Usage id: usage children: - label: HTML + Javascript id: usage-default - label: Jinja or Nunjucks id: usage-jinja - label: Examples id: examples children: - label: Scrollable id: example-scrollable - label: Top side id: example-top --- {% from "macros/code_preview.njk" import code_preview %} {% from "macros/code_block.njk" import code_block %} {% from "components/select.njk" import select %} {% set options_frameworks = ["Next.js", "SvelteKit", "Nuxt.js", "Remix", "Astro"] %} {% set code_html %} {% call select( trigger_attrs={"class": "w-[200px]"}, listbox_attrs={"data-empty": "No framework found."}, is_combobox=true, search_placeholder="Search framework...", register_on=["alpine:init", "htmx:afterSwap"] ) %} {% for framework in options_frameworks %}
{{ framework }}
{% endfor %} {% endcall %} {% endset %} {% set code_script %} {% include "components/select-script.njk" %} {% endset %} {{ code_preview("combobox", code_script | prettyHtml ~ code_html | prettyHtml) }}

Usage

HTML + Javascript

{% lucide "circle-alert" %}

This component requires Javascript.

You will need to include the Javascript (Alpine.js) code provided below before the HTML code for this component. As with all interactive components, you will need to add some Alpine.js properties to certain elements (e.g. x-bind, x-data, @click).

Combobox uses the same Alpine.js code and markup as the Select component, the only difference being the search box at the top of the listbox.

You can set up a few additional options on the <div data-popover> element:

{% from "components/tabs.njk" import tabs %} {% set tabsets = [ { tab: "HTML", panel: code_block(code_html | prettyHtml) }, { tab: "Javascipt (Alpine.js)", panel: code_block(code_script | prettyHtml) } ] %} {{ tabs(id="combobox", tabsets=tabsets) }}

Jinja or Nunjucks

If you use Jinja (or Nunjucks), you can use the select() macro directly, making sure to set is_combobox to True (or true for Nunjucks). Read more about using Basecoat with Jinja and Nunjucks.

{% set raw_code %}{% raw %}{% call select( listbox_attrs={"data-empty": "No framework found."}, is_combobox=true ) %}
Next.js
SvelteKit
Nuxt.js
Remix
Astro
{% endcall %}{% endraw %}{% endset %} {{ code_block(raw_code, "jinja") }}

Examples

Scrollable

{% set options_timezones = [ { label: "Americas", timezones: [ { value: "America/New_York", label: "(GMT-5) New York" }, { value: "America/Los_Angeles", label: "(GMT-8) Los Angeles" }, { value: "America/Chicago", label: "(GMT-6) Chicago" }, { value: "America/Toronto", label: "(GMT-5) Toronto" }, { value: "America/Vancouver", label: "(GMT-8) Vancouver" }, { value: "America/Sao_Paulo", label: "(GMT-3) São Paulo" } ] }, { label: "Europe", timezones: [ { value: "Europe/London", label: "(GMT+0) London" }, { value: "Europe/Paris", label: "(GMT+1) Paris" }, { value: "Europe/Berlin", label: "(GMT+1) Berlin" }, { value: "Europe/Rome", label: "(GMT+1) Rome" }, { value: "Europe/Madrid", label: "(GMT+1) Madrid" }, { value: "Europe/Amsterdam", label: "(GMT+1) Amsterdam" } ] }, { label: "Asia/Pacific", timezones: [ { value: "Asia/Tokyo", label: "(GMT+9) Tokyo" }, { value: "Asia/Shanghai", label: "(GMT+8) Shanghai" }, { value: "Asia/Singapore", label: "(GMT+8) Singapore" }, { value: "Asia/Dubai", label: "(GMT+4) Dubai" }, { value: "Australia/Sydney", label: "(GMT+11) Sydney" }, { value: "Asia/Seoul", label: "(GMT+9) Seoul" } ] } ] %} {% set code %} {% call select( trigger_attrs={"class": "w-[200px]"}, content_attrs={"class": "w-72"}, listbox_attrs={"data-empty": "No timezone found."}, is_combobox=true, search_placeholder="Search timezone...", register_on=["alpine:init", "htmx:afterSwap"] ) %}
{% for group in options_timezones %}
{{ group.label }} {% for timezone in group.timezones %}
{{ timezone.label }}
{% endfor %}
{% endfor %}

{% lucide "circle-plus" %} Create timezone
{% endcall %} {% endset %} {{ code_preview("combobox-with-groups", code | prettyHtml) }}

Top side

{% set options_frameworks = ["Next.js", "SvelteKit", "Nuxt.js", "Remix", "Astro"] %} {% set code %} {% call select( trigger_attrs={"class": "w-[200px]"}, listbox_attrs={"data-empty": "No framework found."}, is_combobox=true, search_placeholder="Search framework...", register_on=["alpine:init", "htmx:afterSwap"], content_attrs={"data-side": "top"} ) %} {% for framework in options_frameworks %}
{{ framework }}
{% endfor %} {% endcall %}{% endset %} {{ code_preview("combobox", code | prettyHtml) }}