uni-app.d.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. declare module "@dcloudio/vite-plugin-uni";
  2. declare module "@/uni_modules/cool-vibrate" {
  3. export function vibrate(duration: number): void;
  4. }
  5. declare module "@/uni_modules/cool-open-web" {
  6. export function openWeb(url: string): boolean;
  7. }
  8. declare type Theme = "light" | "dark";
  9. declare interface Uni {
  10. setAppTheme(options: {
  11. theme: "auto" | Theme;
  12. success?: () => void;
  13. fail?: (err: {
  14. errCode: number;
  15. errSubject: string;
  16. data: UTSJSONObject;
  17. errMsg: string;
  18. }) => void;
  19. }): void;
  20. onAppThemeChange(callback: (res: { appTheme: Theme }) => void): number;
  21. onOsThemeChange(callback: (res: { osTheme: Theme }) => void): number;
  22. onHostThemeChange(callback: (res: { hostTheme: Theme }) => void): void;
  23. createCanvasContextAsync(options: {
  24. id: string;
  25. component: ComponentInternalInstance;
  26. success?: (context: CanvasContext) => void;
  27. fail?: (err: {
  28. errCode: number;
  29. errSubject: string;
  30. data: UTSJSONObject;
  31. errMsg: string;
  32. }) => void;
  33. complete?: () => void;
  34. }): Promise<CanvasContext>;
  35. rpx2px(px: number): number;
  36. }
  37. declare interface NodeInfo {
  38. id?: string;
  39. bottom?: number;
  40. context?: number;
  41. dataset?: number;
  42. height?: number;
  43. left?: number;
  44. node?: number;
  45. right?: number;
  46. scrollHeight?: number;
  47. scrollLeft?: number;
  48. scrollTop?: number;
  49. scrollWidth?: number;
  50. top?: number;
  51. width?: number;
  52. }
  53. declare interface UniEvent {
  54. bubbles: boolean;
  55. cancelable: boolean;
  56. type: string;
  57. target: any;
  58. currentTarget: any;
  59. timeStamp: number;
  60. [key: string]: any;
  61. }
  62. declare interface UniInputEvent extends UniEvent {
  63. detail: {
  64. value: string;
  65. cursor: number;
  66. };
  67. }
  68. declare interface UniInputFocusEvent extends UniEvent {
  69. detail: {
  70. value: string;
  71. height: number;
  72. };
  73. }
  74. declare interface UniTextareaFocusEvent extends UniEvent {
  75. detail: {
  76. value: string;
  77. height: number;
  78. };
  79. }
  80. declare interface UniInputBlurEvent extends UniEvent {
  81. detail: {
  82. value: string;
  83. cursor: number;
  84. };
  85. }
  86. declare interface UniTextareaBlurEvent extends UniEvent {
  87. detail: {
  88. value: string;
  89. cursor: number;
  90. };
  91. }
  92. declare interface UniInputConfirmEvent extends UniEvent {
  93. type: "confirm";
  94. detail: {
  95. value: string;
  96. };
  97. }
  98. declare interface UniInputKeyboardHeightChangeEvent extends UniEvent {
  99. type: "keyboardheightchange";
  100. target: {
  101. autofocus: boolean;
  102. disabled: boolean;
  103. type: string;
  104. value: string;
  105. };
  106. currentTarget: {
  107. autofocus: boolean;
  108. disabled: boolean;
  109. type: string;
  110. value: string;
  111. };
  112. isStopPropagation: boolean;
  113. detail: {
  114. duration: number;
  115. height: number;
  116. };
  117. }
  118. declare interface UniTextareaLineChangeEvent extends UniEvent {
  119. detail: {
  120. lineCount: number;
  121. heightRpx: number;
  122. height: number;
  123. };
  124. }
  125. declare interface UniTextareaBlurEvent extends UniEvent {
  126. detail: {
  127. value: string;
  128. cursor: number;
  129. };
  130. }
  131. declare interface UniTouch {
  132. clientX: number;
  133. clientY: number;
  134. force: number;
  135. identifier: number;
  136. pageX: number;
  137. pageY: number;
  138. radiusX: number;
  139. radiusY: number;
  140. rotationAngle: number;
  141. screenX: number;
  142. screenY: number;
  143. }
  144. declare interface UniTouchEvent extends UniEvent {
  145. changedTouches: {
  146. clientX: number;
  147. clientY: number;
  148. force: number;
  149. identifier: number;
  150. pageX: number;
  151. pageY: number;
  152. screenX: number;
  153. screenY: number;
  154. }[];
  155. touches: UniTouch[];
  156. stopPropagation: () => void;
  157. preventDefault: () => void;
  158. }
  159. declare interface UniPointerEvent extends UniEvent {
  160. clickX: number;
  161. clickY: number;
  162. pageX: number;
  163. pageY: number;
  164. screenX: number;
  165. screenY: number;
  166. x: number;
  167. y: number;
  168. }
  169. declare interface UniSliderChangeEvent extends UniEvent {
  170. detail: {
  171. value: number;
  172. };
  173. }
  174. declare interface UniPickerViewChangeEvent extends UniEvent {
  175. detail: {
  176. value: number[];
  177. };
  178. }
  179. declare interface UniScrollEvent extends UniEvent {
  180. detail: {
  181. scrollTop: number;
  182. scrollLeft: number;
  183. scrollHeight: number;
  184. scrollWidth: number;
  185. deltaY: number;
  186. deltaX: number;
  187. };
  188. }
  189. declare interface UniScrollToUpperEvent extends UniEvent {
  190. detail: {
  191. direction: string;
  192. };
  193. }
  194. declare interface UniScrollToLowerEvent extends UniEvent {
  195. detail: {
  196. direction: string;
  197. };
  198. }
  199. declare interface UniRefresherEvent extends UniEvent {
  200. detail: {
  201. dy: number;
  202. };
  203. }
  204. declare interface UniSwiperChangeEvent extends UniEvent {
  205. detail: {
  206. current: number;
  207. currentItemId: string;
  208. source: string;
  209. };
  210. }
  211. declare interface UniMouseEvent extends UniEvent {
  212. clientX: number;
  213. clientY: number;
  214. pageX: number;
  215. pageY: number;
  216. screenX: number;
  217. screenY: number;
  218. x: number;
  219. y: number;
  220. }
  221. declare interface UniImageLoadEvent extends UniEvent {
  222. detail: {
  223. width: number;
  224. height: number;
  225. };
  226. }
  227. declare interface JSON {
  228. parseObject<T>(text: string): T | null;
  229. }
  230. declare type UTSJSONObject = {
  231. [key: string]: any;
  232. parse?<T>(): T | null;
  233. get?(key: string): any | null;
  234. set?(key: string, value: any | null): void;
  235. getAny?(key: string): any | null;
  236. getAny?(key: string, def: any): any;
  237. getBoolean?(key: string): boolean | null;
  238. getBoolean?(key: string, def: any): boolean;
  239. getNumber?(key: string): number | null;
  240. getNumber?(key: string, def: any): number;
  241. getString?(key: string): string | null;
  242. getString?(key: string, def: any): string;
  243. getJSON?(key: string): UTSJSONObject | null;
  244. getJSON?(key: string, def: any): UTSJSONObject;
  245. getArray?<T>(key: string): T[] | null;
  246. getArray?<T>(key: string, def: T[]): T[];
  247. getArray?(key: string): any[] | null;
  248. getArray?(key: string, def: any[]): any[];
  249. toMap?(): Map<string, any>;
  250. };
  251. declare interface ChooseImageTempFile {
  252. path: string;
  253. size: number;
  254. name: string;
  255. type: string;
  256. }
  257. declare type RequestMethod =
  258. | "OPTIONS"
  259. | "GET"
  260. | "HEAD"
  261. | "POST"
  262. | "PUT"
  263. | "DELETE"
  264. | "TRACE"
  265. | "CONNECT";
  266. declare const onAddToFavorites: (
  267. hook: (options: Page.AddToFavoritesOption) => Page.CustomFavoritesContent,
  268. target?: ComponentInternalInstance | null
  269. ) => void;
  270. declare const onBackPress: (
  271. hook: (options: Page.BackPressOption) => any,
  272. target?: ComponentInternalInstance | null
  273. ) => void;
  274. declare const onError: (
  275. hook: (error: string) => void,
  276. target?: ComponentInternalInstance | null
  277. ) => void;
  278. declare const onExit: (hook: () => void, target?: ComponentInternalInstance | null) => void;
  279. declare const onHide: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  280. declare const onInit: (
  281. hook: (query?: AnyObject | undefined) => void,
  282. target?: ComponentInternalInstance | null
  283. ) => void;
  284. declare const onLaunch: (
  285. hook: (options?: App.LaunchShowOption | undefined) => void,
  286. target?: ComponentInternalInstance | null
  287. ) => void;
  288. declare const onLoad: (
  289. hook: (query?: AnyObject | undefined) => void,
  290. target?: ComponentInternalInstance | null
  291. ) => void;
  292. declare const onNavigationBarButtonTap: (
  293. hook: (options: Page.NavigationBarButtonTapOption) => void,
  294. target?: ComponentInternalInstance | null
  295. ) => void;
  296. declare const onNavigationBarSearchInputChanged: (
  297. hook: (event: Page.NavigationBarSearchInputEvent) => void,
  298. target?: ComponentInternalInstance | null
  299. ) => void;
  300. declare const onNavigationBarSearchInputClicked: (
  301. hook: () => any,
  302. target?: ComponentInternalInstance | null
  303. ) => void;
  304. declare const onNavigationBarSearchInputConfirmed: (
  305. hook: (event: Page.NavigationBarSearchInputEvent) => void,
  306. target?: ComponentInternalInstance | null
  307. ) => void;
  308. declare const onNavigationBarSearchInputFocusChanged: (
  309. hook: onNavigationBarSearchInputFocusChangedHook,
  310. target?: ComponentInternalInstance | null
  311. ) => void;
  312. declare type onNavigationBarSearchInputFocusChangedHook = (
  313. options: NavigationBarSearchInputFocusChanged
  314. ) => void;
  315. declare const onPageHide: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  316. declare const onPageNotFound: (
  317. hook: (options: App.PageNotFoundOption) => void,
  318. target?: ComponentInternalInstance | null
  319. ) => void;
  320. declare const onPageScroll: (
  321. hook: (options: Page.PageScrollOption) => void,
  322. target?: ComponentInternalInstance | null
  323. ) => void;
  324. declare const onPageShow: (
  325. hook: ((options?: App.LaunchShowOption | undefined) => void) | (() => void),
  326. target?: ComponentInternalInstance | null
  327. ) => void;
  328. declare const onPullDownRefresh: (
  329. hook: () => any,
  330. target?: ComponentInternalInstance | null
  331. ) => void;
  332. declare const onReachBottom: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  333. declare const onReady: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  334. declare const onResize: (
  335. hook: (options: Page.ResizeOption) => void,
  336. target?: ComponentInternalInstance | null
  337. ) => void;
  338. declare const onSaveExitState: (
  339. hook: onSaveExitStateHook,
  340. target?: ComponentInternalInstance | null
  341. ) => void;
  342. declare type onSaveExitStateHook = () => SaveExitState;
  343. declare const onShareAppMessage: (
  344. hook: (
  345. options: Page.ShareAppMessageOption
  346. ) => Page.CustomShareContent | Promise<Omit<Page.CustomShareContent, "promise">>,
  347. target?: ComponentInternalInstance | null
  348. ) => void;
  349. declare const onShareTimeline: (
  350. hook: () => Page.ShareTimelineContent,
  351. target?: ComponentInternalInstance | null
  352. ) => void;
  353. declare const onShow: (
  354. hook: ((options?: App.LaunchShowOption | undefined) => void) | (() => void),
  355. target?: ComponentInternalInstance | null
  356. ) => void;
  357. declare const onTabItemTap: (
  358. hook: (options: Page.TabItemTapOption) => void,
  359. target?: ComponentInternalInstance | null
  360. ) => void;
  361. declare const onThemeChange: (
  362. hook: (options: UniApp.OnThemeChangeCallbackResult) => void,
  363. target?: ComponentInternalInstance | null
  364. ) => void;
  365. declare const onUnhandledRejection: (
  366. hook: (options: UniApp.OnUnhandledRejectionCallbackResult) => void,
  367. target?: ComponentInternalInstance | null
  368. ) => void;
  369. declare const onUnload: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  370. declare interface UniElement {
  371. $vm: ComponentPublicInstance;
  372. id: string;
  373. firstChild: UniElement;
  374. lastChild: UniElement;
  375. previousSibling: UniElement;
  376. parentElement: UniElement;
  377. children: UniElement[];
  378. attributes: Map<string, any>;
  379. dataset: Map<string, any>;
  380. style: CSSStyleDeclaration;
  381. classList: string[];
  382. takeSnapshot(options: {
  383. success?: (res: { tempFilePath: string }) => void;
  384. fail?: (err: { errCode: number; errMsg: string }) => void;
  385. }): void;
  386. }
  387. declare interface CanvasContext extends HTMLCanvasElement {
  388. createImage(): HTMLImageElement;
  389. reset(): void;
  390. }
  391. declare type Image = HTMLImageElement;
  392. declare type VueApp = any;