4466ba436b
## Description This PR ensures that the default prettier config is used for examples and templates. This config is compatible with `prettier@3` as well (upgrading prettier is bigger change that can be a future PR). ## Changes - Updated `.prettierrc.json` in root with `"trailingComma": "es5"` (will be needed upgrading to prettier@3) - Added `examples/.prettierrc.json` with default config (this will change every example) - Added `packages/create-next-app/templates/.prettierrc.json` with default config (this will change every template) ## Related - Fixes #54402 - Closes #54409
86 lines
3.4 KiB
Markdown
86 lines
3.4 KiB
Markdown
# Example app with styled-components
|
|
|
|
This example features how you use a different styling solution than [styled-jsx](https://github.com/vercel/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](https://github.com/styled-components/styled-components).
|
|
|
|
This example uses the Rust-based [SWC](https://nextjs.org/docs/advanced-features/compiler#styled-components) in Next.js for better performance than Babel.
|
|
|
|
Currently, only the `ssr` and `displayName` transforms have been implemented. These two transforms are the main requirement for using `styled-components` in Next.js.
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-styled-components)
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-styled-components&project-name=with-styled-components&repository-name=with-styled-components)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-styled-components with-styled-components-app
|
|
```
|
|
|
|
```bash
|
|
yarn create next-app --example with-styled-components with-styled-components-app
|
|
```
|
|
|
|
```bash
|
|
pnpm create next-app --example with-styled-components with-styled-components-app
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|
|
|
|
### Try it on CodeSandbox
|
|
|
|
[Open this example on CodeSandbox](https://codesandbox.io/s/github/vercel/next.js/tree/canary/examples/with-styled-components)
|
|
|
|
### Notes
|
|
|
|
When wrapping a [Link](https://nextjs.org/docs/api-reference/next/link) from `next/link` within a styled-component, the [as](https://styled-components.com/docs/api#as-polymorphic-prop) prop provided by `styled` will collide with the Link's `as` prop and cause styled-components to throw an `Invalid tag` error. To avoid this, you can either use the recommended [forwardedAs](https://styled-components.com/docs/api#forwardedas-prop) prop from styled-components or use a different named prop to pass to a `styled` Link.
|
|
|
|
<details>
|
|
<summary>Click to expand workaround example</summary>
|
|
<br />
|
|
|
|
**components/StyledLink.js**
|
|
|
|
```javascript
|
|
import Link from "next/link";
|
|
import styled from "styled-components";
|
|
|
|
const StyledLink = ({ as, children, className, href }) => (
|
|
<Link href={href} as={as} passHref>
|
|
<a className={className}>{children}</a>
|
|
</Link>
|
|
);
|
|
|
|
export default styled(StyledLink)`
|
|
color: #0075e0;
|
|
text-decoration: none;
|
|
transition: all 0.2s ease-in-out;
|
|
|
|
&:hover {
|
|
color: #40a9ff;
|
|
}
|
|
|
|
&:focus {
|
|
color: #40a9ff;
|
|
outline: none;
|
|
border: 0;
|
|
}
|
|
`;
|
|
```
|
|
|
|
**pages/index.js**
|
|
|
|
```javascript
|
|
import StyledLink from "../components/StyledLink";
|
|
|
|
export default () => (
|
|
<StyledLink href="/post/[pid]" forwardedAs="/post/abc">
|
|
First post
|
|
</StyledLink>
|
|
);
|
|
```
|
|
|
|
</details>
|