openedx / openedx/paragon

[code health] (DRAFT) Replacing the values of properties with Paragon variables

Open
#2,809 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

code health raccoon-gang
Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

  1. In the ColorPicker component, I noticed that you can use the existing SCSS variables provided by the Paragon. It's a good idea to keep your code clean by using the provided Paragon variables as much as possible. The same problem with shadows in the Sheet component.

My screenshot is just a suggestion for replacing variables:

Screenshot 2023-11-14 at 13 12 44

  1. Move the $form-control-icon-width and $select-icon-padding variables to the appropriate variable file

  2. In the alpha version of Paragon, after transferring files from Bootstrap, you need to check and remove unnecessary comments if necessary

For example:
image

  1. Create a separate file for the IconButton component with variables and mixins and transfer there all the variables and mixins from the component’s styles file.

  2. Move the variables from the ProductTour (Checkpoint) component's general styles file to the variables file. It would also be nice to remove the “Override PopperJS arrow placement” comments, since it seems to me that it is obvious that the styles of this component are overriding the bootstrap styles (due to the use of !important).

  3. For an Scrollable component, it might be a good idea to add variables for key styles. We also have shadows provided by Paragon, which can also be used.

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 by reviewing the linked SCSS files for ColorPicker, Sheet, Form, IconButton, ProductTour, and Scrollable, along with the referenced variable files. Identify component-local values, variables, mixins, comments, and shadows that should be consolidated or replaced with existing Paragon variables. Done means the requested styles are reorganized consistently across all six areas without unnecessary Bootstrap comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
bootstrap, scss
Domain
frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.