react-shadow-dom-retarget-events

What it does

Fixes events for react components rendered in a shadow dom.

Why

When you render a react component inside shadow dom events will not be dispatched to react. I.e. when a user clicks in your react component nothing happens. This happens (or does not happen) with any events.

A bug is filed at #10422.

How to fix it

Luckily someone wrote a workaround on Stack Overflow. It works by adding vanilla JS event listeners and dispatching events to React.

This repo is based on his answer in an npm module.

Installation

yarn add react-shadow-dom-retarget-events or

npm install react-shadow-dom-retarget-events --save

Usage

import retargetEvents and call it with the shadowRoot:

1import React from 'react';
2import retargetEvents from 'react-shadow-dom-retarget-events';
3
4class App extends React.Component {
5  render() {
6  	return <div onClick={() => alert('I have been clicked')}>Click me</div>;
7  }
8}
9
10const proto = Object.create(HTMLElement.prototype, {
11  attachedCallback: {
12    value: function() {
13      const mountPoint = document.createElement('span');
14      const shadowRoot = this.createShadowRoot();
15      shadowRoot.appendChild(mountPoint);
16      ReactDOM.render(<App/>, mountPoint);
17      retargetEvents(shadowRoot);
18    }
19  }
20});
21document.registerElement('my-custom-element', {prototype: proto});

History

• v1.08 Support for cancelBubble and FireFox's composedPath
• v1.07 Support for onBlur
• v1.06 Support von React 16, Added Events, Code Cleanup
• v1.05 Initial commits and basic functionality