@dcloudio/uni-app-x 0.7.29 → 0.7.30

package/types/page.d.ts

@@ -1604,18 +1604,633 @@ interface Page {
 
 type PageOrigin = Page
 
-export interface UniDialogPage {
-  $component: any | null
-  $disableEscBack: boolean
-  $vm: ComponentPublicInstance | null
+export interface UniBasePage {
+  /**
+   * 页面的路由地址
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
   route: string
+  /**
+   * 页面的路由参数信息
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
   options: Map<string, string | null>
-  getParentPage: () => ComponentPublicInstance | null
-  vm: ComponentPublicInstance | null
+  /**
+   * 监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
   on(eventName: string, callback: Function): void
+  /**
+   * 监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
   once(eventName: string, callback: Function): void
+  /**
+   * 移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。如果仅提供事件名，则移除该事件的所有监听器。
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": 4.28x"
+   *  }
+   * }
+   */
   off(eventName: string, callback?: Function | null): void
+  /**
+   * 触发自定义事件，附加的参数会传递给事件监听器。
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
   emit(eventName: string, args: any | null): void
+  /**
+   * 获取所属父页面
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  getParentPage(): UniPage | null
+  /**
+   * 获取当前页面的 dialog 子页面集合
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  getDialogPages(): UniDialogPage[]
+}
+
+export interface UniPage extends UniBasePage {
+  /**
+   * UniPage vue 实例对象
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  vm: ComponentPublicInstance | null
+  /**
+   * UniPage vue 实例对象
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  $vm: ComponentPublicInstance | null
+  /**
+   * 获取当前页面样式 \
+   * 包含 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#getPageStyle
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  getPageStyle(): UTSJSONObject
+  /**
+   * 设置当前页面样式 \
+   * 支持 pages.json 页面下的 style 节点属性和根节点 globalStyle 属性
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-current-pages.html#setPageStyle
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  setPageStyle(style: UTSJSONObject): void
+  /**
+   * 返回一个匹配特定 ID 的元素， 如果不存在，返回 null。\
+   * 如果需要获取指定的节点类型，需要使用 as 进行类型转换。\
+   * ID 区分大小写，且应该是唯一的。如果存在多个匹配的元素，则返回第一个匹配的元素。
+   *
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-element.html
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-element.html
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  getElementById(id: string.IDString | string): UniElement | null
+  /**
+   * 返回 android 平台页面根 view
+   *
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-element.html
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-element.html
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "x"
+   *  }
+   * }
+   */
+  getAndroidView(): View | null
+  /**
+   * 返回页面 HTML Element 对象
+   *
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-element.html
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-element.html
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  getHTMLElement(): UniElement | null
+}
+type UniPageOrigin = UniPage
+
+export interface UniDialogPage extends UniBasePage {
+  $component: any | null
+  $disableEscBack: boolean
+  /**
+   * UniDialogPage vue 实例对象
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  $vm: ComponentPublicInstance | null
+  /**
+   * UniDialogPage vue 实例对象
+   * @tutorial https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/collocation/app.html#applifecycle
+   * @uniPlatform {
+   *  "app": {
+   *    "android": {
+   *      "osVer": "5.0",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "ios": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "4.28"
+   *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+   *  },
+   *  "mp": {
+   *    "weixin": {
+   *      "hostVer": "√",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    },
+   *  },
+   *  "web": {
+   *    "uniVer": "x",
+   *    "unixVer": "4.28"
+   *  }
+   * }
+   */
+  vm: ComponentPublicInstance | null
 }
 type UniDialogPageOrigin = UniDialogPage
 
@@ -1642,7 +2257,7 @@ declare global {
    *  }
    * }
    */
-  const getCurrentPages: () => Page[]
+  const getCurrentPages: () => UniPage[]
   type OnLoadOptions = NativeMap<string, any>
   interface OnBackPressOptions {
     /**
@@ -1687,6 +2302,7 @@ declare global {
 
   type Page = PageOrigin
   type UniDialogPage = UniDialogPageOrigin
+  type UniPage = UniPageOrigin
 }
 
 declare module '@vue/runtime-core' {