zmp-sdk 2.47.0-beta.3 → 2.47.0-beta.4

package/index.d.ts

@@ -2493,6 +2493,43 @@ declare const showWidgetArgs: ZodObject<{
     onMethodChange?: ((...args: unknown[]) => unknown) | undefined;
     id: string;
 }>[];
+/**
+ * ...Implementation of the Checkout Kit Widget...
+ *
+ * @minimumVersion 2.47.0
+ * @zaloOnly Chỉ hoạt động khi chạy bên trong ứng dụng Zalo mobile.
+ *
+ * @param {string} id - ID của element, nơi cần hiển thị widget.
+ * @param {(data: any) => void} [onMethodChange] - Callback được gọi khi phương thức thanh toán được thay đổi. Callback này nhận vào dữ liệu liên quan đến phương thức thanh toán đã chọn.
+ * @param {(error: string) => void} [fail] - Callback được gọi khi có lỗi xảy ra trong quá trình tương tác với widget. Callback này nhận vào thông tin về lỗi.
+ *
+ * @example Hiển thị Widget Checkout Kit:
+ * ```ts
+ * import React, { useEffect } from "react";
+ * import { CheckoutKit } from "zmp-sdk/apis";
+ *
+ * function HomePage() {
+ *   useEffect(() => {
+ *     CheckoutKit.showWidget({
+ *       id: "checkoutKitWidget",
+ *       onMethodChange: (data) => {
+ *         console.log(data);
+ *       },
+ *     });
+ *   }, []);
+ *
+ *   return (
+ *     <>
+ *       ...
+ *       <div id="checkoutKitWidget" />
+ *       ...
+ *     </>
+ *   );
+ * }
+ *
+ * export default HomePage;
+ * ```
+ */
 declare function showWidget(args: AsyncVoidCallback$1 & TypeOf<(typeof showWidgetArgs)[0]>): Promise<void>;
 
 declare const eventTypeType: ZodEnum<["APP_INITIALIZING", "APP_READY"]>;