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

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

@@ -0,0 +1,143 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface EditorProps extends StandardProps {
+  /** 设置编辑器为只读
+   * @default false
+   * @supported weapp, jd, ascf
+   */
+  readOnly?: boolean
+  /** 提示信息
+   * @supported weapp, jd, ascf
+   */
+  placeholder?: string
+  /** 点击图片时显示图片大小控件
+   * @default false
+   * @supported weapp, jd
+   */
+  showImgSize?: boolean
+  /** 点击图片时显示工具栏控件
+   * @default false
+   * @supported weapp, jd
+   */
+  showImgToolbar?: boolean
+  /** 点击图片时显示修改尺寸控件
+   * @default false
+   * @supported weapp, jd
+   */
+  showImgResize?: boolean
+  /** 编辑器允许的名单内的格式。
+   * @supported ascf
+   */
+  enableFormats?: string[]
+  /** 点击编辑器拉起输入法后，输入法键盘右下角文字类型。
+   * @supported ascf
+   */
+  enterkeyhint?: 'send' | 'search' | 'next' | 'previous' | 'go' | 'done' | 'enter'
+  /** 点击键盘回车键时是否保持键盘不收起。
+   * @supported ascf
+   */
+  confirmHold?: boolean
+  /** 编辑器初始化完成时触发
+   * @supported weapp, jd, ascf
+   */
+  onReady?: CommonEventFunction
+  /** 编辑器聚焦时触发
+   * @supported weapp, jd, ascf
+   */
+  onFocus?: CommonEventFunction<EditorProps.editorEventDetail>
+  /** 编辑器失去焦点时触发
+   * detail = { html, text, delta }
+   * @supported weapp, jd, ascf
+   */
+  onBlur?: CommonEventFunction<EditorProps.editorEventDetail>
+  /** 编辑器内容改变时触发
+   * detail = { html, text, delta }
+   * @supported weapp, jd, ascf
+   */
+  onInput?: CommonEventFunction<EditorProps.editorEventDetail>
+  /** 通过 Context 方法改变编辑器内样式时触发，返回选区已设置的样式
+   * @supported weapp, jd, ascf
+   */
+  onStatusChange?: CommonEventFunction
+}
+declare namespace EditorProps {
+  interface editorEventDetail {
+    html
+    text
+    delta
+  }
+}
+/** 富文本编辑器，可以对图片、文字进行编辑。
+ *
+ * 编辑器导出内容支持带标签的 html和纯文本的 text，编辑器内部采用 delta 格式进行存储。
+ *
+ * 通过 setContents 接口设置内容时，解析插入的 html 可能会由于一些非法标签导致解析错误，建议开发者在小程序内使用时通过 delta 进行插入。
+ *
+ * 富文本组件内部引入了一些基本的样式使得内容可以正确的展示，开发时可以进行覆盖。需要注意的是，在其它组件或环境中使用富文本组件导出的 html 时，需要额外引入 这段样式，并维护 `<ql-container><ql-editor></ql-editor></ql-container>` 的结构。
+ *
+ * 图片控件仅初始化时设置有效。
+ *
+ * *编辑器内支持部分 HTML 标签和内联样式，不支持 **class** 和 **id***
+ * @classification forms
+ * @supported weapp, jd, ascf
+ * @example_react
+ * ```tsx
+ * class App extends Components {
+ *   state = {
+ *     placeholder: '来，输入隔壁的名字试试...'
+ *   }
+ *
+ *   editorReady = e => {
+ *     Taro.createSelectorQuery().select('#editor').context((res) => {
+ *       this.editorCtx = res.context
+ *     }).exec()
+ *   }
+ *
+ *   undo = e => {
+ *     this.editorCtx.undo()
+ *   }
+ *
+ *   render () {
+ *     return (
+ *       <View>
+ *         <Editor id='editor' className='editor' placeholder={this.state.placeholder} onReady={this.editorReady}></Editor>
+ *         <Button type='warn' onClick={this.undo}>撤销</Button>
+ *       </View>
+ *     )
+ *   }
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="container">
+ *     <editor id="editor" class="editor" :placeholder="placeholder" `@ready="editorReady"></editor>
+ *     <button type="warn" `@tap="undo">撤销</button>
+ *   </view>
+ * </template>
+ *
+ * <script>
+ *   import Taro from 'vite-plugin-taro-runtime/taro'
+ *   export default {
+ *     data() {
+ *       return {
+ *         placeholder: '来，输入隔壁的名字试试...'
+ *       }
+ *     },
+ *     methods: {
+ *       editorReady() {
+ *         Taro.createSelectorQuery().select('#editor').context((res) => {
+ *           this.editorCtx = res.context
+ *         }).exec()
+ *       },
+ *       undo() {
+ *         this.editorCtx.undo()
+ *       }
+ *     }
+ *   }
+ * </script>
+ * ```
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/editor.html
+ */
+declare const Editor: ComponentType<EditorProps>
+export { Editor, EditorProps }

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

