SignInPageAPI
React SignInPage 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。
演示
导入
import { SignInPage } from '@toolpad/core/SignInPage';
// or
import { SignInPage } from '@toolpad/core';通过阅读本指南，了解有关最小化捆绑包大小的更多信息，了解差异。
原生组件的 Props 也可用。
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| localeText | object | - | 账户组件的标签。 |
| providers | Array<{ id: string, name: string }> | [] | 要显示的身份验证提供程序列表。 |
| 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。 |
| sx | Array<func | object | bool> | func | object | - | 用于自定义 有关更多详细信息，请参阅 `sx` 页面。 |
该组件不能持有 ref。
| 插槽名称 | 类名 | 默认组件 | 描述 |
|---|---|---|---|
| emailField | TextField | 在凭据表单中使用的自定义电子邮件字段组件。 | |
| passwordField | TextField | 在凭据表单中使用的自定义密码字段组件。 | |
| submitButton | Button | 在凭据表单中使用的自定义提交按钮组件。 | |
| forgotPasswordLink | Link | 在凭据表单中使用的自定义忘记密码链接组件。 | |
| signUpLink | Link | 在凭据表单中使用的自定义注册链接组件。 | |
| title | Typography | 用于覆盖默认标题部分的组件 | |
| subtitle | Typography | 用于覆盖默认副标题部分的组件 | |
| rememberMe | FormControlLabel | 用于覆盖凭据表单中默认“记住我”复选框的组件 |
源代码
如果您在此页面中找不到所需信息，请考虑查看组件的实现以获取更多详细信息。