gatsby-plugin-styled-components

A Gatsby plugin for styled-components with built-in server-side rendering support.

Install

npm install gatsby-plugin-styled-components styled-components babel-plugin-styled-components

How to use

Edit gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-styled-components`,
      options: {
        // Add any options here
      },
    },
  ],
}

Options

You can pass options to the plugin, see the Styled Components docs for a full list of options.

For example, to disable the displayName option:

options: {
  displayName: false
}

Note: The ssr option will be ignored. Gatsby will apply it automatically when needed.

Disabling vendor prefixing

If you don't require vendor prefixes for adding legacy CSS properties then this can be disabled by supplying the disableVendorPrefixes option:

options: {
  disableVendorPrefixes: true
}

Changelog: gatsby-plugin-styled-components

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

6.14.0 (2024-11-06)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.13.1 (2024-01-23)

Note: Version bump only for package gatsby-plugin-styled-components

6.13.0 (2023-12-18)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.12.0 (2023-08-24)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.11.0 (2023-06-15)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.10.0 (2023-05-16)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.9.0 (2023-04-18)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.8.0 (2023-03-21)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.7.0 (2023-02-21)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.6.0 (2023-02-07)

🧾 Release notes

Bug Fixes

• update babel monorepo #37568 (13a0a9e)

6.5.0 (2023-01-24)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.4.0 (2023-01-10)

🧾 Release notes

Chores

• update babel monorepo #37386 (b941876)

6.3.0 (2022-12-13)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.2.0 (2022-11-25)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.1.0 (2022-11-22)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

6.0.0 (2022-11-08)

🧾 Release notes

Chores

• Update peerDeps #36965 (b624442)
• apply patches for v5 #36796 (25f79b6)

5.24.0 (2022-09-27)

🧾 Release notes

Chores

• allow react/react-dom@experimental #36533 (7ef4a3f)

5.23.0 (2022-09-13)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.22.0 (2022-08-30)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.21.0 (2022-08-16)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.20.0 (2022-08-02)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.19.0 (2022-07-19)

🧾 Release notes

Chores

• Update READMEs for better instructions (0890a5c)

5.18.0 (2022-07-05)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.17.0 (2022-06-21)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.16.0 (2022-06-07)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.15.0 (2022-05-24)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.14.0 (2022-05-10)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.13.0 (2022-04-26)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.12.1 (2022-04-13)

Note: Version bump only for package gatsby-plugin-styled-components

5.12.0 (2022-04-12)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.11.0 (2022-03-29)

🧾 Release notes

Bug Fixes

• compatibility with react rc 2 #35108 (0c61265)

5.10.0 (2022-03-16)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.9.0 (2022-03-01)

🧾 Release notes

Chores

• Format changelog files (088f23b)

5.8.0 (2022-02-22)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.7.0 (2022-02-08)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.6.0 (2022-01-25)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.5.0 (2022-01-11)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.4.0 (2021-12-14)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.3.0 (2021-12-01)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.2.0 (2021-11-16)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.1.0 (2021-11-02)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

5.0.0 (2021-10-21)

🧾 Release notes

Chores

• apply patches for v4 #33170 (f8c5141)

4.14.0 (2021-09-18)

🧾 Release notes

Features

• Add ability to disable vendor prefixes fixes #33147 (3d05986)

Chores

• update babel monorepo #32996 (048c7a7)

4.13.0 (2021-09-01)

🧾 Release notes

Chores

• re-generate changelogs #32886 (417df15)

4.12.0 (2021-08-18)

🧾 Release notes

Chores

• update babel monorepo #32564 (a554998)

4.11.0 (2021-08-04)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.10.0 (2021-07-20)

🧾 Release notes

Chores

• update babel monorepo #32238 (466d4c0)

4.9.0 (2021-07-07)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.8.0 (2021-06-23)

🧾 Release notes

Chores

• bump babel minor #31857 (7d42e8d)

4.7.1 (2021-06-10)

Chores

• bump babel minor #31857 #31859 (8636025)

4.7.0 (2021-06-09)

🧾 Release notes

Chores

• update babel monorepo #31143 (701ab2f)

4.6.0 (2021-05-25)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.5.0 (2021-05-12)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.4.0 (2021-04-28)

🧾 Release notes

Chores

• Remove breaking changes section #30806 #issuecomment-817204219 (7ebf454)

4.3.0 (2021-04-14)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.2.0 (2021-03-30)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.1.0 (2021-03-16)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

4.0.0 (2021-03-02)

🧾 Release notes

Bug Fixes

• Support topLevelImportPaths option #29544 (a6be92e)

Chores

• remove multiple h1s from official plugin docs #29465 (9428145)

Other Changes

• Move peerdeps to 16.9.0 & 17+ for react & react-dom #29735 (6b86b99)

3.10.0 (2021-02-02)

🧾 Release notes

Bug Fixes

• add namespace option #29095 (1a09302)

3.9.0 (2021-01-20)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

3.8.0 (2021-01-06)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

3.7.0 (2020-12-15)

🧾 Release notes

Chores

• update dependency cross-env to ^7.0.3 #28505 (a819b9b)

3.6.0 (2020-12-02)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

3.5.0 (2020-11-20)

🧾 Release notes

Chores

• update babel monorepo #27528 (539dbb0)

3.4.0 (2020-11-12)

🧾 Release notes

Note: Version bump only for package gatsby-plugin-styled-components

3.3.14 (2020-10-09)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.13 (2020-10-06)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.12 (2020-09-28)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.11 (2020-09-15)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.10 (2020-07-09)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.9 (2020-07-02)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.8 (2020-07-01)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.7 (2020-07-01)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.6 (2020-06-24)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.5 (2020-06-22)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.4 (2020-06-09)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.3 (2020-06-02)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.2 (2020-05-20)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.1 (2020-05-05)

Note: Version bump only for package gatsby-plugin-styled-components

3.3.0 (2020-04-27)

Note: Version bump only for package gatsby-plugin-styled-components

3.2.4 (2020-04-24)

Note: Version bump only for package gatsby-plugin-styled-components

3.2.3 (2020-04-17)

Bug Fixes

• wrap ignore pattern in quotes (#23176) (7563db6)

3.2.2 (2020-04-16)

Note: Version bump only for package gatsby-plugin-styled-components

3.2.1 (2020-03-23)

Note: Version bump only for package gatsby-plugin-styled-components

3.2.0 (2020-03-20)

Features

• gatsby: bump node min version to 10.13.0 (#22400) (83d681a)

3.1.21 (2020-03-16)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.20 (2020-03-06)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.19 (2020-02-01)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.18 (2020-01-21)

Bug Fixes

• blog: 307 redirect from https://www.styled-components.com (#20719) (175a731)

3.1.17 (2020-01-09)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.16 (2019-12-10)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.15 (2019-12-10)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.14 (2019-11-26)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.13 (2019-11-15)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.12 (2019-11-10)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.11 (2019-10-14)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.10 (2019-10-14)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.9 (2019-10-09)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.8 (2019-09-26)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.7 (2019-09-26)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.6 (2019-09-20)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.5 (2019-09-09)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.4 (2019-09-01)

Bug Fixes

• update minor updates in packages except react, babel and eslint (#17254) (252d867)

3.1.3 (2019-08-23)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.2 (2019-07-12)

Bug Fixes

• correct links in package changelogs (#15630) (d07b9dd)

3.1.1 (2019-07-11)

Note: Version bump only for package gatsby-plugin-styled-components

3.1.0 (2019-06-20)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.7 (2019-03-11)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.6 (2019-02-19)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.5 (2019-02-01)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.4 (2018-11-29)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.3 (2018-11-20)

Bug Fixes

• update peerDependency, plugins rely on extra arg being passed in API hooks (#10045) (83b7a18), closes /github.com/gatsbyjs/gatsby/pull/9943#issuecomment-440152666

3.0.2 (2018-11-15)

Bug Fixes

• gatsby-plugin-styled-components: fix global styles pollution (#9943) (a75c641), closes #9922

3.0.1 (2018-10-29)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0 (2018-09-17)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-rc.5 (2018-09-11)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-rc.4 (2018-09-11)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-rc.3 (2018-09-11)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-rc.2 (2018-09-11)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-rc.1 (2018-08-29)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-rc.0 (2018-08-21)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-beta.4 (2018-08-16)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-beta.3 (2018-07-21)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-beta.2 (2018-06-20)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-beta.1 (2018-06-17)

Note: Version bump only for package gatsby-plugin-styled-components

3.0.0-beta.0 (2018-06-17)

Note: Version bump only for package gatsby-plugin-styled-components