bkui-vue 0.0.1-beta.2 → 0.0.1-beta.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (419) hide show
  1. package/README.md +25 -17
  2. package/README_EN.md +89 -0
  3. package/dist/bkui-vue.cjs.js +9736 -1174
  4. package/dist/bkui-vue.esm.js +9873 -1358
  5. package/dist/bkui-vue.umd.js +9736 -1174
  6. package/dist/style.css +3189 -166
  7. package/lib/alert/alert.d.ts +24 -15
  8. package/lib/alert/alert.variable.css +32 -0
  9. package/lib/alert/index.d.ts +180 -3
  10. package/lib/alert/index.js +1 -1
  11. package/lib/animate-number/animate-number.d.ts +12 -7
  12. package/lib/animate-number/index.d.ts +97 -2
  13. package/lib/animate-number/index.js +1 -1
  14. package/lib/backtop/backtop.d.ts +27 -13
  15. package/lib/backtop/backtop.variable.css +32 -0
  16. package/lib/backtop/index.d.ts +166 -2
  17. package/lib/backtop/index.js +1 -1
  18. package/lib/badge/badge.d.ts +40 -19
  19. package/lib/badge/badge.variable.css +32 -0
  20. package/lib/badge/index.d.ts +217 -2
  21. package/lib/badge/index.js +1 -1
  22. package/lib/breadcrumb/breadcrumb-item.d.ts +13 -9
  23. package/lib/breadcrumb/breadcrumb.css +10 -1
  24. package/lib/breadcrumb/breadcrumb.d.ts +37 -9
  25. package/lib/breadcrumb/breadcrumb.less +13 -2
  26. package/lib/breadcrumb/breadcrumb.variable.css +42 -1
  27. package/lib/breadcrumb/index.d.ts +144 -43
  28. package/lib/breadcrumb/index.js +1 -1
  29. package/lib/button/button-group.d.ts +3 -5
  30. package/lib/button/button.d.ts +35 -30
  31. package/lib/button/button.less +6 -6
  32. package/lib/button/button.variable.css +32 -0
  33. package/lib/button/index.d.ts +187 -3
  34. package/lib/button/index.js +1 -1
  35. package/lib/card/card.d.ts +30 -15
  36. package/lib/card/card.variable.css +32 -0
  37. package/lib/card/index.d.ts +187 -2
  38. package/lib/card/index.js +1 -1
  39. package/lib/checkbox/checkbox-group.d.ts +13 -9
  40. package/lib/checkbox/checkbox.d.ts +31 -22
  41. package/lib/checkbox/checkbox.variable.css +32 -0
  42. package/lib/checkbox/index.d.ts +261 -2
  43. package/lib/checkbox/index.js +1 -1
  44. package/lib/checkbox/type.d.ts +6 -5
  45. package/lib/collapse/collapse.css +8 -0
  46. package/lib/collapse/collapse.d.ts +50 -18
  47. package/lib/collapse/collapse.less +10 -0
  48. package/lib/collapse/collapse.variable.css +8 -0
  49. package/lib/collapse/index.d.ts +166 -2
  50. package/lib/collapse/index.js +1 -1
  51. package/lib/components.d.ts +37 -0
  52. package/lib/date-picker/date-picker.css +407 -0
  53. package/lib/date-picker/date-picker.d.ts +404 -0
  54. package/lib/date-picker/date-picker.less +526 -0
  55. package/lib/date-picker/date-picker.variable.css +500 -0
  56. package/lib/date-picker/fecha.d.ts +6 -0
  57. package/lib/date-picker/index.d.ts +713 -0
  58. package/lib/date-picker/index.js +1 -0
  59. package/lib/date-picker/interface.d.ts +22 -0
  60. package/lib/date-picker/utils.d.ts +97 -0
  61. package/lib/dialog/dialog.d.ts +57 -27
  62. package/lib/dialog/index.d.ts +286 -2
  63. package/lib/dialog/index.js +1 -1
  64. package/lib/directives/clickoutside.d.ts +23 -0
  65. package/lib/directives/index.d.ts +2 -0
  66. package/lib/directives/index.js +14 -14
  67. package/lib/directives/tooltips.d.ts +17 -0
  68. package/lib/divider/divider.css +38 -0
  69. package/lib/divider/divider.d.ts +48 -0
  70. package/lib/divider/divider.less +53 -0
  71. package/lib/divider/divider.variable.css +131 -0
  72. package/lib/divider/index.d.ts +142 -0
  73. package/lib/divider/index.js +1 -0
  74. package/lib/dropdown/dropdown-item.d.ts +19 -0
  75. package/lib/dropdown/dropdown-menu.d.ts +16 -0
  76. package/lib/dropdown/dropdown.css +43 -0
  77. package/lib/dropdown/dropdown.d.ts +61 -0
  78. package/lib/dropdown/dropdown.less +54 -0
  79. package/lib/dropdown/dropdown.variable.css +136 -0
  80. package/lib/dropdown/index.d.ts +192 -0
  81. package/lib/dropdown/index.js +1 -0
  82. package/lib/exception/exception.d.ts +11 -9
  83. package/lib/exception/exception.variable.css +32 -0
  84. package/lib/exception/index.d.ts +95 -1
  85. package/lib/exception/index.js +1 -1
  86. package/lib/fixed-navbar/fixed-navbar.d.ts +15 -9
  87. package/lib/fixed-navbar/fixed-navbar.variable.css +32 -0
  88. package/lib/fixed-navbar/index.d.ts +112 -2
  89. package/lib/fixed-navbar/index.js +1 -1
  90. package/lib/form/common.d.ts +3 -0
  91. package/lib/form/form-item.d.ts +159 -0
  92. package/lib/form/form.css +39 -0
  93. package/lib/form/form.d.ts +84 -0
  94. package/lib/form/form.less +50 -0
  95. package/lib/form/form.variable.css +39 -0
  96. package/lib/form/index.d.ts +286 -0
  97. package/lib/form/index.js +1 -0
  98. package/lib/form/type.d.ts +21 -0
  99. package/lib/form/validator.d.ts +8 -0
  100. package/lib/icon/angle-double-down-line.d.ts +4 -0
  101. package/lib/icon/angle-double-down-line.js +15 -0
  102. package/lib/icon/angle-double-left-line.d.ts +4 -0
  103. package/lib/icon/angle-double-left-line.js +15 -0
  104. package/lib/icon/angle-double-left.d.ts +4 -0
  105. package/lib/icon/angle-double-left.js +15 -0
  106. package/lib/icon/angle-double-right-line.d.ts +4 -0
  107. package/lib/icon/angle-double-right-line.js +15 -0
  108. package/lib/icon/angle-double-right.d.ts +4 -0
  109. package/lib/icon/angle-double-right.js +15 -0
  110. package/lib/icon/angle-double-up-line.d.ts +4 -0
  111. package/lib/icon/angle-double-up-line.js +15 -0
  112. package/lib/icon/angle-down-fill.d.ts +4 -0
  113. package/lib/icon/angle-down-fill.js +15 -0
  114. package/lib/icon/angle-down-line.d.ts +4 -0
  115. package/lib/icon/angle-down-line.js +15 -0
  116. package/lib/icon/angle-down.d.ts +4 -0
  117. package/lib/icon/angle-down.js +15 -0
  118. package/lib/icon/angle-left.d.ts +4 -0
  119. package/lib/icon/angle-left.js +15 -0
  120. package/lib/icon/angle-right.d.ts +4 -0
  121. package/lib/icon/angle-right.js +15 -0
  122. package/lib/icon/angle-up-fill.d.ts +4 -0
  123. package/lib/icon/angle-up-fill.js +15 -0
  124. package/lib/icon/angle-up.d.ts +4 -0
  125. package/lib/icon/angle-up.js +15 -0
  126. package/lib/icon/arrows-left.d.ts +4 -0
  127. package/lib/icon/arrows-left.js +15 -0
  128. package/lib/icon/arrows-right.d.ts +4 -0
  129. package/lib/icon/arrows-right.js +15 -0
  130. package/lib/icon/bk.d.ts +4 -0
  131. package/lib/icon/bk.js +15 -0
  132. package/lib/icon/circle.d.ts +4 -0
  133. package/lib/icon/circle.js +15 -0
  134. package/lib/icon/close.d.ts +4 -0
  135. package/lib/icon/close.js +15 -0
  136. package/lib/icon/code.d.ts +4 -0
  137. package/lib/icon/code.js +15 -0
  138. package/lib/icon/cog-shape.d.ts +4 -0
  139. package/lib/icon/cog-shape.js +15 -0
  140. package/lib/icon/collapse-left.d.ts +4 -0
  141. package/lib/icon/collapse-left.js +15 -0
  142. package/lib/icon/copy.d.ts +4 -0
  143. package/lib/icon/copy.js +15 -0
  144. package/lib/icon/done.d.ts +4 -0
  145. package/lib/icon/done.js +15 -0
  146. package/lib/icon/down-shape.d.ts +4 -0
  147. package/lib/icon/down-shape.js +15 -0
  148. package/lib/icon/down-small.d.ts +4 -0
  149. package/lib/icon/down-small.js +15 -0
  150. package/lib/icon/ellipsis.d.ts +4 -0
  151. package/lib/icon/ellipsis.js +15 -0
  152. package/lib/icon/error.d.ts +4 -0
  153. package/lib/icon/error.js +15 -0
  154. package/lib/icon/eye.d.ts +4 -0
  155. package/lib/icon/eye.js +15 -0
  156. package/lib/icon/folder-open.d.ts +4 -0
  157. package/lib/icon/folder-open.js +15 -0
  158. package/lib/icon/folder-shape-open.d.ts +4 -0
  159. package/lib/icon/folder-shape-open.js +15 -0
  160. package/lib/icon/folder-shape.d.ts +4 -0
  161. package/lib/icon/folder-shape.js +15 -0
  162. package/lib/icon/folder.d.ts +4 -0
  163. package/lib/icon/folder.js +15 -0
  164. package/lib/icon/help-document-fill.d.ts +4 -0
  165. package/lib/icon/help-document-fill.js +15 -0
  166. package/lib/icon/help-fill.d.ts +4 -0
  167. package/lib/icon/help-fill.js +15 -0
  168. package/lib/icon/help.d.ts +4 -0
  169. package/lib/icon/help.js +15 -0
  170. package/lib/icon/icon.d.ts +12 -0
  171. package/lib/icon/icon.js +15 -0
  172. package/lib/icon/index.d.ts +42 -0
  173. package/lib/icon/index.js +1 -1
  174. package/lib/icon/info-line.d.ts +4 -0
  175. package/lib/icon/info-line.js +15 -0
  176. package/lib/icon/info.d.ts +4 -0
  177. package/lib/icon/info.js +15 -0
  178. package/lib/icon/left-shape.d.ts +4 -0
  179. package/lib/icon/left-shape.js +15 -0
  180. package/lib/icon/play-shape.d.ts +4 -0
  181. package/lib/icon/play-shape.js +15 -0
  182. package/lib/icon/plus.d.ts +4 -0
  183. package/lib/icon/plus.js +15 -0
  184. package/lib/icon/qq.d.ts +4 -0
  185. package/lib/icon/qq.js +15 -0
  186. package/lib/icon/right-shape.d.ts +4 -0
  187. package/lib/icon/right-shape.js +15 -0
  188. package/lib/icon/search.d.ts +4 -0
  189. package/lib/icon/search.js +15 -0
  190. package/lib/icon/share.d.ts +4 -0
  191. package/lib/icon/share.js +15 -0
  192. package/lib/icon/spinner.d.ts +4 -0
  193. package/lib/icon/spinner.js +15 -0
  194. package/lib/icon/success.d.ts +4 -0
  195. package/lib/icon/success.js +15 -0
  196. package/lib/icon/switcher-loading.d.ts +4 -0
  197. package/lib/icon/switcher-loading.js +15 -0
  198. package/lib/icon/text-file.d.ts +4 -0
  199. package/lib/icon/text-file.js +15 -0
  200. package/lib/icon/tree-application-shape.d.ts +4 -0
  201. package/lib/icon/tree-application-shape.js +15 -0
  202. package/lib/icon/unvisible.d.ts +4 -0
  203. package/lib/icon/unvisible.js +15 -0
  204. package/lib/icon/up-shape.d.ts +4 -0
  205. package/lib/icon/up-shape.js +15 -0
  206. package/lib/icon/warn.d.ts +4 -0
  207. package/lib/icon/warn.js +15 -0
  208. package/lib/icon/weixin.d.ts +4 -0
  209. package/lib/icon/weixin.js +15 -0
  210. package/lib/index.d.ts +4 -0
  211. package/lib/input/index.d.ts +363 -2
  212. package/lib/input/index.js +2 -2
  213. package/lib/input/input.css +1 -0
  214. package/lib/input/input.d.ts +68 -46
  215. package/lib/input/input.less +4 -3
  216. package/lib/input/input.variable.css +33 -0
  217. package/lib/link/index.d.ts +164 -2
  218. package/lib/link/index.js +1 -1
  219. package/lib/link/link.d.ts +25 -13
  220. package/lib/link/link.variable.css +32 -0
  221. package/lib/loading/index.d.ts +124 -2
  222. package/lib/loading/index.js +1 -1
  223. package/lib/loading/loading.d.ts +26 -15
  224. package/lib/loading/loading.variable.css +32 -0
  225. package/lib/menu/index.d.ts +188 -0
  226. package/lib/menu/index.js +1 -0
  227. package/lib/menu/menu-group.d.ts +14 -0
  228. package/lib/menu/menu-item.d.ts +16 -0
  229. package/lib/menu/menu.css +182 -0
  230. package/lib/menu/menu.d.ts +64 -0
  231. package/lib/menu/menu.less +180 -0
  232. package/lib/menu/menu.variable.css +275 -0
  233. package/lib/menu/submenu.css +3 -0
  234. package/lib/menu/submenu.d.ts +22 -0
  235. package/lib/menu/submenu.less +5 -0
  236. package/lib/menu/submenu.variable.css +96 -0
  237. package/lib/menu/utils.d.ts +41 -0
  238. package/lib/message/index.d.ts +2 -0
  239. package/lib/message/index.js +1 -0
  240. package/lib/message/message.css +53 -0
  241. package/lib/message/message.less +61 -0
  242. package/lib/message/message.variable.css +146 -0
  243. package/lib/message/messageConstructor.d.ts +73 -0
  244. package/lib/modal/index.d.ts +214 -3
  245. package/lib/modal/index.js +1 -1
  246. package/lib/modal/modal.d.ts +33 -15
  247. package/lib/modal/props.mixin.d.ts +5 -1
  248. package/lib/navigation/index.d.ts +2 -0
  249. package/lib/navigation/index.js +1 -0
  250. package/lib/navigation/navigation-title.d.ts +25 -0
  251. package/lib/navigation/navigation.css +184 -0
  252. package/lib/navigation/navigation.d.ts +111 -0
  253. package/lib/navigation/navigation.less +210 -0
  254. package/lib/navigation/navigation.variable.css +277 -0
  255. package/lib/notify/index.d.ts +2 -0
  256. package/lib/notify/index.js +1 -0
  257. package/lib/notify/notify.css +49 -0
  258. package/lib/notify/notify.less +58 -0
  259. package/lib/notify/notify.variable.css +142 -0
  260. package/lib/notify/notifyConstructor.d.ts +91 -0
  261. package/lib/pagination/index.d.ts +395 -0
  262. package/lib/pagination/index.js +1 -0
  263. package/lib/pagination/pagination.css +179 -0
  264. package/lib/pagination/pagination.d.ts +220 -0
  265. package/lib/pagination/pagination.less +201 -0
  266. package/lib/pagination/pagination.variable.css +272 -0
  267. package/lib/pagination/type.d.ts +6 -0
  268. package/lib/pagination/use-limit.d.ts +8 -0
  269. package/lib/pagination/use-list.d.ts +8 -0
  270. package/lib/pagination/use-small-list.d.ts +5 -0
  271. package/lib/pagination/use-total.d.ts +5 -0
  272. package/lib/popover/index.d.ts +287 -27
  273. package/lib/popover/index.js +1 -1
  274. package/lib/popover/popover.css +23 -14
  275. package/lib/popover/popover.d.ts +74 -45
  276. package/lib/popover/popover.less +57 -46
  277. package/lib/popover/popover.variable.css +55 -14
  278. package/lib/popover/props.d.ts +77 -0
  279. package/lib/preset.d.ts +7 -0
  280. package/lib/process/index.d.ts +205 -0
  281. package/lib/process/index.js +15 -0
  282. package/lib/process/process.css +138 -0
  283. package/lib/process/process.d.ts +131 -0
  284. package/lib/process/process.less +178 -0
  285. package/lib/process/process.variable.css +231 -0
  286. package/lib/progress/index.d.ts +398 -2
  287. package/lib/progress/index.js +1 -1
  288. package/lib/progress/progress.css +0 -3
  289. package/lib/progress/progress.d.ts +88 -35
  290. package/lib/progress/progress.less +0 -4
  291. package/lib/progress/progress.variable.css +32 -3
  292. package/lib/radio/index.d.ts +277 -2
  293. package/lib/radio/index.js +1 -1
  294. package/lib/radio/radio-button.d.ts +24 -16
  295. package/lib/radio/radio-group.d.ts +11 -10
  296. package/lib/radio/radio.css +6 -0
  297. package/lib/radio/radio.d.ts +23 -13
  298. package/lib/radio/radio.less +7 -0
  299. package/lib/radio/radio.variable.css +38 -0
  300. package/lib/rate/index.d.ts +113 -2
  301. package/lib/rate/index.js +1 -1
  302. package/lib/rate/rate.d.ts +13 -10
  303. package/lib/rate/star.d.ts +33 -16
  304. package/lib/select/common.d.ts +13 -3
  305. package/lib/select/index.d.ts +962 -2
  306. package/lib/select/index.js +15 -1
  307. package/lib/select/option.d.ts +12 -19
  308. package/lib/select/optionGroup.d.ts +130 -0
  309. package/lib/select/select.css +130 -14
  310. package/lib/select/select.d.ts +152 -150
  311. package/lib/select/select.less +164 -26
  312. package/lib/select/select.variable.css +162 -14
  313. package/lib/shared/bk-helper-core.d.ts +6 -0
  314. package/lib/shared/bk-mask-manager.d.ts +32 -3
  315. package/lib/shared/bk-pop-manager.d.ts +8 -1
  316. package/lib/shared/bk-popover.d.ts +56 -5
  317. package/lib/shared/index.d.ts +24 -0
  318. package/lib/shared/index.js +1 -1
  319. package/lib/shared/utils.d.ts +6 -0
  320. package/lib/shared/vue-types.d.ts +3 -6
  321. package/lib/shared/z-index-manager.d.ts +6 -1
  322. package/lib/sideslider/index.d.ts +206 -2
  323. package/lib/sideslider/index.js +1 -1
  324. package/lib/sideslider/sideslider.d.ts +39 -18
  325. package/lib/sideslider/sideslider.variable.css +32 -0
  326. package/{index.d.ts → lib/slider/index.d.ts} +4 -5
  327. package/lib/slider/index.js +15 -0
  328. package/{commitlint.config.js → lib/slider/slider-button.d.ts} +50 -42
  329. package/lib/slider/slider.css +149 -0
  330. package/lib/slider/slider.d.ts +189 -0
  331. package/lib/slider/slider.less +179 -0
  332. package/lib/slider/slider.variable.css +242 -0
  333. package/lib/steps/index.d.ts +250 -0
  334. package/lib/steps/index.js +15 -0
  335. package/lib/steps/steps.css +288 -0
  336. package/lib/steps/steps.d.ts +161 -0
  337. package/lib/steps/steps.less +324 -0
  338. package/lib/steps/steps.variable.css +381 -0
  339. package/lib/styles/index.d.ts +43 -25
  340. package/lib/styles/index.js +1 -1
  341. package/lib/styles/mixins/popper.css +43 -0
  342. package/lib/styles/mixins/popper.less +52 -0
  343. package/lib/styles/mixins/popper.variable.css +43 -0
  344. package/lib/styles/mixins/size.less +9 -0
  345. package/lib/styles/reset.css +273 -0
  346. package/lib/styles/reset.less +313 -0
  347. package/lib/styles/reset.variable.css +273 -0
  348. package/lib/styles/themes/themes.less +52 -2
  349. package/lib/switcher/index.d.ts +286 -2
  350. package/lib/switcher/index.js +1 -1
  351. package/lib/switcher/switcher.css +149 -135
  352. package/lib/switcher/switcher.d.ts +48 -32
  353. package/lib/switcher/switcher.less +210 -154
  354. package/lib/switcher/switcher.variable.css +181 -135
  355. package/lib/tab/index.d.ts +552 -0
  356. package/lib/tab/index.js +1 -0
  357. package/lib/tab/tab-nav.d.ts +190 -0
  358. package/lib/tab/tab-panel.d.ts +48 -0
  359. package/lib/tab/tab.css +147 -0
  360. package/lib/tab/tab.d.ts +163 -0
  361. package/lib/tab/tab.less +221 -0
  362. package/lib/tab/tab.variable.css +240 -0
  363. package/lib/table/const.d.ts +4 -0
  364. package/lib/table/index.d.ts +259 -2
  365. package/lib/table/index.js +1 -1
  366. package/lib/table/props.d.ts +110 -0
  367. package/lib/table/render.d.ts +72 -0
  368. package/lib/table/table.css +83 -0
  369. package/lib/table/table.d.ts +75 -38
  370. package/lib/table/table.less +107 -1
  371. package/lib/table/table.variable.css +115 -0
  372. package/lib/table/utils.d.ts +69 -0
  373. package/lib/tag/index.d.ts +229 -2
  374. package/lib/tag/index.js +1 -1
  375. package/lib/tag/tag.css +91 -0
  376. package/lib/tag/tag.d.ts +83 -53
  377. package/lib/tag/tag.less +103 -2
  378. package/lib/tag/tag.variable.css +123 -0
  379. package/lib/timeline/index.d.ts +129 -0
  380. package/lib/timeline/index.js +1 -0
  381. package/lib/timeline/timeline.css +235 -0
  382. package/lib/timeline/timeline.d.ts +81 -0
  383. package/lib/timeline/timeline.less +239 -0
  384. package/lib/timeline/timeline.variable.css +328 -0
  385. package/{changelog.config.js → lib/transfer/index.d.ts} +2 -8
  386. package/lib/transfer/index.js +1 -0
  387. package/lib/transfer/transfer.css +158 -0
  388. package/lib/transfer/transfer.d.ts +185 -0
  389. package/lib/transfer/transfer.less +171 -0
  390. package/lib/transfer/transfer.variable.css +251 -0
  391. package/lib/tree/index.d.ts +254 -0
  392. package/lib/tree/index.js +1 -0
  393. package/lib/tree/props.d.ts +80 -0
  394. package/lib/tree/tree.css +44 -0
  395. package/lib/tree/tree.d.ts +98 -0
  396. package/lib/tree/tree.less +55 -0
  397. package/lib/tree/tree.variable.css +44 -0
  398. package/lib/tree/util.d.ts +57 -0
  399. package/lib/use-form.d.ts +3 -0
  400. package/lib/use-message.d.ts +2 -0
  401. package/lib/virtual-render/index.d.ts +556 -0
  402. package/lib/virtual-render/index.js +1 -0
  403. package/lib/virtual-render/props.d.ts +157 -0
  404. package/lib/virtual-render/v-virtual-render.d.ts +7 -0
  405. package/lib/virtual-render/virtual-render.css +40 -0
  406. package/lib/virtual-render/virtual-render.d.ts +244 -0
  407. package/lib/virtual-render/virtual-render.less +51 -0
  408. package/lib/virtual-render/virtual-render.variable.css +40 -0
  409. package/package.json +63 -48
  410. package/index.html +0 -40
  411. package/lib/checkbox-group/index.d.ts +0 -2
  412. package/lib/checkbox-group/index.js +0 -1
  413. package/lib/radio-button/index.d.ts +0 -2
  414. package/lib/radio-button/index.js +0 -1
  415. package/lib/radio-group/index.d.ts +0 -2
  416. package/lib/radio-group/index.js +0 -1
  417. package/lib/table/common.d.ts +0 -3
  418. package/lib/table/table-layout.d.ts +0 -14
  419. package/lib/table/type.d.ts +0 -12
