React Placeholder Component

Placeholder

Use loading react placeholders for your components or pages to indicate something may still be loading.

Other frameworks

CoreUI components are available as native Angular, Bootstrap (Vanilla JS), and Vue components. To learn more please visit the following pages.

On this page

About#

Placeholders can be used to enhance the experience of your application. They're built only with HTML and CSS, meaning you don't need any JavaScript to create them. You will, however, need some custom JavaScript to toggle their visibility. Their appearance, color, and sizing can be easily customized with our utility classes.

Example#

In the example below, we take a typical card component and recreate it with placeholders applied to create a "loading card". Size and proportions are the same between the two.

Card title

Some quick example text to build on the card title and make up the bulk of the card's content.

Go somewhere

<CCard style={{ width: '18rem' }}>
  <CCardImage orientation="top" src={ReactImg} />
  <CCardBody>
    <CCardTitle>Card title</CCardTitle>
    <CCardText>
      Some quick example text to build on the card title and make up the bulk of the card's
      content.
    </CCardText>
    <CButton color="primary" href="#">Go somewhere</CButton>
  </CCardBody>
</CCard>
<CCard style={{ width: '18rem' }}>
  <CCardImage as="svg" orientation="top" width="100%" height="162" xmlns="http://www.w3.org/2000/svg" role="img" aria-label="Placeholder" preserveAspectRatio="xMidYMid slice" focusable="false">
    <title>Placeholder</title><rect width="100%" height="100%" fill="#868e96"></rect>
  </CCardImage>
  <CCardBody>
    <CPlaceholder as={CCardTitle} animation="glow" xs={7}>
      <CPlaceholder xs={6} />
    </CPlaceholder>
    <CPlaceholder as={CCardText} animation="glow">
      <CPlaceholder xs={7} />
      <CPlaceholder xs={4} />
      <CPlaceholder xs={4} />
      <CPlaceholder xs={6} />
      <CPlaceholder xs={8} />
    </CPlaceholder>
    <CPlaceholder as={CButton} color="primary" disabled href="#" tabIndex={-1} xs={6}></CPlaceholder>
  </CCardBody>
</CCard>

How it works#

Create placeholders with the <CPlaceholder> component and a grid column propx (e.g., xs={6}) to set the width. They can replace the text inside an element or be added as a modifier class to an existing component.

We apply additional styling to CButtons via ::before to ensure the height is respected. You may extend this pattern for other situations as needed, or add a   within the element to reflect the height when actual text is rendered in its place.

<p aria-hidden="true">
  <CPlaceholder xs={6} />
</p>
<CPlaceholder as={CButton} color="primary" aria-hidden="true" disabled href="#" tabIndex={-1} xs={4}></CPlaceholder>

The use of aria-hidden="true" only indicates that the element should be hidden to screen readers. The loading behavior of the placeholder depends on how authors will actually use the placeholder styles, how they plan to update things, etc. Some JavaScript code may be needed to swap the state of the placeholder and inform AT users of the update.

Width#

You can change the width through grid column classes, width utilities, or inline styles.

<CPlaceholder xs={6} />
<CPlaceholder className="w-75" />
<CPlaceholder style={{ width: '30%'}} />

Color#

By default, the <CPlaceholder> uses currentColor. This can be overridden with a custom color or utility class.

<CPlaceholder xs={12} />

<CPlaceholder color="primary" xs={12} />
<CPlaceholder color="secondary" xs={12} />
<CPlaceholder color="success" xs={12} />
<CPlaceholder color="danger" xs={12} />
<CPlaceholder color="warning" xs={12} />
<CPlaceholder color="info" xs={12} />
<CPlaceholder color="light" xs={12} />
<CPlaceholder color="dark" xs={12} />

Sizing#

The size of <CPlaceholder>s are based on the typographic style of the parent element. Customize them with size prop: lg, sm, or xs.

<CPlaceholder xs={12} size="lg"/>
<CPlaceholder xs={12}/>
<CPlaceholder xs={12} size="sm"/>
<CPlaceholder xs={12} size="xs"/>

Animation#

Animate placeholders with animation="glow" or animation="wave" to better convey the perception of something being actively loaded.

<CPlaceholder as="p" animation="glow">
  <CPlaceholder xs={12} />
</CPlaceholder>

<CPlaceholder as="p" animation="wave">
  <CPlaceholder xs={12} />
</CPlaceholder>

Customizing#

SASS variables#

$placeholder-opacity-max:           .5 !default;
$placeholder-opacity-min:           .2 !default;

API#

CPlaceholder#

import { CPlaceholder } from '@coreui/react'
// or
import CPlaceholder from '@coreui/react/src/components/placeholder/CPlaceholder'

Property	Description	Type	Default
animation	Set animation type to better convey the perception of something being actively loaded.	`'glow'` \| `'wave'`	-
as	Component used for the root node. Either a string to use a HTML element or a component.	`(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)`	-
className	A string of all className you want applied to the component.	`string`	-
color	Sets the color context of the component to one of CoreUI’s themed colors.	`'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string`	-
lg	The number of columns on large devices (<1200px).	`number`	-
md	The number of columns on medium devices (<992px).	`number`	-
size	Size the component extra small, small, or large.	`'xs'` \| `'sm'` \| `'lg'`	-
sm	The number of columns on small devices (<768px).	`number`	-
xl	The number of columns on X-Large devices (<1400px).	`number`	-
xs	The number of columns on extra small devices (<576px).	`number`	-
xxl	The number of columns on XX-Large devices (≥1400px).	`number`	-