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

# Create your widgets

> Learn how you can create a custom widget for your Vue InstantSearch app.

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="vue"
    baseHref="/doc/guides/building-search-ui/widgets/create-your-own-widgets"
    options={[
{ value: "js", label: "JavaScript", description: "InstantSearch.js" },
{ value: "react", label: "React", description: "React InstantSearch" },
{ value: "vue", label: "Vue", description: "Vue InstantSearch" },
{ value: "ios", label: "iOS", description: "InstantSearch iOS" },
{ value: "android", label: "Android", description: "InstantSearch Android" },
]}
  />
</div>

You can build your own components when the provided ones aren't sufficient.

<Info>
  If you're creating a custom InstantSearch widget because you didn't find a built-in option for your use case,
  consider [opening a feature request](https://github.com/algolia/instantsearch/discussions/new?category=ideas\&labels=triage\&title=Feature%20request%3A%20) to describe what you're trying to build.
</Info>

## Existing connectors

Sometimes you might want to create a component which uses a piece of data not provided by any of the widgets.
You also might want to make a custom component for having access to the data in different places than the template.

You can do this with the `createWidgetMixin` function exposed by Vue InstantSearch.
It works together with the [connectors](/doc/guides/building-search-ui/widgets/customize-an-existing-widget/js#customize-the-complete-ui-of-the-widgets) from InstantSearch.js.

<Steps>
  <Step title="Connect the menu widget">
    Choose the [`connectMenu`](/doc/api-reference/widgets/menu/js) connector for this example.

    <CodeGroup>
      ```vue Vue 3 theme={"system"}
      <script>
      import { createWidgetMixin } from 'vue-instantsearch/vue3/es';
      import { connectMenu } from 'instantsearch.js/es/connectors';

      export default {
        mixins: [createWidgetMixin({ connector: connectMenu })],
      };
      </script>
      ```

      ```vue Vue 2 theme={"system"}
      <script>
      import { createWidgetMixin } from 'vue-instantsearch';
      import { connectMenu } from 'instantsearch.js/es/connectors';

      export default {
        mixins: [createWidgetMixin({ connector: connectMenu })],
      };
      </script>
      ```
    </CodeGroup>

    All information from that connector will then be available to your template as well as your other Vue lifecycle methods (after `created`).
    All information will be available on `this.state` on your instance, and will be `null` initially
    (so make sure your code is safe by wrapping usage in the template for example in an `v-if="state"`).
  </Step>

  <Step title="Determine widget parameters">
    All connectors expect to be passed widget parameters.
    Since these change over the lifecycle of a component, and are usually passed through props, the widget mixin expects a property `widgetParams` on the component's instance.
    Create it with a `computed` property, based on props:

    ```js Vue icon=code theme={"system"}
    export default {
      // ...
      props: {
        attribute: {
          type: String,
          required: true,
        },
      },
      computed: {
        widgetParams() {
          return {
            attribute: this.attribute,
          };
        },
      },
    };
    ```
  </Step>

  <Step title="Filter items by widget state">
    Use `state` here to filter over the items.

    ```js Vue icon=code theme={"system"}
    export default {
      // ...
      computed: {
        // ...
        items() {
          // Not needed here if you v-if in the template
          // Only labels of three character long allowed
          return this.state.items.filter(item => item.label.length === 3)
        },
      },
    };
    ```

    <Info>
      This is also possible with the `transform-items` prop on [`ais-menu`](/doc/api-reference/widgets/menu/vue)).
    </Info>

    For more information, see [UI state](/doc/api-reference/widgets/ui-state/vue).
  </Step>

  <Step title="Render menu items in the template">
    ```vue Vue theme={"system"}
    <ul>
      <li v-for="item in items" :key="item.value">
        <button @click="state.refine(item.value)">
          {{ item.label }}
        </button>
      </li>
    </ul>
    ```
  </Step>
</Steps>

## Custom connectors

If you want to make your own connector, you can do that using a function with this signature:

```js JavaScript icon=code theme={"system"}
const connector = (renderFn, unmountFn) => (widgetParams = {}) => ({
  init({ instantSearchInstance }) {
    renderFn(
      {
        /* Anything you put here comes in this.state */
      },
      true
    );
  },

  render({ results, instantSearchInstance }) {
    renderFn(
      {
        /* Anything you put here comes in this.state */
      },
      false
    );
  },

  dispose() {
    unmountFn();
  },
});
```

That lets you access the lowest level of abstraction,
including the [Algolia search helper](/doc/guides/building-search-ui/upgrade-guides/js#algolia-search-helper).
