@hig/skeleton-item

HIG SkeletonItem component

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
139233Jun 10, 2021Apr 3, 2017Minified + gzip package size for @hig/skeleton-item in KB

Readme

Skeleton Item

The Skeleton Item component renders a rectangular loading indicator, meant to serve as a placeholder until your actual content is ready to be rendered.

Getting started

yarn add @hig/skeleton-item @hig/theme-context @hig/theme-data

Import the component

import SkeletonItem from '@hig/skeleton-item';

Basic usage

<SkeletonItem maxWidth="400px" marginBottom="24px" />

Custom CSS

Use the className prop to pass in a css class name to the outermost container of the component. The class name will also pass down to most of the other styled elements within the component.

SkeletonItem also has a stylesheet prop that accepts a function wherein you can modify its styles. For instance

import SkeletonItem from '@hig/skeleton-item';

function YourComponent() {
  // ...
  const customStylesheet = (styles, props, themeData) => ({
    ...styles,
    skeletonItem: {
      ...styles.skeletonItem,
      color: themeData["colorScheme.status.error"]
    }
  });

  return (
    <SkeletonItem stylesheet={customStylesheet} />
  );
}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.