Simplify your stack and build anything. Or everything.
Build tomorrow’s web with a modern solution you truly own.
Code-based nature means you can build on top of it to power anything.
It’s time to take back your content infrastructure.

ShimmerEffect

The ShimmerEffect component provides a visual placeholder while content is loading. Match its dimensions to the content that will replace it to reduce layout shift.

Import

1
import { ShimmerEffect } from '@payloadcms/ui'

Basic usage

Loading component example…

Composing a skeleton

Combine multiple shimmer elements to approximate the final layout.

Loading component example…

Loading indicators should not replace an accessible loading label or status when users need to know that work is in progress.

Common props

These are the props most commonly used with this component. See its exported types in @payloadcms/ui for the complete list.

Prop

Type

Default

Description

height

number | string

'60px'

Sets the placeholder height.

width

number | string

'100%'

Sets the placeholder width.

animationDelay

string

'0ms'

Delays the shimmer animation.

transparent

boolean

false

Allows the underlying background to remain visible.

disableInlineStyles

boolean

false

Leaves dimensions to a custom class or stylesheet.

Was this page helpful?

Next

Table