@wordpress/autop
TypeScript icon, indicating that this package has built-in type declarations

3.56.0 • Public • Published

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 linebreaks 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.

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.

Package Sidebar

Install

npm i @wordpress/autop

Weekly Downloads

49,684

Version

3.56.0

License

GPL-2.0-or-later

Unpacked Size

174 kB

Total Files

14

Last publish

Collaborators

  • riad
  • gutenbergplugin
  • mamaduka
  • ryanwelcher
  • garypendergast
  • aduth
  • adamsilverstein
  • gziolo
  • ntwb
  • noisysocks
  • kadamwhite
  • jorgefilipecosta
  • ellatrix
  • iandunn206
  • whyisjake
  • ockham
  • sirreal
  • nosolosw
  • wpisabel
  • ntsekouras
  • nerrad
  • desrosj
  • talldanwp
  • peterwilsoncc