云策 WordPress 开发者社区

块编辑器开发文档

@wordpress/wordcount

查看官方原文 ↗
💡 云策文档标注

概述

@wordpress/wordcount 是一个 WordPress 字数统计工具包，提供基于 ES2015+ 环境的 API 用于计算文本中的单词或字符数。它作为 Gutenberg 项目的一部分，以 monorepo 形式组织。

关键要点

  • 安装方式：通过 npm install @wordpress/wordcount --save 安装，需确保运行环境支持 ES2015+ 特性，否则需包含 @wordpress/babel-preset-default 中的 polyfill。
  • 核心 API：提供 count 函数，接受文本、统计类型（如 'words'、'characters_excluding_spaces'、'characters_including_spaces'）和用户设置作为参数，返回数字形式的计数结果。
  • 项目背景：属于 Gutenberg 项目的独立包，采用 monorepo 结构，贡献方式可参考项目的主要贡献指南。
📄 原文内容

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 Strategy: The type of count. Accepts ‘words’, ‘characters_excluding_spaces’, or ‘characters_including_spaces’.
  • userSettings UserSettings: 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.