OptionalbeforeOptional content rendered just above the submit button — for a supplementary control the built-in fields don't cover (e.g. a toggle that reveals an extra input, a consent checkbox, or a short notice). Managed entirely by the consumer; the form does not read or submit it.
OptionalcolorsOverride default color values
OptionalcustomCustom fields rendered after the name field. Values are sent as metadata on register.
OptionaldefaultPre-fill the email field (e.g. from an invitation link).
OptionaldefaultPre-fill the password and confirm-password fields.
For flows where the consumer ALREADY HOLDS a credential the user has just proved — e.g. importing an account from a system being replaced, where the user authenticated with their old password moments earlier. Saves them inventing a second password at the highest-abandonment moment.
The value is only an initial value: the fields stay editable, and the
form validates it exactly like a typed one (so a password that fails the
policy still surfaces the normal error). Pass undefined for the normal
empty form.
OptionaliconsOverride default icons
OptionallabelsOverride default text strings
OptionallockRender the email field read-only. Pair with defaultEmail when the
address is fixed by context (e.g. an invitation) and must not be changed.
OptionalminMinimum password length to state and enforce in the requirement list, when the organisation has raised it above the identity default of 8.
OptionalonCalled when the email field loses focus with a non-empty value, and again on submit before the account is created. Use it to look the address up before registration completes — e.g. to tell the user an account already exists, to require SSO for a managed domain, or to offer a data-import path for a matching account in a system being replaced.
Purely a notification: the form neither waits for it nor changes behavior
based on it. To block or divert submission, render your own UI (a dialog,
or beforeSubmit content) in response.
OptionalonCalled when a registration attempt fails
OptionalonCalled when the user clicks the "Sign in" link
OptionalonCalled when registration completes successfully
OptionalpasswordHow the password rules are shown under the field: 'list' (default), one
line per rule with a heading, or 'compact', a single wrapping row of
small chips that tick as they are met.
OptionalrequireMake the name field required (default: false)
OptionalshowShow the "Already have an account?" link (default: true)
OptionalstylesOverride default dimensions and spacing
OptionalsxMUI sx prop applied to the root container
Props for the RegisterForm component.