day8 / day8/re-com

Update Icons to Use SVGs

Open
#262 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Clojure
Stars
823
Forks
142
PR merge metrics
No merged PRs in 30d

Description

1. Status Quo

Uses Material Design Iconic Font. Implemented as font and CSS files distributed manually that must be made available via HTTP. A [:span] contains a special character code that maps to an icon in the font.

Upsides
  • No breaking changes.
  • No work to complete.
  • Supports old browsers (e.g. Internet Explorer, Android prior to 4.4 etc) although we probably don't care anymore.
Downsides
  • Must be manually deployed as a separate file. Not pulled in automatically with the JAR dependency and :require. Esp bad for upgrade experience or new users expecting the library to "just work".
  • Limited styling compared to SVG, in theory.
  • Limited to icons supported by the Iconic font distribution.
  • At some point upstream will probably stop shipping font files for icon sets, as it is effectively an obsolete technique now with widespread SVG support in browsers.

2. Material Design SVG Icons - Manual

Would use Material Icons as SVG represented as hiccup in reagent view functions.

Upsides
  • Pulled in automatically with JAR dependency and :require. No extra files to deploy.
  • Full CSS styling available, but would we actually use it ?
  • Opens up possibilities of animations and transitions.
  • Can include any SVG, not limited to a pre-packaged font.
  • Supports any relevant browser today (i.e. MS Edge, Chrome, Firefox, Safari etc)
Downsides
  • As the library maintainer, to upgrade or add icons from the upstream SVG icon set would be a manual process.
  • Tree shaking would not be possible or a breaking API change would be required.

3. Material Design SVG Icons - Automated

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 locating the current Material Design Iconic Font CSS and font integration, then inspect the Reagent view functions that render icons. Compare the manual and automated Material Icons SVG approaches described in the issue and establish which migration path is intended. Done should include the selected SVG icon implementation being packaged with the JAR without separate asset deployment.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure, react
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.