Skip to main content

Interface: ShowLoginOptions

Defined in: types.ts:1419

Options for MemberNamespace.showLogin. The login form options match the <allegro-login-form> attributes of the same name.

Properties​

PropertyTypeDescriptionDefined in
buttonText?stringLabel for the submit button.types.ts:1436
closeOnBackdrop?booleanClose the dialog when the reader clicks the backdrop. Defaults to false.types.ts:1432
description?stringShort text shown under the heading, styled with ::part(description) or --loginForm--description--*.types.ts:1426
email?stringEmail address to prefill. The reader can still change it.types.ts:1448
formLabelText?stringLabel text for the email field.types.ts:1440
heading?stringHeading 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:1424
hideThirdParty?booleanHide the social login buttons.types.ts:1444
loginMethod?"magic-link" | "otp" | "magic-link-otp"How readers sign in. Defaults to magic-link.types.ts:1434
placeholderText?stringPlaceholder shown inside the email field.types.ts:1442
position?"center" | "top"Where the dialog sits: center (the default), or top with --modal--top-offset of space above it.types.ts:1430
registrationForm?stringSlug of a form whose fields a new reader fills in before their account is created. No email is sent until they answer.types.ts:1450
registrationText?stringText 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:1452
showFormLabel?booleanShow the email field's label. When off, the label is still read by screen readers.types.ts:1438
showLastUsed?booleanShow a "Last used" badge on the login method the reader last used on this browser.types.ts:1446
size?"small" | "medium" | "large" | "full"The dialog's maximum width. Defaults to small.types.ts:1428
trackingData?TrackEventDataCustom data merged into every event the dialog and form track.types.ts:1454