package/README.md CHANGED
@@ -1,4 +1,13 @@
1
- # bkui-vue
1
+ ![bkui-vue3](docs/logo.png)
2
+ ---
3
+
4
+ [![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/TencentBlueKing/bkui-vue3/blob/master/LICENSE.txt) [![Release Version](https://img.shields.io/npm/v/bkui-vue.svg)](https://www.npmjs.com/package/bkui-vue) <!--[![month dowloads](http://img.shields.io/npm/dm/bkui-vue.svg)](https://npmcharts.com/compare/bkui-vue?minimal=true)--> [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bkui-vue3/pulls)
5
+
6
+ [English](README_EN.md) | 简体中文
7
+
8
+ # bkui-vue3
9
+
10
+ 基于蓝鲸 Magicbox 和 Vue3 的前端组件库
2
11
 
3
12
  ## Project setup
4
13
  ```
@@ -25,27 +34,26 @@ yarn test
25
34
  yarn lint
26
35
  ```
27
36
 
37
+ #### 如何新增使用一个 icon
28
38
 
29
- #### 如何新增使用一个icon
30
-
31
- * 将你的svg保存到 packages/icon/src/svg目录下
32
- * 重命名为你的icon使用的具有识别的英文名称
33
- * 执行命令 yarn generate:icon
34
- * 在组件中使用类似语法`import { HelpFill } from '@bkui-vue/icon/';`引用即可
39
+ * 将你的 svg 保存到 `packages/icon/src/svg` 目录下
40
+ * 重命名为你的 icon 使用的具有识别的英文名称
41
+ * 执行命令 `yarn generate:icon`
42
+ * 在组件中使用类似语法 `import { HelpFill } from '@bkui-vue/icon/';` 引用即可
35
43
 
36
44
 
37
45
  ## 如何开始
38
46
 
39
- 想要贡献代码,建议请先参照已有的特性文档和开发环境构建文档。可以运行`npm run plop` 输入组件名生成新组件模板
47
+ 想要贡献代码,建议请先参照已有的特性文档和开发环境构建文档。可以运行 `npm run plop` 输入组件名生成新组件模板
40
48
 
41
- ## GIT提交规范
49
+ ## GIT 提交规范
42
50
 
43
- 为了规范commit-msg格式,建议使用yarn cz自动生成commit-msg, 不同的提交标记以规范化区分提交内容:
44
- ```
51
+ 为了规范 commit-msg 格式,建议使用 `yarn cz` 自动生成 commit-msg, 不同的提交标记以规范化区分提交内容:
45
52
 
53
+ ```
46
54
  <标记>(<组件名称>): [提交的概要注释] issue #[123]
47
55
  // 空一行
48
- <本次变更详细说明>
56
+ <本次变更详细说明>
49
57
  // 空一行
50
58
  <footer>
51
59
  ```
@@ -57,9 +65,9 @@ chore(common): 梳理组件库开发流程
57
65
 
58
66
  affects: bkui-vue, @bkui-vue/button, @bkui-vue/checkbox, @bkui-vue/input, @bkui-vue/radio
59
67
 
60
- 允许单个组件执行jest任务
61
- 添加Husky提交流程较验
62
- 添加chanelog自动生成机制
68
+ 允许单个组件执行 jest 任务
69
+ 添加 husky 提交流程较验
70
+ 添加 chanelog 自动生成机制
63
71
 
64
72
  ISSUES CLOSED: #1
65
73
  ```
@@ -69,7 +77,7 @@ ISSUES CLOSED: #1
69
77
  | 标记 | 说明 |
70
78
  | -------------- | ------------------------------------------- |
71
79
  | feature/feat | 新功能开发 |
72
- | bug/fix/bugfix | bug修复 |
80
+ | bug/fix/bugfix | bug 修复 |
73
81
  | refactor/perf | 重构代码/优化配置&参数/优化逻辑及功能 |
74
82
  | test | 添加单元测试用例相关 |
75
83
  | docs | 添加文档 |
@@ -78,4 +86,4 @@ ISSUES CLOSED: #1
78
86
  | merge | 仅做分支合并同步 |
79
87
  | depend | 对工程的依赖进行增删改 |
80
88
  | chore | 构建脚本、任务等相关代码 |
81
- | del | 删除可能仍然有人用到的功能、API等破坏性动作 |
89
+ | del | 删除可能仍然有人用到的功能、API 等破坏性动作 |
package/README_EN.md ADDED
@@ -0,0 +1,89 @@
1
+ ![bkui-vue3](docs/logo-en.png)
2
+ ---
3
+
4
+ [![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/TencentBlueKing/bkui-vue3/blob/master/LICENSE.txt) [![Release Version](https://img.shields.io/npm/v/bkui-vue.svg)](https://www.npmjs.com/package/bkui-vue) <!--[![month dowloads](http://img.shields.io/npm/dm/bkui-vue.svg)](https://npmcharts.com/compare/bkui-vue?minimal=true)--> [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentBlueKing/bkui-vue3/pulls)
5
+
6
+ English | [简体中文](README.md)
7
+
8
+ # bkui-vue3
9
+
10
+ A UI library base on BlueKing Magicbox and Vue3
11
+
12
+ ## Project setup
13
+ ```
14
+ yarn install
15
+ ```
16
+
17
+ ### Compiles and hot-reloads for development
18
+ ```
19
+ yarn dev
20
+ ```
21
+
22
+ ### Compiles and minifies for production
23
+ ```
24
+ yarn build
25
+ ```
26
+
27
+ ### Run your unit tests
28
+ ```
29
+ yarn test
30
+ ```
31
+
32
+ ### Lints and fixes files
33
+ ```
34
+ yarn lint
35
+ ```
36
+
37
+ #### How to add an icon
38
+
39
+ * Save your svg to the `packages/icon/src/svg` directory
40
+ * Rename to a recognizable English name used by your icon
41
+ * Execute the command `yarn generate:icon`
42
+ * Use similar syntax `import { HelpFill } from '@bkui-vue/icon/';` in the component to reference
43
+
44
+
45
+ ## How to get started
46
+
47
+ If you want to contribute code, it is recommended to refer to the existing feature documentation and development environment build documentation first. You can run `npm run plop` and enter the component name to generate a new component template
48
+
49
+ ## GIT commit specification
50
+
51
+ In order to standardize the commit-msg format, it is recommended to use `yarn cz` to automatically generate commit-msg, with different commit markers to standardize and differentiate the commit content:
52
+
53
+ ```
54
+ <tag>(<component name>): [submitted summary notes] issue #[123]
55
+ // Skip a line
56
+ <details of this change>
57
+ // Skip a line
58
+ <footer>
59
+ ```
60
+
61
+ example:
62
+
63
+ ```shell
64
+ chore(common): Standard component library development process
65
+
66
+ affects: bkui-vue, @bkui-vue/button, @bkui-vue/checkbox, @bkui-vue/input, @bkui-vue/radio
67
+
68
+ Allow a single component to execute jest tasks
69
+ Add husky submission process verification
70
+ Add chanelog automatic generation mechanism
71
+
72
+ ISSUES CLOSED: #1
73
+ ```
74
+
75
+ ### tag description:
76
+
77
+ | tag | description |
78
+ | -------------- | ------------------------------------------- |
79
+ | feature/feat | new feature development |
80
+ | bug/fix/bugfix | bug fix |
81
+ | refactor/perf | refactor code/optimize configuration & parameters/optimize logic and functions |
82
+ | test | add unit test case related |
83
+ | docs | add document |
84
+ | info | add comment information |
85
+ | format | Without modifying the business logic, only format the code specification |
86
+ | merge | only do branch merge sync |
87
+ | depend | add, delete and modify the dependencies of the project |
88
+ | chore | build scripts, tasks and other related code |
89
+ | del | remove disruptive actions such as features, APIs, etc. that may still be used |