npm install. Only major versions have the potential to introduce breaking changes (noted in the following release notes).It's finally here!!! 🚀See the migrating to v5 FAQ page for easy upgrade instructions!
...and much more all, with no breaking changes!
Changes that happened since the initial announcement
StyleSheetManager enhancements
<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
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"
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.
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.
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:
Changes from rc.0:
mixin-deep so it is transpiled consistently for IEFix styled-components's react-native import for React Native Web, by @fiberjw (see #2797)
Remove dev-time warning if referencing a theme prop without an outer ThemeProvider, the check for it isn't smart enough to handle cases with "or" or ternary fallbacks and creates undesirable noise in various third party integrations
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
<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
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
useTheme() hook (https://github.com/styled-components/styled-components/pull/2765)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
remove the concept of foldedComponentIds (#2652); fixes an issue where if a folded component itself is used later in the component tree than the folding result it could lead to specificity clashes
bump too many classes warning back up to 200 (7af8e12bc32e44ea977e3e9fa6d45b6fdfd3a4e2)
revise & simplify how we determine the theme, fix createGlobalStyle HMR and behavior around defaultProps.theme (#2647)
switched from stylis to @emotion/stylis (#2640); mostly a bundle size win and a minor performance boost
removed "stylisOptions" prop from StyleSheetManager, but reimplemented the ability to remove vendor prefixes as "disableVendorPrefixes"
disable ComponentStyle staticness in non-production modes (#2634); should help fix some cases where className mismatches happen in runtimes like next.js dev mode
lower the threshold for the "too many classes" warning to 50 (#2622); the previous limit was 200, probably much too high
Fix babel macro with updated babel-plugin-styled-components (https://github.com/styled-components/styled-components/pull/2635)
Fix backward-compat issue with a way of doing SSR in v4 (https://github.com/styled-components/styled-components/pull/2639)
We'll explore reintroducing it in v5 but better safe than sorry.
Make it possible to initialize SC_ATTR and SC_DISABLE_SPEEDY via REACT_APP_* .env variables for easier integration with CRA applications (see #2501)
Fix components being folded inappropriately when an interim HOC is present (see #2586)
Fix theme prop for styled native components, also fixes theme in
defaultProps for them (see #2576)
Add "forwardedAs" prop to allow deeply passing a different "as" prop value to underlying components
when using styled() as a higher-order component (see #2580)
Implement defaultProps folding (see #2597)
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)
Under the hood code cleanup of the Babel macro, by @lucleray (see #2286)
Fix function-form attrs to receive the full execution context (including theme) (see #2210)
Adjust innerRef deprecation warning to not be fired if wrapping a custom component, since that underlying component may not be on forwardRef yet and actually using the prop (see #2211)
Expose the ThemeConsumer and ThemeContext exports for the native and primitives entries (see #2217)
Remove createGlobalStyle multimount warning; Concurrent and Strict modes intentionally render the same component multiple times, which causes this warning to be triggered always even when usage is correct in the application (see #2216)
Folded components are now targetable via component selector as in v3 if you used the old .extend API (see #2239)
Don't treat uppercased strings as tag-like components and don't filter out props from them (see #2225)
Performance optimization for fully static (no function interpolation) styled-components by avoiding using ThemeConsumer since it isn't necessary, by @mxstbr (see #2166)
Allow disabling "speedy" mode via global SC_DISABLE_SPEEDY variable, by @devrelm (see #2185)
To make use of this, you can either set SC_DISABLE_SPEEDY in your app's entry file or use something like webpack.DefinePlugin to do it at build time:
webpack.DefinePlugin({
SC_DISABLE_SPEEDY: true,
});Attrs can now be passed a function (see #2200); thanks @oliverlaz for providing an early PoC PR for this!
e.g.:
styled.div.attrs(props => ({ 'aria-title': props.title }))``;Fix the warnTooManyClasses dev helper not being totally dead code eliminated in production (see #2200)
Deprecate functions as object keys for object-form attrs (see #2200)
e.g.:
styled.div.attrs({ 'aria-title': props => props.title })``; // bad
styled.div.attrs(props => ({ 'aria-title': props.title }))``; // goodSupport for this will be removed in styled-components v5. The primary impetus behind this change is to eliminate confusion around basic functions vs styled-components vs React components provided as values in the object-form attrs constructor, each of which has different handling behaviors. The single outer function to receive the props and then return a props object is conceptually simpler.
The standalone CDN build is now UMD-compliant and can be used with RequireJS, etc.
Add pixels to unitless numbers when object interpolation is used, by @Fer0x (see #2173)
Trying to interpolate a non-styled component into CSS is now a hard error, rather than a warning (see #2173)
Interpolating a styled component into a string now returns the static component selector (emotion cross-compat)
import styled from 'styled-components';
const Comp = styled.div`
color: red;
`;
`${Comp}`; // .sc-hashAdd suppressClassNameWarning prop to disable warning when wrapping a React component with styled() and the className isn't used, by @Fer0x (see #2156)
Expose ThemeContext to enable static contextType support for React 16.6, by @imbhargav5 (see #2152)
Filter out invalid HTML attributes from attrs, by @Fer0x (see #2133)
Add warning if an attrs prop is a function that returns an element, by @timswalling (see #2162)
Add suppressMultiMountWarning prop to disable warning on multiple cgs mount, by @imbhargav5 (see #2107)
Fix self-reference replacement edge cases, by @probablyup (see #2109)