> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Show starter prompts on the chat welcome screen

> Build a custom chat welcome screen with starter prompts using InstantSearch.js.

export const customLabel_0 = "in beta"

export const FlavorSwitcher = ({current, baseHref = "", options = [], label = "InstantSearch framework"}) => {
  if (options.length === 0) {
    return <div className="not-prose" role="alert" style={{
      margin: "0.25rem 0 1.5rem",
      padding: "0.75rem",
      border: "1px solid #f59e0b",
      borderRadius: "0.625rem",
      color: "inherit",
      fontSize: "0.875rem"
    }}>
        FlavorSwitcher requires at least one option.
      </div>;
  }
  const selected = options.find(option => option.value === current) ?? options[0];
  return <div className="not-prose mint-flavor-switcher">
      <style>{`
        .mint-flavor-switcher {
          --mfs-bg: #ffffff;
          --mfs-bg-hover: #f4f4f5;
          --mfs-bg-current: #eef2ff;
          --mfs-border: #d4d4d8;
          --mfs-fg: #18181b;
          --mfs-muted: #71717a;
          --mfs-accent: #4f46e5;
          position: relative;
          width: min(100%, 19rem);
          margin: 0.25rem 0 1.5rem;
          color: var(--mfs-fg);
          font-size: 0.875rem;
          line-height: 1.25rem;
        }

        .dark .mint-flavor-switcher {
          --mfs-bg: #18181b;
          --mfs-bg-hover: #27272a;
          --mfs-bg-current: #272747;
          --mfs-border: #3f3f46;
          --mfs-fg: #fafafa;
          --mfs-muted: #a1a1aa;
          --mfs-accent: #a5b4fc;
        }

        .mint-flavor-switcher details {
          position: relative;
        }

        .mint-flavor-switcher summary {
          display: flex;
          min-height: 2.75rem;
          box-sizing: border-box;
          align-items: center;
          justify-content: space-between;
          gap: 0.75rem;
          padding: 0.625rem 0.75rem;
          border: 1px solid var(--mfs-border);
          border-radius: 0.625rem;
          background: var(--mfs-bg);
          color: var(--mfs-fg);
          cursor: pointer;
          font-weight: 600;
          list-style: none;
          transition: border-color 150ms ease, box-shadow 150ms ease;
        }

        .mint-flavor-switcher summary::-webkit-details-marker {
          display: none;
        }

        .mint-flavor-switcher summary:hover {
          border-color: var(--mfs-accent);
        }

        .mint-flavor-switcher summary:focus-visible {
          outline: 2px solid var(--mfs-accent);
          outline-offset: 2px;
        }

        .mint-flavor-switcher__label {
          overflow: hidden;
          text-overflow: ellipsis;
          white-space: nowrap;
        }

        .mint-flavor-switcher__chevron {
          flex: none;
          transition: transform 150ms ease;
        }

        .mint-flavor-switcher details[open] .mint-flavor-switcher__chevron {
          transform: rotate(180deg);
        }

        .mint-flavor-switcher__menu {
          position: absolute;
          z-index: 50;
          top: calc(100% + 0.375rem);
          left: 0;
          width: 100%;
          box-sizing: border-box;
          margin: 0;
          padding: 0.375rem;
          border: 1px solid var(--mfs-border);
          border-radius: 0.625rem;
          background: var(--mfs-bg);
          box-shadow: 0 12px 30px rgb(0 0 0 / 16%);
          list-style: none;
        }

        .mint-flavor-switcher__menu li {
          margin: 0;
          padding: 0;
        }

        .mint-flavor-switcher__option {
          display: grid;
          gap: 0.125rem;
          padding: 0.625rem 0.75rem;
          border-radius: 0.4rem;
          color: var(--mfs-fg);
          text-decoration: none;
        }

        .mint-flavor-switcher__option:hover {
          background: var(--mfs-bg-hover);
        }

        .mint-flavor-switcher__option:focus-visible {
          outline: 2px solid var(--mfs-accent);
          outline-offset: -2px;
        }

        .mint-flavor-switcher__option[aria-current="page"] {
          background: var(--mfs-bg-current);
          color: var(--mfs-accent);
        }

        .mint-flavor-switcher__name {
          font-weight: 600;
        }

        .mint-flavor-switcher__description {
          color: var(--mfs-muted);
          font-size: 0.8125rem;
        }

        @media (prefers-reduced-motion: reduce) {
          .mint-flavor-switcher summary,
          .mint-flavor-switcher__chevron {
            transition: none;
          }
        }
      `}</style>

      <details>
        <summary aria-label={`${label}: ${selected.label}`}>
          <span className="mint-flavor-switcher__label">{selected.label}</span>
          <svg className="mint-flavor-switcher__chevron" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
            <path d="m6 9 6 6 6-6" />
          </svg>
        </summary>

        <ul className="mint-flavor-switcher__menu" aria-label={label}>
          {options.map(option => {
    const isCurrent = option.value === selected.value;
    const href = option.href ?? `${baseHref.replace(/\/$/, "")}/${encodeURIComponent(option.value)}`;
    return <li key={option.value}>
                <a className="mint-flavor-switcher__option" href={href} aria-current={isCurrent ? "page" : undefined}>
                  <span className="mint-flavor-switcher__name">
                    {option.label}
                  </span>
                  {option.description ? <span className="mint-flavor-switcher__description">
                      {option.description}
                    </span> : null}
                </a>
              </li>;
  })}
        </ul>
      </details>
    </div>;
};

