MazSkeleton
MazSkeleton is a standalone component to display loading placeholders with animated shimmer effect
Before use it, you should install the MazUi plugin in your project, follow instructions in Getting Started
TIP
This component can be translated globally using the MazUi plugin.
Basic usage
The skeleton displays a loading placeholder with a shimmer animation by default.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton />
</template>Shapes
Use the shape prop to change the skeleton shape: rectangle (default), circle, or square.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton shape="rectangle" width="100px" height="1rem" />
<MazSkeleton shape="circle" size="3rem" />
<MazSkeleton shape="square" size="3rem" />
</template>Sizes
Use the size prop to set both width and height (for circle and square shapes), or use width and height props for more control.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton shape="circle" size="2rem" />
<MazSkeleton shape="circle" size="3rem" />
<MazSkeleton shape="circle" size="4rem" />
<MazSkeleton shape="circle" size="5rem" />
</template>Custom dimensions
For rectangles, use width and height props for precise control.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton width="100%" height="0.75rem" />
<MazSkeleton width="80%" height="0.75rem" />
<MazSkeleton width="60%" height="0.75rem" />
</template>Rounded sizes
Control the border radius using the rounded-size prop.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton rounded-size="none" width="80px" height="2rem" />
<MazSkeleton rounded-size="sm" width="80px" height="2rem" />
<MazSkeleton rounded-size="md" width="80px" height="2rem" />
<MazSkeleton rounded-size="lg" width="80px" height="2rem" />
<MazSkeleton rounded-size="xl" width="80px" height="2rem" />
<MazSkeleton rounded-size="full" width="80px" height="2rem" />
</template>Disable animation
Use the animated prop set to false to disable the shimmer animation.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton shape="circle" size="3rem" :animated="true" />
<MazSkeleton shape="circle" size="3rem" :animated="false" />
</template>Card skeleton example
Combine multiple skeletons to create loading placeholders for complex layouts.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<div class="card-skeleton">
<MazSkeleton shape="circle" size="3rem" />
<div class="content">
<MazSkeleton width="60%" height="0.875rem" />
<MazSkeleton width="40%" height="0.75rem" />
</div>
</div>
</template>Article skeleton example
Create an article loading placeholder with various skeleton elements.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<div class="article-skeleton">
<!-- Featured image -->
<MazSkeleton width="100%" height="200px" rounded-size="lg" />
<!-- Title and description -->
<MazSkeleton width="80%" height="1.5rem" />
<MazSkeleton width="100%" height="0.75rem" />
<MazSkeleton width="100%" height="0.75rem" />
<MazSkeleton width="60%" height="0.75rem" />
<!-- Author -->
<div class="author">
<MazSkeleton shape="circle" size="2rem" />
<MazSkeleton width="100px" height="0.75rem" />
</div>
</div>
</template>List skeleton example
Create a list loading placeholder.
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<div class="list-skeleton">
<div v-for="i in 4" :key="i" class="list-item">
<MazSkeleton shape="square" size="2.5rem" rounded-size="md" />
<div class="content">
<MazSkeleton width="70%" height="0.75rem" />
<MazSkeleton width="50%" height="0.625rem" />
</div>
</div>
</div>
</template>Accessibility
The component includes proper accessibility attributes:
role="status"to indicate loading statearia-live="polite"for screen reader announcements- Customizable
aria-labelandloading-textprops
<script lang="ts" setup>
import MazSkeleton from 'maz-ui/components/MazSkeleton'
</script>
<template>
<MazSkeleton
shape="circle"
size="3rem"
aria-label="Loading user avatar"
loading-text="Please wait while loading..."
/>
</template>Props
| Name | Description | Type | Required | Default | Possible values |
|---|---|---|---|---|---|
| shape | Skeleton shape type | "square" | "circle" | "rectangle" | No | "rectangle" | 'square' | 'circle' | 'rectangle' |
| size | Size with units (ex: '2rem', '40px', '3em') | ``${number}rem|${number}px|${number}em|${number}vw|${number}vh|${number}vmin|${number}vmax|${number}%|${number}ch|${number}cm|${number}mm|${number}in|${number}ex|${number}pc|${number...` | No | "1rem" | - |
| width | Custom width | ``${number}rem|${number}px|${number}em|${number}vw|${number}vh|${number}vmin|${number}vmax|${number}%|${number}ch|${number}cm|${number}mm|${number}in|${number}ex|${number}pc|${number...` | No | - | - |
| height | Custom height | ``${number}rem|${number}px|${number}em|${number}vw|${number}vh|${number}vmin|${number}vmax|${number}%|${number}ch|${number}cm|${number}mm|${number}in|${number}ex|${number}pc|${number...` | No | - | - |
| animated | Disable animation | boolean | No | true | - |
| rounded-size | Controls the border radius | MazRoundedSize | No | 'md' | 'none' | 'sm' | 'md' | 'lg' | 'xl' | 'full' |
| aria-label | Accessibility label | string | No | 'skeleton.ariaLabel' (translations) | - |
| loading-text | Loading text for accessibility | string | No | 'skeleton.loadingText' (translations) | - |