@tarojs/taro 3.4.0-beta.1 → 3.4.1

package/types/compile.d.ts

@@ -53,12 +53,12 @@ export type IOption = Record<string, any>
 
 export interface ICopyOptions {
   patterns: {
-    from: string,
-    to: string,
-    ignore?: string[],
-    transform?: Function,
+    from: string
+    to: string
+    ignore?: string[]
+    transform?: Function
     watch?: boolean
-  }[],
+  }[]
   options: {
     ignore?: string[]
   }
@@ -68,11 +68,11 @@ export interface ISassOptions {
   /**
    * 引入的全局 sass 文件，如果要引入多个文件，支持数组形式传入
    */
-  resource?: string | string[],
+  resource?: string | string[]
   /**
    * 项目根目录的绝对地址(若为小程序云开发模板，则应该是client目录)
    */
-  projectDirectory?: string,
+  projectDirectory?: string
   /**
    * 全局 scss 变量，若 data 与 resource 中设置了同样的变量，则 data 的优先级高于 resource
    */
@@ -89,21 +89,21 @@ export namespace PostcssOption {
     generateScopedName: string | ((localName: string, absoluteFilePath: string) => string)
   }>
   export type url = TogglableOptions<{
-    limit: number,
+    limit: number
     basePath?: string | string[]
   }>
 }
 
 export interface IPostcssOption {
-  autoprefixer?: TogglableOptions,
-  pxtransform?: TogglableOptions,
-  cssModules?: PostcssOption.cssModules,
-  url?: PostcssOption.url,
+  autoprefixer?: TogglableOptions
+  pxtransform?: TogglableOptions
+  cssModules?: PostcssOption.cssModules
+  url?: PostcssOption.url
   [key: string]: any
 }
 
 export interface ICompileOption {
-  exclude?: string[],
+  exclude?: string[]
   include?: string[]
 }
 