<div className="mint-flavor-switcher-slot not-prose">
  <FlavorSwitcher
    current="js"
    baseHref="/doc/guides/building-search-ui/going-further/chat-customization/welcome-screen"
    options={[
{ value: "js", label: "JavaScript", description: "InstantSearch.js" },
{ value: "react", label: "React", description: "React InstantSearch" },
]}
  />
</div>

<Callout icon="flask-conical" color="#14b8a6">
  This widget is **{customLabel_0 || "experimental"}** and is subject to change in minor versions.
</Callout>

When the [`chat`](/doc/api-reference/widgets/chat/js) widget has no messages yet, it shows a welcome screen. Use the [`empty`](/doc/api-reference/widgets/chat/js#param-templates) template to replace it with your own greeting and a set of starter prompts. Each prompt sends a message to the agent when clicked, so users can start a conversation in one tap.

If you only need prompt suggestions *after* the agent responds, use [Agent Studio prompt suggestions](/doc/guides/algolia-ai/agent-studio/how-to/integration#prompt-suggestions) instead.

## Render starter prompts with the `empty` template

The `empty` template receives a `sendMessage` function. Call it with `{ text }` to submit a starter prompt as the first message:

```js JavaScript icon=code theme={"system"}
import algoliasearch from "algoliasearch/lite";
import instantsearch from "instantsearch.js";
import { chat, chatTrigger } from "instantsearch.js/es/widgets";

const search = instantsearch({
  indexName: "instant_search",
  searchClient: algoliasearch("YourApplicationID", "YourSearchOnlyAPIKey"),
});

const starterPrompts = [
  "What are your best-selling headphones?",
  "Help me find a gift under $50",
  "Compare espresso machines",
];

search.addWidgets([
  chat({
    container: "#chat",
    agentId: "YOUR_AGENT_ID",
    templates: {
      empty({ sendMessage }, { html }) {
        return html`
          <div class="ais-ChatGreeting">
            <h2 class="ais-ChatGreeting-heading">How can I help you today?</h2>
            <p class="ais-ChatGreeting-subheading">
              Ask me anything about our products, or start with a suggestion.
            </p>

            <div class="ais-ChatPromptSuggestions">
              ${starterPrompts.map(
                (prompt) =>
                  html`<button
                    type="button"
                    class="ais-ChatPromptSuggestions-suggestion"
                    onClick=${() => sendMessage({ text: prompt })}
                  >
                    ${prompt}
                  </button>`,
              )}
            </div>
          </div>
        `;
      },
    },
  }),
  chatTrigger({
    container: "#chat-trigger",
  }),
]);

search.start();
```

<Note>
  The `chat` widget renders the panel but doesn't open it on its own. Add an entry point on the same InstantSearch instance: the [`chatTrigger`](/doc/api-reference/widgets/chat-trigger/js) widget, [AI mode](/doc/guides/building-search-ui/going-further/chat-customization/ai-search-experience/js) on a `searchBox`, or an inline layout.
</Note>

The `empty` template reuses the built-in classes (`ais-ChatGreeting` and `ais-ChatPromptSuggestions`) so it inherits the default styling. Replace them with your own classes to fully restyle the welcome screen.

## Reuse the default greeting

Instead of writing the greeting markup yourself, render the built-in greeting with the exported `chatGreeting` template helper, then add your starter prompts below it. The helper renders the default heading and subheading, and accepts a `banner` image, `translations`, and `classNames`:

```js JavaScript icon=code theme={"system"}
import { chatGreeting } from "instantsearch.js/es/templates";

const greeting = chatGreeting({
  banner: "https://example.com/welcome-banner.png",
  translations: {
    heading: "Welcome to our store",
    subheading: "Ask me anything, or pick a suggestion to get started.",
  },
});

// In the chat widget:
templates: {
  empty(props, { html }) {
    return html`
      <div>
        ${greeting(props)}
        <div class="ais-ChatPromptSuggestions">
          ${starterPrompts.map(
            (prompt) =>
              html`<button
                type="button"
                class="ais-ChatPromptSuggestions-suggestion"
                onClick=${() => props.sendMessage({ text: prompt })}
              >
                ${prompt}
              </button>`,
          )}
        </div>
      </div>
    `;
  },
},
```

## Fetch starter prompts dynamically

The prompts don't have to be static. Fetch them once (for example, from a dedicated Agent Studio agent that returns starter prompts), store them, and render them from the `empty` template:

```js JavaScript icon=code expandable theme={"system"}
const appID = "YourApplicationID";
const apiKey = "YourSearchOnlyAPIKey";
const promptsAgentId = "YOUR_STARTER_PROMPTS_AGENT_ID";

async function getStarterPrompts() {
  const response = await fetch(
    `https://${appID}.algolia.net/agent-studio/1/agents/${promptsAgentId}/completions?stream=false&cache=true&compatibilityMode=ai-sdk-5`,
    {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "X-Algolia-Application-Id": appID,
        "X-Algolia-API-Key": apiKey,
      },
      body: JSON.stringify({
        messages: [
          {
            role: "user",
            parts: [{ text: "Return starter prompts for the welcome screen." }],
          },
        ],
      }),
    }
  );

  const data = await response.json();
  const text = data.parts?.find((part) => part.type === "text")?.text ?? "";

  return text
    .split("\n")
    .map((line) => line.trim())
    .filter(Boolean);
}

let starterPrompts = [];

getStarterPrompts()
  .then((prompts) => {
    starterPrompts = prompts;
    // Re-render the chat so the empty template picks up the prompts.
    search.refresh();
  })
  .catch(() => {
    starterPrompts = [];
  });
```

Reference `starterPrompts` from the `empty` template, exactly as in the static example above.

## Customize more than the empty state

The `empty` template only replaces the initial empty state. To customize the surrounding chat layout (header, message list, prompt input), use the [`layout`](/doc/api-reference/widgets/chat/js#param-templates) template instead. See [`instantsearch.templates.chatInlineLayout()`](/doc/api-reference/widgets/chat/js) for an inline (non-overlay) layout.

## Related

* [chat widget reference](/doc/api-reference/widgets/chat/js)
* [chatTrigger widget reference](/doc/api-reference/widgets/chat-trigger/js)
* [Customize the chat results carousel](/doc/guides/building-search-ui/going-further/chat-customization/results-carousel/js)
* [Agent Studio](/doc/guides/algolia-ai/agent-studio)