uni-app.d.ts 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  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: UniTouch[];
  146. touches: UniTouch[];
  147. stopPropagation: () => void;
  148. preventDefault: () => void;
  149. }
  150. declare interface UniPointerEvent extends UniEvent {
  151. clickX: number;
  152. clickY: number;
  153. pageX: number;
  154. pageY: number;
  155. screenX: number;
  156. screenY: number;
  157. x: number;
  158. y: number;
  159. }
  160. declare interface UniSliderChangeEvent extends UniEvent {
  161. detail: {
  162. value: number;
  163. };
  164. }
  165. declare interface UniPickerViewChangeEvent extends UniEvent {
  166. detail: {
  167. value: number[];
  168. };
  169. }
  170. declare interface UniScrollEvent extends UniEvent {
  171. detail: {
  172. scrollTop: number;
  173. scrollLeft: number;
  174. scrollHeight: number;
  175. scrollWidth: number;
  176. deltaY: number;
  177. deltaX: number;
  178. };
  179. }
  180. declare interface UniScrollToUpperEvent extends UniEvent {
  181. detail: {
  182. direction: string;
  183. };
  184. }
  185. declare interface UniScrollToLowerEvent extends UniEvent {
  186. detail: {
  187. direction: string;
  188. };
  189. }
  190. declare interface UniRefresherEvent extends UniEvent {
  191. detail: {
  192. dy: number;
  193. };
  194. }
  195. declare interface UniSwiperChangeEvent extends UniEvent {
  196. detail: {
  197. current: number;
  198. currentItemId: string;
  199. source: string;
  200. };
  201. }
  202. declare interface UniMouseEvent extends UniEvent {
  203. clientX: number;
  204. clientY: number;
  205. pageX: number;
  206. pageY: number;
  207. screenX: number;
  208. screenY: number;
  209. x: number;
  210. y: number;
  211. }
  212. declare interface UniImageLoadEvent extends UniEvent {
  213. detail: {
  214. width: number;
  215. height: number;
  216. };
  217. }
  218. declare interface JSON {
  219. parseObject<T>(text: string): T | null;
  220. }
  221. declare type UTSJSONObject = {
  222. [key: string]: any;
  223. parse?<T>(): T | null;
  224. get?(key: string): any | null;
  225. set?(key: string, value: any | null): void;
  226. getAny?(key: string): any | null;
  227. getAny?(key: string, def: any): any;
  228. getBoolean?(key: string): boolean | null;
  229. getBoolean?(key: string, def: any): boolean;
  230. getNumber?(key: string): number | null;
  231. getNumber?(key: string, def: any): number;
  232. getString?(key: string): string | null;
  233. getString?(key: string, def: any): string;
  234. getJSON?(key: string): UTSJSONObject | null;
  235. getJSON?(key: string, def: any): UTSJSONObject;
  236. getArray?<T>(key: string): T[] | null;
  237. getArray?<T>(key: string, def: T[]): T[];
  238. getArray?(key: string): any[] | null;
  239. getArray?(key: string, def: any[]): any[];
  240. toMap?(): Map<string, any>;
  241. };
  242. declare interface ChooseImageTempFile {
  243. path: string;
  244. size: number;
  245. name: string;
  246. type: string;
  247. }
  248. declare type RequestMethod =
  249. | "OPTIONS"
  250. | "GET"
  251. | "HEAD"
  252. | "POST"
  253. | "PUT"
  254. | "DELETE"
  255. | "TRACE"
  256. | "CONNECT";
  257. declare const onAddToFavorites: (
  258. hook: (options: Page.AddToFavoritesOption) => Page.CustomFavoritesContent,
  259. target?: ComponentInternalInstance | null
  260. ) => void;
  261. declare const onBackPress: (
  262. hook: (options: Page.BackPressOption) => any,
  263. target?: ComponentInternalInstance | null
  264. ) => void;
  265. declare const onError: (
  266. hook: (error: string) => void,
  267. target?: ComponentInternalInstance | null
  268. ) => void;
  269. declare const onExit: (hook: () => void, target?: ComponentInternalInstance | null) => void;
  270. declare const onHide: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  271. declare const onInit: (
  272. hook: (query?: AnyObject | undefined) => void,
  273. target?: ComponentInternalInstance | null
  274. ) => void;
  275. declare const onLaunch: (
  276. hook: (options?: App.LaunchShowOption | undefined) => void,
  277. target?: ComponentInternalInstance | null
  278. ) => void;
  279. declare const onLoad: (
  280. hook: (query?: AnyObject | undefined) => void,
  281. target?: ComponentInternalInstance | null
  282. ) => void;
  283. declare const onNavigationBarButtonTap: (
  284. hook: (options: Page.NavigationBarButtonTapOption) => void,
  285. target?: ComponentInternalInstance | null
  286. ) => void;
  287. declare const onNavigationBarSearchInputChanged: (
  288. hook: (event: Page.NavigationBarSearchInputEvent) => void,
  289. target?: ComponentInternalInstance | null
  290. ) => void;
  291. declare const onNavigationBarSearchInputClicked: (
  292. hook: () => any,
  293. target?: ComponentInternalInstance | null
  294. ) => void;
  295. declare const onNavigationBarSearchInputConfirmed: (
  296. hook: (event: Page.NavigationBarSearchInputEvent) => void,
  297. target?: ComponentInternalInstance | null
  298. ) => void;
  299. declare const onNavigationBarSearchInputFocusChanged: (
  300. hook: onNavigationBarSearchInputFocusChangedHook,
  301. target?: ComponentInternalInstance | null
  302. ) => void;
  303. declare type onNavigationBarSearchInputFocusChangedHook = (
  304. options: NavigationBarSearchInputFocusChanged
  305. ) => void;
  306. declare const onPageHide: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  307. declare const onPageNotFound: (
  308. hook: (options: App.PageNotFoundOption) => void,
  309. target?: ComponentInternalInstance | null
  310. ) => void;
  311. declare const onPageScroll: (
  312. hook: (options: Page.PageScrollOption) => void,
  313. target?: ComponentInternalInstance | null
  314. ) => void;
  315. declare const onPageShow: (
  316. hook: ((options?: App.LaunchShowOption | undefined) => void) | (() => void),
  317. target?: ComponentInternalInstance | null
  318. ) => void;
  319. declare const onPullDownRefresh: (
  320. hook: () => any,
  321. target?: ComponentInternalInstance | null
  322. ) => void;
  323. declare const onReachBottom: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  324. declare const onReady: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  325. declare const onResize: (
  326. hook: (options: Page.ResizeOption) => void,
  327. target?: ComponentInternalInstance | null
  328. ) => void;
  329. declare const onSaveExitState: (
  330. hook: onSaveExitStateHook,
  331. target?: ComponentInternalInstance | null
  332. ) => void;
  333. declare type onSaveExitStateHook = () => SaveExitState;
  334. declare const onShareAppMessage: (
  335. hook: (
  336. options: Page.ShareAppMessageOption
  337. ) => Page.CustomShareContent | Promise<Omit<Page.CustomShareContent, "promise">>,
  338. target?: ComponentInternalInstance | null
  339. ) => void;
  340. declare const onShareTimeline: (
  341. hook: () => Page.ShareTimelineContent,
  342. target?: ComponentInternalInstance | null
  343. ) => void;
  344. declare const onShow: (
  345. hook: ((options?: App.LaunchShowOption | undefined) => void) | (() => void),
  346. target?: ComponentInternalInstance | null
  347. ) => void;
  348. declare const onTabItemTap: (
  349. hook: (options: Page.TabItemTapOption) => void,
  350. target?: ComponentInternalInstance | null
  351. ) => void;
  352. declare const onThemeChange: (
  353. hook: (options: UniApp.OnThemeChangeCallbackResult) => void,
  354. target?: ComponentInternalInstance | null
  355. ) => void;
  356. declare const onUnhandledRejection: (
  357. hook: (options: UniApp.OnUnhandledRejectionCallbackResult) => void,
  358. target?: ComponentInternalInstance | null
  359. ) => void;
  360. declare const onUnload: (hook: () => any, target?: ComponentInternalInstance | null) => void;
  361. declare interface DOMRect {
  362. x: number;
  363. y: number;
  364. width: number;
  365. height: number;
  366. left: number;
  367. top: number;
  368. right: number;
  369. bottom: number;
  370. }
  371. declare interface UniElement {
  372. $vm: ComponentPublicInstance;
  373. id: string;
  374. firstChild: UniElement;
  375. lastChild: UniElement;
  376. previousSibling: UniElement;
  377. parentElement: UniElement;
  378. children: UniElement[];
  379. attributes: Map<string, any>;
  380. dataset: Map<string, any>;
  381. style: CSSStyleDeclaration;
  382. classList: string[];
  383. takeSnapshot(options: {
  384. success?: (res: { tempFilePath: string }) => void;
  385. fail?: (err: { errCode: number; errMsg: string }) => void;
  386. }): void;
  387. getBoundingClientRectAsync(): Promise<DOMRect>;
  388. getBoundingClientRect(): DOMRect;
  389. getDrawableContext(): DrawableContext;
  390. animate(
  391. keyframes: UniAnimationKeyframe | UniAnimationKeyframe[],
  392. options?:
  393. | {
  394. delay?: number;
  395. direction?: "normal" | "reverse" | "alternate" | "alternate-reverse";
  396. duration?: number;
  397. easing?:
  398. | "ease"
  399. | "ease-in"
  400. | "ease-out"
  401. | "ease-in-out"
  402. | "linear"
  403. | "cubic-bezier";
  404. fill?: "backwards" | "forwards" | "both" | "none";
  405. iterations?: number;
  406. }
  407. | number
  408. ): { id: string; playState: "running" | "paused" | "finished" | "idle" } | null;
  409. }
  410. declare interface CanvasContext extends HTMLCanvasElement {
  411. createImage(): HTMLImageElement;
  412. reset(): void;
  413. }
  414. declare type Image = HTMLImageElement;
  415. declare type VueApp = any;
  416. declare interface UniNativeViewElement extends UniElement {
  417. bindAndroidView(view: any): void;
  418. bindIOSView(): void;
  419. bindHarmonyFrameNode(node: FrameNode): void;
  420. bindHarmonyWrappedBuilder<O extends Object>(
  421. builder: WrappedBuilder<[options: O]>
  422. ): BuilderNode<[O]>;
  423. getHarmonyFrameNode(): FrameNode | null;
  424. }
  425. declare type UniNativeViewInitEvent = {
  426. detail: {
  427. element: UniNativeViewElement;
  428. };
  429. };