You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
237 lines
7.9 KiB
237 lines
7.9 KiB
declare namespace Page {
|
|
interface CustomShareContent {
|
|
/**
|
|
* 转发标题。默认值：当前应用名称
|
|
*/
|
|
title?: string;
|
|
/**
|
|
* 转发路径，必须是以 / 开头的完整路径。默认值：当前页面 path
|
|
*/
|
|
path?: string;
|
|
/**
|
|
* 自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4，默认值：使用默认截图
|
|
*/
|
|
imageUrl?: string;
|
|
}
|
|
|
|
interface ShareTimelineContent {
|
|
/**
|
|
* 自定义标题。默认值：当前小程序名称
|
|
*/
|
|
title?: string;
|
|
/**
|
|
* 自定义页面路径中携带的参数
|
|
*/
|
|
path?: string;
|
|
/**
|
|
* 自定义图片路径，可以是本地文件或者网络图片。支持 PNG 及 JPG，显示图片长宽比是 1:1。
|
|
*/
|
|
imageUrl?: string;
|
|
}
|
|
|
|
interface PageScrollOption {
|
|
/**
|
|
* 页面在垂直方向已滚动的距离（单位 px）
|
|
*/
|
|
scrollTop: number;
|
|
}
|
|
|
|
interface ShareAppMessageOption {
|
|
/**
|
|
* 转发事件来源。
|
|
* 可选值：
|
|
* - `button`：页面内转发按钮；
|
|
* - `menu`：右上角转发菜单。
|
|
*/
|
|
from: "button" | "menu";
|
|
/**
|
|
* 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined`
|
|
*/
|
|
target: any;
|
|
/**
|
|
* 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url
|
|
*/
|
|
webViewUrl?: string;
|
|
}
|
|
|
|
interface AddToFavoritesOption {
|
|
/**
|
|
* 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url
|
|
*/
|
|
webviewUrl: string
|
|
}
|
|
|
|
interface CustomFavoritesContent {
|
|
/**
|
|
* 自定义标题，默认值：页面标题或账号名称
|
|
*/
|
|
title?: string;
|
|
/**
|
|
* 自定义 query 字段
|
|
*/
|
|
path?: string;
|
|
/**
|
|
* 自定义图片，显示图片长宽比为 1：1
|
|
*/
|
|
imageUrl?: string;
|
|
}
|
|
|
|
interface TabItemTapOption {
|
|
/**
|
|
* 被点击 tabItem 的序号，从0开始
|
|
*/
|
|
index: string;
|
|
/**
|
|
* 被点击 tabItem 的页面路径
|
|
*/
|
|
pagePath: string;
|
|
/**
|
|
* 被点击 tabItem 的按钮文字
|
|
*/
|
|
text: string;
|
|
}
|
|
|
|
interface NavigationBarButtonTapOption {
|
|
/**
|
|
* 原生标题栏按钮数组的下标
|
|
*/
|
|
index: string;
|
|
}
|
|
|
|
interface BackPressOption {
|
|
/**
|
|
* - backbutton 顶部导航栏左边的返回按钮或 Android 实体返回键
|
|
* - navigateBack 返回 API，即 uni.navigateBack()
|
|
*/
|
|
from: 'backbutton' | 'navigateBack';
|
|
}
|
|
|
|
interface NavigationBarSearchInputEvent {
|
|
/**
|
|
* 搜索输入框输入内容
|
|
*/
|
|
text: string;
|
|
}
|
|
|
|
interface PageInstanceBaseProps<D extends AnyObject = any> {
|
|
/**
|
|
* 到当前页面的路径，类型为 `String`
|
|
*/
|
|
route?: string;
|
|
}
|
|
|
|
interface PageInstance<D extends AnyObject = any, T extends AnyObject = any> extends PageInstanceBaseProps<D> {
|
|
/**
|
|
* 生命周期回调 监听页面加载
|
|
*
|
|
* 页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。
|
|
* @param query 打开当前页面路径中的参数
|
|
*/
|
|
onLoad?(query?: AnyObject): void;
|
|
/**
|
|
* 生命周期回调 监听页面显示
|
|
*
|
|
* 页面显示/切入前台时触发。
|
|
*/
|
|
onShow?(): void;
|
|
/**
|
|
* 生命周期回调 监听页面初次渲染完成
|
|
*
|
|
* 页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。
|
|
*/
|
|
onReady?(): void;
|
|
/**
|
|
* 生命周期回调 监听页面隐藏
|
|
*
|
|
* 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。
|
|
*/
|
|
onHide?(): void;
|
|
/**
|
|
* 生命周期回调 监听页面卸载
|
|
*
|
|
* 页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。
|
|
*/
|
|
onUnload?(): void;
|
|
/**
|
|
* 监听用户下拉动作
|
|
* - 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。
|
|
* - 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
|
|
* - 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。
|
|
*/
|
|
onPullDownRefresh?(): void;
|
|
/**
|
|
* 页面上拉触底事件的处理函数
|
|
* - 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。
|
|
* - 在触发距离内滑动期间，本事件只会被触发一次。
|
|
*/
|
|
onReachBottom?(): void;
|
|
/**
|
|
* 用户点击右上角转发
|
|
*
|
|
* 监听用户点击页面内转发按钮（`<button>` 组件 `open-type="share"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。
|
|
* @param options 分享发起来源参数
|
|
* @return 转发内容
|
|
*/
|
|
onShareAppMessage?(options: ShareAppMessageOption): CustomShareContent;
|
|
/**
|
|
* 用户点击右上角转发到朋友圈
|
|
*
|
|
* 监听右上角菜单“分享到朋友圈”按钮的行为，并自定义发享内容。
|
|
*/
|
|
onShareTimeline?(): ShareTimelineContent;
|
|
/**
|
|
* 用户点击右上角收藏
|
|
*
|
|
* 监听用户点击右上角菜单“收藏”按钮的行为，并自定义收藏内容。
|
|
*/
|
|
onAddToFavorites?(options: AddToFavoritesOption): CustomFavoritesContent;
|
|
/**
|
|
* 页面滚动触发事件的处理函数
|
|
*
|
|
* 监听用户滑动页面事件。
|
|
* @param options 页面滚动参数
|
|
*/
|
|
onPageScroll?(options: PageScrollOption): void;
|
|
/**
|
|
* 页面尺寸改变时触发
|
|
* @param options 页面滚动参数
|
|
*/
|
|
onResize?(options: PageScrollOption): void;
|
|
/**
|
|
* 当前是 tab 页时，点击 tab 时触发
|
|
* @param options tab 点击参数
|
|
*/
|
|
onTabItemTap?(options: TabItemTapOption): void;
|
|
/**
|
|
* 监听原生标题栏按钮点击事件
|
|
* @param options tab 点击参数
|
|
*/
|
|
onNavigationBarButtonTap?(options: NavigationBarButtonTapOption): void;
|
|
/**
|
|
* 监听页面返回
|
|
* @param options tab 点击参数
|
|
* @return 返回 `true` 时阻止页面返回
|
|
*/
|
|
onBackPress?(options: BackPressOption): any;
|
|
/**
|
|
* 监听原生标题栏搜索输入框输入内容变化事件
|
|
*/
|
|
onNavigationBarSearchInputChanged?(event: NavigationBarSearchInputEvent): void;
|
|
/**
|
|
* 监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。
|
|
*/
|
|
onNavigationBarSearchInputConfirmed?(event: NavigationBarSearchInputEvent): void;
|
|
/**
|
|
* 监听原生标题栏搜索输入框点击事件
|
|
*/
|
|
onNavigationBarSearchInputClicked?(): void;
|
|
}
|
|
|
|
type PageConstructor = <T extends AnyObject & PageInstance>(
|
|
options: PageInstance<AnyObject, T> & T,
|
|
) => void;
|
|
|
|
type GetCurrentPages = <T extends AnyObject = {}>() => Array<PageInstance<AnyObject, T> & T>;
|
|
}
|
|
|
|
declare const getCurrentPages: Page.GetCurrentPages;
|
|
|