Logo for jsDocs.io

react-loading-skeleton

  • Version 3.5.0
  • Published
  • 26.7 kB
  • No dependencies
  • MIT license

Install

npm i react-loading-skeleton
yarn add react-loading-skeleton
pnpm add react-loading-skeleton

Overview

Make beautiful, animated loading skeletons that automatically adapt to your app.

Index

Functions

Interfaces

Type Aliases

Functions

function Skeleton

Skeleton: ({
    count,
    wrapper: Wrapper,
    className: customClassName,
    containerClassName,
    containerTestId,
    circle,
    style: styleProp,
    ...originalPropsStyleOptions
}: SkeletonProps) => ReactElement;

    function SkeletonTheme

    SkeletonTheme: ({
        children,
        ...styleOptions
    }: PropsWithChildren<SkeletonStyleProps>) => ReactElement;

      Interfaces

      interface SkeletonProps

      interface SkeletonProps extends SkeletonStyleProps {}

        property circle

        circle?: boolean;

          property className

          className?: string;

            property containerClassName

            containerClassName?: string;

              property containerTestId

              containerTestId?: string;

                property count

                count?: number;

                  property style

                  style?: CSSProperties;

                    property wrapper

                    wrapper?: React.FunctionComponent<PropsWithChildren<unknown>>;

                      interface SkeletonStyleProps

                      interface SkeletonStyleProps {}

                        property baseColor

                        baseColor?: string;

                          property borderRadius

                          borderRadius?: string | number;

                            property customHighlightBackground

                            customHighlightBackground?: string;

                              property direction

                              direction?: 'ltr' | 'rtl';

                                property duration

                                duration?: number;

                                  property enableAnimation

                                  enableAnimation?: boolean;

                                    property height

                                    height?: string | number;

                                      property highlightColor

                                      highlightColor?: string;

                                        property inline

                                        inline?: boolean;

                                          property width

                                          width?: string | number;

                                            Type Aliases

                                            type SkeletonThemeProps

                                            type SkeletonThemeProps = PropsWithChildren<SkeletonStyleProps>;

                                              Package Files (4)

                                              Dependencies (0)

                                              No dependencies.

                                              Dev Dependencies (42)

                                              Peer Dependencies (1)

                                              Badge

                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-loading-skeleton.

                                              • Markdown
                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-loading-skeleton)
                                              • HTML
                                                <a href="https://www.jsdocs.io/package/react-loading-skeleton"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>