@@ -0,0 +1,25 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface FollowSwanProps extends StandardProps {
+  /** 组件大小
+   * @supported swan
+   * @default "default"
+   */
+  size?: string
+  /** 组件样式
+   * @supported swan
+   * @default "primary"
+   */
+  type?: string
+  /** 关注和取消关注成功的回调，返回关注状态 {isFavor: true|false}
+   * @supported swan
+   */
+  onFavorStatusChange?: CommonEventFunction
+}
+/** 关注小程序
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/follow-swan/
+ */
+declare const FollowSwan: ComponentType<FollowSwanProps>
+export { FollowSwan, FollowSwanProps }

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

@@ -0,0 +1,130 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface FormProps extends StandardProps {
+  /** 是否返回 `formId` 用于发送模板消息。
+   * @default false
+   * @supported weapp, alipay, swan, qq, jd, h5, harmony_hybrid
+   */
+  reportSubmit?: boolean
+  /** 等待一段时间（毫秒数）以确认 `formId` 是否生效。
+   * 如果未指定这个参数，`formId` 有很小的概率是无效的（如遇到网络失败的情况）。
+   * 指定这个参数将可以检测 `formId` 是否有效，
+   * 以这个参数的时间作为这项检测的超时时间。
+   * 如果失败，将返回 `requestFormId:fail` 开头的 `formId`。
+   * @default 0
+   * @supported weapp
+   */
+  reportSubmitTimeout?: number
+  /** 模板消息的类型，report-submit 为 true 时填写有效
+   * 取值：default / subscribe
+   * @default 'default'
+   * @supported swan
+   */
+  reportType?: string
+  /** 发送订阅类模板消息所用的模板库标题 ID ，可通过 getTemplateLibraryList 获取
+   * 当参数类型为 Array 时，可传递 1~3 个模板库标题 ID （注：此处填写模板库id。示例：BD0001）
+   * @supported swan
+   */
+  templateId?: string | Array<string>
+  /** 发送订阅类模板消息时所使用的唯一标识符，内容由开发者自定义，用来标识订阅场景
+   * 注意：同一用户在同一 subscribe-id 下的多次授权不累积下发权限，只能下发一条。若要订阅多条，需要不同 subscribe-id
+   * @supported swan
+   */
+  subscribeId?: string
+  /** 用于分发目的。取值：0 或 1，其中 0 表示默认，1 表示留资目标，需要和留资分发配置一起使用，详情见留资分发配置
+   * @supported tt
+   * @default 0
+   */
+  conversionTarget?: number
+  /** 用于分发目的。开发者在【小程序开发者后台 -> 进入目标小程序 -> 运营 -> 流量配置 -> 抖音 -> 留资分发配置】复制创建的配置 ID，需要和留资分发配置一起使用，详情见留资分发配置
+   *
+   * @supported tt
+   * @default ""
+   */
+  clueComponentId?: string
+  /** 携带 form 中的数据触发 submit 事件
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid, ascf
+   */
+  onSubmit?: CommonEventFunction<FormProps.onSubmitEventDetail>
+  /** 表单重置时会触发 reset 事件
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid, ascf
+   */
+  onReset?: CommonEventFunction
+}
+declare namespace FormProps {
+  interface onSubmitEventDetail {
+    /** 当点击 `<form>` 表单中 `form-type` 为 `submit` 的 `<button>` 组件时，
+     * 会将表单组件中的 `value` 值进行提交，
+     * 需要在表单组件中加上 `name` 来作为 `key`。
+     */
+    value?: {
+      [formItemName: string]: any
+    }
+    /** 当 `reportSubmit` 为 `true` 时，返回 `formId` 用于发送模板消息。
+     */
+    formId?: string
+  }
+}
+/** 表单。将组件内的用户输入的 switch input checkbox slider radio picker 提交。
+ *
+ * 当点击 form 表单中 form-type 为 submit 的 button 组件时，会将表单组件中的 value 值进行提交，需要在表单组件中加上 name 来作为 key。
+ * @classification forms
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid, ascf
+ * @example_react
+ * ```tsx
+ * class App extends Component {
+ *
+ *   formSubmit = e => {
+ *     console.log(e)
+ *   }
+ *
+ *   formReset = e => {
+ *     console.log(e)
+ *   }
+ *
+ *   render () {
+ *     return (
+ *       <Form onSubmit={this.formSubmit} onReset={this.formReset} >
+ *         <View className='example-body'>
+ *           <Switch name='switch' className='form-switch'></Switch>
+ *         </View>
+ *       </Form>
+ *     )
+ *   }
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <form `@submit="formSubmit" `@reset="formReset" >
+ *       <view class="taro-example-body">
+ *         <switch name="switch" class="form-switch"></Switch>
+ *       </view>
+ *       <view class="taro-example-btns">
+ *         <button form-type="submit">Submit</button>
+ *         <button type="default" form-type="reset">Reset</button>
+ *     </view>
+ *   </form>
+ * </template>
+ *
+ * <script>
+ * export default {
+ *   data() {
+ *     return {}
+ *   },
+ *   methods: {
+ *     formSubmit (e) {
+ *       console.log(e)
+ *     },
+ *
+ *     formReset (e) {
+ *       console.log(e)
+ *     }
+ *   }
+ * }
+ * </script>
+ * ```
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/form.html
+ */
+declare const Form: ComponentType<FormProps>
+export { Form, FormProps }

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

