Skip to content
Razor catalogue

On this page

@addTagHelper *, Webority.Ui.Razor

Where it goes

Show it while the session check runs, before the app chooses between the public and signed-in screens.

While the session resolves
An OAuth callback or a short redirect page renders the splash while it finishes, then sends the browser on.

The live example below is scaled into a frame. The real component is position: fixed and covers the whole viewport.

ACSigning you in…
Show code
<app-splash initials="AC" description="Signing you in…"></app-splash>

<meta http-equiv="refresh" content="1;url=/dashboard" />

Preview

Use a logo for the real brand mark, and initials when there is no logo asset yet.

With a logo, and with initials
Pass a logo node for the real brand mark; initials are the fallback when there is no asset. The splash sits below the modal layer: z-index 1040 is above the app and below a modal backdrop, so if boot fails and the app raises an error dialog, the dialog is not trapped behind the splash.
ACSigning you in…
Show code
@* Fallback mark *@
<app-splash initials="AC" description="Signing you in…" />

@* With the brand asset: inner content replaces the initials *@
<app-splash description="Signing you in…">
    <img class="splash-logo" src="/logo.svg" alt="Acme" />
</app-splash>

Indicator and size

Choose the indicator with variant, and the mark's size with a preset or pixels.

Bar, ring and dots
ACSigning you in…
variant=bar
ACSigning you in…
variant=ring
ACSigning you in…
variant=dots
Show code
<app-splash initials="AC" variant="Bar" description="Signing you in…" />
<app-splash initials="AC" variant="Ring" description="Signing you in…" />
<app-splash initials="AC" variant="Dots" description="Signing you in…" />
Preset and exact sizes
ACSigning you in…
size="sm"
ACSigning you in…
size="md"
ACSigning you in…
size="lg"
ACSigning you in…
size="96"
Show code
<app-splash initials="AC" size="ControlSize.Sm" description="Signing you in…" />
<app-splash initials="AC" size="ControlSize.Md" description="Signing you in…" />
<app-splash initials="AC" size="ControlSize.Lg" description="Signing you in…" />
<app-splash initials="AC" size-px="96" description="Signing you in…" />

Text under the mark

One line says what is happening, and an optional quieter line adds the detail.

Description and subtext
ACSigning you in…This only takes a moment
Show code
<app-splash initials="AC" description="Signing you in…" subtext="This only takes a moment" />
Accessible label
ACLoading…
label="Loading" (default)
ACVerifying…
label="Verifying your account"
Show code
<app-splash initials="AC" description="Loading…" />
<app-splash initials="AC" description="Verifying…" label="Verifying your account" />

Every option

Every value of every prop, one cell each.

variant: all three

variant="bar" (default)
ACSigning you in…
variant="ring"
ACSigning you in…
variant="dots"
ACSigning you in…

size: the presets and an exact px diameter

size="sm"
ACSigning you in…
size="md" (default)
ACSigning you in…
size="lg"
ACSigning you in…
size="96"
ACSigning you in…

mark: logo, initials, neither

(content): overrides initials
Signing you in…
initials="AC": fallback mark
ACSigning you in…
(neither): indicator only
Signing you in…

description: one line, two lines, none

description only
ACSigning you in…
description + subtext
ACSigning you in…This only takes a moment
(neither): mark + indicator only
AC

label: the accessible name for the live region

label="Loading" (default)
ACLoading…
label="Verifying your account"
ACVerifying…

className: extra classes on the root

class="splash-demo" (React className): extra classes on the root
ACSigning you in…

Guidance

What to do, and what to avoid.

Use it when

  • The app is resolving its session and no route can render yet.
  • You are restoring state on cold start and the shell is not ready.
  • A flash of the wrong screen would otherwise be visible.

Reach for something else when

  • A section of an already-rendered page is loading. → AppSkeleton
  • A small, shapeless wait. → AppSpinner
  • A form is submitting. Use the loading prop of the button. → AppButton
  • Boot failed and the user must be told. → AppAlert

Reference

Try every prop, read the full list, and check keyboard and screen reader behaviour.

bar ring dots
sm md lg
(none) 48 96
ACSigning you in…
React, generated from the controls
<AppSplash initials="AC" description="Signing you in…" size="sm" />
Razor, the same props
<app-splash initials="AC" description="Signing you in…" size="Sm" />

8 props. The 4 most used come first.

Used on most screens 4 props

PropTypeDefaultDescription
initialsdefault - string - The fallback mark shown when there is no logo.
descriptiondefault - string - One line of text under the mark, for example Signing you in.
subtextdefault - string - A quieter second line under the text.
variantdefault bar Bar | Ring | Dots bar The indeterminate boot indicator: a sweeping bar, a spinning ring or bouncing dots. Boot has no measurable percentage, so the indicator never shows progress.

Less common 4 props

PropTypeDefaultDescription
(content)default - markup - Brand mark. When present it replaces the initials. Same as the React <AppSplash> logo prop.
sizedefault md Sm | Md | Lg md The mark size, a preset. The presets are 44, 56 and 72 px.
size-pxdefault - number - The size in pixels, instead of a preset.
labeldefault Loading string Loading The accessible name for the live region.

Screen reader

3 notes
  • The screen is a polite live region (role status, aria-live polite) named by label, so a screen reader announces the state once it settles without interrupting.
  • The indicator (bar, ring or dots) is hidden from assistive technology; the text and label carry the meaning.
  • The mark is the logo, or the initials when there is no logo.