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

Update icon naming convention #395

Closed
rossmoody opened this issue Mar 1, 2019 · 0 comments
Closed

Update icon naming convention #395

rossmoody opened this issue Mar 1, 2019 · 0 comments

Comments

@rossmoody
Copy link
Contributor

@rossmoody rossmoody commented Mar 1, 2019

Proposing an approach similar to Font Awesome for the way we structure our icons in naming convention and style pattern.

Categories

Brands

Logos and anything related to a branding element of a business or entity that still receives a color override. This section would follow the naming convention rules but would live under this category. I.e. apple-s, apple, apple-l

Full Color

Any icon that is full color in nature and doesn’t inherit color overrides. Can be treated almost like a standalone graphic. Brand logos that are full color would go in here. The main difference being this would be the full color version of it.

Icons

The library of our standard icons. The three styles that would fall under this category would be.

  • Solid: Icons that have filled interiors. If the icon can’t be filled, the stroked version becomes a thicker version of the ‘Normal’ state. For instance: https://d.pr/i/gpVtty
  • Normal: icons that follow the traditional brand aesthetic of stroked lines with round end caps.
  • Light: lighter stroked version of the normal icon. Typical use case for these would be instances where an icon needs to be larger than 32px but would start to look very heavy and off balance if normal is used.

Naming Convention

Icons (including Brand and Full Color categories) would follow a naming convention of:

Title -> Alt Characteristic, Shape, Direction -> Style Modifier

Title: The main identifying characteristic of the icon. The reason someone might look for it.
Alt Characteristic or Shape: An alternate characteristic about the icon that makes it unique from one that came before it and/or if it is tied to a standard shape like circle, square, diamond, etc... There can be more than one, especially if a direction is involved. I.e. arrow-big-circle-right-s.svg
Style Modifier: We are currently going to have Solid, Normal or Light modifiers denoted by their first letter. In the case of Regular icons, no modifier letter is given.

Example

image

Component

QuestionSIcon | QuestionIcon | QuestionLIcon
QuestionSquareSIcon | QuestionSquareIcon | QuestionSquareLIcon

SVG File

question-s.svg | question.svg | question-l-.svg
question-square-s.svg | question-square.svg | question-square-l.svg
@rossmoody rossmoody modified the milestone: Building Blocks Mar 6, 2019
@rossmoody rossmoody closed this Jun 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.