Package Exports
- @wordpress/wordcount
- @wordpress/wordcount/build-module/index.js
- @wordpress/wordcount/build/index.js
- @wordpress/wordcount/src/index.js
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 such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.
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.
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.
