将字符串转换为 kebab-case，与 WordPress Core 的 _wp_to_kebab_case() 保持一致。

此包的存在是因为没有现成的库符合 WordPress Core 的 _wp_to_kebab_case() 函数的语义，而 WordPress 需要保留这些语义以实现向后兼容。

安装

安装模块

npm install @wordpress/kebab-case --save

用法

kebabCase

将任意字符串转换为 kebab-case。

该转换旨在匹配 WordPress Core 的 _wp_to_kebab_case() 函数（并由此匹配 Lodash 的 _.kebabCase()）：此包的测试套件覆盖了 Core 函数的每个测试用例。这些语义在数字处理方式上不同于其他 kebab-case 实现（'white23' 变为 'white-23'，'font2xl' 变为 'font-2-xl'，但 'white4th' 保持为 'white-4th'）。

import { kebabCase } from '@wordpress/kebab-case';

kebabCase( 'whiteToWhite' ); // 'white-to-white'
kebabCase( 'white2white' ); // 'white-2-white'
kebabCase( 'font2xl' ); // 'font-2-xl'
kebabCase( '#ffffff' ); // 'ffffff'
kebabCase( "i've done" ); // 'ive-done'

API

kebabCase

将任意字符串转换为 kebab-case。与 Lodash 的 _.kebabCase() 向后兼容。与 _wp_to_kebab_case() 向后兼容。

相关

参数

  • str unknown：要转换的字符串。

返回值

  • kebab-case 字符串

参与贡献此包

这是 Gutenberg 项目中的一个独立包。该项目以 monorepo 形式组织，由多个自包含的软件包组成，每个包都有特定用途。此 monorepo 中的包会发布到 npm，并被 WordPress 以及其他软件项目使用。

如需了解有关参与此包或整个 Gutenberg 项目的更多信息，请阅读项目的主要 贡献者指南。