yarn add styled-components@beta

What's Changed

• fix(types): allow interpolating false by @agriffis in https://github.com/styled-components/styled-components/pull/3799
• Disallow mix of $as and as by @agriffis in https://github.com/styled-components/styled-components/pull/3801
• chore: update typescript by @agriffis in https://github.com/styled-components/styled-components/pull/3803
• fix: typescript typo by @agriffis in https://github.com/styled-components/styled-components/pull/3804
• fix: css vars mangled by hyphenateStyleName by @agriffis in https://github.com/styled-components/styled-components/pull/3812
• collected fixes for v6 typescript by @agriffis in https://github.com/styled-components/styled-components/pull/3809
• chore: correctly link local styled-components to sandbox by @alexandernanberg in https://github.com/styled-components/styled-components/pull/3822

Breaking changes in v6 (as of this version)

• now using stylis v4 (if using stylis-plugin-rtl you'll need to upgrade to the newer version)
• dropped $as and $forwardedAs props (use as or forwardedAs)
• dropped automatic prop filtering, use transient props ($ prefix) for stuff you don't want to be passed to child component / HTML
• node >= 14 needed

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-beta.2...v6.0.0-beta.3

What's Changed

• Fix statement on Ukraine by @Fer0x in https://github.com/styled-components/styled-components/pull/3724
• Fix/nonce in ssr by @samimakicc in https://github.com/styled-components/styled-components/pull/3755

New Contributors

• @samimakicc made their first contribution in https://github.com/styled-components/styled-components/pull/3755

Full Changelog: https://github.com/styled-components/styled-components/compare/v5.3.5...v5.3.6

yarn add styled-components@beta

What's Changed

• breaking removed runtime prop validation functionality; use transient props for styling-only props or shouldForwardProp for more advanced scenarios
• only minify standalone prod build by @henryqdineen in https://github.com/styled-components/styled-components/pull/3796
• refactored component types to use a consolidated setup with a runtime switch (web | native) in the generic
• improve misc types
• smaller code size

Breaking changes in v6 (as of this version)

• now using stylis v4 (if using stylis-plugin-rtl you'll need to upgrade to the newer version)
• dropped automatic prop filtering, use transient props ($ prefix) for stuff you don't want to be passed to child component / HTML
• node >= 14 needed

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-beta.1...v6.0.0-beta.2

yarn add styled-components@beta

What's Changed

• Fix speedy rule insertion when css contains multiple rules by @janicduplessis in https://github.com/styled-components/styled-components/pull/3787
• performance optimizations
• smaller code size

Breaking changes in v6 (as of this version)

• now using stylis v4 (if using stylis-plugin-rtl you'll need to upgrade to the newer version)
• node >= 14 needed

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-beta.0...v6.0.0-beta.1

yarn add styled-components@beta

What's Changed

• refactor: conditionally use useInsertionEffect where available by @probablyup in https://github.com/styled-components/styled-components/pull/3726
• refactor: replace git.io within error message by @SukkaW in https://github.com/styled-components/styled-components/pull/3733
• fix: minor grammar mistakes in contribution guidelines by @imchell in https://github.com/styled-components/styled-components/pull/3771
• V6/fix newbie012 type regression by @probablyup in https://github.com/styled-components/styled-components/pull/3776
• chore: upgrade jest by @probablyup in https://github.com/styled-components/styled-components/pull/3778
• fixed bug #3793 and #3792 by @jasham in https://github.com/styled-components/styled-components/pull/3794
• updated a few dependencies
• removed react-primitives support
• update react-native component aliases to current stable list
• build size optimization (now 12.98kB)

Breaking changes in v6 (as of this version)

• now using stylis v4 (if using stylis-plugin-rtl you'll need to upgrade to the newer version)
• node >= 14 needed

New Contributors

• @SukkaW made their first contribution in https://github.com/styled-components/styled-components/pull/3733
• @imchell made their first contribution in https://github.com/styled-components/styled-components/pull/3771
• @jasham made their first contribution in https://github.com/styled-components/styled-components/pull/3794

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-alpha.5...v6.0.0-beta.0

• Fix types associated with styled-components/macros
• Add optional peer dependency for babel-plugin-styled-components (required for macros)

Updated sandbox for alpha: https://codesandbox.io/s/styled-components-v6-alpha-sandbox-05bod1?file=/src/App.tsx

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-alpha.4...v6.0.0-alpha.5

• Added type for CSSProp (this is in definitely typed but wasn't exposed by us)
• Exposed more base types

Recommended styled-components.d.ts setup for your project:

// create styled-components.d.ts in your project source
// if it isn't being picked up, check tsconfig compilerOptions.types
import type { CSSProp } from 'styled-components';
import Theme from './theme';

type ThemeType = typeof Theme;

declare module 'styled-components' {
  export interface DefaultTheme extends ThemeType {}
}

declare module 'react' {
  interface DOMAttributes<T> {
    css?: CSSProp;
  }
}

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-alpha.2...v6.0.0-alpha.4

Added "types" package.json fields for TS type acquistion.

Full Changelog: https://github.com/styled-components/styled-components/compare/v6.0.0-alpha.1...v6.0.0-alpha.2

Fixed the TS declarations not getting emitted correctly by rollup.

Full Changelog: https://github.com/styled-components/styled-components/compare/.v6.0.0-alpha.0...v6.0.0-alpha.1

After an epic amount of refactoring, I'm pleased to announce the first alpha of styled-components v6!

Highlights:

1. styled-components is now written in TypeScript and ships its own types
2. stylis v4
3. tons of bug fixes
4. node 14+ now required

Full Changelog: https://github.com/styled-components/styled-components/compare/v5.2.0...v6.0.0-alpha.0

What's Changed

• Backport #3568 (read from textContent rather than innerHTML during rehydrate) to v5 by @keeganstreet in https://github.com/styled-components/styled-components/pull/3591
• [v5] generate more complete sourcemaps by @henryqdineen in https://github.com/styled-components/styled-components/pull/3597

New Contributors

• @henryqdineen made their first contribution in https://github.com/styled-components/styled-components/pull/3597

Full Changelog: https://github.com/styled-components/styled-components/compare/v5.3.1...v5.3.3

• Make sure StyleSheetManager renders all styles in iframe / child windows (see #3159) thanks @eramdam!

• Rework how components self-reference in extension scenarios (see #3236); should fix a bunch of subtle bugs around patterns like & + &

• Fix keyframes not receiving a modified stylis instance when using something like stylis-plugin-rtl (see #3239)

• Big performance gain for components using style objects (see #3239)

• We no longer emit dynamic classNames for empty rulesets, so some className churn may occur in snapshots

• Preallocate global style placement to ensure cGS is consistently inserted at the top of the stylesheet; note that this is done in runtime order so, if you have multiple cGS that have overlapping styles, ensure they're defined in code in the sequence you would want them injected (see #3239)

• Add "engines" to package.json (currently set to Node 10, the oldest supported LTS distribution) (see #3201) thanks @MichaelDeBoey!

Finally, special thanks to @willheslam for testing and some last minute fixes on this release!

We are planning to release 5.2 on September 2/3, please help us test!

yarn add styled-components@test

• Preallocate global style placement to ensure cGS is consistently inserted at the top of the stylesheet; note that this is done in runtime order so, if you have multiple cGS that have overlapping styles, ensure they're defined in code in the sequence you would want them injected (see #3239)

  NOTE: This is a behavioral change and might require adjustment in your codebase if you have many createGlobalStyle components in use. We do not think it will affect the majority of projects other than fix existing bugs.

• createGlobalStyle is now React.StrictMode compliant

• Make sure StyleSheetManager renders all styles in iframe / child windows (see #3159) thanks @eramdam!

• Rework how components self-reference in extension scenarios (see #3236); should fix a bunch of subtle bugs around patterns like & + &

• Fix keyframes not receiving a modified stylis instance when using something like stylis-plugin-rtl (see #3239)

• Big performance gain for components using style objects (see #3239)

• We no longer emit dynamic classNames for empty rulesets, so some className churn may occur in snapshots

• Add "engines" to package.json (currently set to Node 10, the oldest supported LTS distribution) (see #3201) thanks @MichaelDeBoey!

New Functionality

• Implement shouldForwardProp API for native and primitive platforms, which was previously missing in [v5.1.0] (see #3093) This has been released under a patch bump instead of a minor, since it's only been missing from Native-support.

Bugfixes

• Added useTheme hook to named exports for react-primitives entrypoint (see #2982) thanks @jladuval!
• Escape every CSS ident character necessary when converting component display names to class names (see #3102) thanks @kripod!

New Functionality

• Add shouldForwardProp API (almost the same as emotion's, just a slightly different usage pattern); https://github.com/styled-components/styled-components/pull/3006

  Sometimes when composing multiple higher-order components together, it's possible to get into scenarios when multiple layers consume props by the same name. In the past we've introduced various workarounds for popular props like "as" but this power-user API allows for more granular customization of what props are passed down to descendant component children when using the styled() HOC wrapper.

  When combined with other APIs like .attrs() this becomes a very powerful constellation of abilities.

  Here's how you use it:

  const Comp = styled('div').withConfig({
    shouldForwardProp: (prop, defaultValidatorFn) => !['filterThis'].includes(prop),
  })`
    color: red;
  `;
  
  render(<Comp filterThis="abc" passThru="def" />);
  
  # Renders: <div className="[generated]" passThru="def"></div>

  The second argument defaultValidatorFn is what we use internally to validate props based on known HTML attributes. It's provided so you can filter exactly what props you don't wish to pass and then fall-back to the default filtering mechanism if desired.

  Other methods on the styled HOC like .attrs can be chained after withConfig(), and before opening your template literal:

  const Comp = styled('div').withConfig({
    shouldForwardProp: (prop, defaultValidatorFn) => !['filterThis'].includes(prop),
  }).attrs({ className: 'foo' })`
    color: red;
  `;
  
  render(<Comp filterThis="abc" passThru="def" />);
  
  # Renders: <div className="[generated] foo" passThru="def"></div>

  Thanks @stevesims and all that contributed!

• Add "transient props" API; https://github.com/styled-components/styled-components/pull/3052

  Think of transient props as a lightweight, but complementary API to shouldForwardProp. Because styled-components allows any kind of prop to be used for styling (a trait shared by most CSS-in-JS libraries, but not the third party library ecosystem in general), adding a filter for every possible prop you might use can get cumbersome.

  Transient props are a new pattern to pass props that are explicitly consumed only by styled components and are not meant to be passed down to deeper component layers. Here's how you use them:

  const Comp = styled.div`
    color: ${props => props.$fg || 'black'};
  `;
  
  render(<Comp $fg="red">I'm red!</Comp>);

  Note the dollar sign ($) prefix on the prop; this marks it as transient and styled-components knows not to add it to the rendered DOM element or pass it further down the component hierarchy.

Bugfixes

• Fix slow SSR Rehydration for malformed CSS and increase fault-tolerance (see #3018)

• Change isPlainObject (internal method) to support objects created in a different context (see #3068) thanks @keeganstreet!

• Add support for the <video disablePictureInPicture> (see #3058) thanks @egdbear!

It's finally here!!! 🚀See the migrating to v5 FAQ page for easy upgrade instructions!

Read the v5 release announcement!

TL;DR:

• 19% smaller bundle size
• 18% faster client-side mounting
• 17% faster updating of dynamic styles
• 45% faster server-side rendering
• RTL support

...and much more all, with no breaking changes!

NOTE: At this time we recommend not using @import inside of createGlobalStyle. We're working on better behavior for this functionality but it just doesn't really work at the moment and it's better if you just embed these imports in your HTML index file, etc.

Changes

• StyleSheetManager enhancements

  • you can now supply stylis plugins like stylis-plugin-rtl; <StyleSheetManager stylisPlugins={[]}>...</StyleSheetManager>
  • disableVendorPrefixes removes autoprefixing if you don't need legacy browser support; <StyleSheetManager disableVendorPrefixes>...</StyleSheetManager>
  • disableCSSOMInjection forces using the slower injection mode if other integrations in your runtime environment can't parse CSSOM-injected styles; <StyleSheetManager disableCSSOMInjection>...</StyleSheetManager>

• Removed the "subfunction" attrs syntax that was deprecated in v4

  styled.div.attrs({ role: p => p.onClick ? 'button' : '' })`
    color: red;
  `

  becomes

  styled.div.attrs(p => ({ role: p.onClick ? 'button' : '' }))`
    color: red;
  `

• Update css-to-react-native to v3.0.0 (#2811); the one breaking change noted is that unitless line height is no longer allowed when setting font properties

  • if you get a lot of warnings at dev time from not having units in your styles, this codemod is available to help expedite updates: https://github.com/styled-components/styled-components-native-code-mod thanks @jacobp100

• disallow /ad/i in generated class names (#2837); this change primarily helps to avoid some overly aggressive ad blockers that will mangle generated classnames containing the substring "ad"

• if you use styled-components from CDN, in v5 the "react-is" dependency was added (make sure you add this to your project)

This should be the last RC before general v5 release in a week or two!

NOTE: If you've been testing this stylisPlugins functionality with the stylis-rtl plugin, please switch from stylis-rtl to stylis-plugin-rtl.

• make useTheme cleaner (#2879) props @sayjeyhi
• unnecessary flattening and interleave of css without interpolations @vepor
• switch back to mainline hoist-non-react-statics (#2934) …
• use funding field instead of post install script (#2931) props @koba04
• fix usage of nested stylesheetmanagers in SSR
• expose version in API (#2888) props @jamesarmenta
• refactor stylis management (#2936)

Note: we've switched from canary to v5 as the target branch for the new release. It's basically the same, but fixed up so it'll merge cleanly onto master.

Changes from rc.1:

• fix a few missed cases where attrs were not preferred over props (d2f4509)
• remove the theme usage dev-time check (df36f93); this was done in master already, just forward-porting
• aggregate classNames passed via attrs (#2859, 12a9f3c)
• replace rehydration from CSSOM with progressive regex (#2872)

Changes from rc.0:

• Inline mixin-deep so it is transpiled consistently for IE

We're almost there! After several months of work (thank you beta testers!) this is the first v5 release candidate build.

Overall v5 changes:

• Major performance and bundle size improvements over v4, see the announcement blog for more details!

• StyleSheetManager enhancements

  • you can now supply stylis plugins like stylis-rtl; <StyleSheetManager stylisPlugins={[]}>...</StyleSheetManager>
  • disableVendorPrefixes removes autoprefixing if you don't need legacy browser support; <StyleSheetManager disableVendorPrefixes>...</StyleSheetManager>
  • disableCSSOMInjection forces using the slower injection mode if other integrations in your runtime environment can't parse CSSOM-injected styles; <StyleSheetManager disableCSSOMInjection>...</StyleSheetManager>

• Removed the "subfunction" attrs syntax that was deprecated in v4

  styled.div.attrs({ role: p => p.onClick ? 'button' : '' })`
    color: red;
  `

  becomes

  styled.div.attrs(p => ({ role: p.onClick ? 'button' : '' }))`
    color: red;
  `

Changes since the last beta:

• disallow /ad/i in generated class names (#2837); this change primarily helps to avoid some overly aggressive ad blockers that will mangle generated classnames containing the substring "ad"

• Update css-to-react-native to v3.0.0 (#2811); the one breaking change noted is that unitless line height is no longer allowed when setting font properties

  • if you get a lot of warnings at dev time from not having units in your styles, this codemod is available to help expedite updates: https://github.com/styled-components/styled-components-native-code-mod thanks @jacobp100

• replace merge-anything with mixin-deep (#2838); saving bytes, this is used when merging defaultProps for extended styled components

• shard createGlobalStyle by runtime instance (#2824); cGS is implemented such that it's really meant to be used as a singleton, but it's not uncommon for people to have multiple instances of the same cGS component on the page at once. This change ensures that as instances and mounted and removed the existing global styles don't get removed as well

• memoize theme (#2820); a minor performance tweak when ThemeProvider is given a reference-equal theme prop

• make ThemeProvider error straightforward (#2787); more obvious messaging that the theme prop is required when using ThemeProvider

This is the last minor release before v5, please start using the beta and give us feedback!

This is a minor release not a patch release due to this change: #2738. Apologies if this causes some code churn in your projects, it was a long-standing bug that needed fixing.

• Fix to use ownerDocument instead of global document, by @yamachig (see #2721)

• Backport fix for SSR classname mismatches in development mode for some environments like next.js (see #2701)

• Fix attrs not properly taking precedence over props

• Backport fix where classnames are composed in the wrong order if custom class names are passed in (see #2760)

• Fix add check for style tag detached - sheet in the style tag is null in this case, by @newying61 (see #2707)

• add lightweight dev warning when theme is consumed but not provided (#2655)

• fix component selectors + css prop usage (#2656)

5.0.0-beta.7 was unpublished due to a build error

• Revert #2586; breaks rehydration in dev for certain runtimes like next.js

We'll explore reintroducing it in v5 but better safe than sorry.

Major thanks to our wonderful contributors!

• Remove className usage checker dev utility due to excessive false-positive noise in certain runtime environments like next.js and the related warning suppression prop (see #2563).

• Attach displayName to forwardRef function as described in React docs (see #2508).

• Compatibility with react-native-web 0.11 (see #2453).

• Add stack trace to .attrs warning (see #2486).

• Fix functions as values for object literals. (see 2489)

• Remove validation in Babel macro, by @mAAdhaTTah (see #2427)

Thanks to our amazing contributors for leading the charge on this big minor release! Awesome perf stuff in there and QOL changes in preparation for v5.

• Reduced GC pressure when using component selector styles. (see #2424).

• Add svg tag marker to domElements.js (see #2389)

• Make the GlobalStyleComponent created by createGlobalStyle call the base constructor with props (see #2321).

• Move to Mono repository structure with lerna @imbhargav5 (see #2326)

• Expose StyleSheetContext and StyleSheetConsumer for you fancy babes doing wild stuff

• Filter suppressClassNameWarning to not to pass down to the wrapped components @taneba (see #2365)

• Fix an edge case where React would break streaming inside <textarea> elements, which have special child behavior and aren't a suitable place to inject a style tag (see #2413)

This is a rollup of the highlights of beta 0-11 for convenience. See the migration guide for easy updating steps and the beta announcement blog for our summary of v4's changes, thought process, etc.

New stuff

• Add babel macro for full-featured interop with create react app v2+, by @lucleray (see #2032)

• Expose ThemeConsumer component, context consumer render prop component from the React.createContext API if people are interested in using it rather than / in addition to the withTheme HOC, by @probablyup

• Add createGlobalStyle that returns a component which, when mounting, will apply global styles. This is a replacement for the injectGlobal API. It can be updated, replaced, removed, etc like any normal component and the global scope will update accordingly, by @JamieDixon @marionebl, @yjimk, and @imbhargav5 (see #1416)

  const GlobalStyles = createGlobalStyle`
    html {
      color: 'red';
    }
  `;
  
  // then put it in your React tree somewhere:
  // <GlobalStyles />

• Added a first-class API for rendering polymorphism via "as" prop. In most cases, this new prop will replace your need to use the .withComponent API. It allows you to control what underlying element or component is rendered at runtime, while not messing with the styles, by @probablyup (see #1962)

  import { Link } from 'react-router'
  
  const Component = styled.div`
    color: red;
  `
  
  // Examples
  <Component>Hello world!</Component>
  <Component as="span">Hello world!</Component>
  <Component as={Link} to="home">Hello world!</Component>

Breaking changes

• Fix how ampersand is handled in self-referential selector combinations, e.g. & + & (see #2071)

• Remove deprecated consolidateStreamedStyles API, by @probablyup (see #1906)

• Remove deprecated jsnext:main entry point from package.json, by @probablyup (see #1907)

• Remove deprecated .extend API, by @probablyup (see #1908)

• Migrate to new context API, by @alexandernanberg (see #1894)

• Remove TS typings; they are now to be found in DefinitelyTyped, by @probablyup. See https://github.com/styled-components/styled-components/issues/1778 for more information.

• Add new data-styled-version attribute to generated <style> tags to allow multiple versions of styled-components to function on the page at once without clobbering each other, by @probablyup

  It's still highly recommended to use aliasing via your bundler to dedupe libraries like styled-components and react.

• [Breaking change] Refactor keyframes helper, by @fer0x (see #1930).

  Keyframes is now implemented in a "lazy" manner: its styles will be injected with the render phase of components using them.

  keyframes no longer returns an animation name, instead it returns an object which has method .getName() for the purpose of getting the animation name.

• Migrate to use new React.forwardRef API, by @probablyup; note that this removes the innerRef API since it is no longer needed.

• Implement styled() wrapper folding. In a nutshell, when you nest styled wrappers (e.g. styled(styled.div)) the components are now folded such that only one is mounted that contains the merged styles of its ancestors. This is conceptually equivalent to the removed "extend" functionality, but without many of the downsides -- and it's automatic, by @probablyup (see #1962)

Developer experience improvements

• Add warning when component is not a styled component and cannot be referred via component selector, by @egdbear (see #2070)

  When using CRA v2, import styled components from styled-components/macro instead to gain all the benefits of our babel plugin.

• Add a warning when wrapping a React component with styled() and the className isn't used (meaning styling isn't applied), by @Fer0x (see #2073)

• Tweak the styled components base component naming to look nicer in DevTools, by @probablyup (see #2012)

• Beef up the error message that sometimes occurs when multiple versions of styled components are used together and the StyleSheet instance can't be found, by @probablyup (see #2012)

Misc

• Add enzymeFind test utility to easily grab instances of a styled-component from enyzme mounted testing scenarios, by @probablyup (see #2049)

  import { mount } from 'enzyme';
  import React from 'react';
  import styled from 'styled-components';
  import { enzymeFind } from 'styled-components/test-utils';
  
  const Thing = styled.div`
    color: red;
  `;
  
  const wrapper = mount(
    <div>
      <Thing isCool />
    </div>
  );
  
  const thing = enzymeFind(wrapper, Thing);
  
  // expect(thing.props()).toHaveProperty('isCool') etc

• Inline and optimize the static hoisting functionality to avoid a bundler bug and shed a bit of package weight, by @probablyup (see #2021

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Add warning when component is not a styled component and cannot be referred via component selector, by @egdbear (see #2070)

• Fix how ampersand is handled in self-referential selector combinations, e.g. & + & (see #2071)

• Add babel macro for full-featured interop with create react app v2+, by @lucleray (see #2032)

  When using CRA v2, import styled components from styled-components/macro instead to gain all the benefits of our babel plugin.

• Add a warning when wrapping a React component with styled() and the className isn't used (meaning styling isn't applied), by @Fer0x (see #2073)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Add support for as to be used with attrs for better polymorphism, by @imbhargav5 (see #2055)

• Fix withTheme HOC to use a theme defined in defaultProps of the wrapped component, by @theboyWhoCriedWoolf (see #2033)

• Add enzymeFind test utility to easily grab instances of a styled-component from enyzme mounted testing scenarios, by @probablyup (see #2049)

import { mount } from 'enzyme';
import React from 'react';
import styled from 'styled-components';
import { enzymeFind } from 'styled-components/test-utils';

const Thing = styled.div`
  color: red;
`;

const wrapper = mount(
  <div>
    <Thing isCool />
  </div>
);

const thing = enzymeFind(wrapper, Thing);

// expect(thing.props()).toHaveProperty('isCool') etc

• Revert change to use React.PureComponent; the ecosystem just isn't ready yet.

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Fix usage of keyframes with createGlobalStyle, by @probablyup (see #2029)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Inline and optimize the static hoisting functionality to avoid a bundler bug and shed a bit of package weight, by @probablyup (see #2021)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Revise createGlobalStyle HMR back to the original PR code without using componentDidMount, by @probablyup (see #2017)

• Some light refactoring to further reduce object allocations, by @probablyup (see #2016)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Fix a bug introduced from some refactoring that went into beta.5 around usage of keyframes with multiple interpolations, by @probablyup (see #2013)

• Tweak the styled components base component naming to look nicer in DevTools, by @probablyup (see #2012)

• Beef up the error message that sometimes occurs when multiple versions of styled components are used together and the StyleSheet instance can't be found, by @probablyup (see #2012)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Fix issue with createGlobalStyle and hot module reload, by @probablyup (see #2007)

• Remove keyframes factory function, by @probablyup (see #2006)

Blog post ・ Migration instructions

npm install --save styled-components@beta

Note: this beta has a lot of internal changes. If you notice anything funky, please let us know. All tests are passing, etc.

• Use PureComponent instead of Component for the StyledComponent base class, by @probablyup

• Internal refactoring to simplify the codebase and make it more readily DCE-able, by @probablyup

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Fix an issue when streaming with very large amounts of output where sometimes styles might not make it to the client, by @probablyup (see #1996)

• Fix the createGlobalStyle multiusage warning having false positives, by @probablyup (see #1993)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Expose ThemeConsumer component, the "consumer" render prop component from the React.createContext API if people are interested in using it rather than / in addition to the withTheme HOC, @probablyup

• Remove "no tags" experiment, by @probablyup (see #1987); if you are using the babel plugin, please make sure it's fully updated

• Fixed an issue with createGlobalStyle when the component was composed in multiple places and render of the subsequent component instance happened before unmount of the original; previously we removed styles immediately upon unmount of any instance without checking how many copies were still alive, by @probablyup (see #1989)

Blog post ・ Migration instructions

npm install --save styled-components@beta

• Fixed an issue where createGlobalStyle was clobbering the very next style to be applied during rehydration in production mode, by @probablyup (see #1976)

• Removed some unused code, by @probablyup (see #1976)

• Switched createGlobalStyle to be a PureComponent, by @probablyup (see #1976)

The first beta of v4 is here! 👏🥂

Blog post ・ Migration instructions

npm install --save styled-components@beta

There's a ton of new and exciting things in v4, along with breaking changes. See the full list below:

• Remove deprecated consolidateStreamedStyles API, by @probablyup (see #1906)

• Remove deprecated jsnext:main entry point from package.json, by @probablyup (see #1907)

• Remove deprecated .extend API, by @probablyup (see #1908)

• Migrate to new context API, by @alexandernanberg (see #1894)

• Remove TS typings; they are now to be found in DefinitelyTyped, by @probablyup. See https://github.com/styled-components/styled-components/issues/1778 for more information.

• Add new data-styled-version attribute to generated <style> tags to allow multiple versions of styled-components to function on the page at once without clobbering each other, by @probablyup

  It's still highly recommended to use aliasing via your bundler to dedupe libraries like styled-components and react.

• [Breaking change] Refactor keyframes helper, by @fer0x (see #1930).

  Keyframes is now implemented in a "lazy" manner: its styles will be injected with the render phase of components using them.

  keyframes no longer returns an animation name, instead it returns an object which has method .getName() for the purpose of getting the animation name.

• Add createGlobalStyle that returns a component which, when mounting, will apply global styles. This is a replacement for the injectGlobal API. It can be updated, replaced, removed, etc like any normal component and the global scope will update accordingly, by @JamieDixon @marionebl, @yjimk, and @imbhargav5 (see #1416)

  const GlobalStyles = createGlobalStyle`
    html {
      color: 'red';
    }
  `
  
  // then put it in your React tree somewhere:
  // <GlobalStyles />

• Migrate to use new React.forwardRef API, by @probablyup; note that this removes the innerRef API since it is no longer needed.

• Implement styled() wrapper folding. In a nutshell, when you nest styled wrappers (e.g. styled(styled.div)) the components are now folded such that only one is mounted that contains the merged styles of its ancestors. This is conceptually equivalent to the removed "extend" functionality, but without many of the downsides -- and it's automatic, by @probablyup (see #1962)

• Added a first-class API for rendering polymorphism via "as" prop. In most cases, this new prop will replace your need to use the .withComponent API. It allows you to control what underlying element or component is rendered at runtime, while not messing with the styles, by @probablyup (see #1962)

  import { Link } from 'react-router'
  
  const Component = styled.div`
    color: red;
  `
  
  // Examples
  <Component>Hello world!</Component>
  <Component as="span">Hello world!</Component>
  <Component as={Link} to="home">Hello world!</Component>

A note for preact users: if you are doing the preact-compat aliasing, it won't work with this beta because they haven't implemented React.createContext in preact-compat yet.

Lots of 🔥fixes in this release! As always, thank you contributors for your hard work 🙇

• Allow non-plain objects as ThemeProvider themes, by @phyllisstein (see #1780)

• [internal] Upgrade flow-bin to latest, by @halvves (see #1748)

• [internal] Update various CI bits, by @probablyup (see #1769)

• Reimplement SSR stream handling as a transform stream rather than a second-order readable stream, by @probablyup (see #1768)

• Allow React Component as attr, by @valerybugakov (see #1751)

• Added pointer events to valid attributes check, by @plankguy (see #1790)

Note: v3.3.1 was skipped due to a bad deploy.

The team is very excited to release v3.3.0, containing a number of important bugfixes and quality of life improvements to the library! This will probably be the last feature release before v4.0 (roadmap) this summer.

Thank you so much to all the people who contributed. styled-components is nothing without its community ❤️

• Fix off-by-one error in insertRuleHelpers.js, by @migueloller (see #1749)

• Add first-class support for objects, by @mxstbr (see #1732)

  const Component = styled.div({
    color: 'blue'
  })

• Fix typo in console warning about multiple instances, by @lucianbuzzo (see #1730)

• Make the multiple instance warning criteria a little more strict to avoid badgering people running unit tests, by @probablyup (see #1693)

• Fix React.createRef() values for innerRef being ignored in React Native, by @simonbuchan (see #1718)

• Hoist non-react static properties on wrapped classes, by @probablyup (see #1750)

• Support attributes prefixed by x-, by @mlecoq (see #1753)

The primary fix in this patch release was related to a misconfiguration in the stylis rule splitter which could cause some rules to be discarded when there was no whitespace around selector operands.

• Fix cascade: false being erroneously set on the Stylis rule splitter (see #1677)
• Fix typo in ComponentStyle.js comments (see #1678)
• Accept ref forwarding components in styled constructor (see #1658)
• Fix onInvalid check in validAttrs, by @slootsantos (see #1668)
• Fix makeSpeedyTag's css method (see #1663)
• Fix ComponentStyle caching strategy to take StyleSheet cache into account, by @darthtrevino (see #1634)
• Add new test-utils to simplify finding styled-components in the DOM in unit testing scenarios, by @jamiebuilds (see #1652)
• Add minified commonjs and esm builds for bundle size tracking (see #1681)

Make sure that you're installing v3.2.5 as v3.2.4 was missing some postinstall scripts for our OpenCollective message 😅

Deprecations

Preprocessing option in our babel plugin

The preprocess option was never here to stay and its experiment has essentially proven to be insufficient for our future goals. Check out Sweetsour/ISTF for our current effort of making styled-components more performant and adding a CSS pipeline to it: https://github.com/kitten/sweetsour

Thanks to @Samatar26 for his PR!

Changes

Add process.env.SC_ATTR to override our style tag's marker attribute

While we're figuring out how to improve our context-drive StyleSheetManager in a stable way that works with SSR and sharded stylesheets, we would still like to provide a way for you to use styled-components that enables widgets and other use-cases where it might be necessary to prevent us from destroying your stylesheet on pages.

Specifically this affects people who are building non-SSR code that runs on pages where styled-components is already in place. In these cases our SSR rehydration would go along and happily remove another module's style tags. We haven't considered this closely as it is not a good practice in our eyes to run duplicated styled-components modules in a single app. But when you're not dealing with a single app only it might make sense.

You can now change the the style tag's styled-components attribute by bundling with the SC_ATTR environment variable. Given a setup where you can set this variable, we will now inject style tags with a different attribute, so that they're not affected by the standard SSR rehydration.

Documentation will follow soon; Thanks to @Fer0x for this change!

Fixes

SSR memory leaks? No more!

This release simply frees up some memory by removing cloned StyleSheets when they're not needed anymore.

Fixes

SSR accumulating non-critical CSS

If you've noticed that v3.2 would cause your server-side rendered app to output all styles it knows of, you weren't alone!

The ServerTag was accidentally cloning itself incorrectly. This meant that the ServerStyleSheet would inherit the same server styles from the “master” StyleSheet.

We now clone the tag correctly and a test is in place to ensure this doesn't happen again, since this bug came up a couple of times in past v2 releases. Thanks to @DeividasK for reporting this bug!

Fix at-rules nested inside style rules

Have some styles gone missing? In the newer >=3.1 versions that introduced speedy mode (i.e. insertRule support) some rules might not have been injected properly. This came down to insertRule being more strict with what we add. In development an incorrectly formatted CSS rule might not cause much trouble, but in production insertRule complains about it.

Stylis, more specifically stylis-rule-sheet, was generating invalid CSS when at-rules were nested inside style rules. For instance the following CSS would cause trouble:

/* input */
&:hover {
  @media (min-width: 768px) { color: papayahwip; }
}

/* incorrect output */
@media (min-width: 768px) {
  &:hover { color: papayahwip; }
}}
/* ^ note the extra closing curly brace */

/* v3.2.2 fixed output */
@media (min-width: 768px) {
  &:hover { color: papayahwip; }
}

Fix imprecise IS_BROWSER detection

Before v3.2.2 we would check whether styled-components is running inside the browser using: typeof window !== 'undefined'. This proofed insufficient in a couple of special cases for some people, so we have now added 'HTMLElement' in window to this check.

Thanks to @danieldunderfelt for contributing this fix!

Fixes

Incorrect SSR React Element output

We accidentally removed dangerouslySetInnerHtml in our SSR output with just some children string. This would cause some characters to be encoded.

We have corrected this mistake and more unit tests are now in place to prevent this from happening again. Thanks to @misund for reporting this mistake!

Support out-of-order injection for @import at-rules

@import rules must appear at the top of style sheets (i.e tags).

In older versions we used to shard our style tags into local and global ones. Because any CSS that is being passed to us is also reordered, so that @import rules appear at the top, often this would mean that a lone injectGlobal would get away with @import rules.

This wasn't sufficient as using @import in a component (obviously unsupported and not recommended) or in another consecutive injectGlobal would cause this logic to break, since @import wouldn't appear at the top of the stylesheet anymore.

This oversight was made worse by the fact that we stopped sharding local and global style tags. This would mean that @import could now show up fairly late in a stylesheet, instead of at its top.

In this version we introduce a patch that creates an additional style tag at the top of all other ones that we create, when necessary, which is going to accept all @import rules separately. So when you use injectGlobal and pass it an @import rule, it will now be stripped out of the rest of your CSS, and put into a completely isolated style tag.

This is a small minor release that introduces a couple of minor changes, but also a complete rewrite of our StyleSheet implementation. Not only is it smaller, but it also lowers the barrier to entry for new contributors (like yourself, dear reader, hopefully!) to read and understand it, and eventually contribute great new features!

Deprecations

Stream reconciliation function consolidateStreamedStyles

If you’ve recently migrated to streamed server-side-rendered styles, then you will be familiar with our consolidateStreamedStyles function, which was an “extended rehydration” that moved all streamed styled-components style tags when called.

Due to our refactor of our StyleSheet behaviour (see below), our new rehydration implementation now takes care of this for you automatically.

This function will now output a deprecation warning when it’s being used and effectively does nothing at all. (Take a look at its source for more information)

Refactors

Rewrite and refactor StyleSheet and ServerStyleSheet

We now handle the style rules around a “style tag” based approach, which also means that our BrowserStyleSheet is a thing of the past. Depending on the environment, we will now switch between server, browser, and insertRule style tags, which all abstract their internal behaviour.

The concept of “local” vs “global” styles has been removed, in anticipation of some upcoming, future APIs, and our rehydration has been rewritten as well. You will see only a single style tag after rehydration, and now splits between style tags when injecting global styles as well. This is not a breaking change, but produces the same behaviour and specificity as it did before. (Change)

You will also notice a couple of improved and more detailed error messages—if you ever run into them that is—which will help you to understand some things that might go wrong more easily. (Change)

Style tags will now also be injected consecutively in the DOM. This means that styled-components won’t append them to the target, but will append them to its last style tag, if a first one was already injected. This should help you to predict the order of injection, when dealing with external CSS. (Change)

Misc.

• Replace murmurhash implementation and avoid destructuring tag function arguments (see #1516)

Added

StyleSheetManager target prop

You can now pass an element to a StyleSheetManager and all the components in its context below in the tree will add their styles to new tags in the specified target.

While this is not guaranteed to work with SSR yet, it can help you to easily add runtime-styles to a different part of the DOM. For example the shadow DOM.

Multiple instance of styled-components warning

Starting from this version, style-components will log a warning when multiple instances of it are being bundled and run on the same page. Due to our rehydration this can lead to errors, where one instance of styled-components will interfere with the other. This is why we have decided to add a small warning notifying you of this, since we don’t see the practice of adding multiple styled-components instances to a single page as a best practice.

Please note that this warning won’t show up, when older version of styled-components are present, as they don’t contain the code necessary to be detected.

StyleSheet.remove API (Internal)

This is an internal API that allows us to remove rules and components from our StyleSheets, which will come in handy for some new APIs for global styles quite soon.

Misc.

• Add controlsList to validAttr list (see #1537)
• Add foreignObject svg element (see #1544)

Fixes

Enable semicolon autocompletion in styles

We accidentally disabled semicolon autocompletion in stylis, which accidentally introduced an unnoticed breaking change in a past version a while back.

Semicolon autocompletion is now enabled and back again. Thanks to @Blasz for reporting this mistake!

Nested media queries in insertRule aka production mode

Our version of stylis-rule-sheet was updated which fixes nested media queries which can now be used as is expected in production. (see #1529 and #1528)

Misc.

• Remove type="text/css"-attribute from style tag to remove warnings from w3c validator (see #1551)

Thanks

Thanks to the numerous contributors and maintainers who have worked towards this release. We're sorry if some names are missing, so thanks additionally goes out to everyone who’s worked hard to get v3 out!

• @mdugue
• @jdrouet
• @marhalpert
• @pziemkowski
• @gribnoysup
• @marionebl
• @bteng22
• @paul-veevers

(In no particular order)

• Bugfix for the last style tag sometimes being emitted multiple times during streaming (see #1479)

• Bugfix for speedy mode rehydration and added handling for out-of-order style injection (see #1482)

NOTE: When calling consolidateStreamedStyles() after streaming, make sure it is called as early in the bundle as possible.

styled-components injects new CSS upon construction of new components not prerender, so consolidation must happen before any new CSS is injected on the page.

A quick bugfix release:

1. Apply a workaround to re-enable "speedy" mode for IE/Edge (see #1468)
2. Fix a memory leak in the server-side streaming logic (see #1475)

See the release blogpost for more details!

Added

Streaming server-side rendering support

React 16 introduced ReactDOMServer.renderToNodeStream, thanks to @probablyup styled-components now has full streaming server-side rendering support so you can take advantage of the faster Time-To-First-Byte! :tada:

See the documentation on the website for more information.

Much faster CSS injection in production

Thanks to @schwers we now use insertRule in production, which makes for much faster CSS injection. In benchmarks this change makes styled-components mount ~10x faster and re-render ~20x faster! :tada:

Note: Your app will probably not mount 10x faster, but we've seen Time-To-First-Interactive drop by a couple hundred milliseconds in production apps with this change!

This major release prepares some great features that are yet to come, so be ready for some new and exciting features soon! But for now please read on for what’s in the current (majorly awesome) release. :fire:

Breaking Changes

Shipping only flat bundles

Thanks to @Andarist we're now shipping flat bundles for each of our entries only. This means that the entire lib/ folder won’t be inside our npm package. While this might break a couple of third party libraries, it stands to reason that our internals should not have been exposed in this way before.

This new way of bundling not only makes it easier for us to perform some refactors quite soon, it also makes it easier for us to optimise our releases even more. Please check your codebases and libraries for usages of our internals and make sure not to rely on them. Open an issue please if you need help to migrate to v3.

There are bundles for Web, React Native, and React Primitives. The former two come with both ES Modules and CommonJS bundles. The Web bundle also comes with a minified bundle. We’re also now shipping source maps for each of these bundles.

Added styled.SafeAreaView and removed styled.Navigator for React Native

We’ve added the missing SafeAreaView shortcut to the native bundle, and removed the deprecated Navigator. Finally! The typings for TypeScript have been updated as well to reflect this breaking change. (see #1339)

Added

isStyledComponent utility

Because we’re now shipping flat bundles we also wanted to provide a frequently requested utility function that determines whether a given component is a StyledComponent. This utility returns a boolean telling you just that. (see #1418)

It should make it easier to determine whether to pass on innerRef or ref for instance in some cases, and should allow you to avoid accessing some of our internals or to check whether a component has styledComponentId set.

More information on this utility can be found on our website’s API reference section.

Improved React Native Importing

From time to time, it’s easy to forget to import styled-components/native instead on React Native. So now it’s possible to import just styled-components on React Native as well and Metro Bundler will automatically switch to the native bundle. This release also deprecates the old styled-components/native import, so make sure to migrate.

We also now log a warning when the web-version of styled-components is accidentally imported in React Native, so you can be sure that the right bundle is always being used. (see #1391 and #1394)

Deprecations

• As stated above, importing from styled-components/native is deprecated. Please switch to just styled-components.

Fixes

• innerRef could be undefined when using withTheme, which can lead to unexpected behaviour when spreading props or passing it on. (see #1414)
• Nested themes were not being republished correctly when the outer theme changes (see #1382)

Chores

• Add ESLint precommit hook, thanks to @lukebelliveau (see #1393)
• Remove trailing commas on function arguments (not compatible with ES5 JS engines)
• Upgrade test suites to run against react v16 (see #1426)
• Ship source maps for all bundles to make debugging easier (see #1425)

Thanks

Thanks to the numerous contributors and maintainers who have worked towards this release. We're sorry if some names are missing, so thanks additionally goes out to everyone who’s worked hard to get v3 out!

• @Andarist
• @lukebelliveau
• @BenLorantfy
• @tazsingh
• @gribnoysup
• @probablyup — Our new core contributor

(In no particular order)

More stable class names

• babel-plugin-styled-components@1.4.0
• styled-components@2.4.0

These tandem releases introduce a stabler algorithm for determining the unique hash of each component, which should lead to more consistent class names across environments. (both across dev/test/prod and across client/server when using SSR)

Big thanks to @probablyup, ref styled-components/styled-components#1381 and styled-components/babel-plugin-styled-components#112

Badge

There's now an official styled-components badge, thanks to @iRoachie (see #1363)! Throw that on all the projects you have that use styled-components:

[![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components)

Changes

Smaller bundle size

@probablyup spent some time removing our warning messages in production mode, reducing the library size by about half a kB min+gzip! (see #1365)

Fix unminified UMD bundle

It turns out our unminified UMD build contained some process.env declarations, which broke when used via a <script> tag in your HTML. This is now fixed, thanks to @maciej-ka! (see #1355)

Prettier

Our entire repo is now using Prettier, making it easy to stay consistent with our code style, thanks to @existentialism! (see #593)

Update contribution and community guidelines

We spent some time updating our contribution and community guidelines to encourage shallow contributions to ensure the longevity of this project and to remove the core team as bottlenecks from development. The TL;DR is this:

If your Pull Request is merged, regardless of content, you're eligible for push access to the organization on GitHub. This is checked for on pull request merges and an invite is sent automatically.

See our contributing.md for more information on Why and How we do this, and expect a blogpost about it in the near future too. Thanks to @orta, @alloy and @ashfurrow for encouraging and helping us to explore this way of managing open source.

Big changes

Easier contributing

Thanks to @gribnoysup we now have a sandbox for quickly testing changes in the library in a real app! (see #1257) To start contributing locally, run these commands locally and you're all set up:

# Clone the repo locally
git clone git@github.com:styled-components/styled-components.git
# Install the dependencies in the root folder
yarn install # or npm install
# Build the library
yarn run build # or npm run build
# Install the Sandbox app dependencies
cd sandbox
yarn install # or npm install
# Start the sandbox app!
yarn run start # or npm run start

Better support for innerRef when wrapping function components

Function components cannot have refs so our innerRef prop would break when used with withTheme:

Thanks to @MatthieuLemoine, rather than attaching a ref to stateless function components (which results in a warning) we now pass the innerRef prop to it directly for it to handle. (see #1205)

Smaller changes

• Consistently escape displayNames when creating componentId, thanks to @evan-scott-zocdoc (see #1313)
• Add basic support for style objects in the Typescript definitions, thanks to @nbostrom (see #1123)
• Better issue template (see #1342)

In this release we're fixing a little problem that'd occur when using styled-components using static styling in development together with react-hot-loader.

As hot loading updates the styles, the styled components wouldn't update as they initially judged their styles as being static. This behaviour is now being disabled in development.

We found a significant bug in styled-components for React Native, where components wouldn't update their styles even if they are being passed new props. 😿

If you're using React Native with styled-components v2.2.2, you probably already noticed this bug. Please update to v2.2.3.

• Fix incorrect StyledNativeComponent#componentWillReceiveProps implementation (see #1276)

Another quick release with lots of bug fixes! :tada:

• Prevent withTheme HOC from breaking when passing a theme from defaultProps, thanks to @kutyel (see #1130)
• Refactor out theme logic in StyledComponent's componentWillMount & componentWillReceiveProps (see #1130)
• Add onReset to valid react props list, thanks to @4urbanoff (see #1234)
• Add support for ServerStyleSheet PropType in both StyleSheetManager and StyledComponent, thanks to @digital-flowers (see #1245)
• Prevent component styles from being static if attrs are dynamic, thanks to @schwers (see #1219)
• Changed 'too many classes' error to recommend attrs for frequently changed styles, thanks to @lukebelliveau (see #1213)