@uni-helper/uni-pages-types 0.5.0 → 0.6.1

package/README.md

@@ -7,11 +7,13 @@
 </p>
 <p style="text-align: center">
   <a href="https://github.com/kejunmao"><img src="https://img.shields.io/badge/Author-KeJun-blue?style=for-the-badge" alt="Author"></a>
-  <a href="https://github.com/ModyQyW"><img src="https://img.shields.io/badge/Maintainer-ModyQyW-blue?style=for-the-badge" alt="Author"></a>
+  <a href="https://github.com/ModyQyW"><img src="https://img.shields.io/badge/Maintainer-ModyQyW-blue?style=for-the-badge" alt="Maintainer"></a>
 </p>
 
 为 `uni-app` 的 `pages.json` 提供 TypeScript 类型。
 
+完整文档见 [uni-helper.js.org](https://uni-helper.js.org/vite-plugin-uni-pages)，另有 [Netlify](https://vite-plugin-uni-pages.netlify.app) 和 [Cloudflare Pages](https://vite-plugin-uni-pages.pages.dev) 镜像。
+
 不想看文档？直接问 AI 🤖 <a href="https://deepwiki.com/uni-helper/vite-plugin-uni-pages"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
 
 > **请考虑持续[赞助](https://github.com/ModyQyW/sponsors)以维持该项目的持续健康发展，非常感谢！🙏**
@@ -30,6 +32,7 @@ import { AnimationType, Condition, EasyCom } from '@uni-helper/uni-pages-types'
 
 ## 关联项目
 
+- [skiyee/oiyo](https://oiyo.js.org) - uni-app 增强型工程框架
 - [@uni-helper/vite-plugin-uni-pages](https://github.com/uni-helper/vite-plugin-uni-pages/tree/main/packages/core) - 使用 TypeScript 编写 uni-app 的 pages.json，支持约定式路由
 - [@uni-helper/pages-json-schema](https://github.com/uni-helper/vite-plugin-uni-pages/tree/main/packages/schema) - 为 uni-app 的 pages.json 提供 schema
 - [@uni-helper/uni-pages-types](https://github.com/uni-helper/vite-plugin-uni-pages/tree/main/packages/types) - 为 uni-app 的 pages.json 提供 TypeScript 类型

package/dist/index.d.mts

@@ -1,17 +1,17 @@
 //#region src/common.d.ts
-type RGBColor = `rgb(${number}, ${number}, ${number})`;
-type RGBAColor = `rgba(${number}, ${number}, ${number}, ${number})`;
-type HEXColor = `#${string}`;
-type Color = RGBColor | RGBAColor | HEXColor;
-type PxSize = `${number}px`;
-type RpxSize = `${number}rpx`;
-type PercentageSize = `${number}%`;
-type ThemeVar = `@${string}`;
+export type RGBColor = `rgb(${number}, ${number}, ${number})`;
+export type RGBAColor = `rgba(${number}, ${number}, ${number}, ${number})`;
+export type HEXColor = `#${string}`;
+export type Color = RGBColor | RGBAColor | HEXColor;
+export type PxSize = `${number}px`;
+export type RpxSize = `${number}rpx`;
+export type PercentageSize = `${number}%`;
+export type ThemeVar = `@${string}`;
 /**
  * 窗口动画，详见 [窗口动画](https://uniapp.dcloud.net.cn/api/router.html#animation)
  */
-type AnimationType = 'slide-in-right' | 'slide-in-left' | 'slide-in-top' | 'slide-in-bottom' | 'pop-in' | 'fade-in' | 'zoom-out' | 'zoom-fade-out' | 'none';
-interface TitleNViewButton {
+export type AnimationType = 'slide-in-right' | 'slide-in-left' | 'slide-in-top' | 'slide-in-bottom' | 'pop-in' | 'fade-in' | 'zoom-out' | 'zoom-fade-out' | 'none';
+export interface TitleNViewButton {
   /**
    * 自定义按钮样式，详见 [自定义按钮样式](https://uniapp.dcloud.net.cn/collocation/pages#app-titlenview-buttons-type)
    *
@@ -50,11 +50,19 @@ interface TitleNViewButton {
    * @format color
    */
   background?: HEXColor | RGBAColor;
+  /**
+   * 自定义按钮上显示的角标文本，最多显示 3 个字符，超过则显示为 ...
+   *
+   * @desc H5
+   */
+  badgeText?: string;
   /**
    * 自定义按钮按下状态文字颜色，支持 HEX 和 RGBA 颜色
    *
    * @default color 属性值自动调整透明度为 0.3
    *
+   * @desc H5 暂不支持
+   *
    * @format color
    */
   colorPressed?: HEXColor | RGBAColor;
@@ -108,7 +116,7 @@ interface TitleNViewButton {
 /**
  * @deprecated 请使用 ConditionListItem
  */
-interface ConditionItem {
+export interface ConditionItem {
   /**
    * 启动模式名称
    */
@@ -122,7 +130,7 @@ interface ConditionItem {
    */
   query?: string;
 }
-interface ConditionListItem {
+export interface ConditionListItem {
   /**
    * 启动模式名称
    */
@@ -137,11 +145,11 @@ interface ConditionListItem {
   query?: string;
   [x: string]: any;
 }
-type ConditionList = ConditionListItem[];
+export type ConditionList = ConditionListItem[];
 /**
  * 启动模式配置
  */
-interface Condition {
+export interface Condition {
   /**
    * 当前激活的模式，list 节点的索引值
    */
@@ -159,7 +167,7 @@ interface Condition {
  *
  * @desc 2.5.5+
  */
-interface EasyCom {
+export interface EasyCom {
   /**
    * 是否开启自动扫描，开启后将会自动扫描符合 `components/组件名称/组件名称.vue` 目录结构的组件
    *
@@ -819,6 +827,8 @@ interface AppPlus {
        * "normal" 正常
        *
        * "bold" 粗体
+       *
+       * @default "normal"
        */
       titleWeight?: 'normal' | 'bold';
       [x: string]: any;
@@ -1348,6 +1358,10 @@ interface H5 {
    * h5 平台下拉刷新动画，只有 circle 类型
    */
   pullToRefresh?: {
+    /**
+     * 是否开启窗口的下拉刷新功能
+     */
+    support?: boolean;
     /**
      * 下拉刷新控件颜色，支持 HEX 颜色
      *
@@ -1356,12 +1370,54 @@ interface H5 {
      * @format color
      */
     color?: HEXColor;
+    /**
+     * 下拉刷新控件样式，h5 平台只有 "circle" 类型
+     */
+    style?: 'default' | 'circle';
+    /**
+     * 下拉刷新控件进入刷新状态的拉拽高度，支持单位为 px 的逻辑像素值或百分比
+     */
+    height?: PxSize | PercentageSize;
+    /**
+     * 可下拉拖拽的范围，支持单位为 px 的逻辑像素值或百分比
+     */
+    range?: PxSize | PercentageSize;
     /**
      * 下拉刷新控件的起始位置，支持单位为 px 的逻辑像素值或百分比
      *
      * @default "0px"
      */
     offset?: PxSize | PercentageSize;
+    /**
+     * 下拉可刷新状态时下拉刷新控件显示的内容，仅 style 为 "default" 时有效
+     */
+    contentdown?: {
+      /**
+       * 下拉刷新控件上显示的标题内容
+       */
+      caption?: string;
+      [x: string]: any;
+    };
+    /**
+     * 释放可刷新状态时下拉刷新控件显示的内容，仅 style 为 "default" 时有效
+     */
+    contentover?: {
+      /**
+       * 下拉刷新控件上显示的标题内容
+       */
+      caption?: string;
+      [x: string]: any;
+    };
+    /**
+     * 正在刷新状态时下拉刷新控件显示的内容，仅 style 为 "default" 时有效
+     */
+    contentrefresh?: {
+      /**
+       * 下拉刷新控件上显示的标题内容
+       */
+      caption?: string;
+      [x: string]: any;
+    };
     [x: string]: any;
   };
   [x: string]: any;
@@ -1411,7 +1467,7 @@ interface MpAlipay {
   /**
    * 仅支持 iOS，是否支持手势返回
    *
-   * @default "YES"
+   * @default "NO"
    */
   gestureBack?: 'YES' | 'NO';
   /**
@@ -2355,6 +2411,8 @@ interface MpWeixin {
    *
    * "homePageAndLatestPage" 如果从这个页面退出小程序，下次冷启动后立刻加载这个页面，页面的参数保持不变（不可用于 tab 页）
    *
+   * @default "homePage"
+   *
    * @desc [2.8.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
    */
   restartStrategy?: 'homePage' | 'homePageAndLatestPage';
@@ -2386,6 +2444,14 @@ interface MpWeixin {
    * @default "static"
    */
   handleWebviewPreload?: 'static' | 'manual' | 'auto';
+  /**
+   * 是否启用 ucss 样式覆盖
+   *
+   * @default true
+   *
+   * @desc 小程序
+   */
+  enableUcssReset?: boolean;
   [x: string]: any;
 }
 //#endregion
@@ -2588,6 +2654,80 @@ interface BaseStyle {
    * @desc 支付宝小程序
    */
   'allowsBounceVertical'?: 'YES' | 'NO';
+  /**
+   * 是否隐藏系统顶部状态栏
+   *
+   * @default false
+   *
+   * @desc uni-app x App
+   */
+  'hideStatusBar'?: boolean;
+  /**
+   * 点击系统状态栏滚动条是否返回顶部
+   *
+   * @default false
+   *
+   * @desc uni-app x App
+   */
+  'enableBackToTop'?: boolean;
+  /**
+   * 是否开启回弹效果，优先级高于 allowsBounceVertical
+   *
+   * @default false
+   *
+   * @desc uni-app x App
+   */
+  'bounces'?: boolean;
+  /**
+   * Android 平台是否开启弹簧回弹效果
+   *
+   * @default false
+   *
+   * @desc uni-app x App-Android
+   */
+  'androidOverscroll'?: boolean;
+  /**
+   * Android 平台下拉刷新前景颜色，支持 HEX 颜色
+   *
+   * @desc uni-app x App-Android
+   *
+   * @format color
+   */
+  'androidRefresherColor'?: HEXColor | ThemeVar;
+  /**
+   * 是否隐藏系统底部导航栏
+   *
+   * 与 hideStatusBar 同时开启可实现页面全屏
+   *
+   * @default false
+   *
+   * @desc uni-app x App
+   */
+  'hideBottomNavigationIndicator'?: boolean;
+  /**
+   * 页面内容是否可以渲染到虚拟按键区域
+   *
+   * @default false
+   *
+   * @desc uni-app x App-Android 4.41+
+   */
+  'androidThreeButtonNavigationTranslucent'?: boolean;
+  /**
+   * 虚拟按键区域背景色，支持 HEX 颜色
+   *
+   * @desc uni-app x App-Android
+   *
+   * @format color
+   */
+  'androidThreeButtonNavigationBackgroundColor'?: HEXColor | ThemeVar;
+  /**
+   * 虚拟按键区域前景色
+   *
+   * @desc uni-app x App-Android
+   *
+   * @format color
+   */
+  'androidThreeButtonNavigationStyle'?: HEXColor | ThemeVar;
   /**
    * 设置编译到 App 平台的特定样式，配置项参考 [app-plus](https://uniapp.dcloud.net.cn/collocation/pages#app-plus)
    *
@@ -2734,11 +2874,19 @@ interface BaseStyle {
    * @desc H5（2.9.9+）
    */
   'maxWidth'?: number;
+  /**
+   * 是否启用 ucss 样式覆盖
+   *
+   * @default true
+   *
+   * @desc 小程序
+   */
+  'enableUcssReset'?: boolean;
 }
 /**
  * globalStyle 节点的类型，用于设置应用的状态栏、导航条、标题、窗口背景色等
  */
-interface GlobalStyle extends BaseStyle {
+export interface GlobalStyle extends BaseStyle {
   /**
    * 页面容器背景色，支持 HEX 颜色
    *
@@ -2820,7 +2968,33 @@ interface GlobalStyle extends BaseStyle {
  *
  * 页面中配置项会覆盖 globalStyle 中相同的配置项
  */
-interface PageStyle extends BaseStyle {
+export interface PageStyle extends BaseStyle {
+  /**
+   * 页面容器背景色，支持 HEX 颜色
+   *
+   * 会覆盖窗口背景色 backgroundColor，backgroundColor 仅在页面设置下拉刷新时才可能看到
+   *
+   * @default "#ffffff"
+   *
+   * @desc uni-app x
+   *
+   * @format color
+   */
+  backgroundColorContent?: HEXColor | ThemeVar;
+  /**
+   * 页面旋转设置
+   *
+   * "auto" 设备自适应
+   *
+   * "portrait" 竖向
+   *
+   * "landscape" 横向
+   *
+   * @default "portrait"
+   *
+   * @desc uni-app x Android 4.13+、uni-app x iOS 4.25+，Web 由手机浏览器控制
+   */
+  pageOrientation?: 'auto' | 'portrait' | 'landscape';
   /**
    * 导航栏阴影，配置参考 [导航栏阴影](https://uniapp.dcloud.net.cn/collocation/pages#navigationbarshadow)
    *
@@ -2852,6 +3026,16 @@ interface PageStyle extends BaseStyle {
    * @desc App-iOS（3.4.0+）
    */
   disableSwipeBack?: boolean;
+  /**
+   * 是否将侧滑返回手势转为页面 onBackPress 事件
+   *
+   * 仅在 disableSwipeBack 为 false 时生效
+   *
+   * @default false
+   *
+   * @desc uni-app x
+   */
+  swipeBackAsBackPress?: boolean;
   [x: string]: any;
 }
 //#endregion
@@ -2861,7 +3045,7 @@ interface PageStyle extends BaseStyle {
  *
  * pages 数组的元素类型
  */
-interface PageMetaDatum {
+export interface PageMetaDatum {
   /**
    * 配置页面路径
    */
@@ -2881,7 +3065,7 @@ interface PageMetaDatum {
 /**
  * pages 数组的元素类型
  */
-interface PageItem {
+export interface PageItem {
   /**
    * 配置页面路径
    */
@@ -2903,13 +3087,13 @@ interface PageItem {
  *
  * 文档中为必填，类型上保持可选，插件可由文件扫描自动生成
  */
-type Pages = PageItem[];
+export type Pages = PageItem[];
 //#endregion
 //#region src/preload-rule.d.ts
 /**
  * 进入页面后预下载分包的规则
  */
-interface PreloadRuleItem {
+export interface PreloadRuleItem {
   /**
    * 进入页面后预下载分包的 root 或 name
    *
@@ -2933,23 +3117,31 @@ interface PreloadRuleItem {
  *
  * @desc 微信小程序、QQ 小程序、抖音小程序、支付宝小程序、京东小程序
  */
-type PreloadRule = Record<string, PreloadRuleItem>;
+export type PreloadRule = Record<string, PreloadRuleItem>;
 //#endregion
 //#region src/sub-packages.d.ts
 /**
- * subPackages 数组的元素类型，即应用的子包
+ * subPackages 数组的元素类型，即应用的分包
  */
-interface SubPackage {
+export interface SubPackage {
   /**
-   * 子包的根目录
+   * 分包的根目录
    */
   root: string;
   /**
-   * 子包由哪些页面组成，参数同 pages
+   * 是否声明对应分包为独立分包
+   *
+   * @default false
+   *
+   * @desc uni-app x
+   */
+  independent?: boolean;
+  /**
+   * 分包由哪些页面组成，参数同 pages
    */
   pages: Pages;
   /**
-   * 子包的插件
+   * 分包的插件
    */
   plugins?: Record<string, any>;
   [x: string]: any;
@@ -2957,10 +3149,10 @@ interface SubPackage {
 /**
  * 分包加载配置，H5 不支持
  */
-type SubPackages = SubPackage[];
+export type SubPackages = SubPackage[];
 //#endregion
 //#region src/tab-bar.d.ts
-interface TabBarIconFont {
+export interface TabBarIconFont {
   /**
    * 字库 Unicode 码
    */
@@ -2987,7 +3179,7 @@ interface TabBarIconFont {
   selectedColor?: HEXColor;
   [x: string]: any;
 }
-interface TabBarItem {
+export interface TabBarItem {
   /**
    * 页面路径，必须在 pages 中先定义
    */
@@ -3033,7 +3225,7 @@ interface TabBarItem {
   iconfont?: TabBarIconFont;
   [x: string]: any;
 }
-interface TabBarMidButton {
+export interface TabBarMidButton {
   /**
    * 中间按钮的宽度，tabBar 其它项为减去此宽度后平分
    *
@@ -3044,6 +3236,8 @@ interface TabBarMidButton {
    * 中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果
    *
    * @default "50px"
+   *
+   * @desc uni-app x 为 "80px"
    */
   height?: string;
   /**
@@ -3075,7 +3269,7 @@ interface TabBarMidButton {
 /**
  * 设置底部 tab 的表现
  */
-interface TabBar {
+export interface TabBar {
   /**
    * tab 上的文字默认颜色
    *
@@ -3104,6 +3298,14 @@ interface TabBar {
    * @format color
    */
   borderStyle?: 'black' | 'white' | HEXColor | ThemeVar;
+  /**
+   * tabBar 上边框的颜色，优先级高于 borderStyle
+   *
+   * @desc uni-app x
+   *
+   * @format color
+   */
+  borderColor?: HEXColor | ThemeVar;
   /**
    * iOS 高斯模糊效果，参考 [使用说明](https://uniapp.dcloud.net.cn/tutorial/app-blureffect.html)
    *
@@ -3112,6 +3314,36 @@ interface TabBar {
    * @desc App 2.4.0+、H5 3.0.0+（只有最新版浏览器才支持）
    */
   blurEffect?: 'dark' | 'extralight' | 'light' | 'none';
+  /**
+   * 是否开启玻璃效果 tabBar
+   *
+   * iOS 26 及以上使用系统液态玻璃效果，iOS 26 以下降级为系统毛玻璃效果，启用后仅支持图片图标，不支持 iconfont
+   *
+   * 鸿蒙平台为开启沉浸光感效果并叠加在页面内容之上，启用后在 7.0.0(26) 之上为沉浸光感效果且为胶囊形态，在 6.1.0(23) 之上为毛玻璃效果且为胶囊形态，在更低版本为普通毛玻璃效果
+   *
+   * 启用后 tabBar 以悬浮方式覆盖在页面内容上方，页面排版高度包含 tabBar 覆盖区域
+   *
+   * @default false
+   *
+   * @desc uni-app x
+   */
+  glassEffect?: boolean;
+  /**
+   * 鸿蒙平台沉浸光感效果的材质等级
+   *
+   * @default "adaptive"
+   *
+   * @desc uni-app x 鸿蒙 6.1.0(23)+
+   */
+  glassEffectMaterialLevel?: 'exquisite' | 'gentle' | 'smooth' | 'adaptive';
+  /**
+   * 是否禁用玻璃效果 tabBar 自动上推页面滚动内容
+   *
+   * @default false
+   *
+   * @desc uni-app x
+   */
+  disableGlassSafeAreaAutoFit?: boolean;
   /**
    * tab 列表，最少 2个，最多 5 个，app 端没有该限制
    *
@@ -3225,7 +3457,7 @@ interface TabBar {
 /**
  * 配置显示该窗口的规则
  */
-interface MatchMedia {
+export interface MatchMedia {
   /**
    * 当设备可见区域宽度 >= minWidth 时，显示该 window
    *
@@ -3236,7 +3468,7 @@ interface MatchMedia {
 /**
  * leftWindow / topWindow / rightWindow 的类型
  */
-interface TheWindow {
+export interface TheWindow {
   /**
    * 配置页面路径
    */
@@ -3258,7 +3490,7 @@ interface TheWindow {
  *
  * @desc uni-app 3.5.0+、uni-app-x 3.99+
  */
-interface UniIdRouter {
+export interface UniIdRouter {
   /**
    * 登录页面路径
    *
@@ -3286,7 +3518,7 @@ interface UniIdRouter {
  *
  * 注意定位权限申请等原属于 app.json 的内容，需要在 manifest 中配置
  */
-interface PagesConfig {
+export interface PagesConfig {
   /**
    * 设置默认页面的窗口表现
    */
@@ -3369,6 +3601,6 @@ interface PagesConfig {
   entryPagePath?: string;
   [x: string]: any;
 }
-interface UserPagesConfig extends PagesConfig {}
+export interface UserPagesConfig extends PagesConfig {}
 //#endregion
-export { AnimationType, type AppHarmony, type AppPlus, Color, Condition, ConditionItem, ConditionList, ConditionListItem, EasyCom, GlobalStyle, type H5, HEXColor, MatchMedia, type MpAlipay, type MpBaidu, type MpHarmony, type MpJd, type MpKuaishou, type MpLark, type MpQq, type MpToutiao, type MpWeixin, type MpXhs, PageItem, PageMetaDatum, PageStyle, Pages, PagesConfig, PercentageSize, PreloadRule, PreloadRuleItem, PxSize, RGBAColor, RGBColor, RpxSize, SubPackage, SubPackages, TabBar, TabBarIconFont, TabBarItem, TabBarMidButton, TheWindow, ThemeVar, TitleNViewButton, UniIdRouter, UserPagesConfig };
+export type { AppHarmony, AppPlus, H5, MpAlipay, MpBaidu, MpHarmony, MpJd, MpKuaishou, MpLark, MpQq, MpToutiao, MpWeixin, MpXhs };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/uni-pages-types",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "Type definitions for uni-app pages.json",
   "author": "KeJun",
   "license": "MIT",
@@ -47,7 +47,7 @@
     }
   },
   "devDependencies": {
-    "tsdown": "^0.22.14",
+    "tsdown": "^0.23.1",
     "typescript": "^6.0.3"
   },
   "scripts": {