tencentblueking/bkui-vue3

English | 简体中文

bkui-vue3

基于蓝鲸 Magicbox 和 Vue3 的前端组件库

Project setup

yarn install

Compiles and hot-reloads for development

yarn dev

Compiles and minifies for production

yarn build

Run your unit tests

yarn test

Lints and fixes files

yarn lint

如何新增使用一个 icon

• 将你的 svg 保存到 packages/icon/src/svg 目录下
• 重命名为你的 icon 使用的具有识别的英文名称
• 执行命令 yarn generate:icon
• 在组件中使用类似语法 import { HelpFill } from '@bkui-vue/icon/'; 引用即可

如何开始

想要贡献代码，建议请先参照已有的特性文档和开发环境构建文档。可以运行 yarn cc 输入组件名生成新组件模板

GIT 提交规范

为了规范 commit-msg 格式，建议使用 yarn cz 自动生成 commit-msg, 不同的提交标记以规范化区分提交内容：

<标记>(<组件名称>): [提交的概要注释] issue #[123]
// 空一行
<本次变更详细说明>
// 空一行
<footer>

示例:

chore(common): 梳理组件库开发流程

affects: bkui-vue, @bkui-vue/button, @bkui-vue/checkbox, @bkui-vue/input, @bkui-vue/radio

允许单个组件执行 jest 任务
添加 husky 提交流程较验
添加 chanelog 自动生成机制

ISSUES CLOSED: #1

标记说明

标记	说明
feature/feat	新功能开发
bug/fix/bugfix	bug 修复
refactor/perf	重构代码/优化配置&参数/优化逻辑及功能
test	添加单元测试用例相关
docs	添加文档
info	添加注释类信息
format	不修改业务逻辑下，仅做代码规范的格式化
merge	仅做分支合并同步
depend	对工程的依赖进行增删改
chore	构建脚本、任务等相关代码
del	删除可能仍然有人用到的功能、API 等破坏性动作

bkui-vue3's Issues

feat(tag): 完善 tag 组件

perf: 更新Eslint配置

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

fix(pagination): 初始页码未接收传值

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

bugfix: 修复backtop组件拼写错误问题

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

test(all): 调整测试用例

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

table: 宽度设置未生效

resize-layout 3.0 组件开发

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

feat(tag): add tag component

添加code-diff组件

增加code-diff组件

fix(radio): 修复bug

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

format(all): 设置Issue template

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

feature(pagination): 新增pagination组件

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

[input] 完善input 文档

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

date-picker功能完善

message 样例更新

message 样例更新

docs(radio): 补充文档

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

[button] 完善按钮文档

docs(form): 补充文档

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

docs(exception):组件文档完善

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

docs(alert): 补充文档

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

fix(checkbox): 修复Bug

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

feature(checkobox): 文档完善

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

table功能完善

• 长列表虚拟渲染head动画修复
• 虚拟滚动组件支持自定义滚动执行时间间隔

docs(文档): 调整样式

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

backTop组件示例错误，没有显示

demo 使用错误，需要修复

bugfix: test

Version / Branch / tag

出了什么问题？(What Happened?)

如何复现？(How to reproduce?)

预期结果(What you expect?)

transfer 组件开发

transfer 组件开发

modal支持遮罩显示与不显示

feature(form): bug修复

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

test

doc(tab/divider): 组件文档完善与eslint修正

feature(composeFormItem): 新增composeFormItem

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

tree组件功能完善

• 支持节点异步请求加载

feat(DatePicker ): 组件添加插槽

1、支持日期选择器的展示trigger内的tooltips里content的插槽（slot="content"）
2、支持自定义底部区域的插槽（slot="footer"）
3、支持自定义日期选择器的展示trigger插槽（slot="trigger"）

feature(form): 导出form

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

notify样例更新

notify样例更新

feature(form): 调整样式

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

perf(radio): 调整逻辑

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

feature(dialog): 组件开发

dialog 组件开发

fix(form): 验证逻辑更新

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

select组件完善

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

hotfix(pagination): 页码计算错误

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

slider功能完善

slider功能完善

级联选择组件开发

级联组件开发

docs(pagination): 完善文档

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):

feat(tag-input): 新增 tag-input 组件

switcher 组件开发

switcher 组件开发

popover功能完善

• 支持boundary，绑定到制定位置元素
• fixOnBoundary，支持配置，固定弹出元素到指定位置元素
• theme，支持自定义theme class、data-custom-theme多种定义模式

swiper 组件开发

swiper 组件开发

docs(dropdownmenu): 完善文档

是BUG反馈还是需求提交(Is this a BUG REPORT or FEATURE REQUEST)? (choose one):

bkui-vue3 版本(The versions used):

发生了什么(What happened):

期望是什么(What you expected to happen):

如何复现(How to reproduce it):

相关的日志详情(访问日志及应用日志: paas.log/login.log/esb.log/esb_api.log)和截图等(Log & Screenshot):

备注(Anything else we need to know):