Package Exports
- @wordpress/wordcount
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wordpress/wordcount) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Word Count
WordPress word count utility.
Installation
Install the module
npm install @wordpress/wordcount --saveThis package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as IE browsers then using core-js will add polyfills for these methods.
API
count
Count some words.
Usage
import { count } from '@wordpress/wordcount';
const numberOfWords = count( 'Words to count', 'words', {} );Parameters
- text
string: The text being processed - type
WPWordCountStrategy: The type of count. Accepts 'words', 'characters_excluding_spaces', or 'characters_including_spaces'. - userSettings
WPWordCountUserSettings: Custom settings object.
Returns
number: The word or character count.
