Skip to content
InterfaceDebugger & Diagnostics@public

FlxPreloaderOptions

Options for the default DOM preloader.

ts
export interface FlxPreloaderOptions

Properties

PropertyModifiersTypeDescription
className-stringOptional CSS class names applied to the root element.
container-HTMLElementElement to mount the preloader inside. Defaults to document.body.
footer-() => HTMLElementOptional content rendered below the status and actions.
header-() => HTMLElementOptional content rendered before the title. Keep boot branding inline/local.
minimumVisibleMs-numberMinimum time to retain an already-visible preloader. Defaults to 0.
placement-'host' | 'viewport'Whether the preloader covers its host or the viewport.
progress-'bar' | 'spinner' | 'none'Progress presentation. Defaults to a bar.
retryLabel-stringAccessible retry button label. Defaults to 'Retry'.
showDelayMs-numberDelay before mounting, preventing flashes on fast boots. Defaults to 0.
subtitle-stringOptional supporting text shown below the title.
theme-FlxPreloaderThemeVisual theme overrides exposed as CSS custom properties.
title-stringTitle shown in the loading screen. Defaults to 'Loading…'.
transitionMs-numberFade duration after completion. Defaults to 400 ms.

Released under the MIT License.