custom-elements-jsx

v2.0.1

Published

3 years ago

JSX-render for custom elements

Downloads

0High
0Medium
0Low

rid-32

jsx render custom elements

Custom elements JSX-render

Small library for creating HTMLElements from JSX markup. It is very useful inside of custom elements.

Here is an example of simple SPA created with this library: https://github.com/DenRostokin/learning-custom-elements

How to install

The required packages are @babel/plugin-syntax-jsx, @babel/plugin-transform-react-jsx and custom-elements-jsx:

$ npm install --save-dev @babel/plugin-syntax-jsx @babel/plugin-transform-react-jsx

$ npm install --save custom-elements-jsx

$ yarn add --dev @babel/plugin-syntax-jsx @babel/plugin-transform-react-jsx

$ yarn add custom-elements-jsx

First of all you need to config your .babelrc file like this:

// .babelrc
{
  "plugins": [
    "@babel/plugin-syntax-jsx",
    ["@babel/plugin-transform-react-jsx", { "pragma": "jsx" }]
  ]
}

Usage

Lets create our custom element:

import jsx, { Component } from "custom-elements-jsx";

class CustomElement extends Component {
  render() {
    const { children, age } = this.props;

    return (
      <div className="customElement-container">
        <h3>{`Hello, ${children}`}</h3>
        <h4>{`You are ${age} years old`}</h4>
      </div>
    );
  }
}

// Check that the element hasn't already been registered
if (!window.customElements.get("custom-element"))
  window.customElements.define("custom-element", CustomElement);

Remember that you must use dash in the custom elements names. https://developers.google.com/web/fundamentals/web-components/customelements

Now you can use this component inside of other custom elements or append it to the root element:

const element = <custom-element age={26}>Den</custom-element>;

const root = document.getElementById("root");

// the element is an instanse of the HTMLElement
root.appendChild(element);

Of cause element with id="root" should exist in your html-file:

<body>
  <div id="root"></div>

  <script src="script.js"></script>
  <body></body>
</body>

This is a React way when you have only one empty div-element and you render your app into it.

When you create a custom component first of all you go to the constructor of it. You should remember, that you don't have props inside of constructor method. If you want to do something before a first render you have to call special method, called componentDidCreate. This method will be called when component will be added into DOM tree, but before the render function.

After this method you are going to the render method. You can return such values as: HTMLElement, array of HTMLElements like children, fragment created by createFragmentWithChildren(), null, undefind or false.

Also you have 3 additional methods of component lifecycle: componentDidMount, componentDidUpdate, componentWillUnmount. Method componentDidMount will be called after the render method. Method componentWillUnmount will be called after removing custom element from a DOM tree.

You can update custom element content by using method update() without parameters.render method will be called inside of update and then will be called componentDidUpdate method.

Custom element inherited from a Component class has state property and setState function which set new state and call update method to update element content.

import jsx, { Component } from 'custom-elements-jsx'

class CustomElement extends Component {
  constructor() {
    this.state = { value: 1 }
  }

  incrementValue() {
    this.setState({ value: 2 })
  }

  render() {
    const { value } = this.state

    return (
      <div id="container">
        <h3>{value}</h3>
        <button onClick={this.incrementValue}>Increment!</button>
      </div>
    }
  }
}

By default all props that you specify to custom element will be passed inside of it. If you want to set some prop as attribute you need to specify catch prop:

const element = <custom-element id="hello" catch="id" />;

You can specify multiple props in the catch. You need to use array for this:

const element = (
  <custom-element id="hello" role="button" catch={["id", "role"]} />
);

Features

You can connect Redux to your custom element:

import jsx, { Component } from "custom-elements-jsx";
import { bindActionCreators } from "redux";

import store from "./store.js";
import * as actions from "./actions.js";

const mapState = state => ({
  value: state.value
});

const bindedActions = bindActionCreators(actions, store.dispatch);

class CustomElement extends Component {
  componentDidMount() {
    this.unsubscribe = store.subscribe(this.update);
  }

  componentWillUnmount() {
    this.unsubscribe();
  }

  render() {
    const { value } = mapState(store.getState());

    return <button onClick={bindedActions.incValue}>{value}</button>;
  }
}

You have to use store.getState() inside of render method to get new values from the store after updating.

Custom-elements-jsx allows you to use element <custom-fragment>. This element works like React.Fragment:

import jsx, { Component } from "custom-elements-jsx";

class ElementWithFragment extends Component {
  render() {
    return (
      <custom-fragment>
        <h1>Title</h1>
        <div>Simple block</div>
        <p>Empty paragraph</p>
      </custom-fragment>
    );
  }
}

if (!window.customElements.get("element-with-fragment"))
  window.customElements.define("element-with-fragment", ElementWithFragment);

document.body.appendChild(<element-with-fragment />);

After that you will get the markup like this:

<body>
  <element-with-fragment>
    <h1>Title</h1>
    <div>Simple block</div>
    <p>Empty paragraph</p>
  </element-with-fragment>
</body>

Also you can use fuction createFragmentWithChildren(children, props). This function receives array of children (each child must be an instanse of the HTMLElement) and props object and adds props into each child. Then it creates fragment using document.createDocumentFragment() function and fills the fragment by children with props.

import { createFragmentWithChildren } from "custom-elements-jsx";

const div = document.createElement("div");
const p = document.createElement("p");

const children = [div, p];

document.body.appendChild(createFragmentWithChildren(children));

This function can be usefull if you need to add props to the children inside your custom element:

import jsx, {
  Component,
  createFragmentWithChildren
} from "custom-elements-jsx";

class CustomChild extends Component {
  render() {
    const { name } = this.props;

    return <h1>{name}</h1>;
  }
}

if (!window.customElements.get("custom-child"))
  window.customElements.define("custom-child", CustomChild);

class CustomParent extends Component {
  render() {
    const name = "John";

    return createFragmentWithChildren(children, { name });
  }
}

if (!window.customElements.get("custom-parent"))
  window.customElements.define("custom-parent", CustomParent);

document.body.appendChild(
  <custom-parent>
    <custom-child />
    <custom-child />
  </custom-parent>
);

After that you will get the markup like this:

<body>
  <custom-parent>
    <custom-child><h1>John</h1></custom-child>
    <custom-child><h1>John</h1></custom-child>
  </custom-parent>
</body>

How to test

To test this library you need to install Chrome browser if you still dont have becausekarma` test runner needs it. Then you can run:

  npm install && npm run test

  yarn && yarn test

If you want to run tests in watch mode you need to use test:watch except test command.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Custom elements JSX-render

Contents

How to install

Usage

Features

How to test