@wordpress/autop

WordPress's automatic paragraph functions `autop` and `removep`.

Usage no npm install needed!

<script type="module">
  import wordpressAutop from 'https://cdn.skypack.dev/@wordpress/autop';
</script>

README

Autop

JavaScript port of WordPress's automatic paragraph function autop and the removep reverse behavior.

Installation

Install the module

npm install @wordpress/autop --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

autop

Replaces double line-breaks with paragraph elements.

A group of regex replaces used to identify text formatted with newlines and replace double line-breaks with HTML paragraph tags. The remaining line- breaks after conversion become <br /> tags, unless br is set to 'false'.

Usage

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

Parameters

  • text string: The text which has to be formatted.
  • br boolean: Optional. If set, will convert all remaining line- breaks after paragraphing. Default true.

Returns

  • string: Text which has been converted into paragraph tags.

removep

Replaces <p> tags with two line breaks. "Opposite" of autop().

Replaces <p> tags with two line breaks except where the <p> has attributes. Unifies whitespace. Indents <li>, <dt> and <dd> for better readability.

Usage

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

Parameters

  • html string: The content from the editor.

Returns

  • string: The content with stripped paragraph tags.



Code is Poetry.