├── .gitignore
├── README.md
├── package.json
├── public
├── favicon.ico
├── index.html
└── manifest.json
└── src
├── App.css
├── App.js
├── App.test.js
├── index.css
├── index.js
├── logo.svg
├── registerServiceWorker.js
└── utils
└── webcomponent.js
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/ignore-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 |
6 | # testing
7 | /coverage
8 |
9 | # production
10 | /build
11 |
12 | /public/molecule-moljs
13 |
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 |
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Stencil components in React
2 |
3 | [Stencil](https://stenciljs.com/) is not a JS framework. It is a compiler that produces a reusable web component that can be embedded anywhere else.
4 |
5 | This is a step by step guide to consume a non-trivial stencil component in a [React](https://reactjs.org/) app.
6 |
7 | The starter react app was created with [create-react-app](https://github.com/facebook/create-react-app).
8 |
9 | ## Similar guides
10 | - [Stencil components in Vue](https://github.com/alesgenova/stenciljs-in-vue.git)
11 | - [Stencil components in Angular](https://github.com/alesgenova/stenciljs-in-angular.git)
12 |
13 | ## Table of contents
14 | - [Add the component(s) to the dependencies](#1-add-the-components-to-the-dependencies)
15 | - [Import the component](#2-import-the-components)
16 | - [Consume the component](#3-consume-the-component)
17 | - [Appendix: Attribute vs Prop](#appendix-attribute-vs-prop)
18 |
19 |
20 | ## 0: Build a stenciljs component and publish it to npm
21 | Creating your first stencil component is very easy and it is well documented [here](https://stenciljs.com/docs/my-first-component).
22 |
23 | This example will consume two components:
24 | - [@openchemistry/molecule-vtkjs](https://github.com/OpenChemistry/oc-web-components/tree/master/packages/molecule-vtkjs) : To display molecular structures
25 | - [split-me](https://github.com/alesgenova/split-me) : To create resizable split layouts
26 |
27 |
28 | ## 1: Add the component(s) to the dependencies
29 |
30 | Add the component to the app dependencies in `package.json`
31 |
32 | ```json
33 | // package.json
34 |
35 | "dependencies": {
36 | ...
37 | "@openchemistry/molecule-vtkjs": "^0.3.2",
38 | "split-me": "^1.1.4"
39 | }
40 | ```
41 |
42 | ## 2: Import the component(s)
43 | Import the component in the `index.js` of the app:
44 | ```js
45 | import { defineCustomElements as defineMolecule } from '@openchemistry/molecule-vtkjs/dist/loader';
46 | import { defineCustomElements as defineSplitMe } from 'split-me/dist/loader';
47 |
48 | defineMolecule(window);
49 | defineSplitMe(window);
50 | ```
51 |
52 | ## 3: Consume the component
53 | It is now possible to use the tag provided by the stencil component in the `render` function of any react component.
54 |
55 | ```jsx
56 | render() {
57 | return (
58 |
59 |
60 |
61 |
62 | )
63 | }
64 | ```
65 |
66 | ## Appendix: Attribute vs Prop
67 | `oc-molecule-vtkjs` has a property named `cjson` that expects an object (or a JSON.stringified object).
68 |
69 | Strings and numbers can be passed directly as attributes to a stencil component.
70 |
71 | One way to pass a complex object to a component could be to `JSON.stringify()` the object and then `JSON.parse()` it inside the component. But this round trip can be expensive, and it would be a good idea to pass the object directly as a prop.
72 |
73 | React doesn't provide a convenient way to distinguish between attribute and prop, so a little work is needed to achieve this.
74 |
75 | It just boils down to saving a reference to the element of the stencil component, and then set the property directly in the javascript code.
76 |
77 | To make this operation easier, it can be convenient to create a reusable utility function [`wc`](https://github.com/ionic-team/ionic-react-conference-app/blob/master/src/utils/stencil.js).
78 |
79 | ```js
80 | export function wc(customEvents = {}, props = {}) {
81 | let storedEl;
82 |
83 | return function (el) {
84 | for (let name in customEvents) {
85 | let value = customEvents[name] ;
86 | // If we have an element then add event listeners
87 | // otherwise remove the event listener
88 | const action = (el) ? el.addEventListener : storedEl.removeEventListener;
89 | if (typeof value === 'function') {
90 | action(name, value);
91 | return;
92 | }
93 | }
94 |
95 | // If we have an element then set props
96 | if (el) {
97 | for (let name in props) {
98 | let value = props[name] ;
99 | el[name] = value;
100 | }
101 | }
102 | storedEl = el;
103 | };
104 | }
105 | ```
106 |
107 | And then use it in the `jsx` to bind events and properties to the webcomponent this way:
108 | ```jsx
109 | import React, { Component } from 'react';
110 | import { wc } from './utils/webcomponent';
111 |
112 | class SomeComponent extends Component {
113 |
114 | render() {
115 | return (
116 |
43 | );
44 | }
45 |
46 | }
47 |
48 | export default App;
49 |
--------------------------------------------------------------------------------
/src/App.test.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import ReactDOM from 'react-dom';
3 | import App from './App';
4 |
5 | it('renders without crashing', () => {
6 | const div = document.createElement('div');
7 | ReactDOM.render(, div);
8 | ReactDOM.unmountComponentAtNode(div);
9 | });
10 |
--------------------------------------------------------------------------------
/src/index.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 0;
3 | padding: 0;
4 | font-family: sans-serif;
5 | }
6 |
--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import ReactDOM from 'react-dom';
3 | import './index.css';
4 | import App from './App';
5 | import registerServiceWorker from './registerServiceWorker';
6 |
7 | import { defineCustomElements as defineMolecule } from '@openchemistry/molecule-vtkjs/dist/loader';
8 | import { defineCustomElements as defineSplitMe } from 'split-me/dist/loader';
9 |
10 | ReactDOM.render(, document.getElementById('root'));
11 | registerServiceWorker();
12 |
13 | defineMolecule(window);
14 | defineSplitMe(window);
15 |
--------------------------------------------------------------------------------
/src/logo.svg:
--------------------------------------------------------------------------------
1 |
8 |
--------------------------------------------------------------------------------
/src/registerServiceWorker.js:
--------------------------------------------------------------------------------
1 | // In production, we register a service worker to serve assets from local cache.
2 |
3 | // This lets the app load faster on subsequent visits in production, and gives
4 | // it offline capabilities. However, it also means that developers (and users)
5 | // will only see deployed updates on the "N+1" visit to a page, since previously
6 | // cached resources are updated in the background.
7 |
8 | // To learn more about the benefits of this model, read https://goo.gl/KwvDNy.
9 | // This link also includes instructions on opting out of this behavior.
10 |
11 | const isLocalhost = Boolean(
12 | window.location.hostname === 'localhost' ||
13 | // [::1] is the IPv6 localhost address.
14 | window.location.hostname === '[::1]' ||
15 | // 127.0.0.1/8 is considered localhost for IPv4.
16 | window.location.hostname.match(
17 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
18 | )
19 | );
20 |
21 | export default function register() {
22 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
23 | // The URL constructor is available in all browsers that support SW.
24 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location);
25 | if (publicUrl.origin !== window.location.origin) {
26 | // Our service worker won't work if PUBLIC_URL is on a different origin
27 | // from what our page is served on. This might happen if a CDN is used to
28 | // serve assets; see https://github.com/facebookincubator/create-react-app/issues/2374
29 | return;
30 | }
31 |
32 | window.addEventListener('load', () => {
33 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
34 |
35 | if (isLocalhost) {
36 | // This is running on localhost. Lets check if a service worker still exists or not.
37 | checkValidServiceWorker(swUrl);
38 |
39 | // Add some additional logging to localhost, pointing developers to the
40 | // service worker/PWA documentation.
41 | navigator.serviceWorker.ready.then(() => {
42 | console.log(
43 | 'This web app is being served cache-first by a service ' +
44 | 'worker. To learn more, visit https://goo.gl/SC7cgQ'
45 | );
46 | });
47 | } else {
48 | // Is not local host. Just register service worker
49 | registerValidSW(swUrl);
50 | }
51 | });
52 | }
53 | }
54 |
55 | function registerValidSW(swUrl) {
56 | navigator.serviceWorker
57 | .register(swUrl)
58 | .then(registration => {
59 | registration.onupdatefound = () => {
60 | const installingWorker = registration.installing;
61 | installingWorker.onstatechange = () => {
62 | if (installingWorker.state === 'installed') {
63 | if (navigator.serviceWorker.controller) {
64 | // At this point, the old content will have been purged and
65 | // the fresh content will have been added to the cache.
66 | // It's the perfect time to display a "New content is
67 | // available; please refresh." message in your web app.
68 | console.log('New content is available; please refresh.');
69 | } else {
70 | // At this point, everything has been precached.
71 | // It's the perfect time to display a
72 | // "Content is cached for offline use." message.
73 | console.log('Content is cached for offline use.');
74 | }
75 | }
76 | };
77 | };
78 | })
79 | .catch(error => {
80 | console.error('Error during service worker registration:', error);
81 | });
82 | }
83 |
84 | function checkValidServiceWorker(swUrl) {
85 | // Check if the service worker can be found. If it can't reload the page.
86 | fetch(swUrl)
87 | .then(response => {
88 | // Ensure service worker exists, and that we really are getting a JS file.
89 | if (
90 | response.status === 404 ||
91 | response.headers.get('content-type').indexOf('javascript') === -1
92 | ) {
93 | // No service worker found. Probably a different app. Reload the page.
94 | navigator.serviceWorker.ready.then(registration => {
95 | registration.unregister().then(() => {
96 | window.location.reload();
97 | });
98 | });
99 | } else {
100 | // Service worker found. Proceed as normal.
101 | registerValidSW(swUrl);
102 | }
103 | })
104 | .catch(() => {
105 | console.log(
106 | 'No internet connection found. App is running in offline mode.'
107 | );
108 | });
109 | }
110 |
111 | export function unregister() {
112 | if ('serviceWorker' in navigator) {
113 | navigator.serviceWorker.ready.then(registration => {
114 | registration.unregister();
115 | });
116 | }
117 | }
118 |
--------------------------------------------------------------------------------
/src/utils/webcomponent.js:
--------------------------------------------------------------------------------
1 | /***
2 | Taken from: https://github.com/ionic-team/ionic-react-conference-app/blob/master/src/utils/stencil.js
3 |
4 | This function is meant to make it easier to use Props and Custom Events with Custom
5 | Elements in React.
6 | props.updateFavoriteFilter(e.target.value)}
9 | >
10 |
11 | <<< SHOULD BE WRITTEN AS >>>
12 | props.updateFavoriteFilter(e.target.value)
16 | })}
17 | >
18 |
19 | ***/
20 |
21 | export function wc(customEvents = {}, props = {}) {
22 | let storedEl;
23 |
24 | return function (el) {
25 | for (let name in customEvents) {
26 | let value = customEvents[name] ;
27 | // If we have an element then add event listeners
28 | // otherwise remove the event listener
29 | const action = (el) ? el.addEventListener : storedEl.removeEventListener;
30 | if (typeof value === 'function') {
31 | action(name, value);
32 | return;
33 | }
34 | }
35 |
36 | // If we have an element then set props
37 | if (el) {
38 | for (let name in props) {
39 | let value = props[name] ;
40 | el[name] = value;
41 | }
42 | }
43 | storedEl = el;
44 | };
45 | }
46 |
--------------------------------------------------------------------------------