mini-types - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "mini-types",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "TypeScript declarations for Alipay's mini program.",
@@ -5,0 +5,0 @@ "scripts": {

types/api/open/tradePay.d.ts

@@ -25,7 +25,12 @@ /**
     /**
-     * 接入小程序支付时传入此参数。此参数为支付宝交易号，注意参数有大小写区分
+     * 接入小程序支付时传入此参数。此参数为支付宝交易号，注意参数有大小写区分。
      */
-    tradeNO: string;
+    tradeNO?: string;
 
     /**
+     * 完整的支付参数拼接成的字符串，从服务端获取。
+     */
+    orderStr?: string;
+
+    /**
      * 调用成功的回调函数
@@ -32,0 +37,0 @@ */

types/api/ui/index.d.ts

@@ -15,1 +15,2 @@ /// <reference path="./navigator.d.ts" />
 /// <reference path="./feedback.d.ts" />
+/// <reference path="./optionsSelect.d.ts" />

types/api/ui/tabbar.d.ts

@@ -12,2 +12,189 @@ declare namespace my {
   function switchTab(options: ISwitchTabOptions): void;
+
+  interface IHideTabBarOptions {
+    /**
+     * 是否需要动画效果，默认无。
+     */
+    animation?: boolean;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库版本 1.11.0 或更高版本，低版本需要做 兼容处理。
+   * 隐藏标签页（tabbar）。
+   */
+  function hideTabBar(options: IHideTabBarOptions): void;
+
+  interface IHideTabBarRedDotOptions {
+    /**
+     * tabbar 的哪一项，从左边算起。
+     */
+    index: number;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+   * 隐藏标签页（tabbar）某一项右上角的红点。
+   */
+  function hideTabBarRedDot(options: IHideTabBarRedDotOptions): void;
+
+  interface IRemoveTabBarBadgeOptions {
+    /**
+     * 标签页的项数序号，从左边开始计数。
+     */
+    index: number;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+   * 移除标签页（tabbar） 某一项右上角的文本。
+   */
+  function removeTabBarBadge(options: IRemoveTabBarBadgeOptions): void;
+
+  interface ISetTabBarBadgeOptions {
+    /**
+     * 标签页的项数序号，从左边开始计数。
+     */
+    index: number;
+
+    /**
+     * 显示的文本，超过三个字符则显示成前两个字符+“…”，例如：“支付宝”显示“支付宝”，“蚂蚁金服”显示“蚂蚁…”。
+     */
+    text: string;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 及以上版本。
+   * 为标签页（tabbar）某一项的右上角添加文本。
+   */
+  function setTabBarBadge(options: ISetTabBarBadgeOptions): void;
+
+  interface ISetTabBarItemOptions {
+    /**
+     * 标签页的项数序号，从左边开始计数。
+     */
+    index: number;
+
+    /**
+     * 标签页按钮上的文字。
+     */
+    text: number;
+
+    /**
+     * 图片路径，建议尺寸为 81px * 81px，支持网络图片。
+     */
+    iconPath: number;
+
+    /**
+     * 选中时的图片路径，建议尺寸为 81px * 81px，支持网络图片。
+     */
+    selectedIconPath: number;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+   * 动态设置标签页（tabbar）某一项的内容。
+   */
+  function setTabBarItem(options: ISetTabBarItemOptions): void;
+
+  interface ISetTabBarStyleOptions {
+    /**
+     * 标签（tab）上的文字默认颜色
+     */
+    color: string;
+
+    /**
+     * 标签（tab）上的文字选中时的颜色
+     */
+    selectedColor: string;
+
+    /**
+     * 标签（tab）的背景色
+     */
+    backgroundColor: string;
+
+    /**
+     * 标签页（tabbar）上边框的颜色， 仅支持  black 、 white 。
+     */
+    borderStyle: string;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+   * 动态设置标签页（tabbar）的整体样式，如文字颜色、标签背景色、标签边框颜色等。
+   */
+  function setTabBarStyle(options: ISetTabBarStyleOptions): void;
+
+  interface IShowTabBarOptions {
+    /**
+     * 是否需要动画效果，默认无。
+     */
+    animation?: string;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+   * 显示标签页（tabbar）。
+   */
+  function showTabBar(options: IShowTabBarOptions): void;
+
+  interface IShowTabBarRedDotOptions {
+    /**
+     * 标签页的项数序号，从左边开始计数。
+     */
+    index: number;
+
+    success?: () => void;
+
+    fail?: () => void;
+
+    complete?: () => void;
+  }
+
+  /**
+   * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+   * 显示标签页（tabbar）某一项的右上角的红点。
+   */
+  function showTabBarRedDot(options: IShowTabBarRedDotOptions): void;
 }

types/app.d.ts

@@ -103,3 +103,5 @@ declare namespace tinyapp {
  */
-declare function App(options: tinyapp.AppOptions): void;
+/* tslint:disable:no-unnecessary-generics */
+declare function App<G>(options: tinyapp.AppOptions<G>): void;
+/* tslint:enable:no-unnecessary-generics */
 
@@ -106,0 +108,0 @@ /**

types/component.d.ts

@@ -101,8 +101,10 @@ declare namespace tinyapp {
 
-declare function Component(
+/* tslint:disable:no-unnecessary-generics */
+declare function Component<P, D, M extends tinyapp.IComponentMethods>(
   options: tinyapp.ComponentOptions<
-    Record<string, any>,
-    any,
-    tinyapp.IComponentMethods
+    P,
+    D,
+    M
   >
 ): void;
+/* tslint:enable:no-unnecessary-generics */

types/page.d.ts

@@ -46,3 +46,9 @@ declare namespace tinyapp {
     onTitleClick?(): void;
-    onTabItemTap?(): void;
+
+    /**
+     * 版本要求：基础库 1.11.0 或更高版本，若版本较低，建议做 兼容处理。
+     * 点击标签（tab）时触发。
+     */
+    onTabItemTap?(item: { index: number; pagePath: string; text: string; }): void;
+
     beforeTabItemTap?(): void;
@@ -158,3 +164,5 @@ }
  */
-declare function Page(options: tinyapp.PageOptions<any>): void;
+/* tslint:disable:no-unnecessary-generics */
+declare function Page<D>(options: tinyapp.PageOptions<D>): void;
+/* tslint:enable:no-unnecessary-generics */
 
@@ -161,0 +169,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

177371

increased by3.67%

Number of package files

79

increased by1.28%

Lines of code

5883

increased by3.72%

No dependency changes