WordPress 自动段落函数 autop 及其反向行为 removep 的 JavaScript 移植版本。

安装

安装该模块

npm install @wordpress/autop --save

此包假定您的代码将在 ES2015+ 环境中运行。如果您使用的是对这类语言特性和 API 支持有限或完全不支持的环境，则应在代码中包含 @wordpress/babel-preset-default 随附的 polyfill。

API

autop

将双换行符替换为段落元素。

一组用于识别带有换行符格式化的文本并用 HTML 段落标签替换双换行符的正则表达式替换。转换后剩余的换行符将成为 <br /> 标签，除非 br 设置为 'false'。

用法

import { autop } from '@wordpress/autop';
autop( 'my text' ); // "<p>my text</p>"

参数

  • text string: 需要格式化的文本。
  • br boolean: 可选。如果设置，将在分段后转换所有剩余的换行符。默认为 true。

返回

  • string: 已转换为段落标签的文本。

removep

将 <p> 标签替换为两个换行符。“autop()”的反向操作。

将 <p> 标签替换为两个换行符，但 <p> 带有属性时除外。统一空白字符。缩进 <li>、<dt> 和 <dd> 以提高可读性。

用法

import { removep } from '@wordpress/autop';
removep( '<p>my text</p>' ); // "my text"

参数

  • html string: 来自编辑器的内容。

返回

  • string: 已剥离段落标签的内容。

为此包做出贡献

这是 Gutenberg 项目的一部分，是一个独立的包。该项目组织为一个 monorepo。它由多个自包含的软件包组成，每个包都有特定的用途。此 monorepo 中的包发布到 npm，并被 WordPress 以及其他软件项目使用。

要了解有关为此包或整个 Gutenberg 做出贡献的更多信息，请阅读项目的主要 贡献者指南。