useFuse

Demo

source

Exact MatchCase SensitiveMatch all when empty

Roslyn Mitchell Score Index: 0

Cathleen Matthews Score Index: 1

Carleton Harrelson Score Index: 2

Allen Moores Score Index: 3

John Washington Score Index: 4

Brooke Colton Score Index: 5

Mary Rennold Score Index: 6

Nanny Field Score Index: 7

Chasity Michael Score Index: 8

Oakley Giles Score Index: 9

Johanna Shepherd Score Index: 10

Maybelle Wilkie Score Index: 11

Dawson Rowntree Score Index: 12

Manley Pond Score Index: 13

Lula Sawyer Score Index: 14

Hudson Hext Score Index: 15

Alden Senior Score Index: 16

Tory Hyland Score Index: 17

Constance Josephs Score Index: 18

Larry Kinsley Score Index: 19

Available in the @vueuse/integrations add-on.

Install Fuse.js as a peer dependency

NPM

bash

npm install fuse.js@^7

Yarn

bash

yarn add fuse.js

Usage

import { useFuse } from '@vueuse/integrations/useFuse'
import { ref } from 'vue'

const data = [
  'John Smith',
  'John Doe',
  'Jane Doe',
  'Phillip Green',
  'Peter Brown',
]

const input = ref('Jhon D')

const { results } = useFuse(input, data)

/*
 * Results:
 *
 * { "item": "John Doe", "index": 1 }
 * { "item": "John Smith", "index": 0 }
 * { "item": "Jane Doe", "index": 2 }
 *
 */

Type Declarations

Show Type Declarations

typescript

export type FuseOptions<T> = IFuseOptions<T>
export interface UseFuseOptions<T> {
  fuseOptions?: FuseOptions<T>
  resultLimit?: number
  matchAllWhenSearchEmpty?: boolean
}
export declare function useFuse<DataItem>(
  search: MaybeRefOrGetter<string>,
  data: MaybeRefOrGetter<DataItem[]>,
  options?: MaybeRefOrGetter<UseFuseOptions<DataItem>>,
): {
  fuse: Ref<
    {
      search: <R = DataItem>(
        pattern: string | Expression,
        options?: FuseSearchOptions,
      ) => FuseResult<R>[]
      setCollection: (
        docs: readonly DataItem[],
        index?: FuseIndex<DataItem> | undefined,
      ) => void
      add: (doc: DataItem) => void
      remove: (predicate: (doc: DataItem, idx: number) => boolean) => DataItem[]
      removeAt: (idx: number) => void
      getIndex: () => FuseIndex<DataItem>
    },
    | Fuse<DataItem>
    | {
        search: <R = DataItem>(
          pattern: string | Expression,
          options?: FuseSearchOptions,
        ) => FuseResult<R>[]
        setCollection: (
          docs: readonly DataItem[],
          index?: FuseIndex<DataItem> | undefined,
        ) => void
        add: (doc: DataItem) => void
        remove: (
          predicate: (doc: DataItem, idx: number) => boolean,
        ) => DataItem[]
        removeAt: (idx: number) => void
        getIndex: () => FuseIndex<DataItem>
      }
  >
  results: ComputedRef<FuseResult<DataItem>[]>
}
export type UseFuseReturn = ReturnType<typeof useFuse>