react-shadow-root

react-shadow-root

Lets you add a shadow root to React components allowing you to use the shadow DOM. It also includes a StyleSlot component which allows users to easily, but not accidentally, override the styles in the shadow DOM of the component.

Installation

npm install --save react-shadow-root

Examples

https://apearce.github.io/react-shadow-root/

ShadowRoot

Usage

import React form 'react';
import ShadowRoot from 'react-shadow-root';

class ShadowCounter extends React.Component {
  state = { cnt: 0 };

  increment = () => {
    this.setState({
      cnt: this.state.cnt + 1
    });
  }

  render() {
    const style = `span {
      background-color: #333;
      border-radius: 3px;
      color: #fff;
      padding: 1px 5px;
    }
    button {
      background-color: #fff;
      border: 1px solid currentColor;
      border-radius: 3px;
      color: #333;
      cursor: pointer;
      outline: 0;
    }
    button:active {
      background-color: #333;
      color: #fff;
    }`;

    return (
      <div> // The shadow root will be attached to this DIV
        <ShadowRoot>
          <style>{style}</style>
          <span>{this.state.cnt}</span> <button onClick={this.increment}>Click Me</button>
        </ShadowRoot>
      </div>
    );
  }
}

When the shadow root is created on its parent element, all children are copied into the shadow DOM. Styles in the shadow DOM are automatically scoped. You can inspect the element to confirm. Slots work as expected; just be sure to add {this.props.children} after the closing ShadowRoot tag.

Props

Prop	Type	Values	Default	Description
delegatesFocus	Boolean	true or false	false	Expands the focus behavior of elements within the shadow DOM. Click here for more information.
mode	String	open or closed	closed	Sets the mode of the shadow root.

StyleSlot

Add a StyleSlot after the styles for your component. If a user passes a child style tag with the slot attribute set to the same name as the StyleSlot components name attribute, the styles will be merged in to the shadow DOM. Click here for more information.

Props

Prop	Type	Default	Description
name	String	styles	Sets the name of the slot.

Notes

• A minimum of React 16 is required
• Not all browsers support the shadow DOM. Click here for current browser support.
• Not all HTML elements support the shadow DOM. Click here for more information.
• It has been tested with the 'new' Context API and it worked fine. It has not been tested with the legacy API.