uni-app.d.ts 9.7 KB

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