インストール

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

  1. npm install @wordpress/wordcount --save

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

API

カウント

いくつかの単語をカウントします。

使用法

  1. import { count } from '@wordpress/wordcount';
  2. const numberOfWords = count( 'Words to count', 'words', {} );

パラメータ

  • text string: 処理されるテキスト
  • type WPWordCountStrategy: カウントのタイプ。‘words’、‘characters_excluding_spaces’、または‘characters_including_spaces’を受け入れます。
  • userSettings WPWordCountUserSettings: カスタム設定オブジェクト。

戻り値

  • number: 単語または文字のカウント。

このパッケージへの貢献

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

このパッケージやグーテンベルク全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。