react-circular-progressbar

  • Version 2.1.0
  • Published
  • 69.7 kB
  • No dependencies
  • MIT license

Install

npm i react-circular-progressbar
yarn add react-circular-progressbar
pnpm add react-circular-progressbar

Overview

A circular progress indicator component

Index

Functions

function buildStyles

buildStyles: ({
rotation,
strokeLinecap,
textColor,
textSize,
pathColor,
pathTransition,
pathTransitionDuration,
trailColor,
backgroundColor,
}: {
rotation?: number;
strokeLinecap?: any;
textColor?: string;
textSize?: string | number;
pathColor?: string;
pathTransition?: string;
pathTransitionDuration?: number;
trailColor?: string;
backgroundColor?: string;
}) => CircularProgressbarStyles;

    function CircularProgressbarWithChildren

    CircularProgressbarWithChildren: (
    props: CircularProgressbarWithChildrenProps
    ) => JSX.Element;

      Classes

      class CircularProgressbar

      class CircularProgressbar extends React.Component<CircularProgressbarProps> {}

        property defaultProps

        static defaultProps: CircularProgressbarDefaultProps;

          method getBackgroundPadding

          getBackgroundPadding: () => number;

            method getPathRadius

            getPathRadius: () => number;

              method getPathRatio

              getPathRatio: () => number;

                method render

                render: () => JSX.Element;

                  Package Files (4)

                  Dependencies (0)

                  No dependencies.

                  Dev Dependencies (18)

                  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-circular-progressbar.

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