Components/LoadingOverlay
Since 1.0.0BETA

LoadingOverlay

A loading mask for blocking a container or the full screen while async work is running.

This page was migrated by AI, please review carefully

Migration is complete, but please validate against source code and manual review.

LoadingOverlay

Use LoadingOverlay when content should stay visible but temporarily blocked during loading, saving, syncing, or long-running actions.

import { ref } from 'vue' const loading = ref(false)

In-Container Overlay

LoadingOverlay (container)

Demo will load when visible.
<template>
  <TxButton @click="loading = !loading">Toggle</TxButton>
  <TxLoadingOverlay :loading="loading" text="Loading...">
    <div style="height: 120px; display: flex; align-items: center; justify-content: center;">Content</div>
  </TxLoadingOverlay>
</template>

Fullscreen Overlay

LoadingOverlay (fullscreen)

Demo will load when visible.
<template>
  <TxButton @click="loading = !loading">Toggle</TxButton>
  <TxLoadingOverlay fullscreen :loading="loading" text="Loading..." />
</template>

API

Props

PropTypeDefaultDescription
loadingbooleanfalseShows or hides the overlay.
fullscreenbooleanfalseTeleports the overlay to body and covers the viewport.
textstring''Optional message displayed below the spinner.
spinnerSizenumber18Spinner size in pixels.
backgroundstring-CSS background used for the overlay mask.