klarr-agency / circum-icons Goto Github PK

• Fork this repo
• Create a new file README-ES.md
• Translate file to spanish
• Done!

If you have ideas on how we can improve this project feel free to share it in the discussions section :)

Thank you for your contribution!

A few bundle issues here result in production and development errors.

1. You ship React in your bundle, causes mismatching versions error.
2. There is no Barrel export so Webpack based frameworks will experience a development slowdown trying to serialize 400kb of modules.
3. The bundle is un-treeshakeable due to it shipping all icons as an array and serializes them in runtime.
4. Using this library results in 77kb added to bundle regardless of bundler and serializer

To resolve:

1. Add React as a peer dependency so Rollup skips bundling it.
2. Consider running a generate script before building to generate a React component for each SVG as a separate file.
3. Add a barrel export file for all the generated components
4. Run SWC or any other transpiler over the bundle to produce ESM and CJS modules.

I am happy to fix these issues and submit a PR if you'd like.

I want to use these icons in Inferno.
I need to be able to import iconList in my Inferno wrapper.
To do so, I need a package that exports the iconList const. Right now, the only solution is to clone your repository, manually copy the iconList.js file in my source directory.
It would be better if you could publish a package that exports { iconList } instead. This is to help third parties to include your package as a whole (including a copy of the license, links to source etc) in their distribution.

I would go one step further and refactor your packages to have circum-icon-core as dependency and import { iconList } from circum-icon-core

Temporarily, the manual copy/pasting approach is used for this package.

Please verify these criteria before summiting your issue

• [ x ] I look through all icons at circumicons.com to see if there is no icon with the same use case.
• [ x ] Explicit content is not allowed

Describe the icon you'd like
I want to add more icons like tech companies icons, basic feature icons, monument icons, currency icons, and many more.

Additional context
here I am adding a screenshot of my hand-drawing icon idea so you can make a better understanding.

Keyword
Google, Microsoft, Apple, Amazon, Pyramid, Eiffel Tower, Statue of Unity, Statue of Liberty, Rupee, Pound, Euro, Yuan, Flag, Taj Mahal, Football, Golf, Earth, Torch, Screenshot, Lock Orientation, Scanner, Reading mode, Cast, Vibrate, Key...

I've seen that you maintain multiple repositories for each library/framework. It's not necessary to make changes on each repo when you make updates/changes. This problem could be easily solved by using Lerna.

Project structure would be:

-- packages
  -- circum-icons-core
  -- circum-icons-svelte
  -- circum-icons-react
  -- circum-icons-vue

Lerna would deal publishing packages to proper npm registries.

Another idea:

Instead of creating and editing displayIcons.js file manually from svg files, you could write a build script that generates displayIcons.js file by extracting both names and direct inner html of svg files. So, it would be easy to add new icons just by adding files to svg folder and build circum-icons-core package.

Is your feature request related to a problem? Please describe.
Using the packages in typescript can be troublesome since the package doesn't include a type definition.

Describe the solution you'd like
I'd like to add type definitions to all the packages

Describe alternatives you've considered
The types could also be added to the definitely typed repo, but in opinion having the type definitions in the main package is easier and doesn't require a third party

Additional context
When I get the time I will create a PR with functional type definitions

Describe the bug
In the Github "About" section, "Every icons" should read "Every icon".

To Reproduce
Steps to reproduce the behavior:

1. Click "Code" above
2. Look on the right

Additional context
Will require a repository admin to change via Github's web interface (gear icon next to "About")