Interface: ShowLoginOptions
Defined in: types.ts:1361
Options for MemberNamespace.showLogin. The login form options match the
<allegro-login-form> attributes of the same name.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
buttonText? | string | Label for the submit button. | types.ts:1378 |
closeOnBackdrop? | boolean | Close the dialog when the reader clicks the backdrop. Defaults to false. | types.ts:1374 |
description? | string | Short text shown under the heading, styled with ::part(description) or --loginForm--description--*. | types.ts:1368 |
email? | string | Email address to prefill. The reader can still change it. | types.ts:1390 |
formLabelText? | string | Label text for the email field. | types.ts:1382 |
heading? | string | Heading shown above the email field, styled with allegro-login-form::part(heading) or the --loginForm--heading--* variables. Without one, the dialog is named "Sign in" for screen readers. | types.ts:1366 |
hideThirdParty? | boolean | Hide the social login buttons. | types.ts:1386 |
loginMethod? | "magic-link" | "otp" | "magic-link-otp" | How readers sign in. Defaults to magic-link. | types.ts:1376 |
placeholderText? | string | Placeholder shown inside the email field. | types.ts:1384 |
position? | "center" | "top" | Where the dialog sits: center (the default), or top with --modal--top-offset of space above it. | types.ts:1372 |
registrationForm? | string | Slug of a form whose fields a new reader fills in before their account is created. No email is sent until they answer. | types.ts:1392 |
registrationText? | string | Text shown above the registration fields and announced to screen readers when they appear. Pass '' to hide it; a default message is still announced. | types.ts:1394 |
showFormLabel? | boolean | Show the email field's label. When off, the label is still read by screen readers. | types.ts:1380 |
showLastUsed? | boolean | Show a "Last used" badge on the login method the reader last used on this browser. | types.ts:1388 |
size? | "small" | "medium" | "large" | "full" | The dialog's maximum width. Defaults to small. | types.ts:1370 |
trackingData? | TrackEventData | Custom data merged into every event the dialog and form track. | types.ts:1396 |