---
title: "MazSkeleton"
description: "MazSkeleton is a standalone component to display loading placeholders with animated shimmer effect"
package: "maz-ui"
url: "https://maz-ui.com/components/maz-skeleton"
---

# MazSkeleton

> MazSkeleton is a standalone component to display loading placeholders with animated shimmer effect

- Package: `maz-ui`
- Import: `import MazSkeleton from 'maz-ui/components/MazSkeleton'`
- Nuxt: auto-imported by `@maz-ui/nuxt`, no import needed in a Nuxt app
- Web: https://maz-ui.com/components/maz-skeleton

> Before use it, you should install the MazUi plugin in your project, follow instructions in [Getting Started](../guide/getting-started.md)

**Tip:**

This component can be translated globally using the [MazUi](https://maz-ui.com/ecosystem/translations.md) plugin.

## Basic usage

The skeleton displays a loading placeholder with a shimmer animation by default.

```vue
<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`.

```vue
<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.

```vue
<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.

```vue
<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.

```vue
<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.

```vue
<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.

```vue
<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.

```vue
<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.

```vue
<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 state
- `aria-live="polite"` for screen reader announcements
- Customizable `aria-label` and `loading-text` props

```vue
<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>
```

## MazSkeleton API

`import MazSkeleton from 'maz-ui/components/MazSkeleton'`

### Props

- `shape` (`"square" | "circle" | "rectangle"`, default: `"rectangle"`): Skeleton shape type.
- `size` (`` `${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... ``, default: `"1rem"`): Size with units (ex: '2rem', '40px', '3em').
- `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... ``): Custom width.
- `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... ``): Custom height.
- `animated` (`boolean`, default: `true`): Disable animation.
- `rounded-size` (`MazRoundedSize`, default: `'md'`): Controls the border radius. Values: `'none'`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'full'` (non exhaustive).
- `aria-label` (`string`, default: `'skeleton.ariaLabel' (translations)`): Accessibility label.
- `loading-text` (`string`, default: `'skeleton.loadingText' (translations)`): Loading text for accessibility.
