vite-plugin-taro-runtime 0.7.0 → 0.7.1-beta.2

package/dist/components/types/OpenData.d.ts

@@ -0,0 +1,98 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface OpenDataProps extends StandardProps {
+  /** 开放数据类型
+   * @supported weapp, swan, tt, qq
+   */
+  type: keyof OpenDataProps.Type
+  /** 当 type="groupName" 时生效, 群id
+   * @supported weapp
+   */
+  openGid?: string
+  /** 当 type="user*" 时生效，以哪种语言展示 userInfo
+   * @default "en"
+   * @supported weapp, qq
+   */
+  lang?: keyof OpenDataProps.Lang
+  /** 数据为空时的默认文案
+   * @supported weapp, tt
+   */
+  defaultText?: string
+  /** 用户头像为空时的默认图片，支持相对路径和网络图片路径
+   * @supported weapp, tt
+   */
+  defaultAvatar?: string
+  /** 当数据为空且未设置默认值时，是否显示官方默认值
+   * @supported tt
+   */
+  useEmptyValue?: string
+  /** 当 type=groupCloudStorage 时有效，群分享对应的 shareTicket
+   * @supported qq
+   */
+  shareTicket?: string
+  /** 当 type=*CloudStorage 时有效，指定要拉取的 key 列表
+   * @supported qq
+   */
+  keyList?: string
+  /** 当 type=*CloudStorage 时有效，从主域透传给开放数据域的数据，会自动注入到自定义开放数据域组件的 properties 中
+   * @supported qq
+   */
+  componentData?: string
+  /** 群名称或用户信息为空时触发
+   * @supported weapp, tt, qq
+   */
+  onError?: CommonEventFunction
+}
+declare namespace OpenDataProps {
+  /** type 的合法值 */
+  interface Type {
+    /** 拉取群名称 */
+    groupName
+    /** 用户昵称 */
+    userNickName
+    /** 用户头像 */
+    userAvatarUrl
+    /** 用户性别 */
+    userGender
+    /** 用户所在城市 */
+    userCity
+    /** 用户所在省份 */
+    userProvince
+    /** 用户所在国家 */
+    userCountry
+    /** 用户的语言 */
+    userLanguage
+  }
+  /** lang 的合法值 */
+  interface Lang {
+    /** 英文 */
+    en
+    /** 简体中文 */
+    zh_CN
+    /** 繁体中文 */
+    zh_TW
+  }
+}
+/** 用于展示平台开放的数据
+ * @classification open
+ * @supported weapp, swan, tt, qq
+ * @example_react
+ * ```tsx
+ * class App extends Component {
+ *   render () {
+ *     return (
+ *       <OpenData type='userAvatarUrl'/>
+ *     )
+ *   }
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <open-data type="userAvatarUrl" />
+ * </template>
+ * ```
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/open-data.html
+ */
+declare const OpenData: ComponentType<OpenDataProps>
+export { OpenData, OpenDataProps }

package/dist/components/types/OpenEmbeddedAtomicservice.d.ts

@@ -0,0 +1,52 @@
+import { ComponentType } from 'react'
+import { CommonEventFunction, StandardProps } from './common'
+
+interface OpenEmbeddedAtomicserviceProps extends StandardProps {
+  /** 需要半屏跳转的元服务的AppId参数。
+   * @supported ascf
+   */
+  appid: string
+  /** 打开的页面路径。
+   * 路径后可以带参数，参数与路径之间用?分隔，参数与键值用=相连，多个参数用&分隔。
+   * 在元服务的App.onLaunch、App.onShow和Page.onLoad的回调函数中可以获得参数query。
+   *   - path为空或无效值时，则打开首页。
+   *   - path不为空，则之前的路径应为在app.json中定义的代码包路径。
+   * 例如，在app.json中定义了页面: "page/path/index"，则有效应用内页面路径为："page/path/index?key1=value1&key2=value2"。
+   * 注意： 该字段仅当目标元服务是ASCF框架开发的元服务时可直接使用，对于ArkTS开发的元服务，需双方自行约定实现，参数将通过目标元服务的Want对象的parameters字段进行传递。
+   * @supported ascf
+   */
+  path?: string
+  /** 需要传递给目标元服务的数据。
+   *   - 若被半屏打开的是ASCF框架开发的元服务，请通过ascfPara.extraData字段传入业务数据。例如：{ascfPara: {extraData: {data: "test"}}}
+   *   - 若被半屏打开的是ArkTS开发的元服务，直接以平铺键值对形式传参，例如：{ data: "test" }。
+   * 注意： subPackageName为系统保留字段，请勿使用。
+   * @supported ascf
+   */
+  wantParam?: object
+  /** 退出的回调事件。
+   * 被半屏打开的元服务正常退出时触发，event.detail = { params }，其中params为元服务退出时返回的数据。
+   *   - 若被半屏打开的是ArkTS开发的元服务，在目标元服务内通过调用terminateSelfWithResult或terminateSelf正常退出时，触发本回调函数。
+   *   - 若被半屏打开的是ASCF框架开发的元服务，从1.0.18开始，在目标元服务内通过调用has.terminateSelf退出时，触发本回调函数。
+   * @supported ascf
+   */
+  onTerminated?: CommonEventFunction
+  /** 异常的回调事件。
+   * @supported ascf
+   */
+  onError?: CommonEventFunction<OpenEmbeddedAtomicserviceProps.onErrorEventDetail>
+}
+
+declare namespace OpenEmbeddedAtomicserviceProps {
+  interface onErrorEventDetail {
+    errMsg: string
+    errCode: number
+  }
+}
+
+/** OpenEmbeddedAtomicservice
+ * @classification media
+ * @supported ascf
+ * @see https://developer.huawei.com/consumer/cn/doc/atomic-ascf/components-open-embedded-atomicservice
+ */
+declare const OpenEmbeddedAtomicservice: ComponentType<OpenEmbeddedAtomicserviceProps>
+export { OpenEmbeddedAtomicservice, OpenEmbeddedAtomicserviceProps }