@@ -0,0 +1,56 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface FunctionalPageNavigatorProps extends StandardProps {
+  /** 跳转到的小程序版本，有效值 develop（开发版），trial（体验版），release（正式版）；线上版本必须设置为 release
+   * @default "release"
+   * @supported weapp
+   */
+  version?: keyof FunctionalPageNavigatorProps.Version
+  /** 要跳转到的功能页
+   * @supported weapp
+   */
+  name?: keyof FunctionalPageNavigatorProps.Name
+  /** 功能页参数，参数格式与具体功能页相关
+   * @supported weapp
+   */
+  args?: object
+  /** 功能页返回，且操作成功时触发， detail 格式与具体功能页相关
+   * @supported weapp
+   */
+  onSuccess?: CommonEventFunction
+  /** 功能页返回，且操作失败时触发， detail 格式与具体功能页相关
+   * @supported weapp
+   */
+  onFail?: CommonEventFunction
+  /** 因用户操作从功能页返回时触发
+   * @supported weapp
+   */
+  onCancel?: CommonEventFunction
+}
+declare namespace FunctionalPageNavigatorProps {
+  /** version 的合法值 */
+  interface Version {
+    /** 开发版 */
+    develop
+    /** 体验版 */
+    trial
+    /** 正式版 */
+    release
+  }
+  /** name 的合法值 */
+  interface Name {
+    /** [用户信息功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/user-info.html) */
+    loginAndGetUserInfo
+    /** [支付功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/request-payment.html) */
+    requestPayment
+    /** [收货地址功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/choose-address.html) */
+    chooseAddress
+  }
+}
+/** 仅在插件中有效，用于跳转到插件功能页
+ * @classification navig
+ * @supported weapp
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/functional-page-navigator.html
+ */
+declare const FunctionalPageNavigator: ComponentType<FunctionalPageNavigatorProps>
+export { FunctionalPageNavigator, FunctionalPageNavigatorProps }

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

@@ -0,0 +1,72 @@
+import { ComponentType } from 'react'
+import { StandardProps, CommonEventFunction } from './common'
+interface GridBuilderProps extends StandardProps {
+  /**
+   * 布局方式
+   * @supported weapp
+   * @default "aligned"
+   *
+   * 可选值:
+   * - aligned: 每行高度由同一行中最大高度子节点决定
+   * - masonry: 瀑布流，根据子元素高度自动布局
+   */
+  type: 'aligned' | 'masonry'
+  /**
+   * 需要用于渲染的列表
+   * @supported weapp
+   * @default []
+   */
+  list: any[]
+  /**
+   * 完整列表的长度，如果不传则取 list 的长度作为其值
+   * @supported weapp
+   */
+  childCount?: number
+  /**
+   * 交叉轴元素数量
+   * @supported weapp
+   * @default 2
+   */
+  crossAxisCount?: number
+  /** 交叉轴元素最大范围
+   * @supported weapp
+   * @default 0
+   */
+  maxCrossAxisExtent?: number
+  /**
+   * 主轴方向间隔
+   * @supported weapp
+   * @default 0
+   */
+  mainAxisGap?: number
+  /** 交叉轴方向间隔
+   * @supported weapp
+   * @default 0
+   */
+  crossAxisGap?: number
+  /**
+   * 长度为 4 的数组，按 top、right、bottom、left 顺序指定内边距
+   * @supported weapp
+   * @default [0, 0, 0, 0]
+   */
+  padding?: [number, number, number, number]
+  /**
+   * 列表项创建时触发，event.detail = {index}，index 即被创建的列表项序号
+   * @supported weapp
+   */
+  onItemBuild?: CommonEventFunction
+  /**
+   * 列表项回收时触发，event.detail = {index}，index 即被回收的列表项序号
+   * @supported weapp
+   */
+  onItemDispose?: CommonEventFunction
+}
+
+/**
+ * 网格构造器，仅支持作为 `<scroll-view type="custom">` 模式的直接子节点，仅 Skyline 支持。
+ * @classification skyline
+ * @supported weapp
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/grid-builder.html
+ */
+declare const GridBuilder: ComponentType<GridBuilderProps>
+export { GridBuilder, GridBuilderProps }

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

