Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-shadow

Package Overview
Dependencies
Maintainers
1
Versions
84
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-shadow

Utilise Shadow DOM in React with all the benefits of style encapsulation.

  • 1.1.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
70K
increased by113.77%
Maintainers
1
Weekly downloads
 
Created
Source
ReactShadow

Utilise Shadow DOM in React with all the benefits of style encapsulation.

Travis   License MIT   Experimental

  • npm: npm i react-shadow --save
  • Heroku: http://react-shadow.herokuapp.com/

Screenshot


Getting Started

By using ReactShadow you have all the benefits of Shadow DOM in React.

import ShadowDOM from 'react-shadow';

export default props => {

    return (
        <ShadowDOM include={['css/core/calendar.css', props.theme]}>
            <h1>Calendar for {props.date}</h1>
        </ShadowDOM>
    );

}

In the above example the h1 element will become the host element with a shadow boundary — and the two defined CSS documents will be fetched and appended.

Avoiding FOIC

As the CSS documents are being fetched over the network, the host element will have a className of resolving for you to avoid the dreaded FOIC. Once all of the documents have been attached the className will change to resolved.

Cached Documents

Where components share documents, only one instance will be fetched due to memoize of the fetchInclude function.

Inlining Styles

Instead of defining external CSS documents to fetch, you could choose to add all of the component's styles to the component itself by simply embedding a style node in your component. Naturally all styles added this way will be encapsulated within the shadow boundary.

export default props => {

    const styles = `:host { background-color: ${props.theme} }`;

    return (
        <ShadowDOM>
          <div>
            <h1>Calendar for {props.date}</h1>
            <style type="text/css">{styles}</style>
          </div>
        </ShadowDOM>
    );
}

It's worth noting that if you combine this approach with the loading of external CSS documents, you will have 2 style (or more) nodes in your component.

Keywords

FAQs

Package last updated on 03 Jan 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc