SignInPageAPI
React SignInPage 組件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
示範
匯入
import { SignInPage } from '@toolpad/core/SignInPage';
// or
import { SignInPage } from '@toolpad/core';閱讀這份關於最小化 bundle 大小的指南，以瞭解差異。
原生組件的 Props 也可用。
| 名稱 | 類型 | 預設值 | 描述 |
|---|---|---|---|
| localeText | object (物件) | - | 帳戶組件的標籤。 |
| providers (供應商) | Array<{ id: string, name: string }> (陣列<{ id: 字串, name: 字串 }>) | [] | 要顯示的驗證供應商列表。 |
| signIn (登入) | func (函式) | undefined (未定義) | 使用者登入時觸發的回呼函數。 簽名： function(provider: AuthProvider, formData: FormData, callbackUrl: string) => void | Promise
|
| slotProps (插槽屬性) | { emailField?: object, forgotPasswordLink?: object, form?: object, oAuthButton?: object, passwordField?: object, rememberMe?: object, signUpLink?: object, submitButton?: object } | {} | 用於每個插槽內部的 props。 |
| slots (插槽) | { emailField?: elementType, forgotPasswordLink?: elementType, passwordField?: elementType, rememberMe?: elementType, signUpLink?: elementType, submitButton?: elementType, subtitle?: elementType, title?: elementType } | {} | 用於每個插槽內部的組件。 請參閱下方的 Slots API (插槽 API) 以取得更多詳細資訊。 |
| sx | Array<func (陣列<函式 | object (物件) | bool (布林值)> | func (函式) | object (物件) | - | 用於自訂 請參閱 `sx` 頁面 以取得更多詳細資訊。 |
此組件無法持有 ref。
| 插槽名稱 | 類別名稱 | 預設組件 | 描述 |
|---|---|---|---|
| emailField (電子郵件欄位) | TextField (文字欄位) | 用於 credentials 表單中的自訂電子郵件欄位組件。 | |
| passwordField (密碼欄位) | TextField (文字欄位) | 用於 credentials 表單中的自訂密碼欄位組件。 | |
| submitButton (提交按鈕) | Button (按鈕) | 用於 credentials 表單中的自訂提交按鈕組件。 | |
| forgotPasswordLink (忘記密碼連結) | Link (連結) | 用於 credentials 表單中的自訂忘記密碼連結組件。 | |
| signUpLink (註冊連結) | Link (連結) | 用於 credentials 表單中的自訂註冊連結組件。 | |
| title (標題) | Typography (排版) | 用於覆寫預設標題區段的組件 | |
| subtitle (副標題) | Typography (排版) | 用於覆寫預設副標題區段的組件 | |
| rememberMe (記住我) | FormControlLabel (表單控制標籤) | 用於覆寫 Credentials 表單中預設「記住我」核取方塊的組件 |
原始碼
如果您在本頁面中找不到所需資訊，請考慮查看組件的實作以取得更多詳細資訊。