VerifyEmailPage
Auto-verifying email confirmation page. Sends token on mount, shows result.
01 Usage
Basic
Verify email
Verifying your email...
<script lang="ts">
import { VerifyEmailPage } from '@urbicon-ui/auth';
import { page } from '$app/state';
// Token from the verification link, e.g. /verify-email?token=...
const token = $derived(page.url.searchParams.get('token') ?? '');
</script>
<VerifyEmailPage {token} />
02 Accessibility
One region for a process the user never started
Verification fires on mount from the token in the URL, so the user takes no action and has
nothing to watch. All three states — spinner, success, failure — render inside a single aria-live="polite" wrapper, so the outcome is announced
when it arrives. This is the one page that deliberately does not use the shell's shared error
region: it would have given the same page two live regions competing to report the same event.
The spinner has words next to it
The loading state is not a bare spinner — it renders the localized "verifying" text inside the live region alongside it. A spinner alone conveys nothing to a screen reader; the text is what actually gets announced.
Focus stays where it was
Nothing on this page moves focus when the result arrives. The live region carries the announcement instead, which is the right trade for an automatic process — but it means a user who tabs away mid-verification will not be returned to the result.
03 API Reference
Prop | Type | Default | Description | |
|---|---|---|---|---|
token required | string | — | Verification token from URL query parameter. | |
apiPath | string | '/api/auth/verify-email' | ApiPath property for the VerifyEmailPage component | |
class | string | — | Extra classes on the root element. | |
csrf | CsrfClientOptions | — | CSRF cookie/header names — only needed when the server overrides the defaults via config.csrf. Mutating requests echo the token automatically. | |
fetcher | typeof globalThis.fetch | — | Custom fetch implementation for all API calls. Defaults to the global fetch. Useful for mock backends in demos/tests or custom retry/auth layers. | |
footer | Snippet | — | Content rendered below the form, above links. | |
header | Snippet | — | Content rendered between the heading and the form. | |
links | Snippet | — | Replaces the link area below the form. | |
slotClasses | AuthPageSlotClasses | — | Per-slot class overrides. Keys: root, card, title, form, field, submit, error, success, links. | |
t | PartialAuthLocale | — | Locale overrides, deep-merged over the active built-in bundle (resolved from the i18n context). Pass any subset — a single string or a whole tree. | |
unstyled | boolean | — | Strip all default styling. |
04 Types
Local type definitions used by this component.
Name | Kind | Category | Used by | Description | |
|---|---|---|---|---|---|
VerifyEmailPageProps | interface | props | 0 | — | |
PartialAuthLocale | type | helper | 1 | Consumer-facing locale input: any subset of AuthLocale. Components
accept this as their t prop and deep-merge it over the active built-in
bundle, so overriding a single string never silently blanks the rest. | |
CsrfClientOptions | interface | helper | 1 | — | |
AuthPageSlotClasses | interface | helper | 1 | Per-slot CSS class overrides for auth page components (LoginPage, RegisterPage, etc.). Each key targets a specific visual area of the page. Only the slots you override are affected. | |
DeepPartial | type | helper | 0 | Recursive partial: every branch and leaf becomes optional. | |
AuthLocale | interface | helper | 0 | The complete auth locale bundle. Every key is required: the bundles this
package ships (en, de) satisfy the full shape, and consumer overrides
enter as PartialAuthLocale — deep-merged over the active built-in
bundle by mergeAuthLocale — so component markup reads keys directly,
without per-key ?? '…' fallback literals (review R19).
Placeholder convention: dynamic values use **single-brace** tokens
({n}, {name}, {email}) that the consuming component substitutes itself
via String.replace('{token}', value). There is deliberately **no**
{{…}} runtime interpolator in this package — the key-based translator twin
(authT/at) was removed in R21 — so {{…}} here would render verbatim. |
05 Installation
Import
import { VerifyEmailPage } from '@urbicon-ui/auth';