1.0.2 • Published 5 months ago
xverse-components-guide v1.0.2
API
| 参数名 | 类型 | 说明 | 默认值 | 是否必填 | 备注 |
|---|---|---|---|---|---|
| imageConfig | IImageConfig[] | 引导步骤图片配置 | - | true | - |
| skipBtnConfig | IBtnConfig | 跳过按钮配置 | - | false | - |
| roomId | string | RoomId | - | false | 如果需要 room 隔离就需要配置 roomId |
| completeModal | IModalProps | 完成指引的弹窗提示 | - | false | - |
| soundControl | ISoundControlButtonProps | 声音控制按钮 | - | false | - |
| onNext | (index: number) => void | 下一步引导时回调 | - | false | - |
| onSkip | () => void | 跳过时回调 | - | false | 当到最后一步引导时，点击跳过 |
| onFinish | () => void | 引导结束时回调 | - | false | - |
| onlyOnce | boolean | 是否只展示一次新手引导 | - | false | - |
| startStep | number | 开始新手引导步骤 | - | false | - |
| style | CSSProperties | 样式 | - | false | - |
| className | string | CSS 类名 | - | false | - |