Giter Club home page Giter Club logo

react-shadow-root's Introduction

react-shadow-root

Lets you add a shadow root to React components allowing you to use the shadow DOM. This provides scoped CSS and includes support for constructable stylesheets.

Installation

npm install --save react-shadow-root

Examples

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

ReactShadowRoot

Usage

import React form 'react';
import ReactShadowRoot 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 */}
        <ReactShadowRoot>
          <style>{style}</style>
          <span>{this.state.cnt}</span> <button onClick={this.increment}>Click Me</button>
        </ReactShadowRoot>
      </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 ReactShadowRoot tag.

Static Properties

Name Description
constructableStylesheetsSupported A boolean telling you if constructable stylesheets are supported by the browser.
constructibleStylesheetsSupported An alias of constructableStylesheetsSupported using the 'correct' spelling.
shadowRootSupported A boolean telling you if attaching a shadow root is supported by the browser, not the element.

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 open Sets the mode of the shadow root.
stylesheets Array arrayOf(CSSStyleSheet) optional Takes an array of CSSStyleSheet objects for constructable stylesheets.

Notes

  • A minimum of React 16 is required.
  • Works in all modern browsers except non-Chromium Edge. Click here for current browser support.
  • Not all HTML elements allow you to attach a shadow root. Click here for more information.
  • It has been tested with the Context API introduced in React 16.3.0 and it worked fine. It has not been tested with the previous API.

react-shadow-root's People

Contributors

apearce avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.