Swizec Teller - a geek with a hatswizec.com

    Getting the CSS out of rendered React components

    Here's a fun problem for ya: How do you get the CSS from a rendered React component?

    Right-click, inspect element, see it in dev tools. D'oh πŸ™„

    What about programmatically?

    thinking giphy

    Turns out that's not so easy.

    You could, for example, try the window.getComputedStyle method. Same as that DevTools view with all the styles.

    But that's too much stuff. You get values for every CSS property that exists in the spec. πŸ˜…

    What else can you try?

    Well there's always the style prop. You could get its value and hope for the best.

    But that only works if you're actually using it. Most people these days do not. Sure it's plenty useful for one-off overrides, but when was the last time you saw a project that heavily relies on the style prop?

    Exactly. Not in a while.

    Most projects have settled on styled-components or CSS modules. That makes our job both easier and harder. 🀨

    Getting CSS from styled-components

    You can watch me figure this one out in a livestream πŸ‘‡

    I tried all of the above and then some. Here's the solution I came up with: πŸ‘¨β€πŸŽ¨ component-css-extractor. Open sourced for your ease of use 😊

    CodeSandbox to prove it works πŸ‘‡

    πŸ‘¨β€πŸŽ¨ component-css-extractor relies on the fact that both styled-components and CSS modules use class names.

    Each styled component that you write is assigned a unique class name. Rendered components get the class property, CSS rules go in a <style> tag in your header.

    We can combine those to get a clean set of CSS rules. Scoped to the target component with nothing extra to mess us up. πŸ‘Œ

    34 lines of prettified code in total πŸ‘‡

    Click through for source
    Click through for source

    As the comments say:

    1. Collect class names for entire subtree
    2. Use document.head.getElementsByTagName("style") to get all <style> tags
    3. Use the css module to parse collected CSS into a JavaScript object
    4. Filter rules that don't apply to our classes
    5. Stringify and return

    Works like a charm πŸ‘¨β€πŸŽ¨

    magic giphy

    Some caveats

    As always there are some limitations.

    First of all, this won't work on the server or during build time. Collecting <style> tags requires access to the DOM as it exists in the browser. You don't have that during server-side-rendering, I think.

    Fortunately you don't need πŸ‘¨β€πŸŽ¨ component-css-extractor on the server. Styled-components has a built-in way of extracting styles into a string for serving to the client.

    The built-in way doesn't work in the browser, hence why I went down this rabbit hole.

    Second of all, if you have global stylesheets in a .css file, πŸ‘¨β€πŸŽ¨ component-css-extractor won't pick those up. Makes the code simpler.

    Imagine having to parse all of CSS in all your stylesheets and figuring out what does and doesn't apply to a particular DOM node. Might as well build a browser rendering engine lol.

    Happy Monday, ~Swizec

    Did you enjoy this article?

    Published on June 3rd, 2019 in Front End, Technical

    Learned something new?
    Want to become an expert?

    Here's how it works πŸ‘‡

    Leave your email and I'll send you thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

    Join Swizec's Newsletter

    And get thoughtful letters πŸ’Œ on mindsets, tactics, and technical skills for your career. Real lessons from building production software. No bullshit.

    "Man, love your simple writing! Yours is the only newsletter I open and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. πŸ‘Œ"

    ~ Ashish Kumar

    Join over 14,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

    Have a burning question that you think I can answer?Β I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

    Ready to Stop copy pasting D3 examples and create data visualizations of your own? Β Learn how to build scalable dataviz components your whole team can understand with React for Data Visualization

    Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

    Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first πŸ’° on the side with ServerlessReact.Dev

    Want to brush up on your modern JavaScript syntax?Β Check out my interactive cheatsheet: es6cheatsheet.com

    By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❀️

    Created bySwizecwith ❀️