uni-app.d.ts 11 KB

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