react-circle

A React component to render a circle with a partially or fully drawn stroke.

Installation

$ npm install @moxy/react-circle

This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.

Motivation

This package was implemented to tackle situations where you need to render a circle where only a percentage of the stroke is drawn (e.g. a loading indicator).

Usage

import React from 'react';
import Circle from '@moxy/react-circle';

const MyComponent = () => (
    <div>
        <Circle strokeWidth={ 2 } strokePercentage={ 0.7 } direction="clockwise" />
    <div>
);

To import a stylesheet, one can import it on the project's entry CSS file:

/* src/index.css */
@import "@moxy/react-circle/dist/index.css";

...or in the project's entry JavaScript file:

/* src/index.js */
import "@moxy/react-circle/dist/index.css";

API

The following props are available to customize react-circle's behavior.

strokeWidth

Type: number | Required: false | Default: 1.5

The width of the circle's contour.

strokePercentage

Type: number | Required: false | Default: 1

The percentage of the circle's contour that is drawn.

direction

Type: string | Required: false | Default: clockwise

The direction in which the contour is drawn, starting from the top of the circle.

The direction has one of the following values:

direction: PropTypes.oneOf([
    'clockwise',
    'antiClockwise',
    'bothSides',
]),

onTransitionEnd

Type: function | Required: false

A function that will be called when a transition between two circle contour lengths finishes.

className

Type: string | Required: false

A className to apply to the component.

Tests

$ npm test
$ npm test -- --watch # during development

Demo

A demo Next.js project is available in the /demo folder so you can try out this component.

First, build the react-circle project with:

$ npm run build

To run the demo, do the following inside the demo's folder:

$ npm i
$ npm run dev

Note: Everytime a change is made to the package a rebuild is required to reflect those changes on the demo.

FAQ

I can't override the component's CSS, what's happening?

There is an ongoing next.js issue about the loading order of modules and global CSS in development mode. This has been fixed in v9.3.6-canary.0, so you can either update next.js to a version higher than v9.3.5, or simply increase the CSS specificity when overriding component's classes, as we did in the demo, e.g. having the page or section CSS wrap the component's one.

License

Released under the MIT License.