Skip to content

AuthForm

Overview

Renders a page-level authentication form with a title, subtitle, and action slot. Handles reauthentication redirects and MFA pending-flow detection automatically, delegating the actual form submission to an inner ActionForm.

Theme entry: AuthForm

Props

NameTypeRequiredDefaultDescription
themeOverrideString|Object|ArraynullA partial theme object merged with the component's default theme; accepts a class string, class array, or theme object.
redirectstring""Route path to redirect to after a successful authentication action.
headerstring""Heading text displayed above the form.
subTitlestring""Secondary text displayed below the heading.
runActionfuncundefinedAsync function that performs the form submission action.
formPropsobject{}Additional props forwarded to the underlying form composable.
permittedbooleantrueWhether the current user is permitted to access this form.

Slots

NameScopedDescription
action-form-inneryes
validation-summaryyesOverride the structured per-field validation alert shown when formContext.state.anyError is set; receives entries, count, and title.
action-baryes
confirm-buttonyes
cancel-buttonyes
actions-hint
form-confirm-dialog-warningsyes
form-contentyesOverride the entire form content area; receives run-action, on-submission-error-handler, and redirect-to bindings.

Full slot reference

Events

NameDescription
form-objectEmitted on mount with a readonly ref to the reactive form values object.
form-contextEmitted on mount with the form context. Use its methods for programmatic form updates.

Full event reference

Source

client/lib/views/AuthForm.vue

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2