块编辑器开发文档

@wordpress/html-entities

💡 云策文档标注

概述

@wordpress/html-entities 是一个 WordPress 包,提供 HTML 实体解码功能,用于处理字符串中的 HTML 实体。它适用于 ES2015+ 环境,并可通过 npm 安装。

关键要点

  • 提供 decodeEntities 函数,用于解码字符串中的 HTML 实体。
  • 需要 ES2015+ 环境支持,否则需包含 @wordpress/babel-preset-default 中的 polyfill。
  • 作为 Gutenberg 项目的一部分,采用 monorepo 结构,可通过 npm 安装。

代码示例

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

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

📄 原文内容

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( 'á' );
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.