package/dist/components/types/PageContainer.d.ts

@@ -0,0 +1,110 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface PageContainerProps extends StandardProps {
+  /** 是否显示容器组件
+   * @default false
+   * @supported weapp, alipay, jd, rn
+   */
+  show?: boolean
+  /** 动画时长，单位毫秒
+   * @default 300
+   * @supported weapp, alipay, jd, rn
+   */
+  duration?: number
+  /** z-index 层级
+   * @default 100
+   * @supported weapp, alipay
+   */
+  zIndex?: number
+  /** 是否显示遮罩层
+   * @default true
+   * @supported weapp, alipay, jd, rn
+   */
+  overlay?: boolean
+  /** 弹出位置，可选值为 top bottom right center
+   * @default bottom
+   * @supported weapp, alipay, jd, rn
+   */
+  position?: keyof PageContainerProps.Position
+  /** 是否显示圆角
+   * @default false
+   * @supported weapp, alipay, jd, rn
+   */
+  round?: boolean
+  /** 自定义遮罩层样式
+   * @supported weapp, alipay, jd, rn
+   */
+  overlayStyle?: string
+  /** 自定义弹出层样式
+   * @supported weapp, alipay, jd, rn
+   */
+  customStyle?: string
+  /** 是否在下滑一段距离后关闭
+   * @supported weapp, alipay, jd
+   * @default false
+   */
+  closeOnSlideDown?: boolean
+  /** 进入前触发
+   * @supported weapp, alipay, jd, rn
+   */
+  onBeforeEnter?: CommonEventFunction
+  /** 进入中触发
+   * @supported weapp, alipay, jd, rn
+   */
+  onEnter?: CommonEventFunction
+  /** 进入后触发
+   * @supported weapp, alipay, jd, rn
+   */
+  onAfterEnter?: CommonEventFunction
+  /** 离开前触发
+   * @supported weapp, alipay, jd, rn
+   */
+  onBeforeLeave?: CommonEventFunction
+  /** 离开中触发
+   * @supported weapp, alipay, jd, rn
+   */
+  onLeave?: CommonEventFunction
+  /** 离开后触发
+   * @supported weapp, alipay, jd, rn
+   */
+  onAfterLeave?: CommonEventFunction
+  /** 点击遮罩层时触发
+   * @supported weapp, alipay, jd
+   */
+  onClickOverlay?: CommonEventFunction
+  /** 进入被打断时触发（通过 a: if 打断时不会触发）。
+   * @supported alipay
+   */
+  onEnterCancelled?: CommonEventFunction
+  /** 离开被打断时触发（通过 a: if 打断时不会触发）。
+   * @supported alipay
+   */
+  onLeaveCancelled?: CommonEventFunction
+}
+declare namespace PageContainerProps {
+  /** 弹出位置 */
+  interface Position {
+    /** 上方弹出 */
+    top
+    /** 下方弹出 */
+    bottom
+    /** 右边弹出 */
+    right
+    /** 中央弹出 */
+    center
+  }
+}
+/** 页面容器
+ *
+ * 小程序如果在页面内进行复杂的界面设计（如在页面内弹出半屏的弹窗、在页面内加载一个全屏的子页面等），用户进行返回操作会直接离开当前页面，不符合用户预期，预期应为关闭当前弹出的组件。
+ * 为此提供“假页”容器组件，效果类似于 `popup` 弹出层，页面内存在该容器时，当用户进行返回操作，关闭该容器不关闭页面。返回操作包括三种情形，右滑手势、安卓物理返回键和调用 `navigateBack` 接口。
+ *
+ * Bug & Tip
+ *   1. tip: 当前页面最多只有 1 个容器，若已存在容器的情况下，无法增加新的容器
+ *   2. tip: wx.navigateBack 无法在页面栈顶调用，此时没有上一级页面
+ * @classification viewContainer
+ * @supported weapp, alipay, jd, rn
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/page-container.html
+ */
+declare const PageContainer: ComponentType<PageContainerProps>
+export { PageContainer, PageContainerProps }

