Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SignInPage] Improve default UI and customisation ability #4370

Merged
merged 19 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/pages/toolpad/core/api/sign-in-page.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"props": {
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
},
"required": true,
"additionalInfo": { "sx": true }
},
"providers": {
"type": {
"name": "arrayOf",
Expand All @@ -25,7 +33,7 @@
"slots": {
"type": {
"name": "shape",
"description": "{ emailField?: elementType, forgotPasswordLink?: elementType, passwordField?: elementType, signUpLink?: elementType, submitButton?: elementType }"
"description": "{ emailField?: elementType, forgotPasswordLink?: elementType, headerInfo?: elementType, passwordField?: elementType, signUpLink?: elementType, submitButton?: elementType }"
},
"default": "{}",
"additionalInfo": { "slotsApi": true }
Expand Down Expand Up @@ -66,6 +74,12 @@
"description": "The custom sign up link component used in the credentials form.",
"default": "Link",
"class": null
},
{
"name": "headerInfo",
"description": "Custom information added to the top header beneath the title",
"default": "Typography",
"class": null
}
],
"classes": [],
Expand Down
6 changes: 5 additions & 1 deletion docs/translations/api-docs/sign-in-page/sign-in-page.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,16 @@
}
},
"slotProps": { "description": "The props used for each slot inside." },
"slots": { "description": "The components used for each slot inside." }
"slots": { "description": "The components used for each slot inside." },
"sx": {
"description": "The prop used to customize the styles on the <code>SignInPage</code> container"
}
},
"classDescriptions": {},
"slotDescriptions": {
"emailField": "The custom email field component used in the credentials form.",
"forgotPasswordLink": "The custom forgot password link component used in the credentials form.",
"headerInfo": "Custom information added to the top header beneath the title",
"passwordField": "The custom password field component used in the credentials form.",
"signUpLink": "The custom sign up link component used in the credentials form.",
"submitButton": "The custom submit button component used in the credentials form."
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"markdownlint": "markdownlint-cli2 \"**/*.md\"",
"prettier": "pretty-quick --ignore-path .eslintignore",
"prettier:all": "prettier --write . --ignore-path .eslintignore",
"dev": "dotenv cross-env FORCE_COLOR=1 lerna -- run dev --stream --parallel --ignore docs --ignore playground-nextjs --ignore playground-nextjs-pages --ignore playground-vite",
"dev": "dotenv cross-env FORCE_COLOR=1 lerna -- run dev --stream --parallel --ignore docs --ignore playground-nextjs --ignore playground-nextjs-pages --ignore playground-vite --ignore playground-nextjs-themed",
"docs:dev": "pnpm --filter docs dev",
"docs:build": "pnpm --filter docs build",
"docs:build:api:core": "tsx --tsconfig ./scripts/tsconfig.json ./scripts/docs/buildCoreApiDocs/index.ts",
Expand Down
Loading
Loading