@@ -113,85 +113,85 @@ interface Runtime {
 }
 
 export interface IMiniAppConfig {
-  appOutput?: boolean,
-  enableSourceMap?: boolean,
-  sourceMapType?: string,
-  debugReact?: boolean,
+  appOutput?: boolean
+  enableSourceMap?: boolean
+  sourceMapType?: string
+  debugReact?: boolean
   minifyXML?: {
     collapseWhitespace?: boolean
-  },
-
-  webpackChain?: (chain: any, webpack: any, PARSE_AST_TYPE: any) => void,
-  entry?: webpack.Entry,
-  output?: webpack.Output,
-  postcss?: IPostcssOption,
-  cssLoaderOption?: IOption,
-  sassLoaderOption?: IOption,
-  lessLoaderOption?: IOption,
-  stylusLoaderOption?: IOption,
-  mediaUrlLoaderOption?: IOption,
-  fontUrlLoaderOption?: IOption,
-  imageUrlLoaderOption?: IOption,
-  miniCssExtractPluginOption?: IOption,
-
-  customFilesTypes?: IMINI_APP_FILE_TYPE,
-  commonChunks?: string[] | ((commonChunks: string[]) => string[]),
-  addChunkPages?: ((pages: Map<string, string[]>, pagesNames?: string[]) => void),
+  }
+
+  webpackChain?: (chain: any, webpack: any, PARSE_AST_TYPE: any) => void
+  entry?: webpack.Entry
+  output?: webpack.Output
+  postcss?: IPostcssOption
+  cssLoaderOption?: IOption
+  sassLoaderOption?: IOption
+  lessLoaderOption?: IOption
+  stylusLoaderOption?: IOption
+  mediaUrlLoaderOption?: IOption
+  fontUrlLoaderOption?: IOption
+  imageUrlLoaderOption?: IOption
+  miniCssExtractPluginOption?: IOption
+
+  customFilesTypes?: IMINI_APP_FILE_TYPE
+  commonChunks?: string[] | ((commonChunks: string[]) => string[])
+  addChunkPages?: ((pages: Map<string, string[]>, pagesNames?: string[]) => void)
   optimizeMainPackage?: {
-    enable?: boolean,
+    enable?: boolean
     exclude?: any[]
-  },
+  }
 
   compile?: {
-    exclude?: any[],
+    exclude?: any[]
     include?: any[]
   }
   runtime?: Runtime
 }
 
 export type TogglableOptions<T = IOption> = {
-  enable?: boolean,
+  enable?: boolean
   config?: T
 }
 
 export interface IH5RouterConfig {
-  mode?: 'hash' | 'browser' | 'multi',
-  customRoutes?: IOption,
-  basename?: string,
-  lazyload?: boolean | ((pagename: string) => boolean),
+  mode?: 'hash' | 'browser' | 'multi'
+  customRoutes?: IOption
+  basename?: string
+  lazyload?: boolean | ((pagename: string) => boolean)
   renamePagename?: (pagename: string) => string
   forcePath?: string
 }
 
 export interface IH5Config {
-  publicPath?: string,
-  staticDirectory?: string,
-  chunkDirectory?: string,
+  publicPath?: string
+  staticDirectory?: string
+  chunkDirectory?: string
 
   webpack?: ((webpackConfig: webpack.Configuration, webpack) => webpack.Configuration) | webpack.Configuration
 
-  webpackChain?: (chain: any, webpack: any) => void,
-
-  entry?: webpack.Entry,
-  output?: webpack.Output,
-  router?: IH5RouterConfig,
-  devServer?: webpackDevServer.Configuration,
-  enableSourceMap?: boolean,
-  sourceMapType?: 'none' | 'eval' | 'cheap-eval-source-map' | 'cheap-module-eval-source-map' | 'eval-source-map' | 'cheap-source-map' | 'cheap-module-source-map' | 'inline-cheap-source-map' | 'inline-cheap-module-source-map' | 'source-map' | 'inline-source-map' | 'hidden-source-map' | 'nosources-source-map',
-  enableExtract?: boolean,
-  transformOnly?: boolean,
-
-  cssLoaderOption?: IOption,
-  styleLoaderOption?: IOption,
-  sassLoaderOption?: IOption,
-  lessLoaderOption?: IOption,
-  stylusLoaderOption?: IOption,
-  mediaUrlLoaderOption?: IOption,
-  fontUrlLoaderOption?: IOption,
-  imageUrlLoaderOption?: IOption,
-  miniCssExtractPluginOption?: IOption,
-  esnextModules?: string[],
-  useHtmlComponents?: boolean,
+  webpackChain?: (chain: any, webpack: any) => void
+
+  entry?: webpack.Entry
+  output?: webpack.Output
+  router?: IH5RouterConfig
+  devServer?: webpackDevServer.Configuration
+  enableSourceMap?: boolean
+  sourceMapType?: 'none' | 'eval' | 'cheap-eval-source-map' | 'cheap-module-eval-source-map' | 'eval-source-map' | 'cheap-source-map' | 'cheap-module-source-map' | 'inline-cheap-source-map' | 'inline-cheap-module-source-map' | 'source-map' | 'inline-source-map' | 'hidden-source-map' | 'nosources-source-map'
+  enableExtract?: boolean
+  transformOnly?: boolean
+
+  cssLoaderOption?: IOption
+  styleLoaderOption?: IOption
+  sassLoaderOption?: IOption
+  lessLoaderOption?: IOption
+  stylusLoaderOption?: IOption
+  mediaUrlLoaderOption?: IOption
+  fontUrlLoaderOption?: IOption
+  imageUrlLoaderOption?: IOption
+  miniCssExtractPluginOption?: IOption
+  esnextModules?: string[]
+  useHtmlComponents?: boolean
 
   postcss?: IPostcssOption
 }