package/dist/components/types/PageMeta.d.ts

@@ -0,0 +1,133 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface PageMetaProps extends StandardProps {
+  /** 下拉背景字体、loading 图的样式，仅支持 dark 和 light
+   * @supported weapp
+   */
+  backgroundTextStyle?: string
+  /** 窗口的背景色，必须为十六进制颜色值
+   * @supported weapp, alipay, harmony
+   */
+  backgroundColor?: string
+  /** 顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持
+   * @supported weapp, alipay, harmony
+   */
+  backgroundColorTop?: string
+  /** 底部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持
+   * @supported weapp, alipay, harmony
+   */
+  backgroundColorBottom?: string
+  /** 滚动位置，可以使用 px 或者 rpx 为单位，在被设置时，页面会滚动到对应位置
+   * @default ""
+   * @supported weapp, alipay, harmony
+   */
+  scrollTop?: string
+  /** 滚动动画时长
+   * @default 300
+   * @supported weapp, alipay, harmony
+   */
+  scrollDuration?: number
+  /** 页面根节点样式，页面根节点是所有页面节点的祖先节点，相当于 HTML 中的 body 节点
+   * @default ""
+   * @supported weapp, alipay
+   */
+  pageStyle?: string
+  /** 页面的根字体大小，页面中的所有 rem 单位，将使用这个字体大小作为参考值，即 1rem 等于这个字体大小
+   * @default ""
+   * @supported weapp, alipay
+   */
+  rootFontSize?: string
+  /** 页面内容的背景色，用于页面中的空白部分和页面大小变化 resize 动画期间的临时空闲区域
+   * @supported weapp, alipay, harmony
+   */
+  rootBackgroundColor?: string
+  /** 页面 page 的字体大小，可以设置为 system ，表示使用当前用户设置的微信字体大小
+   * @supported weapp, alipay
+   */
+  pageFontSize?: string
+  /** 页面的方向，可为 auto portrait 或 landscape
+   * @supported weapp
+   */
+  pageOrientation?: string
+  /** 页面尺寸变化时会触发 resize 事件
+   * @supported weapp
+   */
+  onResize?: CommonEventFunction<PageMetaProps.onResizeEventDetail>
+  /** 页面滚动时会触发 scroll 事件
+   * @supported weapp, alipay
+   */
+  onScroll?: CommonEventFunction<PageMetaProps.onScrollEventDetail>
+  /** 如果通过改变 scroll-top 属性来使页面滚动，页面滚动结束后会触发 scrolldone 事件
+   * @supported weapp
+   */
+  onScrollDone?: CommonEventFunction
+}
+declare namespace PageMetaProps {
+  interface onResizeEventDetail {
+    /** 设备方向 */
+    deviceOrientation?: 'portrait' | 'landscape'
+    /** 窗口尺寸 */
+    size: resizeType
+  }
+  /** 窗口尺寸类型 */
+  interface resizeType {
+    /** 窗口宽度 */
+    windowWidth: number
+    /** 窗口高度 */
+    windowHeight: number
+    /** 屏幕宽度 */
+    screenWidth?: number
+    /** 屏幕高度 */
+    screenHeight?: number
+  }
+  interface onScrollEventDetail {
+    scrollTop: number
+  }
+}
+/** 页面属性配置节点，用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 navigation-bar 组件一同使用。
+ * 通过这个节点可以获得类似于调用 Taro.setBackgroundTextStyle Taro.setBackgroundColor 等接口调用的效果。
+ *
+ * :::info
+ * Taro v3.6.19 开始支持
+ * 开发者需要在页面配置里添加：`enablePageMeta: true`
+ * :::
+ *
+ * @supported weapp, alipay, harmony
+ * @example_react
+ * ```tsx
+ * // page.config.ts
+ * export default definePageConfig({ enablePageMeta: true, ... })
+ *
+ * // page.tsx
+ * function Index () {
+ *   return (
+ *     <View>
+ *      <PageMeta
+ *        pageStyle={myPageStyle}
+ *        onScroll={handleScroll}
+ *      >
+ *        <NavigationBar title={title} />
+ *      </PageMeta>
+ *    </View>
+ *   )
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <!-- page.config.ts -->
+ * <!-- export default definePageConfig({ enablePageMeta: true, ... }) -->
+ *
+ * <!-- page.vue -->
+ * <template>
+ *   <page-meta
+ *     :page-style="myPageStyle"
+ *     `@scroll="handleScroll"
+ *   >
+ *     <navigation-bar :title="title" />
+ *   </page-meta>
+ * </template>
+ * ```
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/page-meta.html
+ */
+declare const PageMeta: ComponentType<PageMetaProps>
+export { PageMeta, PageMetaProps }