uni-app.d.ts 9.7 KB

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