@@ -0,0 +1,51 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface GridViewProps extends StandardProps {
+  /**
+   * 布局方式
+   * @supported weapp
+   * @default "aligned"
+   *
+   * 可选值:
+   * - aligned: 每行高度由同一行中最大高度子节点决定
+   * - masonry: 瀑布流，根据子元素高度自动布局
+   */
+  type: 'aligned' | 'masonry'
+  /**
+   * 交叉轴元素数量
+   * @supported weapp
+   * @default 2
+   */
+  crossAxisCount?: number
+  /**
+   * 主轴方向间隔
+   * @supported weapp
+   * @default 0
+   */
+  mainAxisGap?: number
+  /** 交叉轴方向间隔
+   * @supported weapp
+   * @default 0
+   */
+  crossAxisGap?: number
+  /** 交叉轴元素最大范围
+   * @supported weapp
+   * @default 0
+   */
+  maxCrossAxisExtent?: number
+  /**
+   * 长度为 4 的数组，按 top、right、bottom、left 顺序指定内边距
+   * @supported weapp
+   * @default [0, 0, 0, 0]
+   */
+  padding?: [number, number, number, number]
+}
+
+/**
+ * 网格布局容器，仅支持作为 scroll-view 自定义模式下的直接子节点或 sticky-section 组件直接子节点。仅 Skyline 支持。
+ * @classification skyline
+ * @supported weapp
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/grid-view.html
+ */
+declare const GridView: ComponentType<GridViewProps>
+export { GridView, GridViewProps }

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

@@ -0,0 +1,97 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface IconProps extends StandardProps {
+  /** icon 的类型
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid, ascf
+   */
+  type: keyof IconProps.TIconType
+  /** icon 的大小，单位px
+   * @default 23
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid, ascf
+   */
+  size?: number
+  /** icon 的颜色，同 css 的 color
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid, ascf
+   */
+  color?: string
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+}
+declare namespace IconProps {
+  /** icon 的类型 */
+  interface TIconType {
+    /** 成功图标 */
+    success
+    /** 成功图标（不带外圈） */
+    success_no_circle
+    /** 信息图标 */
+    info
+    /** 警告图标 */
+    warn
+    /** 等待图标 */
+    waiting
+    /** 取消图标 */
+    cancel
+    /** 下载图标 */
+    download
+    /** 搜索图标 */
+    search
+    /** 清除图标 */
+    clear
+    /** 圆环图标(多选控件图标未选择)「微信文档未标注属性」 */
+    circle
+    /** 带圆环的信息图标「微信文档未标注属性」 */
+    info_circle
+  }
+}
+/** 图标。组件属性的长度单位默认为 px
+ * @classification base
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid, ascf
+ * @example_react
+ * ```tsx
+ * export default class PageView extends Component {
+ *   constructor() {
+ *     super(...arguments)
+ *   }
+ *
+ *   render() {
+ *     return (
+ *       <View className='components-page'>
+ *         <Icon size='60' type='success' />
+ *         <Icon size='60' type='info' />
+ *         <Icon size='60' type='warn' color='#ccc' />
+ *         <Icon size='60' type='warn' />
+ *         <Icon size='60' type='waiting' />
+ *         <Icon size='20' type='success_no_circle' />
+ *         <Icon size='20' type='warn' />
+ *         <Icon size='20' type='success' />
+ *         <Icon size='20' type='download' />
+ *         <Icon size='20' type='clear' color='red' />
+ *         <Icon size='20' type='search' />
+ *       </View>
+ *     )
+ *   }
+ * }
+ * ```
+ * @example_vue
+ * <template>
+ *   <view class="components-page">
+ *     <icon size="60" type="success" />
+ *     <icon size="60" type="info" />
+ *     <icon size="60" type="warn" color="#ccc" />
+ *     <icon size="60" type="warn" />
+ *     <icon size="60" type="waiting" />
+ *     <icon size="20" type="success_no_circle" />
+ *     <icon size="20" type="warn" />
+ *     <icon size="20" type="success" />
+ *     <icon size="20" type="download" />
+ *     <icon size="20" type="clear" color="red" />
+ *     <icon size="20" type="search" />
+ *   </view>
+ * </template>
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/icon.html
+ */
+declare const Icon: ComponentType<IconProps>
+export { Icon, IconProps }