DenverCoder1/custom-icon-badges

🚀 Feature: Increasing SVG icon libraries count

Open

#922 opened on Aug 21, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)TypeScript (360 forks)github user discovery
enhancementgood first issueserver-sideup-for-grabs

Repository metrics

Stars
 (926 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Description

I see that this repository adds only one icon library, aside of SimpleIcons used by shields.io, which is a shame.

Is there a possibility of adding more icon libraries? I understand that this increase bandwidth or cause other issues, nonetheless I dare to say that amounts of icons in the Octicons library may be insufficient for some cases, since there are only around 250 of them, which - compared to library used by shields - feels like a small fraction.

Here is a table (sorted by stars amount) containing worth-checking repositories with icons:

Supported Repository Author Icons1 Stars Primary Language License
#959 feather feathericons 1953 23787 84.3% JavaScript MIT
ionicons ionic-team 1338 17032 76.7% TypeScript MIT
tabler-icons tabler 4619 15862 56.3% HTML MIT
flag-icons lipis 268 9657 59.8% CSS MIT
icons twbs 287 6856 96.4% JavaScript MIT
weather-icons erikflowers 222 6721 59.7% CSS SIL OFL 1.1

1 - esmaited amount, counted from repository files

If introduced - what I'm looking straightforward to - libraries in URLs can be distinguished by their names.

  • logo=paintbrush -> logo=octicons-paintbrush

Contributor guide

Research direction
Review how icons are currently fetched and rendered; design a way to incorporate multiple icon libraries by adding a prefix to the icon name (e.g., 'octicons paintbrush') and update parsing logic accordingly.
Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70