# @leafygreen-ui/skeleton-loader

> leafyGreen UI Kit Skeleton Loader

Latest version **3.0.11** (published 2026-01-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @leafygreen-ui/skeleton-loader
pnpm add @leafygreen-ui/skeleton-loader
yarn add @leafygreen-ui/skeleton-loader
bun add @leafygreen-ui/skeleton-loader
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.11 |
| Published | 2026-01-21 |
| First published | 2023-06-08 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 185.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 271 |
| Maintainers | hswolff, thesonofthomp, brookescarlett, shaneeza, stephl3, _tsck |

## Links

- npm: https://www.npmjs.com/package/@leafygreen-ui/skeleton-loader
- Repository: https://github.com/mongodb/leafygreen-ui
- Homepage: https://github.com/mongodb/leafygreen-ui/tree/main/packages/skeleton-loader
- Issues: https://jira.mongodb.org/projects/PD/summary
- npm.io page: https://npm.io/package/@leafygreen-ui/skeleton-loader

## Dependencies (9)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@leafygreen-ui/lib](https://npm.io/package/@leafygreen-ui/lib.md) ^15.7.0
- [@leafygreen-ui/a11y](https://npm.io/package/@leafygreen-ui/a11y.md) ^3.0.5
- [@leafygreen-ui/card](https://npm.io/package/@leafygreen-ui/card.md) ^13.3.1
- [@leafygreen-ui/icon](https://npm.io/package/@leafygreen-ui/icon.md) ^14.8.0
- [@leafygreen-ui/tokens](https://npm.io/package/@leafygreen-ui/tokens.md) ^4.2.2
- [@leafygreen-ui/emotion](https://npm.io/package/@leafygreen-ui/emotion.md) ^5.2.0
- [@leafygreen-ui/palette](https://npm.io/package/@leafygreen-ui/palette.md) ^5.0.2
- [@leafygreen-ui/typography](https://npm.io/package/@leafygreen-ui/typography.md) ^22.2.4

## Recent versions

- 3.0.11 (latest) — 2026-01-21
- 1.0.3 (beta) — 2023-07-26
- 2.0.0-alpha.1 (alpha) — 2023-07-20
- 3.0.10 — 2025-11-24
- 3.0.9 — 2025-11-13
- 3.0.8 — 2025-10-31
- 3.0.7 — 2025-10-21
- 3.0.6 — 2025-09-25
- 3.0.5 — 2025-09-10
- 3.0.4 — 2025-09-03
- 3.0.3 — 2025-07-03
- 3.0.2 — 2025-06-30
- 3.0.1 — 2025-06-16
- 3.0.0 — 2025-05-29
- 2.0.12 — 2025-05-19
- … 27 more at https://npm.io/package/@leafygreen-ui/skeleton-loader/versions

## README

# Skeleton Loader

![npm (scoped)](https://img.shields.io/npm/v/@leafygreen-ui/skeleton.svg)

#### [View on MongoDB.design](https://www.mongodb.design/component/skeleton/live-example/)

## Installation

### PNPM

```shell
pnpm add @leafygreen-ui/skeleton-loader
```

### Yarn

```shell
yarn add @leafygreen-ui/skeleton-loader
```

### NPM

```shell
npm install @leafygreen-ui/skeleton-loader
```

## Example

```jsx
<ParagraphSkeleton />
<ParagraphSkeleton withHeader />
<FormSkeleton />
<CardSkeleton />
<TableSkeleton columnLabels={['Column 1', 'Column 2']} />
```

## Properties

#### Skeleton

| Name             | Type     | Default   | Description                           |
| ---------------- | -------- | --------- | ------------------------------------- |
| `size`           | `string` | `default` | Determines the height of the skeleton |
| HTML `div` props |          |           | Additional HTML div properties        |

#### Paragraph Skeleton

| Name             | Type      | Default | Description                                              |
| ---------------- | --------- | ------- | -------------------------------------------------------- |
| `withHeader`     | `boolean` | `false` | Indicates whether the header skeleton should be rendered |
| HTML `div` props |           |         | Additional HTML div properties                           |

#### Table Skeleton

| Name             | Type                     | Default | Description                                                                           |
| ---------------- | ------------------------ | ------- | ------------------------------------------------------------------------------------- |
| `columnLabels`   | `Array<React.ReactNode>` |         | Column labels. Empty strings will be treated as unknown and render a simple skeleton. |
| `numRows`        | `number`                 | `5`     | Number of rows                                                                        |
| `numCols`        | `number`                 | `4`     | Number of columns                                                                     |
| `baseFontSize`   | `13 \| 16`               | `13`    | Base font size                                                                        |
| HTML `div` props |                          |         | Additional HTML div properties                                                        |

#### Form Skeleton

`<FormSkeleton />` only extends HTML `div` props.

#### Card Skeleton

`<CardSkeleton />` only extends HTML `div` props.

#### Icon Skeleton

| Name             | Type                                                        | Default   | Description                           |
| ---------------- | ----------------------------------------------------------- | --------- | ------------------------------------- |
| `size`           | `'small'`\| `'default'`\| `'large'`\| `'xlarge'`\| `number` | `default` | Determines the height of the skeleton |
| HTML `div` props |                                                             |           | Additional HTML div properties        |

---
_Source: https://npm.io/package/@leafygreen-ui/skeleton-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
