Placeholders

    Use loading placeholders (otherwise known as "skeletons") for your components or pages to indicate something may still be loading

    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.

    How it works

    Create placeholders with the Placeholder component and a grid column prop (e.g., xs={6}) to set the width. They can replace the text inside an element or be added to an existing component via the as prop.

    Additional styling is applied to PlaceholderButtons 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.

    Width

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

    Color

    By default, the Placeholder uses currentColor. This can be overriden with a custom color or utility class.

    Sizing

    The size of Placeholders are based on the typographic style of the parent element. Customize them with sizing props: lg, sm, or xs.

    Animation

    Animate placeholders by setting the prop animation to glow or wave to better convey the perception of something being actively loaded.

    API

    import Placeholder from 'react-bootstrap/Placeholder'Copy import code for the Placeholder component
    NameTypeDefaultDescription
    animation
    'glow' | 'wave'

    Changes the animation of the placeholder.

    bg
    'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark'

    Change the background color of the placeholder.

    size
    'xs' | 'sm' | 'lg'

    Component size variations.

    bsPrefix
    string
    'placeholder'

    Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css.

    Placeholder.Buttonview source file

    import Placeholder from 'react-bootstrap/Placeholder'Copy import code for the Placeholder component
    NameTypeDefaultDescription
    animation
    'glow' | 'wave'

    Changes the animation of the placeholder.

    size
    'xs' | 'sm' | 'lg'

    Component size variations.

    variant
    string

    Button variant.

    bsPrefix
    string
    'placeholder'

    Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css.