mui / mui/material-ui

CircularProgress thickness property should support strings (pixels) too

Open
#27,474 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component: CircularProgress scope: progress type: new feature
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

On this line: https://github.com/mui-org/material-ui/blob/d5943120c0a15d3953a81e83c5e5cc0f8667b610/packages/material-ui/src/CircularProgress/CircularProgress.js#L200

You're setting the svg attribute for strokeWidth to the thickness property. You only allow numbers because you do maths on it for the r svg attribute calculations as well as circumference calculations on line 167. However, the HTML spec for strokeWidth is <length> | <percentage>.

The reason this can make a difference is the following idea...

If you want the strokeWidth to equal the padding of a contained component, for example, making a circle around an avatar, it's near impossible to pass the same value so the CircularProgress is "outside" of the avatar component.

It might make sense to allow either, or allow a strokeWidth specific property to be passed in.

  • The issue is present in the latest release.
  • I have searched the issues of this repository and believe that this is not a duplicate.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in packages/material-ui/src/CircularProgress/CircularProgress.js, especially the circumference calculation around line 167 and the strokeWidth assignment around line 200. Determine how string pixel or percentage values should coexist with the existing r and circumference calculations; done means the requested string thickness behavior is supported without breaking numeric thickness.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.