See what's launched

The next gen Gatsby is here Performance, developer velocity, and scaling to meet Enterprise needs - See what’s launched

Sign Up for Free
Community Plugin
View plugin on GitHub

gatsby-plugin-fusejs

A Gatsby plugin that uses Fuse.js to search your content.

Install

Using react-use-fusejs is strongly recommended. You can use Fuse.js without it, but it will be little tricky to use.

npm install --save gatsby-plugin-fusejs react-use-fusejs

How to use

Create fusejs nodes

Edit gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-fusejs`,
      options: {
        query: `
          {
            allMarkdownRemark {
              nodes {
                id
                rawMarkdownBody
                frontmatter {
                  title
                }
              }
            }
          }
        `,
        keys: ['title', 'body'],
        normalizer: ({ data }) =>
          data.allMarkdownRemark.nodes.map((node) => ({
            id: node.id,
            title: node.frontmatter.title,
            body: node.rawMarkdownBody,
          })),
      },
    },
  ],
};

Options

  • query: A GraphQL query that returns the data to be indexed.
  • keys: An array of keys to index. see Fuse.createIndex
  • normalizer: A function that normalizes the data returned by the query.

Implementing search in your site

The search data is stored in the fusejs node. You can applying debouncing or throttling to the search keyword for additional performance benefits.

import { useStaticQuery, graphql } from 'gatsby';
import * as React from 'react';
import { useGatsbyPluginFusejs } from 'react-use-fusejs';

export function Search() {
  const data = useStaticQuery(graphql`
    {
      fusejs {
        index
        data
      }
    }
  `);

  const [query, setQuery] = React.useState('');
  const result = useGatsbyPluginFusejs(query, data.fusejs);

  return (
    <div>
      <input
        type="text"
        value={query}
        onChange={(e) => setQuery(e.target.value)}
      />
      <ul>
        {result.map(({ item }) => (
          <li key={item.id}>{item.title}</li>
        ))}
      </ul>
    </div>
  );
}

export default Search;

Lazy-loading the search data

The fusejs node also have url for the search data. You can use this url to lazy-load the search data.

Below is an example of lazy-loading the search data when the user starts typing.

import { useStaticQuery, graphql } from 'gatsby';
import * as React from 'react';
import { useGatsbyPluginFusejs } from 'react-use-fusejs';

export function Search() {
  const data = useStaticQuery(graphql`
    {
      fusejs {
        publicUrl
      }
    }
  `);

  const [query, setQuery] = React.useState('');
  const [fusejs, setFusejs] = React.useState(null);
  const result = useGatsbyPluginFusejs(query, fusejs);

  const fetching = React.useRef(false);

  React.useEffect(() => {
    if (!fetching.current && !fusejs && query) {
      fetching.current = true;

      fetch(data.fusejs.publicUrl)
        .then((res) => res.json())
        .then((json) => setFusejs(json));
    }
  }, [fusejs, query]);

  return (
    <div>
      <input
        type="text"
        value={query}
        onChange={(e) => setQuery(e.target.value)}
      />
      <ul>
        {result.map(({ item }) => (
          <li key={item.id}>{item.title}</li>
        ))}
      </ul>
    </div>
  );
}

export default Search;

Reusing the search data

You can prevent re-fetching the search data every time the component is mounted by using context.

// src/context/app.jsx
import { createContext, useState } from 'react';

export const AppContext = createContext({
  fusejs: null,
  setFusejs: () => {},
});

export const AppProvider = ({ children }) => {
  const [fusejs, setFusejs] = useState(null);

  return (
    <AppContext.Provider value={{ fusejs, setFusejs }}>
      {children}
    </AppContext.Provider>
  );
};
// gatsby-browser.js
import { AppProvider } from './src/context/app';

export const wrapRootElement = ({ element }) => {
  return <AppProvider>{element}</AppProvider>;
};
// src/components/Search.jsx
import { AppContext } from '../context/app';
import { graphql, useStaticQuery } from 'gatsby';
import * as React from 'react';
import { useGatsbyPluginFusejs } from 'react-use-fusejs';

export function Search() {
  const data = useStaticQuery(graphql`
    {
      fusejs {
        publicUrl
      }
    }
  `);

  const [query, setQuery] = React.useState('');
  const [fusejs, setFusejs] = React.useContext(AppContext);
  const result = useGatsbyPluginFusejs(query, fusejs);

  const fetching = React.useRef(false);

  React.useEffect(() => {
    if (!fetching.current && !fusejs && query) {
      fetching.current = true;

      fetch(data.fusejs.publicUrl)
        .then((res) => res.json())
        .then((json) => setFusejs(json));
    }
  }, [fusejs, query]);

  return (
    <div>
      <input
        type="text"
        value={query}
        onChange={(e) => setQuery(e.target.value)}
      />
      <ul>
        {result.map(({ item }) => (
          <li key={item.id}>{item.title}</li>
        ))}
      </ul>
    </div>
  );
}

export default Search;
© 2022 Gatsby, Inc.