rsnext/examples/with-styled-components-babel
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
pages docs: add missing AppProps import (#43136) 2022-11-22 14:33:29 +01:00
.babelrc [examples] Update styled-components to use SWC (#34770) 2022-03-02 03:43:34 +01:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
package.json fix(examples/with-styled-components-babel): list should have unique key (#40215) 2022-09-05 14:35:13 +00:00
README.md chore: NextJS -> Next.js (#55961) 2023-09-25 14:53:11 +00:00
tsconfig.json [examples] Update styled-components with Babel - add types (#36125) 2022-04-27 12:43:06 +00:00

Example app with styled-components using babel

This example features how you use a different styling solution than styled-jsx that also supports universal styles. That means we can serve the required styles for the first render within the HTML and then load the rest in the client. In this case we are using styled-components.

For this purpose we are extending the <Document /> and injecting the server side rendered styles into the <head>, and also adding the babel-plugin-styled-components (which is required for server side rendering). Additionally we set up a global theme for styled-components using Next.js custom <App> component.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-styled-components-babel with-styled-components-babel-app
yarn create next-app --example with-styled-components-babel with-styled-components-babel-app
pnpm create next-app --example with-styled-components-babel with-styled-components-babel-app

Deploy it to the cloud with Vercel (Documentation).