@arcblock/did-connect-react 3.4.15 → 3.5.1

package/docs/core-components-did-connect.md

@@ -1,166 +0,0 @@
-# Connection UI (DidConnect)
-
-The `DidConnect` component is a pre-built, comprehensive UI solution for handling various decentralized identity (DID) connection flows. It provides a user-friendly interface for actions like login, authentication, and profile requests, supporting multiple connection methods out-of-the-box.
-
-It serves as the visual centerpiece of the `@arcblock/did-connect-react` library, abstracting away the complexity of session management and real-time status updates. The component displays a QR code for DID Wallet users and offers alternative login options such as social logins (OAuth) and passwordless authentication (Passkeys).
-
-Before using `DidConnect`, ensure you have wrapped your application with the [`SessionProvider`](./core-components-session-provider.md) to manage the overall session state.
-
-## Basic Usage
-
-To use `DidConnect`, you need to import it and provide a few essential props. The component is typically controlled by a state variable that determines its visibility.
-
-```jsx DID Connect Example icon=logos:react
-import React, { useState } from 'react';
-import axios from 'axios';
-import DidConnect from '@arcblock/did-connect-react/lib/Connect';
-
-function App() {
-  const [isConnectOpen, setConnectOpen] = useState(false);
-
-  const handleClose = () => setConnectOpen(false);
-  const handleSuccess = () => {
-    // Handle successful login, e.g., redirect the user
-    window.location.href = '/profile';
-  };
-
-  return (
-    <div>
-      <button onClick={() => setConnectOpen(true)}>Login with DID</button>
-      {isConnectOpen && (
-        <DidConnect
-          action="login"
-          checkFn={axios.get}
-          onClose={handleClose}
-          onSuccess={handleSuccess}
-          messages={{
-            title: 'Scan to Sign In',
-            scan: 'Scan QR code with your DID Wallet',
-            confirm: 'Confirm login on your DID Wallet',
-            success: 'You have successfully signed in!',
-          }}
-        />
-      )}
-    </div>
-  );
-}
-
-export default App;
-```
-
-In this example, clicking the "Login with DID" button sets the `isConnectOpen` state to `true`, which renders the `DidConnect` component as a modal dialog. The `checkFn` prop is crucial, as it's the function the component uses to poll for the session status from your backend.
-
-## How It Works
-
-The `DidConnect` component orchestrates the entire user authentication flow, from displaying connection options to handling the final success or error state. The following diagram illustrates this flow:
-
-<!-- DIAGRAM_IMAGE_START:flowchart:4:3:1765962229 -->
-![Connection UI (DidConnect)](assets/diagram/did-connect-diagram-0.jpg)
-<!-- DIAGRAM_IMAGE_END -->
-
-## Component Props
-
-The `DidConnect` component is highly configurable through its props. Below is a detailed list of the available options.
-
-### Core Configuration
-
-These props are essential for setting up the component's basic functionality.
-
-<x-field-group>
-  <x-field data-name="action" data-type="string" data-required="true">
-    <x-field-desc markdown>Defines the purpose of the connection, such as `login`, `claim`, `sign`, etc. This string is passed to your backend to determine the required actions.</x-field-desc>
-  </x-field>
-  <x-field data-name="checkFn" data-type="function" data-required="true">
-    <x-field-desc markdown>The function used to poll the backend for session status updates. It should be a function that makes an API request, like `axios.get`.</x-field-desc>
-  </x-field>
-  <x-field data-name="baseUrl" data-type="string" data-default="''">
-    <x-field-desc markdown>The base URL for the API endpoints. If your API is on a different domain, specify it here.</x-field-desc>
-  </x-field>
-  <x-field data-name="prefix" data-type="string" data-default="/api/did">
-    <x-field-desc markdown>The URL prefix for the DID Connect API endpoints on your backend.</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### Behavior Control
-
-These props control how the connection process behaves.
-
-<x-field-group>
-  <x-field data-name="enabledConnectTypes" data-type="string[]" data-default='["web", "mobile", ...]'>
-    <x-field-desc markdown>An array of strings specifying which connection methods to display. Possible values include `web`, `mobile`, `github`, `google`, `apple`, `passkey`, etc.</x-field-desc>
-  </x-field>
-  <x-field data-name="passkeyBehavior" data-type="'none' | 'both' | 'only-existing' | 'only-new'" data-default="'none'">
-    <x-field-desc markdown>Controls the behavior of Passkey authentication. `none` disables it, `both` allows creating new passkeys and using existing ones, `only-existing` restricts to existing passkeys, and `only-new` forces new passkey creation.</x-field-desc>
-  </x-field>
-  <x-field data-name="allowWallet" data-type="boolean" data-default="true">
-    <x-field-desc markdown>If `false`, the QR code and mobile wallet connection options will be hidden.</x-field-desc>
-  </x-field>
-  <x-field data-name="autoConnect" data-type="boolean" data-default="true">
-    <x-field-desc markdown>If `true`, the component will automatically try to use a previously established connection from the same device.</x-field-desc>
-  </x-field>
-  <x-field data-name="forceConnected" data-type="boolean | string" data-default="true">
-    <x-field-desc markdown>If `true`, a user must connect with the same DID they are already logged in with. If a DID string is provided, the user must connect with that specific DID.</x-field-desc>
-  </x-field>
-  <x-field data-name="saveConnect" data-type="boolean" data-default="true">
-    <x-field-desc markdown>If `true`, the successful connection information is saved locally for future `autoConnect` attempts.</x-field-desc>
-  </x-field>
-  <x-field data-name="useSocket" data-type="boolean" data-default="true">
-    <x-field-desc markdown>If `true`, attempts to use a WebSocket for real-time status updates, falling back to polling if a connection cannot be established.</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### UI Customization
-
-Customize the appearance and text of the `DidConnect` component.
-
-<x-field-group>
-  <x-field data-name="mode" data-type="'dialog' | 'drawer' | 'page'" data-default="'dialog'">
-    <x-field-desc markdown>Determines how the component is displayed. `dialog` shows it as a centered modal, `drawer` as a bottom sheet (on mobile), and `page` embeds it directly into the document flow.</x-field-desc>
-  </x-field>
-  <x-field data-name="messages" data-type="object">
-    <x-field-desc markdown>An object to customize the text displayed in the UI.</x-field-desc>
-    <x-field data-name="title" data-type="string" data-desc="The main title at the top."></x-field>
-    <x-field data-name="scan" data-type="string" data-desc="The instructional text below the title."></x-field>
-    <x-field data-name="confirm" data-type="string" data-desc="Text shown after the QR code is scanned."></x-field>
-    <x-field data-name="success" data-type="string | ReactNode" data-desc="Message displayed upon successful connection."></x-field>
-    <x-field data-name="error" data-type="string" data-desc="Message displayed on error."></x-field>
-  </x-field>
-  <x-field data-name="hideCloseButton" data-type="boolean" data-default="false">
-    <x-field-desc markdown>If `true`, the close button (X) in the top-right corner is hidden.</x-field-desc>
-  </x-field>
-  <x-field data-name="extraContent" data-type="ReactNode" data-default="null">
-    <x-field-desc markdown>Allows you to inject a custom React component or element into the UI, typically appearing below the main title/description.</x-field-desc>
-  </x-field>
-  <x-field data-name="customItems" data-type="ReactNode[]" data-default="[]">
-    <x-field-desc markdown>An array of custom React nodes to be added to the list of connection methods.</x-field-desc>
-  </x-field>
-  <x-field data-name="disableSwitchApp" data-type="boolean" data-default="false">
-    <x-field-desc markdown>If you are using Federated Login, this prop prevents users from switching between different applications in the group during the login process.</x-field-desc>
-  </x-field>
-  <x-field data-name="webWalletUrl" data-type="string">
-    <x-field-desc markdown>The URL of the web-based DID Wallet to be used for the "Connect with Web Wallet" option. Defaults to the official ArcBlock web wallet.</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### Callbacks
-
-Functions that are called at different stages of the connection lifecycle.
-
-<x-field-group>
-  <x-field data-name="onClose" data-type="function" data-required="true">
-    <x-field-desc markdown>Callback function that is executed when the user closes the `DidConnect` dialog (e.g., by clicking the close button or outside the modal).</x-field-desc>
-  </x-field>
-  <x-field data-name="onSuccess" data-type="function" data-required="true">
-    <x-field-desc markdown>Callback function that is executed upon a successful connection. The session data is passed as an argument.</x-field-desc>
-  </x-field>
-  <x-field data-name="onError" data-type="function">
-    <x-field-desc markdown>Callback function that is executed when an error occurs during the process. The error object or message is passed as an argument.</x-field-desc>
-  </x-field>
-  <x-field data-name="onRecreateSession" data-type="function">
-    <x-field-desc markdown>A callback function that is invoked when the session needs to be reset, for example, after a timeout or when the user manually cancels and retries.</x-field-desc>
-  </x-field>
-</x-field-group>
-
-## Next Steps
-
-With a solid understanding of the `DidConnect` component, you can now build robust authentication experiences. For more programmatic control over the connection UI, explore the [`useConnect` hook](./hooks-use-connect.md), which allows you to open and close the `DidConnect` modal from anywhere in your application.

