Skeleton

Server component, no client JS

ImportCopy Anchor Link

import { Skeleton } from '@nizivo/react/skeleton';

// Once per app (Getting started), after
// @nizivo/tokens/tokens.css and @nizivo/react/css/base.css
import '@nizivo/react/css/skeleton.css';

Static or interactiveCopy Anchor Link

Server. It ships no client JavaScript when a Server Component renders it, in every Next.js build mode; its code is bundled only when a client component (a 'use client' file) imports it. The pulse is a CSS animation. How to choose.

In a client app (a Vite or React Router single-page app, or a 'use client' file) it is an ordinary React component: event handlers, refs and state work as usual. In a client app.

ExamplesCopy Anchor Link

import type { JSX } from 'react';
import { Skeleton } from '@nizivo/react/skeleton';

export function SkeletonExample(): JSX.Element {
  return (
    <div aria-busy="true">
      <span className="nz-visually-hidden">Loading orders</span>
      <Skeleton />
      <Skeleton className="orders-skeleton-short" />
      <Skeleton className="orders-skeleton-shorter" />
    </div>
  );
}

PropsCopy Anchor Link

Other exportsCopy Anchor Link

SkeletonProps type

import type { SkeletonProps } from '@nizivo/react/skeleton'

The props of Skeleton, listed above.

SkeletonShape type

import type { SkeletonShape } from '@nizivo/react/skeleton'

Figma "Shape": a text line, a block (media, a chart) or a circle (an avatar).

type SkeletonShape = "line" | "block" | "circle"

SkeletonState type

import type { SkeletonState } from '@nizivo/react/skeleton'

The render state of Skeleton, listed above.

Data attributes and slotsCopy Anchor Link

Style parts by class (.nz-<slot>) and state by data attribute. Attribute meanings come from contracts/vocabulary.json.

CSS hooksCopy Anchor Link

Set a hook on the component's class or any ancestor to restyle it without specificity games; leave it unset for the default shown.

Layers: nz.components. Classes: .nz-skeleton.

AccessibilityCopy Anchor Link

Nothing in this component takes focus or keyboard input.

KeyboardCopy Anchor Link

None.

FigmaCopy Anchor Link

Node ids from design/component-map.json, which nz gen writes from component.json. The links open the Nizivo Figma library, which may ask you to sign in.

• Canonical: Figma node 7275:15181
• Ghost masters: Figma node 756:1169