在前端开发中，很多项目需要使用到各种各样的第三方框架和库。我们可以通过 npm 来安装这些库，方便我们快速地开发项目。其中，relegater 是一个非常实用的 npm 包，它可以帮助我们快速地将任何无序列表转化为有序列表。
安装
在开始使用 relegater 之前，我们需要先安装这个 npm 包。可以使用以下命令：
npm i relegater
使用
在安装完成之后，我们可以在项目的 JavaScript 文件中引入这个包。
import { Relegater } from 'relegater';接着，我们可以使用以下方式创建一个实例：
const r = new Relegater();
使用默认参数
如果我们不传递任何参数，会使用默认的选项进行转换。我们只需要将无序列表作为参数传入即可。
const output = r.sequenceList(['item 1', 'item 2', 'item 3']); console.log(output);
输出的结果将会是一个有序列表。
<ol> <li>item 1</li> <li>item 2</li> <li>item 3</li> </ol>
自定义参数
我们也可以自定义参数，来满足不同的需求。以下是 relegater 支持的参数选项：
| 参数 | 描述 |
|---|---|
| listTag | 列表标签，默认值为 'ol' |
| listItem | 列表项标签，默认值为 'li' |
| listClass | 列表的类名，可以自定义样式 |
| itemClass | 列表项的类名，可以自定义样式 |
| startIndex | 有序列表的开始序号，可以自定义，默认值为 1 |
| separator | 列表项的分隔符，可以自定义，默认值为 '. '，即带点号和空格。如果将其设置为 '、'，则列表项之间的分隔符将会是中文逗号 |
const r = new Relegater({
listTag: 'ol',
listItem: 'li',
listClass: 'ordered-list',
itemClass: 'list-item',
startIndex: 3,
separator: '、'
});然后我们可以使用以下方式创建有序列表：
const output = r.sequenceList(['item 1', 'item 2', 'item 3']); console.log(output);
输出的结果将会是一个根据选项进行自定义的有序列表。
<ol class="ordered-list"> <li class="list-item">3、item 1</li> <li class="list-item">4、item 2</li> <li class="list-item">5、item 3</li> </ol>
示例代码
以下是一个完整的例子，展示了如何使用自定义参数来创建有序列表。
-- -------------------- ---- ------- ------ - --------- - ---- ------------ ----- - - --- ----------- -------- ----- --------- ----- ---------- --------------- ---------- ------------ ----------- -- ---------- --- --- ----- ------ - --------------------- --- ----- --- ----- ----- --------------------
总结
relegater 是一个非常实用的 npm 包，它可以帮助我们快速地将无序列表转化为有序列表，而且还支持自定义参数，能够满足不同的需求。在前端开发中，这个包可以节省我们很多的时间，同时也可以提高我们的工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055da681e8991b448db645