@brettm12345/gatsby-plugin-exact-client-paths

gatsby-plugin-exact-client-paths

• Install
• Usage
  • How is this different from gatsby-plugin-create-client-paths?
• Current Limitations
• Run tests
• 📝 License

Gatsby plugin for client rendering exact page routes.

Install

yarn add gatsby-plugin-exact-client-paths

Usage

// gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-plugin-exact-client-paths',
      options: {
        clientPaths: ['/preview', '/clientOnly'],
      },
    },
  ],
}

How is this different from gatsby-plugin-create-client-paths?

This plugin attempts to address the inability to client-side render singular routes in Gatsby, most particularly with top level routes such as /preview.

With gatsby-plugin-create-client-paths, you must create at least 1 route that is still processed via Gatsby's SSR pipeline that handles the client-side routing for nested paths. This can be problematic when top level client-side routes like https://hostname.com/preview are needed, and we don't want to imperatively define a <Router> component directly in our homepage index component.

This plugin establishes a <Router> behind the scenes of your index page that will normally display your SSR'd content or a client rendered page if the current path matches a path specified in the clientPaths plugin options.

Current Limitations

• Client rendered paths & component trees that call Gatsby's useStaticQuery hook will crash.

Run tests

yarn test

📝 License

This project is MIT licensed.