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

Guidelines for naming icons needed #171

Open
certainlyakey opened this issue Aug 23, 2023 · 0 comments
Open

Guidelines for naming icons needed #171

certainlyakey opened this issue Aug 23, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@certainlyakey
Copy link
Contributor

Summary

People looking for an icon in @cvi/icons package might have a problem discovering it by name unless the icon is named in a particular way.

Ideally we should stick to names that only describe what the icon looks like and not an application or UI feature that it is supposed to be used with. This will allow library partners to reuse same icon for different purposes and meanings.

A good explanation is given in this article. To make things simpler, we could simply use a name offered for a similar icon in FontAwesome where it makes sense, also adding a prefix like outline or filled/solid. Eg, something like outline-circle-xmark.

A goal of a next major version would be to bring more clarity and consistency into names of the already existing icons (could be also done in a backwards compatible way by introducing aliases like FontAwesome did?).

What alternatives have you tried?

No response

Does this feature request involve any updates to the reference design?

No

Implementation details

Rename icons where necessary and optionally introduce aliases so that the same icon could be imported by an old name too.

@certainlyakey certainlyakey added the enhancement New feature or request label Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant