279ae19c7e
this updates some links to the docs site to their new location
99 lines
3.4 KiB
Markdown
99 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/zeit/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).
|
|
|
|
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](https://www.styled-components.com/docs/advanced#theming) for styled-components using NextJS custom [`<App>`](https://nextjs.org/docs/advanced-features/custom-app) component.
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com):
|
|
|
|
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/vercel/next.js/tree/canary/examples/with-styled-components)
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-styled-components with-styled-components-app
|
|
# or
|
|
yarn create next-app --example with-styled-components with-styled-components-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example:
|
|
|
|
```bash
|
|
curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-styled-components
|
|
cd with-styled-components
|
|
```
|
|
|
|
Install it and run:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
# or
|
|
yarn
|
|
yarn dev
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&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>
|