Package Exports

@wordpress/html-entities
@wordpress/html-entities/build-module/index.js
@wordpress/html-entities/build/index.js
@wordpress/html-entities/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wordpress/html-entities) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

HTML Entities

HTML entity utilities for WordPress.

Installation

Install the module

npm install @wordpress/html-entities --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

API

decodeEntities

Decodes the HTML entities from a given string.

Usage

import { decodeEntities } from '@wordpress/html-entities';

const result = decodeEntities( '&aacute;' );
console.log( result ); // result will be "á"

Parameters

html string: String that contain HTML entities.

Returns

string: The decoded string.

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.

Code is Poetry.