Skip to content

Guidelines for naming icons needed #171

Description

@certainlyakey

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions