global.d.ts 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  1. declare const __UNI_PLATFORM__:
  2. | 'h5'
  3. | 'app'
  4. | 'mp-alipay'
  5. | 'mp-baidu'
  6. | 'mp-jd'
  7. | 'mp-kuaishou'
  8. | 'mp-lark'
  9. | 'mp-qq'
  10. | 'mp-toutiao'
  11. | 'mp-weixin'
  12. | 'quickapp-webview'
  13. | 'quickapp-webview-huawei'
  14. | 'quickapp-webview-union'
  15. declare const __VITE_APP_PROXY__: 'true' | 'false'
  16. /** 字段分组映射 */
  17. type IFieldGroup<T> = {
  18. /** 分组标题 */
  19. title?: stirng
  20. /** 分组样式表 */
  21. class?: stirng[]
  22. /** 所需角色,未设置则都可见 */
  23. roles?: string[]
  24. /** 组内包含的 字段信息 */
  25. fields: {
  26. /** 字段显示标题 */
  27. title: string
  28. /** 字段对应的key */
  29. key?: string
  30. /** 字段 样式 */
  31. keyClass
  32. /** 前缀内容 */
  33. preInfo: string
  34. /** 单位 */
  35. unit: string
  36. /** 显示条件 */
  37. show: (args: T) => boolean
  38. /** 呈现内容 */
  39. view: (args: T & string) => string
  40. /** 插槽名称 */
  41. slot?: string
  42. }[]
  43. }
  44. interface CopyGlobalStyle {
  45. /**
  46. * 导航栏背景颜色(同状态栏背景色),支持 HEX 颜色
  47. *
  48. * @desc APP 与 H5 为 #F8F8F8,小程序平台请参考相应小程序文档
  49. *
  50. * @format color
  51. */
  52. navigationBarBackgroundColor?: HEXColor | ThemeVar
  53. /**
  54. * 导航栏标题颜色及状态栏前景颜色,仅支持 "black" / "white"
  55. *
  56. * @default "black"
  57. *
  58. * @desc 支付宝小程序不支持,请使用 my.setNavigationBar
  59. */
  60. navigationBarTextStyle?: 'black' | 'white' | ThemeVar
  61. /**
  62. * 导航栏标题文字内容
  63. */
  64. navigationBarTitleText?: string
  65. /**
  66. * 导航栏阴影
  67. */
  68. navigationBarShadow?: {
  69. /**
  70. * 阴影颜色
  71. */
  72. colorType?: 'grey' | 'blue' | 'green' | 'orange' | 'red' | 'yellow'
  73. }
  74. /**
  75. * 导航栏样式,仅支持 "default" / "custom"
  76. *
  77. * "custom" 即取消默认的原生导航栏,详看 [使用注意](https://uniapp.dcloud.net.cn/collocation/pages#customnav)
  78. *
  79. * @default "default"
  80. *
  81. * @desc 微信小程序 7.0+、百度小程序、H5、App(2.0.3+)
  82. */
  83. navigationStyle?: 'default' | 'custom'
  84. /**
  85. * 下拉显示出来的窗口的背景色,支持 HEX 颜色
  86. *
  87. * @default "#ffffff"
  88. *
  89. * @desc 微信小程序
  90. *
  91. * @format color
  92. */
  93. backgroundColor?: HEXColor | ThemeVar
  94. /**
  95. * 下拉 loading 的样式,仅支持 "dark" / "light"
  96. *
  97. * @default "dark"
  98. *
  99. * @desc 微信小程序
  100. */
  101. backgroundTextStyle?: 'dark' | 'light' | ThemeVar
  102. /**
  103. * 是否开启下拉刷新,详见 [页面生命周期](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle)
  104. *
  105. * @default false
  106. */
  107. enablePullDownRefresh?: boolean
  108. /**
  109. * 页面上拉触底事件触发时距页面底部距离,单位为 px,详见 [页面生命周期](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle)
  110. *
  111. * @default 50
  112. */
  113. onReachBottomDistance?: number
  114. /**
  115. * 顶部窗口的背景色(bounce回弹区域)
  116. *
  117. * @default "#ffffff"
  118. *
  119. * @desc iOS
  120. *
  121. * @format color
  122. */
  123. backgroundColorTop?: HEXColor | ThemeVar
  124. /**
  125. * 底部窗口的背景色(bounce回弹区域)
  126. *
  127. * @default "#ffffff"
  128. *
  129. * @desc iOS
  130. *
  131. * @format color
  132. */
  133. backgroundColorBottom?: HEXColor | ThemeVar
  134. /**
  135. * 导航栏图片地址(替换当前文字标题)
  136. *
  137. * 支付宝小程序内必须使用 https 图片链接地址
  138. *
  139. * @desc 支付宝小程序、H5、APP
  140. */
  141. titleImage?: string
  142. /**
  143. * 导航栏整体(前景、背景)透明设置,仅支持 "always" / "auto" / "none
  144. *
  145. * "always" 一直透明
  146. *
  147. * "auto" 滑动自适应
  148. *
  149. * "none" 不透明
  150. *
  151. * @default "none"
  152. *
  153. * @desc 支付宝小程序、H5、APP
  154. */
  155. transparentTitle?: 'always' | 'auto' | 'none'
  156. /**
  157. * 导航栏点击穿透
  158. *
  159. * @default "NO"
  160. *
  161. * @desc 支付宝小程序、H5
  162. */
  163. titlePenetrate?: 'YES' | 'NO'
  164. /**
  165. * 横屏配置,屏幕旋转设置,仅支持 "auto" / "portrait" / "landscape",详见 [响应显示区域变化](https://developers.weixin.qq.com/miniprogram/dev/framework/view/resizable.html)
  166. *
  167. * "auto" 自动
  168. *
  169. * "portrait" 竖屏
  170. *
  171. * "landscape" 横屏
  172. *
  173. * @default "portrait"
  174. *
  175. * @desc App 2.4.7+、微信小程序、QQ小程序
  176. */
  177. pageOrientation?: string
  178. /**
  179. * 窗口显示的动画效果,详见 [窗口动画](https://uniapp.dcloud.net.cn/api/router#animation)
  180. *
  181. * @default "pop-in"
  182. *
  183. * @desc App
  184. */
  185. animationType?: AnimationType
  186. /**
  187. * 窗口显示动画的持续时间,单位为 ms
  188. *
  189. * @default 300
  190. *
  191. * @desc App
  192. */
  193. animationDuration?: number
  194. /**
  195. * 设置编译到 App 平台的特定样式,配置项参考 [app-plus](https://uniapp.dcloud.net.cn/collocation/pages#app-plus)
  196. *
  197. * 相应的类型是 AppPlus
  198. *
  199. * @desc App
  200. */
  201. 'app-plus'?: AppPlus
  202. /**
  203. * 设置编译到 H5 平台的特定样式,配置项参考 [H5](https://uniapp.dcloud.net.cn/collocation/pages#h5)
  204. *
  205. * 相应的类型是 H5
  206. *
  207. * @desc H5
  208. */
  209. h5?: H5
  210. /**
  211. * 设置编译到 mp-alipay 平台的特定样式,配置项参考 [MP-ALIPAY](https://uniapp.dcloud.net.cn/collocation/pages#mp-alipay) 和 <https://opendocs.alipay.com/mini/framework/app-json#window>
  212. *
  213. * 相应的类型是 MpAlipay
  214. *
  215. * @desc 支付宝小程序
  216. */
  217. 'mp-alipay'?: MpAlipay
  218. /**
  219. * 设置编译到 mp-weixin 平台的特定样式,配置项参考 [MP-WEIXIN](https://uniapp.dcloud.net.cn/collocation/pages#mp-weixin) 和 <https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#window>
  220. *
  221. * 相应的类型是 MpWeixin
  222. *
  223. * @desc 微信小程序
  224. */
  225. 'mp-weixin'?: MpWeixin
  226. /**
  227. * 设置编译到 mp-baidu 平台的特定样式,配置项参考 [MP-BAIDU](https://uniapp.dcloud.net.cn/collocation/pages.html#mp-baidu) 和 <https://smartprogram.baidu.com/docs/develop/framework/process/#window>
  228. *
  229. * 相应的类型是 MpBaidu
  230. *
  231. * @desc 百度小程序
  232. */
  233. 'mp-baidu'?: MpBaidu
  234. /**
  235. * 设置编译到 mp-toutiao 平台的特定样式,配置项参考 <https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/develop/framework/general-configuration#window>
  236. *
  237. * 相应的类型是 MpToutiao
  238. *
  239. * @desc 抖音小程序
  240. */
  241. 'mp-toutiao'?: MpToutiao
  242. /**
  243. * 设置编译到 mp-lark 平台的特定样式
  244. *
  245. * 相应的类型是 MpLark
  246. *
  247. * @desc 飞书小程序
  248. */
  249. 'mp-lark'?: MpLark
  250. /**
  251. * 设置编译到 mp-qq 平台的特定样式
  252. *
  253. * 相应的类型是 MpQq
  254. *
  255. * @desc QQ 小程序
  256. */
  257. 'mp-qq'?: MpQq
  258. /**
  259. * 设置编译到 mp-kuaishou 平台的特定样式
  260. *
  261. * 相应的类型是 MpKuaishou
  262. *
  263. * @desc 快手小程序
  264. */
  265. 'mp-kuaishou'?: MpKuaishou
  266. /**
  267. * 设置编译到 mp-jd 平台的特定样式
  268. *
  269. * 相应的类型是 MpJd
  270. *
  271. * @desc 京东小程序
  272. */
  273. 'mp-jd'?: MpJd
  274. /**
  275. * 引用小程序组件,详见 [小程序组件](https://uniapp.dcloud.net.cn/tutorial/miniprogram-subject.html#%E5%B0%8F%E7%A8%8B%E5%BA%8F%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BB%84%E4%BB%B6%E6%94%AF%E6%8C%81)
  276. *
  277. * @desc App、微信小程序、支付宝小程序、百度小程序、京东小程序
  278. */
  279. usingComponents?: Record<string, string>
  280. /**
  281. * 同层渲染,webrtc(实时音视频)无法正常时尝试配置为 "seperated" 强制关掉同层渲染
  282. *
  283. * @desc 微信小程序
  284. */
  285. renderingMode?: string
  286. /**
  287. * 当存在 leftWindow 时,默认是否显示 leftWindow,详见 [topWindow](https://uniapp.dcloud.net.cn/collocation/pages.html#topwindow)
  288. *
  289. * @default true
  290. *
  291. * @desc H5
  292. */
  293. leftWindow?: boolean
  294. /**
  295. * 当存在 topWindow 时,默认是否显示 topWindow,详见 [topWindow](https://uniapp.dcloud.net.cn/collocation/pages.html#topwindow)
  296. *
  297. * @default true
  298. *
  299. * @desc H5
  300. */
  301. topWindow?: boolean
  302. /**
  303. * 当存在 rightWindow 时,默认是否显示 rightWindow,详见 [topWindow](https://uniapp.dcloud.net.cn/collocation/pages.html#topwindow)
  304. *
  305. * @default true
  306. *
  307. * @desc H5
  308. */
  309. rightWindow?: boolean
  310. /**
  311. * rpx 计算所支持的最大设备宽度,单位为 px
  312. *
  313. * @default 960
  314. *
  315. * @desc App(vue2 且不含 nvue)、H5(2.8.12+)
  316. */
  317. rpxCalcMaxDeviceWidth?: number
  318. /**
  319. * rpx 计算使用的基准设备宽度,设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算,单位为 px
  320. *
  321. * @default 375
  322. *
  323. * @desc App(vue2 且不含 nvue)、H5(2.8.12+)
  324. */
  325. rpxCalcBaseDeviceWidth?: number
  326. /**
  327. * rpx 计算特殊处理的值,始终按实际的设备宽度计算,单位为 rpx
  328. *
  329. * @default 750
  330. *
  331. * @desc App(vue2 且不含 nvue)、H5(2.8.12+)
  332. */
  333. rpxCalcIncludeWidth?: number
  334. /**
  335. * 是否使用动态 rpx,屏幕大小变化会重新渲染 rpx
  336. *
  337. * @default false
  338. *
  339. * @desc App-nvue(vue3 固定值为 true) 3.2.13+
  340. */
  341. dynamicRpx?: boolean
  342. /**
  343. * 当浏览器可见区域宽度大于 maxWidth 时两侧留白,当小于等于 maxWidth 时页面铺满,单位为 px
  344. *
  345. * 不同页面支持配置不同的 maxWidth
  346. *
  347. * maxWidth = leftWindow(可选)+ page(页面主体)+ rightWindow(可选)
  348. *
  349. * 使用时,页面内 fixed 元素需要使用 --window-left 和 --window-right 来保证布局位置正确
  350. *
  351. * @desc H5(2.9.9+)
  352. */
  353. maxWidth?: number
  354. [x: string]: any
  355. }