jwtx-common-component-library开发文档

55 阅读3分钟

jwtx-common-component-library开发文档

适用于PC端涉及表单功能的后台管理系统,简化开发流程,开箱即用

作者:杭文镭

npm地址:www.npmjs.com/package/jwt…

改进建议(邮箱):hangwenlei@gmail.com

在线文档地址:kdocs.cn/join/gt3jfa… (后期会进行在线化文档部署)

依赖环境:Vue3 + vite + element-plus + sass

组件库

  1. JwTable 表格
  • 支持单元格宽度根据文本内容长度自适应
  • 表格行的操作按钮组会根据操作列的宽度进行自适应,放不下的按钮则自动进入更多下拉列
  • 表格的统一操作按钮组(比如批量操作)支持统一化配置,内置了弹窗,仅需将弹窗功能内容放入插槽即可
  • 支持当前页以及跨页进行表格的勾选操作
  • 表头列的展现、表格行的操作按钮、统一操作按钮可进行权限化配置
  • 可接收一个返回promise的函数,用来异步获取表格数据(言外之意就是支持将表格数据的请求接口直接传入,并传入一个数据格式化的函数使表格内容正常展现,筛选条件需额外传入,会被自动带到请求的参数中去),也支持直接静态数据的传入并展现
  • 对于分页的支持
  • 表头列的展示支持动态函数传入控制
  • 所有其余配置继承element-plus的table组件
  1. JwBtnList 按钮群组
  • 支持权限配置
  • 支持按钮群组根据父容器的宽度进行自适应,放不下的按钮则自动进入更多下拉列(从JwTable组件中单独抽离出来)
  1. JwTform 表单
  • 支持权限配置
  • 集成了input、inputNumber、select、datePicker、timerPicker交互组件,所有配置也继承自element-plus,简化开发。v-model直接绑定一个表单数据对象,传入一个配置对象控制各个交互项
  • 如果是inline模式,每一表单交互项会以最合适的宽度自适应布满整个父容器,如果是block模式,则单个表单交互会设为width: 100%
  1. JwSearch 筛选交互项群组
  • 对JwForm进行再次封装成一个针对搜索的模块组件
  1. JwImage 图片
  • 优化了图片加载的视觉效果,支持三种模式:默认加载(行内元素)、以块级元素加载(区域块)、转圈圈的加载方式
  • 图片从加载到现实做了淡入的效果
  • 支持控制图片防止被选中跟拖拽
  1. JwIcon 图标
  • 结合本地字体图标库使用,传入一个class类名
  1. JwLoadingSelect 下拉筛选项
  • 传入一个返回promise的函数,用来加载下拉数据,下拉数据会在下拉事件触发的时候执行,也支持直接传入下拉数据
  1. JwUploadImage 图片上传
  2. JwUploadImageSingle 单个图片上传
  3. JwUploadImageBlock 图片上传(整个区域块)

自定义指令

  1. v-echart 数据图形可视化
  2. v-draggable 拖拽
  3. v-resize 监听元素尺寸变化
  4. v-permission 权限管理
  5. v-tooltip 文本tooltip显示优化

公共方法

  1. aesDecrypt
  2. aesEncrypt
  3. cloneRestForm
  4. convertToDate
  5. copyText
  6. deepFindFromOut
  7. deepForEachFromOut
  8. deepFindObjectAndParents
  9. downloadZipByCDN
  10. fileDownload
  11. findLabelPathByKey
  12. flattenArray
  13. floorToTwoDecimalsString
  14. fmtRefObjAttrs
  15. formatDateTimeToString
  16. formatDateToString
  17. formatTime
  18. generateRandomString
  19. getActualSize
  20. getActualTextWidth
  21. getCloneForm
  22. getDepth
  23. getFmtDateTimeData
  24. getFmtTimePickerData
  25. getLastMonthRange
  26. getLastYearRange
  27. getPermission
  28. getSessionStore
  29. getStore
  30. isNull
  31. isPrimitive
  32. isPromise
  33. isUncloneableType
  34. loadFont
  35. parseStyleString
  36. removeSessionStore
  37. removeStore
  38. rsaEncrypt
  39. setRemSize
  40. setSessionStore
  41. setStore
  42. showNoPermissionOverlay
  43. hideNoPermissionOverlay