package/docs/core-components-did-connect.zh-TW.md

@@ -1,166 +0,0 @@
-# 連線 UI (DidConnect)
-
-`DidConnect` 元件是一個預先建置的、全面的 UI 解決方案，用於處理各種去中心化身分（DID）連線流程。它為登入、驗證和個人資料請求等操作提供了一個使用者友善的介面，並原生支援多種連線方式。
-
-它是 `@arcblock/did-connect-react` 函式庫的視覺核心，將 session 管理和即時狀態更新的複雜性抽象化。該元件會為 DID Wallet 使用者顯示一個 QR code，並提供其他登入選項，例如社群登入（OAuth）和無密碼驗證（Passkeys）。
-
-在使用 `DidConnect` 之前，請確保您已使用 [`SessionProvider`](./core-components-session-provider.md) 將您的應用程式包裹起來，以管理整體的 session 狀態。
-
-## 基本用法
-
-要使用 `DidConnect`，您需要匯入它並提供一些必要的 props。該元件通常由一個決定其可見性的狀態變數來控制。
-
-```jsx DID Connect 範例 icon=logos:react
-import React, { useState } from 'react';
-import axios from 'axios';
-import DidConnect from '@arcblock/did-connect-react/lib/Connect';
-
-function App() {
-  const [isConnectOpen, setConnectOpen] = useState(false);
-
-  const handleClose = () => setConnectOpen(false);
-  const handleSuccess = () => {
-    // 處理成功登入，例如，重新導向使用者
-    window.location.href = '/profile';
-  };
-
-  return (
-    <div>
-      <button onClick={() => setConnectOpen(true)}>使用 DID 登入</button>
-      {isConnectOpen && (
-        <DidConnect
-          action="login"
-          checkFn={axios.get}
-          onClose={handleClose}
-          onSuccess={handleSuccess}
-          messages={{
-            title: '掃描以登入',
-            scan: '使用您的 DID Wallet 掃描 QR code',
-            confirm: '在您的 DID Wallet 上確認登入',
-            success: '您已成功登入！',
-          }}
-        />
-      )}
-    </div>
-  );
-}
-
-export default App;
-```
-
-在此範例中，點擊「使用 DID 登入」按鈕會將 `isConnectOpen` 狀態設定為 `true`，這會將 `DidConnect` 元件渲染為一個強制回應對話框。`checkFn` prop 至關重要，因為它是元件用來從您的後端輪詢 session 狀態的函式。
-
-## 運作方式
-
-`DidConnect` 元件協調了整個使用者驗證流程，從顯示連線選項到處理最終的成功或錯誤狀態。
-
-<!-- DIAGRAM_IMAGE_START:flowchart:4:3:1765962229 -->
-![Connection UI (DidConnect)](assets/diagram/did-connect-diagram-0.zh-TW.jpg)
-<!-- DIAGRAM_IMAGE_END -->
-
-## 元件 Props
-
-`DidConnect` 元件可透過其 props 進行高度設定。以下是可用選項的詳細清單。
-
-### 核心設定
-
-這些 props 對於設定元件的基本功能至關重要。
-
-<x-field-group>
-  <x-field data-name="action" data-type="string" data-required="true">
-    <x-field-desc markdown>定義連線的目的，例如 `login`、`claim`、`sign` 等。此字串會傳遞到您的後端以確定所需的操作。</x-field-desc>
-  </x-field>
-  <x-field data-name="checkFn" data-type="function" data-required="true">
-    <x-field-desc markdown>用於輪詢後端以獲取 session 狀態更新的函式。它應該是一個發出 API 請求的函式，例如 `axios.get`。</x-field-desc>
-  </x-field>
-  <x-field data-name="baseUrl" data-type="string" data-default="''">
-    <x-field-desc markdown>API 端點的基礎 URL。如果您的 API 在不同的網域上，請在此處指定。</x-field-desc>
-  </x-field>
-  <x-field data-name="prefix" data-type="string" data-default="/api/did">
-    <x-field-desc markdown>您後端 DID Connect API 端點的 URL 前綴。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### 行為控制
-
-這些 props 控制連線過程的行為方式。
-
-<x-field-group>
-  <x-field data-name="enabledConnectTypes" data-type="string[]" data-default='["web", "mobile", ...]'>
-    <x-field-desc markdown>一個字串陣列，指定要顯示哪些連線方式。可能的值包括 `web`、`mobile`、`github`、`google`、`apple`、`passkey` 等。</x-field-desc>
-  </x-field>
-  <x-field data-name="passkeyBehavior" data-type="'none' | 'both' | 'only-existing' | 'only-new'" data-default="'none'">
-    <x-field-desc markdown>控制 Passkey 驗證的行為。`none` 會停用它，`both` 允許建立新的 passkey 和使用現有的，`only-existing` 限制只能使用現有的 passkey，而 `only-new` 強制建立新的 passkey。</x-field-desc>
-  </x-field>
-  <x-field data-name="allowWallet" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果為 `false`，QR code 和行動錢包連線選項將被隱藏。</x-field-desc>
-  </x-field>
-  <x-field data-name="autoConnect" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果為 `true`，元件將自動嘗試使用來自同一裝置先前建立的連線。</x-field-desc>
-  </x-field>
-  <x-field data-name="forceConnected" data-type="boolean | string" data-default="true">
-    <x-field-desc markdown>如果為 `true`，使用者必須使用他們已經登入的同一個 DID 進行連線。如果提供了一個 DID 字串，使用者必須使用該特定的 DID 進行連線。</x-field-desc>
-  </x-field>
-  <x-field data-name="saveConnect" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果為 `true`，成功的連線資訊會儲存在本機，以供未來的 `autoConnect` 嘗試使用。</x-field-desc>
-  </x-field>
-  <x-field data-name="useSocket" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果為 `true`，則嘗試使用 WebSocket 進行即時狀態更新，如果無法建立連線，則退回使用輪詢。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### UI 客製化
-
-客製化 `DidConnect` 元件的外觀和文字。
-
-<x-field-group>
-  <x-field data-name="mode" data-type="'dialog' | 'drawer' | 'page'" data-default="'dialog'">
-    <x-field-desc markdown>決定元件的顯示方式。`dialog` 將其顯示為置中對話框，`drawer` 顯示為底部彈出視窗（在行動裝置上），而 `page` 將其直接嵌入文件流中。</x-field-desc>
-  </x-field>
-  <x-field data-name="messages" data-type="object">
-    <x-field-desc markdown>一個用於客製化 UI 中顯示文字的物件。</x-field-desc>
-    <x-field data-name="title" data-type="string" data-desc="頂部的主標題。"></x-field>
-    <x-field data-name="scan" data-type="string" data-desc="標題下方的說明文字。"></x-field>
-    <x-field data-name="confirm" data-type="string" data-desc="QR code 掃描後顯示的文字。"></x-field>
-    <x-field data-name="success" data-type="string | ReactNode" data-desc="成功連線時顯示的訊息。"></x-field>
-    <x-field data-name="error" data-type="string" data-desc="發生錯誤時顯示的訊息。"></x-field>
-  </x-field>
-  <x-field data-name="hideCloseButton" data-type="boolean" data-default="false">
-    <x-field-desc markdown>如果為 `true`，右上角的關閉按鈕（X）將被隱藏。</x-field-desc>
-  </x-field>
-  <x-field data-name="extraContent" data-type="ReactNode" data-default="null">
-    <x-field-desc markdown>允許您將自訂的 React 元件或元素注入 UI 中，通常會出現在主標題/描述下方。</x-field-desc>
-  </x-field>
-  <x-field data-name="customItems" data-type="ReactNode[]" data-default="[]">
-    <x-field-desc markdown>一個自訂 React 節點的陣列，將被新增到連線方式清單中。</x-field-desc>
-  </x-field>
-  <x-field data-name="disableSwitchApp" data-type="boolean" data-default="false">
-    <x-field-desc markdown>如果您正在使用統一登入站點群，此 prop 可防止使用者在登入過程中在群組中的不同應用程式之間切換。</x-field-desc>
-  </x-field>
-  <x-field data-name="webWalletUrl" data-type="string">
-    <x-field-desc markdown>用於「使用網頁錢包連線」選項的網頁版 DID Wallet 的 URL。預設為官方 ArcBlock 網頁錢包。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### 回呼
-
-在連線生命週期的不同階段呼叫的函式。
-
-<x-field-group>
-  <x-field data-name="onClose" data-type="function" data-required="true">
-    <x-field-desc markdown>當使用者關閉 `DidConnect` 對話框時（例如，點擊關閉按鈕或在對話框外部點擊）執行的回呼函式。</x-field-desc>
-  </x-field>
-  <x-field data-name="onSuccess" data-type="function" data-required="true">
-    <x-field-desc markdown>成功連線後執行的回呼函式。Session 資料會作為參數傳遞。</x-field-desc>
-  </x-field>
-  <x-field data-name="onError" data-type="function">
-    <x-field-desc markdown>在過程中發生錯誤時執行的回呼函式。錯誤物件或訊息會作為參數傳遞。</x-field-desc>
-  </x-field>
-  <x-field data-name="onRecreateSession" data-type="function">
-    <x-field-desc markdown>當 session 需要重置時（例如，逾時後或使用者手動取消並重試時）調用的回呼函式。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-## 後續步驟
-
-在對 `DidConnect` 元件有了扎實的理解後，您現在可以建構穩健的驗證體驗。若想對連線 UI 進行更多程式化控制，請探索 [`useConnect` hook](./hooks-use-connect.md)，它允許您從應用程式的任何地方開啟和關閉 `DidConnect` 對話框。

