openedx / openedx/paragon

Variants consistency between components

Open
#1,460 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

Currently most of the components has different number of variants supported that has different colors according to the same
variant name. Probably it will be easier for developers and users when they know a set of the variants that component has. Also for most components there are the same colors are used like for example Button, Badge, Chip etc. and there are special like Alert that uses more light color.
So the idea is to define all variants somewhere on the top level (like Figma Foundation page) and to update each component, for example, "Button uses the top level variants" on the Button page in the Figma. For Alert and other special cases those variants can be overridden.
Also all variants for component will be explicitly shown on the doc pages.

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

Review the Figma Foundation page and the Button, Badge, Chip, and Alert component pages first, comparing their current variant sets and color usage. Done means a shared top-level variant definition is established, component exceptions are documented, and all component variants are explicitly shown on their documentation pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
figma, javascript
Domain
design, documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.