インストール

モジュールをインストールします 

  1. npm install @wordpress/autop --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。そのような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含める必要があります。

API

autop

ダブル改行を段落要素に置き換えます。

改行でフォーマットされたテキストを識別し、ダブル改行をHTML段落タグに置き換えるために使用される正規表現のグループです。変換後の残りの改行は、brが「false」に設定されていない限り、<br />タグになります。

使用法 

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

パラメータ

  • text string: フォーマットする必要があるテキスト。
  • br boolean: オプション。設定されている場合、段落化後のすべての残りの改行を変換します。デフォルトはtrueです。

戻り値

  • string: 段落タグに変換されたテキスト。

removep

  2. `````<p>`````タグを`````<p>`````に属性がある場合を除いて、2つの改行に置き換えます。ホワイトスペースを統一します。`````<li>`````、`````<dt>`````、`````<dd>`````をインデントして、可読性を向上させます。  
  4. *使用法*  
  7. ``````bash
  8. import { removep } from '@wordpress/autop';
  9. removep( '<p>my text</p>' ); // "my text"
  10. `

パラメータ

  • html string: エディタからのコンテンツ。

戻り値

  • string: 段落タグが削除されたコンテンツ。

このパッケージへの貢献

これはグーテンベルクプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージは、[https://www.npmjs.com/]に公開され、[https://make.wordpress.org/core/]や他のソフトウェアプロジェクトで使用されています。

このパッケージやグーテンベルク全体への貢献について詳しく知りたい場合は、プロジェクトの主要な[https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md]をお読みください。