package/docs/core-components-did-connect.zh.md

@@ -1,166 +0,0 @@
-# 连接 UI (DidConnect)
-
-`DidConnect` 组件是一个预构建的、全面的 UI 解决方案，用于处理各种去中心化身份（DID）连接流程。它为登录、认证和个人资料请求等操作提供了用户友好的界面，并开箱即用地支持多种连接方式。
-
-它作为 `@arcblock/did-connect-react` 库的视觉核心，抽象了会话管理和实时状态更新的复杂性。该组件为 DID Wallet 用户显示二维码，并提供其他登录选项，如社交登录（OAuth）和无密码认证（Passkeys）。
-
-在使用 `DidConnect` 之前，请确保已使用 [`SessionProvider`](./core-components-session-provider.md) 包裹您的应用程序，以管理整体会话状态。
-
-## 基本用法
-
-要使用 `DidConnect`，您需要导入它并提供一些必要的 props。该组件通常由一个决定其可见性的状态变量控制。
-
-```jsx DID Connect 示例 icon=logos:react
-import React, { useState } from 'react';
-import axios from 'axios';
-import DidConnect from '@arcblock/did-connect-react/lib/Connect';
-
-function App() {
-  const [isConnectOpen, setConnectOpen] = useState(false);
-
-  const handleClose = () => setConnectOpen(false);
-  const handleSuccess = () => {
-    // 处理成功登录，例如，重定向用户
-    window.location.href = '/profile';
-  };
-
-  return (
-    <div>
-      <button onClick={() => setConnectOpen(true)}>Login with DID</button>
-      {isConnectOpen && (
-        <DidConnect
-          action="login"
-          checkFn={axios.get}
-          onClose={handleClose}
-          onSuccess={handleSuccess}
-          messages={{
-            title: 'Scan to Sign In',
-            scan: 'Scan QR code with your DID Wallet',
-            confirm: 'Confirm login on your DID Wallet',
-            success: 'You have successfully signed in!',
-          }}
-        />
-      )}
-    </div>
-  );
-}
-
-export default App;
-```
-
-在此示例中，点击 “Login with DID” 按钮会将 `isConnectOpen` 状态设置为 `true`，从而将 `DidConnect` 组件渲染为模态对话框。`checkFn` prop 至关重要，因为它是组件用于从您的后端轮询会话状态的函数。
-
-## 工作原理
-
-`DidConnect` 组件协调整个用户认证流程，从显示连接选项到处理最终的成功或错误状态。
-
-<!-- DIAGRAM_IMAGE_START:flowchart:4:3:1765962229 -->
-![Connection UI (DidConnect)](assets/diagram/did-connect-diagram-0.zh.jpg)
-<!-- DIAGRAM_IMAGE_END -->
-
-## 组件 Props
-
-`DidConnect` 组件可通过其 props 进行高度配置。以下是可用选项的详细列表。
-
-### 核心配置
-
-这些 props 对于设置组件的基本功能至关重要。
-
-<x-field-group>
-  <x-field data-name="action" data-type="string" data-required="true">
-    <x-field-desc markdown>定义连接的目的，例如 `login`、`claim`、`sign` 等。此字符串会传递给您的后端以确定所需的操作。</x-field-desc>
-  </x-field>
-  <x-field data-name="checkFn" data-type="function" data-required="true">
-    <x-field-desc markdown>用于向后端轮询会话状态更新的函数。它应该是一个能发起 API 请求的函数，例如 `axios.get`。</x-field-desc>
-  </x-field>
-  <x-field data-name="baseUrl" data-type="string" data-default="''">
-    <x-field-desc markdown>API 端点的基础 URL。如果您的 API 位于不同的域上，请在此处指定。</x-field-desc>
-  </x-field>
-  <x-field data-name="prefix" data-type="string" data-default="/api/did">
-    <x-field-desc markdown>您后端上 DID Connect API 端点的 URL 前缀。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### 行为控制
-
-这些 props 控制连接过程的行为方式。
-
-<x-field-group>
-  <x-field data-name="enabledConnectTypes" data-type="string[]" data-default='["web", "mobile", ...]'>
-    <x-field-desc markdown>一个字符串数组，用于指定要显示的连接方式。可能的值包括 `web`、`mobile`、`github`、`google`、`apple`、`passkey` 等。</x-field-desc>
-  </x-field>
-  <x-field data-name="passkeyBehavior" data-type="'none' | 'both' | 'only-existing' | 'only-new'" data-default="'none'">
-    <x-field-desc markdown>控制 Passkey 认证的行为。`none` 表示禁用，`both` 允许创建新密钥和使用现有密钥，`only-existing` 限制为仅使用现有密钥，而 `only-new` 强制创建新密钥。</x-field-desc>
-  </x-field>
-  <x-field data-name="allowWallet" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果为 `false`，二维码和移动钱包连接选项将被隐藏。</x-field-desc>
-  </x-field>
-  <x-field data-name="autoConnect" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果为 `true`，组件将自动尝试使用来自同一设备的先前建立的连接。</x-field-desc>
-  </x-field>
-  <x-field data-name="forceConnected" data-type="boolean | string" data-default="true">
-    <x-field-desc markdown>如果为 `true`，用户必须使用与他们已登录的 DID 相同的 DID 进行连接。如果提供了 DID 字符串，则用户必须使用该特定的 DID 进行连接。</x-field-desc>
-  </x-field>
-  <x-field data-name="saveConnect" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果为 `true`，成功的连接信息将保存在本地，以供将来的 `autoConnect` 尝试使用。</x-field-desc>
-  </x-field>
-  <x-field data-name="useSocket" data-type="boolean" data-default="true">
-    <x-field-desc markdown>如果为 `true`，则尝试使用 WebSocket 进行实时状态更新，如果无法建立连接，则回退到轮询。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### UI 自定义
-
-自定义 `DidConnect` 组件的外观和文本。
-
-<x-field-group>
-  <x-field data-name="mode" data-type="'dialog' | 'drawer' | 'page'" data-default="'dialog'">
-    <x-field-desc markdown>确定组件的显示方式。`dialog` 将其显示为居中模态框，`drawer` 显示为底部抽屉（在移动设备上），而 `page` 将其直接嵌入到文档流中。</x-field-desc>
-  </x-field>
-  <x-field data-name="messages" data-type="object">
-    <x-field-desc markdown>一个用于自定义 UI 中显示的文本的对象。</x-field-desc>
-    <x-field data-name="title" data-type="string" data-desc="顶部的​​主标题。"></x-field>
-    <x-field data-name="scan" data-type="string" data-desc="标题下方的说明性文本。"></x-field>
-    <x-field data-name="confirm" data-type="string" data-desc="扫描二维码后显示的文本。"></x-field>
-    <x-field data-name="success" data-type="string | ReactNode" data-desc="连接成功时显示的消息。"></x-field>
-    <x-field data-name="error" data-type="string" data-desc="发生错误时显示的消息。"></x-field>
-  </x-field>
-  <x-field data-name="hideCloseButton" data-type="boolean" data-default="false">
-    <x-field-desc markdown>如果为 `true`，右上角的关闭按钮（X）将被隐藏。</x-field-desc>
-  </x-field>
-  <x-field data-name="extraContent" data-type="ReactNode" data-default="null">
-    <x-field-desc markdown>允许您向 UI 中注入自定义的 React 组件或元素，通常显示在主标题/描述下方。</x-field-desc>
-  </x-field>
-  <x-field data-name="customItems" data-type="ReactNode[]" data-default="[]">
-    <x-field-desc markdown>一个自定义 React 节点数组，将被添加到连接方式列表中。</x-field-desc>
-  </x-field>
-  <x-field data-name="disableSwitchApp" data-type="boolean" data-default="false">
-    <x-field-desc markdown>如果您正在使用统一登录站点群，此 prop 会阻止用户在登录过程中在站点群中的不同应用程序之间切换。</x-field-desc>
-  </x-field>
-  <x-field data-name="webWalletUrl" data-type="string">
-    <x-field-desc markdown>用于“使用网页钱包连接”选项的基于 Web 的 DID Wallet 的 URL。默认为官方的 ArcBlock 网页钱包。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### 回调
-
-在连接生命周期的不同阶段调用的函数。
-
-<x-field-group>
-  <x-field data-name="onClose" data-type="function" data-required="true">
-    <x-field-desc markdown>当用户关闭 `DidConnect` 对话框时（例如，通过点击关闭按钮或模态框外部）执行的回调函数。</x-field-desc>
-  </x-field>
-  <x-field data-name="onSuccess" data-type="function" data-required="true">
-    <x-field-desc markdown>连接成功后执行的回调函数。会话数据作为参数传递。</x-field-desc>
-  </x-field>
-  <x-field data-name="onError" data-type="function">
-    <x-field-desc markdown>在此过程中发生错误时执行的回调函数。错误对象或消息作为参数传递。</x-field-desc>
-  </x-field>
-  <x-field data-name="onRecreateSession" data-type="function">
-    <x-field-desc markdown>当会话需要重置时（例如，在超时后或用户手动取消并重试时）调用的回调函数。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-## 后续步骤
-
-在对 `DidConnect` 组件有了扎实的理解之后，您现在可以构建稳健的认证体验。要对连接 UI 进行更多的程序化控制，请探索 [`useConnect` hook](./hooks-use-connect.md)，它允许您从应用程序的任何位置打开和关闭 `DidConnect` 模态框。