How to use with Gatsby? (Styles not loading on static-site generation)

[garronej]

How to use with Gatsby? (Styles not loading on static-site generation)

[Deckstar]

Hello again!

I described my solution for this problem in this blog post. Here's a summary in case someone is reading it here 😄

---

TLDR:

• copy paste the two files below
• make sure your <CacheProvider /> component imports your emotion cache from the new place
• remove gatsby-plugin-material-ui from your gatsby-node.js file if you had it

---

./src/theme/cache.js:

import createCache from '@emotion/cache';

/** @type {import('@emotion/cache').Options} */
export const cacheProps = {
	key: 'mui',
	prepend: true,
};

/** @type {import("@emotion/cache").EmotionCache | undefined} */
export let muiCache;

export const makeMuiCache = () => {
	if (!muiCache) {
	muiCache = createCache(cacheProps);
	}

	return muiCache;
};

---

./gatsby-srr.js:

import { CacheProvider } from '@emotion/react';
import createEmotionServer from '@emotion/server/create-instance';
import React from 'react';
import { renderToString } from 'react-dom/server';
import { getTssDefaultEmotionCache } from 'tss-react';

import { makeMuiCache } from './src/theme/cache';

/** @param {import('gatsby').ReplaceRendererArgs} args */
export const replaceRenderer = (args) => {
  const { bodyComponent, replaceBodyHTMLString, setHeadComponents } = args;

  const muiCache = makeMuiCache();
  const { extractCriticalToChunks } = createEmotionServer(muiCache);

  const emotionStyles = extractCriticalToChunks(
    renderToString(
      <CacheProvider value={muiCache}>{bodyComponent}</CacheProvider>
    )
  );

  const muiStyleTags = emotionStyles.styles.map((style) => {
    const { css, key, ids } = style || {};
    return (
      <style
        key={key}
        data-emotion={`${key} ${ids.join(` `)}`}
        dangerouslySetInnerHTML={{ __html: css }}
      />
    );
  });

  const tssCache = getTssDefaultEmotionCache();
  const { extractCritical } = createEmotionServer(tssCache);
  const { css, ids } = extractCritical(renderToString(bodyComponent));

  const tssStyleTag = (
    <style
      key="tss-styles"
      data-emotion={`css ${ids.join(' ')}`}
      dangerouslySetInnerHTML={{ __html: css }}
    />
  );

  const combinedStyleTags = [...muiStyleTags, tssStyleTag];
  setHeadComponents(combinedStyleTags);

  // render the result from `extractCritical`
  replaceBodyHTMLString(emotionStyles.html);
};

---

Don't forget to delete the Gatsby Material UI plugin if you were using it!

./gatsby-config.js:

module.exports = {
 /* Your site config here */
 plugins: [
   `gatsby-plugin-material-ui`, // <-- delete me!
	// ...rest plugins
 ],
 // ...rest config
};

---

And that's it 😄

Thanks again for the help!

[Deckstar]

Hey! Just wanted to say thanks a lot for the very quick help! :)

It took me a while but I finally solved the issue by combining the code snippet & blog post you posted with some code from the Gatsby Material UI plugin. Basically I had to copy paste most of that plugin into my own gatsby-ssr.js file.

I will try to post my full solution here this weekend and then I think we can close this issue 😄

[garronej]

Hi @Deckstar,

Maybe this can help:

import { getTssDefaultEmotionCache } from "tss-react";
const cache = getTssDefaultEmotionCache();

https://ntsim.uk/posts/how-to-add-vanilla-emotion-ssr-to-gatsby

Let me know if it help. Otherwise please share a sample project with me so I can test.

Best regards