UNPKG

@minto-ai/type-writer

Version:

流式打字机效果组件,提供逐字符显示文本的打字机效果

73 lines (48 loc) 1.3 kB
`@mt-mint/type-writer` 是一个流式打字机效果组件,提供逐字符显示文本的打字机效果。 # 安装 ```bash pnpm install @mt-mint/type-writer ``` # 使用 ## 引入库 ```javascript import { createTypeWriter } from '@mt-mint/type-writer' ``` ## 创建实例 ```javascript const typeWriter = createTypeWriter({ speed: 100 // 打字速度,单位毫秒 }) ``` ## 基本使用 ```javascript // 监听事件 typeWriter.on('change', (text) => { console.log('当前文本:', text) document.getElementById('output').textContent = text }) typeWriter.on('complete', () => { console.log('打字完成') }) // 发送文本 typeWriter .send('你好,') .send('这是一个打字机效果!') .end() ``` ## API ### send(text: string) 发送要显示的文本,支持链式调用。 ### end() 标记文本发送完成。 ### finish() 立即完成打字效果。 ### on(eventName, callback) 监听事件。 ## 事件 - `change`: 文本变化时触发,参数为当前完整文本 - `complete`: 打字完成时触发 ## 配置 | 参数 | 类型 | 默认值 | 说明 | | ----- | ------ | ------ | ---------------- | | speed | number | 100 | 打字速度(毫秒) |