1.0.0 • Published 1 year ago

@edvnz/circular-progress v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

CircularProgress

A simple, customizable circular progress indicator for React Native.

Installation

To install the BottomSheet component, run the following command:

$ npm install @edvnz/circular-progress
# or
$ yarn add @edvnz/circular-progress

Features

  • Display a customizable circular progress indicator
  • Display a percentage or custom text in the center of the circle
  • Optionally display an icon in the center of the circle
  • Optionally display a main text in the center of the circle
  • Customize the size, stroke width, and colors of the progress circle and background circle
  • Customize the variant, color, and alignment of the text displayed in the center of the circle
  • Use a default theme or customize the colors using the bgColor and pgColor props
  • Use a progressPercent prop to specify the percentage of the progress circle to be displayed
  • Use an innerStrokeWidth prop to display an inner circle within the progress circle

Usage

import CircularProgress from 'circular-progress';

<CircularProgress
  size={200}
  strokeWidth={10}
  text="50%"
  progressPercent={50}
  authenticated
  iconName="check"
  mainText="Complete"
  textVariant="heading2"
  textColor="#000"
  iconColor="#000"
  bgColor="#ddd"
  pgColor="#00f"
/>

Props

Prop nameTypeDescription
sizenumberThe size of the progress circle.
strokeWidthnumberThe width of the progress circle's stroke.
textstringThe text to be displayed in the center of the progress circle.
innerStrokeWidthnumberThe width of the inner stroke of the progress circle.
progressPercentnumberThe percentage of the progress circle to be displayed.
authenticatedbooleanWhether or not the progress is authenticated.
iconNamestringThe name of the icon to be displayed in the center of the circle.
mainTextstringThe main text to be displayed in the center of the circle.
textVariantstringThe variant of the text to be displayed in the center of the circle.
textColorstringThe color of the text to be displayed in the center of the circle.
iconColorstringThe color of the icon to be displayed in the center of the circle.
bgColorstringThe color of the background circle.
pgColorstringThe color of the progress circle.