Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Refactor] Investigate directly adding Octicons to project to better match design. #259

Closed
7 tasks
chadstewart opened this issue Aug 23, 2022 · 4 comments
Closed
7 tasks
Assignees
Labels
⚡️ easy win An issue that's easy to complete. 💡 feature

Comments

@chadstewart
Copy link
Contributor

chadstewart commented Aug 23, 2022

Summary

The current icons are inconsistent. They vary with stroke width, which makes it hard for developers to implement them without any back and forth from design.

Possible Solutions:

  1. Try updating Octicons from v8 to v17 in React Icons. If that doesn't work... try solution 2
  2. Install Octicons directly, and replace the icons.

Solution 01:

Note
Make sure to lock the version once it's updated, so it becomes future proof.

  • Check if there's a way to update Octicons version from v8 to v17 on React Icons package.json.
  • Update and lock the version.
  • Replace icons for Octicons

If that didn't work, use solution 2:

Solution 02:

Follow the steps here: https://primer.style/octicons/packages/react.

  • Install: npm install @primer/octicons-react
  • Search the icon: https://primer.style/octicons/
  • Import: eg: import {IssueOpenedIcon} from '@primer/octicons-react'
  • Replace old icons with Octicons

Context:

Currently React Icons uses v8 of Octicons and the latest version is v17. This means that there are several Octicons that is not available through React-Icons.

This issue is exploring the idea of using the Octicon package directly to get access to the latest Octicons.

It's looking better, but still, I think we should use the updated version of Octicons, because they will certainly render better.

I checked, and React Icons is using v8 of Octicons (see package.json), while they're at v17 (see octicons repo).

Can we update the version we're using to be the latest?

React Icons Package.json:
Screen Shot 2022-08-23 at 5 32 50 PM

Octicons:
Screen Shot 2022-08-23 at 5 33 14 PM

Originally posted by @pixelsbyeryc in #243 (comment)

@eryc-cc eryc-cc added ⚡️ easy win An issue that's easy to complete. 💡 feature labels Aug 23, 2022
@eryc-cc
Copy link
Contributor

eryc-cc commented Aug 23, 2022

@chadstewart I added the implementation to the description 🙌

@OgDev-01
Copy link
Contributor

Can we update the version we're using to be the latest?

I don't think we can update the current version of octicons that comes with react icons to the latest, except we create an issue requesting the update Here. But for now, Solution two is our best bet and I'll go with that on this issue 🙌

@0-vortex
Copy link
Contributor

Oh I thought we already implemented version 2 🍕

@0-vortex
Copy link
Contributor

This has been implemented!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚡️ easy win An issue that's easy to complete. 💡 feature
Projects
None yet
Development

No branches or pull requests

4 participants