@wordpress/wordcount
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/wordpress__wordcount package

3.54.0 • Public • Published

Word Count

WordPress word count utility.

Installation

Install the module

npm install @wordpress/wordcount --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

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.



Code is Poetry.

Versions

Current Tags

Version History

Package Sidebar

Install

npm i @wordpress/wordcount

Weekly Downloads

32,786

Version

3.54.0

License

GPL-2.0-or-later

Unpacked Size

152 kB

Total Files

84

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