config.ts 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. import type { TabBar } from '@uni-helper/vite-plugin-uni-pages'
  2. /**
  3. * tabbar 选择的策略,更详细的介绍见 tabbar.md 文件
  4. * 0: 'NO_TABBAR' `无 tabbar`
  5. * 1: 'NATIVE_TABBAR' `完全原生 tabbar`
  6. * 2: 'CUSTOM_TABBAR_WITH_CACHE' `有缓存自定义 tabbar`
  7. * 3: 'CUSTOM_TABBAR_WITHOUT_CACHE' `无缓存自定义 tabbar`
  8. *
  9. * 温馨提示:本文件的任何代码更改了之后,都需要重新运行,否则 pages.json 不会更新导致配置不生效
  10. */
  11. export const TABBAR_STRATEGY_MAP = {
  12. NO_TABBAR: 0,
  13. NATIVE_TABBAR: 1,
  14. CUSTOM_TABBAR_WITH_CACHE: 2,
  15. CUSTOM_TABBAR_WITHOUT_CACHE: 3,
  16. }
  17. // TODO: 1/3. 通过这里切换使用tabbar的策略
  18. // 如果是使用 NO_TABBAR(0),nativeTabbarList 和 customTabbarList 都不生效(里面的配置不用管)
  19. // 如果是使用 NATIVE_TABBAR(1),只需要配置 nativeTabbarList,customTabbarList 不生效
  20. // 如果是使用 CUSTOM_TABBAR(2,3),只需要配置 customTabbarList,nativeTabbarList 不生效
  21. export const selectedTabbarStrategy = TABBAR_STRATEGY_MAP.NATIVE_TABBAR
  22. type NativeTabBarItem = TabBar['list'][number]
  23. // TODO: 2/3. 使用 NATIVE_TABBAR 时,更新下面的 tabbar 配置
  24. export const nativeTabbarList: NativeTabBarItem[] = [
  25. {
  26. iconPath: 'static/tabbar/home.png',
  27. selectedIconPath: 'static/tabbar/homeHL.png',
  28. pagePath: 'pages/index/index',
  29. text: '首页',
  30. },
  31. {
  32. iconPath: 'static/tabbar/example.png',
  33. selectedIconPath: 'static/tabbar/exampleHL.png',
  34. pagePath: 'pages/about/about',
  35. text: '关于',
  36. },
  37. {
  38. iconPath: 'static/tabbar/personal.png',
  39. selectedIconPath: 'static/tabbar/personalHL.png',
  40. pagePath: 'pages/me/me',
  41. text: '个人',
  42. },
  43. ]
  44. export interface CustomTabBarItem {
  45. text: string
  46. pagePath: string
  47. iconType: 'uniUi' | 'uiLib' | 'unocss' | 'iconfont' | 'image' // 不建议用 image 模式,需要配置2张图
  48. icon: any // 其实是 string 类型,这里是为了避免 ts 报错 (tabbar/index.vue 里面 uni-icons 那行)
  49. activeIcon?: string // 只有在 image 模式下才需要,传递的是高亮的图片(PS: 不建议用 image 模式)
  50. badge?: number | 'dot' // badge 显示一个数字或 小红点(样式可以直接在 tabbar/index.vue 里面修改)
  51. isBulge?: boolean // 是否是中间的鼓包tabbarItem
  52. }
  53. // TODO: 3/3. 使用 CUSTOM_TABBAR(2,3) 时,更新下面的 tabbar 配置
  54. export const customTabbarList: CustomTabBarItem[] = [
  55. {
  56. text: '首页',
  57. pagePath: 'pages/index/index',
  58. // 本框架内置了 uniapp 官方UI库 (uni-ui)的图标库
  59. // 使用方式如:<uni-icons type="home" size="30"/>
  60. // 图标列表地址:https://uniapp.dcloud.net.cn/component/uniui/uni-icons.html
  61. iconType: 'uniUi',
  62. icon: 'home',
  63. // badge: 'dot',
  64. },
  65. {
  66. text: '关于',
  67. pagePath: 'pages/about/about',
  68. // 注意 unocss 图标需要如下处理:(二选一)
  69. // 1)在fg-tabbar.vue页面上引入一下并注释掉(见tabbar/index.vue代码第2行)
  70. // 2)配置到 unocss.config.ts 的 safelist 中
  71. iconType: 'unocss',
  72. icon: 'i-carbon-code',
  73. // badge: 10,
  74. },
  75. {
  76. pagePath: 'pages/me/me',
  77. text: '我的',
  78. iconType: 'uniUi',
  79. icon: 'contact',
  80. },
  81. // {
  82. // pagePath: 'pages/index/index',
  83. // text: '首页',
  84. // 注意 iconfont 图标需要额外加上 'iconfont',如下
  85. // iconType: 'iconfont',
  86. // icon: 'iconfont icon-my',
  87. // // 使用 ‘image’时,需要配置 icon + iconActive 2张图片(不推荐)
  88. // // 既然已经用了自定义tabbar了,就不建议用图片了,所以不推荐
  89. // iconType: 'image',
  90. // icon: '/static/tabbar/home.png',
  91. // iconActive: '/static/tabbar/homeHL.png',
  92. // },
  93. ]
  94. /**
  95. * 是否启用 tabbar 缓存
  96. * NATIVE_TABBAR(1) 和 CUSTOM_TABBAR_WITH_CACHE(2) 时,需要tabbar缓存
  97. */
  98. export const tabbarCacheEnable
  99. = [TABBAR_STRATEGY_MAP.NATIVE_TABBAR, TABBAR_STRATEGY_MAP.CUSTOM_TABBAR_WITH_CACHE].includes(selectedTabbarStrategy)
  100. /**
  101. * 是否启用自定义 tabbar
  102. * CUSTOM_TABBAR(2,3) 时,启用自定义tabbar
  103. */
  104. export const customTabbarEnable
  105. = [TABBAR_STRATEGY_MAP.CUSTOM_TABBAR_WITH_CACHE, TABBAR_STRATEGY_MAP.CUSTOM_TABBAR_WITHOUT_CACHE].includes(selectedTabbarStrategy)
  106. /**
  107. * 是否需要隐藏原生 tabbar
  108. * CUSTOM_TABBAR_WITH_CACHE(2) 时,需要隐藏原生tabbar
  109. */
  110. export const needHideNativeTabbar = selectedTabbarStrategy === TABBAR_STRATEGY_MAP.CUSTOM_TABBAR_WITH_CACHE
  111. const _tabbarList = customTabbarEnable ? customTabbarList.map(item => ({ text: item.text, pagePath: item.pagePath })) : nativeTabbarList
  112. export const tabbarList = customTabbarEnable ? customTabbarList : nativeTabbarList
  113. const _tabbar: TabBar = {
  114. // 只有微信小程序支持 custom。App 和 H5 不生效
  115. custom: selectedTabbarStrategy === TABBAR_STRATEGY_MAP.CUSTOM_TABBAR_WITH_CACHE,
  116. color: '#999999',
  117. selectedColor: '#018d71',
  118. backgroundColor: '#F8F8F8',
  119. borderStyle: 'black',
  120. height: '50px',
  121. fontSize: '10px',
  122. iconWidth: '24px',
  123. spacing: '3px',
  124. list: _tabbarList as unknown as TabBar['list'],
  125. }
  126. // 0和1 需要显示底部的tabbar的各种配置,以利用缓存
  127. export const tabBar = tabbarCacheEnable ? _tabbar : undefined