Use with Gatsby - Flowbite React

Learn how to install Flowbite React for your Gatsby project and start building websites with an open-source static site generator built on top of React and GraphQL

Using the CLI#

Run the following command to scaffold a new Flowbite React project using Gatsby:

# npm
npm create flowbite-react@latest -- --template gatsby

# yarn
yarn create flowbite-react --template gatsby

# pnpm
pnpm create flowbite-react@latest --template gatsby

# bun
bun create flowbite-react@latest --template gatsby

Manual Installation

Create project#

Run the following command to create a new Gatsby project with Tailwind CSS:

npm init gatsby

Select "Tailwind CSS" to "Would you like to install a styling system?" question.

Install Flowbite React#

Run the following command to install flowbite-react:

npm i flowbite-react

Add the Flowbite React content path and plugin to tailwind.config.js:

import flowbite from "flowbite-react/tailwind";

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    // ...
    flowbite.content(),
  ],
  plugins: [
    // ...
    flowbite.plugin(),
  ],
};

Dark mode#

In server side rendered applications, such as Gatsby, to avoid page flicker (if dark mode is set) before Gatsby hydrates the content, ThemeModeScript component must be rendered in Head component (see implementation below).

ThemeModeScript renders a script tag that sets dark or removes dark from <html> element before hydration occurs.

Configure#

To use the Gatsby SSR APIs, create a file called gatsby-ssr.js in the root of your site. Export any of the APIs you wish to use in this file.

Create gatsby-ssr.js file at the root folder of the project:

// gatsby-ssr.js

export const onRenderBody = ({ setPreBodyComponents }) => {
  // ...
};

Import ThemeModeScript and add it to setPreBodyComponents function inside an array:

// gatsby-ssr.js

import { ThemeModeScript } from "flowbite-react";

export const onRenderBody = ({ setPreBodyComponents }) => {
  setPreBodyComponents([ThemeModeScript]);
};

Try it out#

Now that you have successfully installed Flowbite React you can start using the components from the library.

import { Button } from "flowbite-react";

export default function IndexPage() {
  return <Button>Click me</Button>;
}