tis-cli前端项目快速搭建命令行工具
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

88 lines
3.4 KiB

  1. # 框架应用集成业务组件&开发指南
  2. ## 1. 前期准备
  3. 需要提前下载tis-design代码,目前tis-design代码包含三个package:```web,mobile,components```
  4. 克隆tis-design代码仓库:```git clone ssh://git@sekiyika.tpddns.cn:8022/home/git/tis-design.git```
  5. - web;
  6. 基础PC组件
  7. - mobile:
  8. 基础移动端组件
  9. - components:
  10. 公共业务组件,根据业务需要基于tis-ui进行封装开发
  11. 要在业务框架和应用开发环境下使用公共业务组件,需要先启动tis-design服务,具体操作:
  12. [1] 到tis-design目录下执行装包命令:```yarn run bootstrap```
  13. [2] 打包一次web组件和mobile组件,执行:```yarn run build:dist```
  14. [3] 启动业务组件components,执行:```yarn run start:component```
  15. 启动之后通过访问:http://localhost:9901/lib.bundle.js 可以获取到业务组件的js
  16. 样式文件的访问地址:http://localhost:9901/lib/index.css
  17. 在框架和应用中通过cdn和external配置的形式进行使用
  18. ## 2. 如何开发
  19. 开发阶段,在app_demo下的index.html,需要引入以下内容:
  20. ```html
  21. <!-- 引入tis-component样式文件,根据不同环境引入 -->
  22. <%=process.env.NODE_ENV==='production' ? '<link rel="stylesheet" href="http://cdn-address.com/tis-component.min.css">' : '<link rel="stylesheet" href="http://localhost:9901/tis-component.min.css">'%>
  23. <!-- CDN的方式引用tis-component,需要先引入vue -->
  24. <script src="https://unpkg.com/vue/dist/vue.js"></script>
  25. <!-- 引入tis-component,根据不同环境引入 -->
  26. <%=process.env.NODE_ENV==='production' ? '<script src="http://cdn-address.com/tis-component.min.js"></script>' : '<script src="http://localhost:9901/tis-component.min.js"></script>'%>
  27. ```
  28. 特别说明:production环境下,需要对应的CDN或者静态资源服务器提供对应的tis-component组件的CSS样式和JS脚本文件的访问地址.此处的 http://cdn-address.com 只是一个示例,需要根据实际CDN地址做对应的替换即可
  29. 还需要在vue.config.js中设置对应的externals(目前app_demo下面的vue.config.js已经更新以下代码):
  30. ```javascript
  31. configureWebpack: {
  32. externals: {
  33. 'tiscom': 'TISCOM',// 业务代码中可以通过 import 'tiscom' 的方式使用,或者全局不需要再import,也可以直接使用tis-component中提供的业务组件
  34. 'vue': {
  35. root: 'Vue',
  36. commonjs: 'vue',
  37. commonjs2: 'vue',
  38. amd: 'vue'
  39. }
  40. }
  41. }
  42. ```
  43. 启动项目后,即可在全局使用业务组件,例如```src/App.vue```下的代码片段:
  44. 以下代码中使用的```<tisc-table-list></tisc-table-list>```可以直接使用,无需再手动import引入,且会根据tis-design下面的components包里的代码修改实时更新
  45. ```html
  46. <template>
  47. <div id="app">
  48. <div>应用中使用业务组件示例</div>
  49. <tisc-table-list></tisc-table-list>
  50. </div>
  51. </template>
  52. ```
  53. ## 3. 打包上线
  54. 打包需要配置对应的cdn或者静态资源服务,存放tis-design相关的打包后的静态资源.
  55. 在tis-design仓库下打包 component 库
  56. 打包命令:```npm run build:component```
  57. 打包后输出的文件目录:
  58. JS文件目录:```tis-design/packages/components/lib/tis-component.min.js```
  59. CSS文件目录:```tis-design/packages/components/lib/tis-component.min.css```
  60. 存放到对应的静态资源服务之后,可以在app_demo下的```public/index.html```中替换对应资源的地址,完成最终的打包上线