@wordpress/element

What is @wordpress/element?

@wordpress/element is a package that provides utilities for working with React elements in the context of WordPress. It is essentially a thin abstraction layer over React, tailored to integrate seamlessly with the WordPress ecosystem.

What are @wordpress/element's main functionalities?

Creating Elements

This feature allows you to create React elements using the `createElement` function, which is similar to React's `React.createElement`.

const { createElement } = require('@wordpress/element');
const element = createElement('div', { className: 'my-class' }, 'Hello World');

Component Class

You can define class components using the `Component` class provided by @wordpress/element, similar to React's `React.Component`.

const { Component } = require('@wordpress/element');
class MyComponent extends Component {
  render() {
    return createElement('div', null, 'Hello from MyComponent');
  }
}

Hooks

The package supports React hooks like `useState`, allowing you to manage state in functional components.

const { useState } = require('@wordpress/element');
function MyFunctionalComponent() {
  const [count, setCount] = useState(0);
  return createElement('button', { onClick: () => setCount(count + 1) }, `Count: ${count}`);
}

Other packages similar to @wordpress/element

react

React is a JavaScript library for building user interfaces. It is the core library that @wordpress/element is built upon. While @wordpress/element provides a WordPress-specific abstraction, React is more general-purpose and widely used across various web applications.

preact

Preact is a fast 3kB alternative to React with the same modern API. It is designed to be a lightweight replacement for React, offering similar functionalities but with a smaller footprint. Unlike @wordpress/element, Preact is not tailored specifically for WordPress.

inferno

Inferno is an insanely fast, React-like library for building high-performance user interfaces on both the client and server. It aims to provide a similar API to React but with a focus on performance. Like Preact, it is not WordPress-specific.

README

@wordpress/element

Element is, quite simply, an abstraction layer atop React.

You may find yourself asking, "Why an abstraction layer?". For a few reasons:

• In many applications, especially those extended by a rich plugin ecosystem as is the case with WordPress, it's wise to create interfaces to underlying third-party code. The thinking is that if ever a need arises to change or even replace the underlying implementation, it can be done without catastrophic rippling effects to dependent code, so long as the interface stays the same.
• It provides a mechanism to shield implementers by omitting features with uncertain futures (createClass, PropTypes).
• It helps avoid incompatibilities between versions by ensuring that every plugin operates on a single centralized version of the code.

On the wp.element global object, you will find the following, ordered roughly by the likelihood you'll encounter it in your code:

• createElement
• render

Installation

Install the module

npm install @wordpress/element --save

Usage

Let's render a customized greeting into an empty element:

<div id="greeting"></div>
<script>
function Greeting( props ) {
	return wp.element.createElement( 'span', null, 
		'Hello ' + props.toWhom + '!'
	);
}

wp.element.render(
	wp.element.createElement( Greeting, { toWhom: 'World' } ),
	document.getElementById( 'greeting' )
);
</script>

Refer to the official React Quick Start guide for a more thorough walkthrough, in most cases substituting React and ReactDOM with wp.element in code examples.

Why React?

At the risk of igniting debate surrounding any single "best" front-end framework, the choice to use any tool should be motivated specifically to serve the requirements of the system. In modeling the concept of a block, we observe the following technical requirements:

• An understanding of a block in terms of its underlying values (in the random image example, a category)
• A means to describe the UI of a block given these values

At its most basic, React provides a simple input / output mechanism. Given a set of inputs ("props"), a developer describes the output to be shown on the page. This is most elegantly observed in its function components. React serves the role of reconciling the desired output with the current state of the page.

The offerings of any framework necessarily become more complex as these requirements increase; many front-end frameworks prescribe ideas around page routing, retrieving and updating data, and managing layout. React is not immune to this, but the introduced complexity is rarely caused by React itself, but instead managing an arrangement of supporting tools. By moving these concerns out of sight to the internals of the system (WordPress core code), we can minimize the responsibilities of plugin authors to a small, clear set of touch points.

JSX

While not at all a requirement to use React, JSX is a recommended syntax extension to compose elements more expressively. Through a build process, JSX is converted back to the createElement syntax you see earlier in this document.

If you've configured Babel for your project, you can opt in to JSX syntax by specifying the pragma option of the transform-react-jsx plugin in your .babelrc configuration.

{
	"plugins": [
		[ "transform-react-jsx", {
			"pragma": "createElement"
		} ]
	]
}

This assumes that you will import the createElement function in any file where you use JSX. Alternatively, consider using the @wordpress/babel-plugin-import-jsx-pragma Babel plugin to automate the import of this function.