@@ -213,11 +213,11 @@ export type SystemConfig = {
   /**
    * 打印日志等级，分为 off,error,warn,info,log,debug
    */
-  logLevel?: LogLevel,
+  logLevel?: LogLevel
   /**
    * 页面设计基准宽度，根据实际设备宽度来缩放元素大小
    */
-  designWidth?: number,
+  designWidth?: number
   /**
    * 全局数据对象，属性名不能以$或_开头，在页面中可通过 this 进行访问;如果全局数据属性与页面的数据属性重名，则页面初始化时，全局数据会覆盖页面中对应的属性值
    */
@@ -228,7 +228,7 @@ type RouterConfig = {
   /**
    * 首页名称
    */
-  entry: string,
+  entry: string
   /**
    * 页面配置列表，key 值为页面名称（对应页面目录名，例如 Hello 对应'Hello'目录），value 为页面详细配置 page
    */
@@ -238,14 +238,14 @@ type RouterPage = {
   /**
    * 页面对应的组件名，与 ux 文件名保持一致，例如'hello' 对应 'hello.ux'
    */
-  component: string,
+  component: string
   /**
    * 页面路径，例如“/user”,不填则默认为/<页面名称>。
    * path 必须唯一,不能和其他 page 的 path 相同。
    * 下面 page 的 path 因为缺失,会被设置为“/Index”：
    * "Index": {"component": "index"}
    */
-  path?: string,
+  path?: string
   /**
    * 声明页面可以处理某种请求
    */
@@ -260,31 +260,31 @@ interface IDefaultDisplayConfig {
   /**
    * 窗口背景颜色
    */
-  backgroundColor?: string,
+  backgroundColor?: string
   /**
    * 是否是全屏模式，默认不会同时作用于 titleBar，titleBar 需要继续通过 titleBar 控制
    */
-  fullScreen?: boolean,
+  fullScreen?: boolean
   /**
    * 是否显示 titleBar
    */
-  titleBar?: boolean,
+  titleBar?: boolean
   /**
    * 标题栏背景色
    */
-  titleBarBackgroundColor?: string,
+  titleBarBackgroundColor?: string
   /**
    * 标题栏文字颜色
    */
-  titleBarTextColor?: string,
+  titleBarTextColor?: string
   /**
    * 标题栏文字(也可通过页面跳转传递参数(titleBarText)设置)
    */
-  titleBarText?: string,
+  titleBarText?: string
   /**
    * 是否显示标题栏右上角菜单按钮，点击菜单按钮调用页面生命周期 onMenuPress 方法，如果该方法未实现则显示系统默认菜单
    */
-  menu?: boolean,
+  menu?: boolean
   /**
    * 软键盘弹出时为保证输入框可见，页面的调整方式。　adjustPan:上移页面; adjustResize:压缩页面显示区域，当页面全屏时，此设置不生效
    */
@@ -304,31 +304,31 @@ export interface ITaroManifestConfig {
   /**
    * 应用包名，确认与原生应用的包名不一致，推荐采用 com.company.module 的格式，如：com.example.demo
    */
-  package: string,
+  package: string
   /**
    * 应用名称，6 个汉字以内，与应用商店保存的名称一致，用于在桌面图标、弹窗等处显示应用名称
    */
-  name: string,
+  name: string
   /**
    * 应用图标，提供 192x192 大小的即可
    */
-  icon: string,
+  icon: string
   /**
    * 应用版本名称，如："1.0"
    */
-  versionName?: string,
+  versionName?: string
   /**
    * 应用版本号，从1自增，推荐每次重新上传包时versionCode+1
    */
-  versionCode: number,
+  versionCode: number
   /**
    * 支持的最小平台版本号，兼容性检查，避免上线后在低版本平台运行并导致不兼容；如果不填按照内测版本处理
    */
-  minPlatformVersion?: string,
+  minPlatformVersion?: string
   /**
    * 接口列表，绝大部分接口都需要在这里声明，否则不能调用，详见每个接口的文档说明
    */
-  features?: FeatureItem[],
+  features?: FeatureItem[]
   /**
    *
    */
@@ -339,11 +339,11 @@ export interface IManifestConfig extends ITaroManifestConfig {
   /**
    * 系统配置信息
    */
-  config: SystemConfig,
+  config: SystemConfig
   /**
    * 路由信息
    */
-  router: RouterConfig,
+  router: RouterConfig
   /**
    * UI 显示相关配置
    */
@@ -353,24 +353,24 @@ export interface IManifestConfig extends ITaroManifestConfig {
 export type PluginItem = string | [string, object]
 
 export interface IProjectBaseConfig {
-  projectName?: string,
-  date?: string,
-  designWidth?: number,
-  watcher?: any[],
-  deviceRatio?: TaroGeneral.TDeviceRatio,
-  sourceRoot?: string,
-  outputRoot?: string,
-  env?: IOption,
-  alias?: IOption,
-  defineConstants?: IOption,
-  copy?: ICopyOptions,
-  csso?: TogglableOptions,
-  terser?: TogglableOptions,
-  uglify?: TogglableOptions,
-  sass?: ISassOptions,
-  plugins?: PluginItem[],
+  projectName?: string
+  date?: string
+  designWidth?: number
+  watcher?: any[]
+  deviceRatio?: TaroGeneral.TDeviceRatio
+  sourceRoot?: string
+  outputRoot?: string
+  env?: IOption
+  alias?: IOption
+  defineConstants?: IOption
+  copy?: ICopyOptions
+  csso?: TogglableOptions
+  terser?: TogglableOptions
+  uglify?: TogglableOptions
+  sass?: ISassOptions
+  plugins?: PluginItem[]
   presets?: PluginItem[]
-  baseLevel?: number,
+  baseLevel?: number
   framework?: string
 }
 

package/types/taro.component.d.ts

@@ -21,31 +21,24 @@ declare module './index' {
     onPageScroll?(obj: PageScrollObject): void
     onShareAppMessage?(obj: ShareAppMessageObject): ShareAppMessageReturn
     onTabItemTap?(obj: TabItemTapObject): void
-    onResize?(obj: any): void
+    onResize?(obj: PageResizeObject): void
   }
-
   interface ComponentOptions {
     addGlobalClass?: boolean
     styleIsolation?: 'isolated' | 'apply-shared' | 'shared'
   }
-
   interface ComponentClass<P = {}, S = any> extends StaticLifecycle<P, S> {
     new (...args: any[]): Component<P, {}>
     propTypes?: any // TODO: Use prop-types type definition.
     defaultProps?: Partial<P>
     displayName?: string
   }
-
   // ref: packages/taro-runtime/src/current.ts
   interface RouterInfo<TParams extends Partial<Record<string, string>> = Partial<Record<string, string>>> {
-    /**
-     * 路由参数。
-     */
+    /** 路由参数 */
     params: TParams
 
-    /**
-     * 页面路径。
-     */
+    /** 页面路径 */
     path: string
 
     onReady: string
@@ -55,13 +48,10 @@ declare module './index' {
     shareTicket: string | undefined
     scene: number | undefined
   }
-
   interface Component<P = {}, S = {}, SS = any> extends ComponentLifecycle<P, S, SS> {
     $scope?: any
   }
-
   type PropsWithChildren<P> = P & { children?: React.ReactNode }
-
   interface FunctionComponent<P = {}> {
     (props: PropsWithChildren<P>, context?: any): React.ReactElement | null
     propTypes?: any // TODO: Use prop-types type definition.
@@ -70,36 +60,31 @@ declare module './index' {
     options?: ComponentOptions
     externalClasses?: string[]
   }
-
   type FC<P = {}> = FunctionComponent<P>
-
   interface StatelessFunctionComponent {
     (): JSX.Element
   }
-
   type SFC = StatelessFunctionComponent
 
   interface Show {
-    componentDidShow?(options?: unknown): void
-    componentDidHide?(options?: unknown): void
-    onShow?(options?: unknown): void
-    onHide?(options?: unknown): void
+    componentDidShow?(): void
+    componentDidHide?(): void
+    onShow?(): void
+    onHide?(): void
   }
-
   interface AppInstance extends Show {
     mount(component: React.ComponentClass | Vue.ComponentOptions<Vue>, id: string, cb: () => void): void
+    componentDidShow?(options?: Record<string, unknown>): void
+    onShow?(options?: Record<string, unknown>): void
     unmount(id: string, cb: () => void): void
   }
-
   type Target = Record<string, unknown> & { dataset: Record<string, unknown>; id: string }
-
   interface MpEvent {
     type: string
     detail: Record<string, unknown>
     target: Target
     currentTarget: Target
   }
-
   interface PageLifeCycle extends Show {
     onPullDownRefresh?(): void
     onReachBottom?(): void
@@ -115,50 +100,87 @@ declare module './index' {
     onLoad(options: Record<string, unknown>): void
     onUnload(): void
   }
-
-  interface PageInstance extends PageLifeCycle {
-    /**
-     * 页面配置。
-     */
+  interface ComponentInstance<
+    TData extends Record<string, unknown> = Record<string, unknown>,
+    TParams extends Record<string, string> = Record<string, string>
+  > {
+    /** 组件的文件路径 */
+    is?: string
+    /** 节点id */
+    id?: string
+    /** 节点dataset */
+    dataset?: string
+    /** 组件数据，包括内部数据和属性值 */
+    data?: TData
+    /** 组件数据，包括内部数据和属性值（与 data 一致） */
+    properties?: TData
+    /** 相对于当前自定义组件的 Router 对象 */
+    router?: RouterInfo<TParams>
+    /** 相对于当前自定义组件所在页面的 Router 对象 */
+    pageRouter?: RouterInfo<TParams>
+    /** 设置data并执行视图层渲染 */
+    setData?(newData: Partial<TData>): void
+    /** 检查组件是否具有 behavior （检查时会递归检查被直接或间接引入的所有behavior） */
+    hasBehavior?(behavior: unknown): boolean
+    /** 触发事件，参见[组件间通信与事件](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/events.html) */
+    triggerEvent?(name: string, detail: Record<string, unknown>, options: {
+      /** 事件是否冒泡 */
+      bubbles?: boolean
+      /** 事件是否可以穿越组件边界，为 false 时，事件将只能在引用组件的节点树上触发，不进入其他任何组件内部 */
+      composed?: boolean
+      /** 事件是否拥有捕获阶段 */
+      capturePhase?: boolean
+    }): void
+    /** 创建一个 SelectorQuery 对象，选择器选取范围为这个组件实例内 */
+    createSelectorQuery?(): SelectorQuery
+    /** 创建一个 IntersectionObserver 对象，选择器选取范围为这个组件实例内 */
+    createIntersectionObserver?(): IntersectionObserver
+    /** 创建一个 MediaQueryObserver 对象 */
+    createMediaQueryObserver?(): MediaQueryObserver
+    /** 使用选择器选择组件实例节点，返回匹配到的第一个组件实例对象（会被 wx://component-export 影响） */
+    selectComponent?<
+      TD extends Record<string, unknown> = Record<string, unknown>,
+      TP extends Record<string, string> = Record<string, string>
+    >(selector: string): ComponentInstance<TD, TP>
+    /** 使用选择器选择组件实例节点，返回匹配到的全部组件实例对象组成的数组（会被 wx://component-export 影响） */
+    selectAllComponents?<
+      TD extends Record<string, unknown> = Record<string, unknown>,
+      TP extends Record<string, string> = Record<string, string>
+    >(selector: string): ComponentInstance<TD, TP>
+    /** 选取当前组件节点所在的组件实例（即组件的引用者），返回它的组件实例对象（会被 wx://component-export 影响） */
+    selectOwnerComponent?<
+      TD extends Record<string, unknown> = Record<string, unknown>,
+      TP extends Record<string, string> = Record<string, string>
+    >(): ComponentInstance<TD, TP>
+    /** 获取这个关系所对应的所有关联节点，参见[组件间关系](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/relations.html) */
+    getRelationNodes?(relationKey: string): NodesRef[]
+    /** 立刻执行 callback ，其中的多个 setData 之间不会触发界面绘制（只有某些特殊场景中需要，如用于在不同组件同时 setData 时进行界面绘制同步） */
+    groupSetData?(callback: () => void): void
+    /** 返回当前页面的 custom-tab-bar 的组件实例，详见[自定义 tabBar](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/custom-tabbar.html) */
+    getTabBar?(): ComponentInstance
+    /** 返回页面标识符（一个字符串），可以用来判断几个自定义组件实例是不是在同一个页面内 */
+    getPageId?(): string
+    /** 执行关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html) */
+    animate?(selector: string, keyFrames: KeyFrame[], duration: number, callback: () => void): void
+    /** 清除关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html) */
+    clearAnimation?(selector: string, options: ClearAnimationOptions, callback: () => void): void
+    /** 清除关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html) */
+    setUpdatePerformanceListener?(options: {
+      /** 是否返回变更的 data 字段信息 */
+      withDataPaths?: boolean
+    }, listener: () => void): void
+  }
+  interface PageInstance extends PageLifeCycle, ComponentInstance {
+    /** 页面配置 */
     config?: PageConfig
     data?: Record<string, unknown>
     path?: string
     options?: Record<string, unknown>
-    /**
-     * 执行关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
-     *
-     * 最低基础库版本：[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
-     **/
-    animate?(selector: string, keyFrames: KeyFrame[], duration: number, callback: () => void): void
-    /**
-     * 执行关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
-     *
-     * 最低基础库版本：[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
-     **/
-    animate?(
-      selector: string,
-      keyFrames: ScrollTimelineKeyframe[],
-      duration: number,
-      scrollTimeline: ScrollTimelineOption
-    ): void
-    /**
-     * 清除关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
-     *
-     * 最低基础库版本：[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
-     **/
-    clearAnimation?(selector: string, callback: () => void): void
-    /**
-     * 清除关键帧动画，详见[动画](https://developers.weixin.qq.com/miniprogram/dev/framework/view/animation.html)
-     *
-     * 最低基础库版本：[`2.9.0`](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)
-     **/
-    clearAnimation?(selector: string, options: ClearAnimationOptions, callback: () => void): void
   }
-
   interface TaroStatic {
     memo<P = {}>(
       FunctionComponent: FunctionComponent<P>,
-      compare?: (oldProps: P, newProps: P) => Boolean
+      compare?: (oldProps: P, newProps: P) => boolean
     ): FunctionComponent<P>
   }
 }