Store Icons

Build Status

Description

All Store icons components.

Disclaimer: Don't fork this project, use, contribute, or open issue with your feature request.

Release schedule

ReleaseStatusInitial ReleaseMaintenance LTS StartEnd-of-lifeStore Compatibility
0.xCurrent Release2019-01-30---------------------2.x

Table of Contents

Concept

This project is based on SVG fragment identifiers. All store icons are served by Render SDK, and with HTML tag <use> we can render a fragment from our icon pack. If you want to know the complete list of fragment SVG's, see here

Usage

First of all, add into the dependencies of your manifest.json and use it as an npm module:

"dependencies": {
  "vtex.store-icons": "0.x"
}

Dedicated Icon

Import the desired icon and use it into your code, for example:

import { IconMenu } from 'vtex.store-icons'

const YourComponent = props => (
  <IconMenu />
)

You can see here a list of every available icon.

Generic Icon

The API provides a generic icon, The Icon component. You can choose from any other icon passing only the id from the respective one you want to add.

For example:

import { Icon } from 'vtex.store-icons'

const YourComponent = props => <Icon id="hpa-cart" />

⚠️ This component is meant to be used on icons there aren't common throughout the store. Choose dedicated components whenever possible.

Icons

Props

Any icon can receive the following props:

PropertyDescriptionTypeDefault value
sizeDesired sizeNumber16
isActivedescBooleantrue
activeClassNameThe className it should have if activeString🚫
mutedClassNameThe className it should have if not activeString🚫

Obs: ...props: It is important to notice that any other <svg> prop passed will work with an icon as well.

Enhanced Props

Some components support modifiers. These are props that define the icon type, orientation, state or shape.

ModifierPossible values
typefilled line outline
orientationup down left right
stateon off
shapesquare rounded circle

Icon List

Brand

ComponentidTypeOrientationStateShape
IconSocialsocial🚫🚫🚫square | rounded | circle

High Priority Actions

ComponentidTypeOrientationStateShape
IconArrowBackarrow-back🚫🚫🚫🚫
IconAssistantSalesassistant-sales🚫🚫🚫🚫
IconProfileprofile🚫🚫🚫🚫
IconCartcart🚫🚫🚫🚫
IconSearchsearch🚫🚫🚫🚫
IconDeletedelete🚫🚫🚫🚫
IconMenumenu🚫🚫🚫🚫
IconLocationMarkerlocation-marker🚫🚫🚫🚫

Middle Priority Actions

ComponentidTypeOrientationStateShape
IconEyesighteyesightfilled | outline🚫on | off🚫
IconMinusminusfilled | outline | line🚫🚫 brands
IconPlusplusfilled | outline | line🚫🚫🚫brands
IconSingleItemsingle-item🚫🚫🚫🚫
IconListlist🚫🚫🚫🚫
IconGallerygallery🚫🚫🚫🚫
IconRemoveremove🚫🚫🚫🚫
IconSwapswap🚫🚫🚫🚫
IconHeartheart🚫🚫🚫🚫
IconGlobeglobe🚫🚫🚫🚫

Informational

ComponentidTypeOrientationStateShape
ComponentidTypeOrientationStateShape
IconCaretcaret🚫up | down | left | right🚫🚫true | false

Status Indicators

ComponentidTypeOrientationStateShape
IconCloseclosefilled | outline🚫🚫🚫
IconCheckcheckfilled | outline | line🚫🚫🚫

Customize

In the usage section, we discuss two ways of using icons. These ways extend to customization, so, prefer to change an existing Icon so that you can use the dedicated version. You can check how to override and name icons below.

Overwriting the default IconPack

As mentioned before, all icon IDs are stored at the iconpack.svg file. You can overwrite the default one by:

  1. On your store-theme create a new folder called iconpacks

  2. Create a file called iconpack.svg

  3. Declare your icon IDs (use the default iconpack as an example in how to do that properly).

Nomenclature

The naming convention is: intention-id--?modifiers

Where the modifiers follows the rule: ?type--?orientation--?state--?shape

πŸ€“ ? stands for optional inputs

Icon Intention

bnd Brand - Display logos, brands or advertisements.

hpa High priority actions - Actions that are important to the global context.

mpa Mild priority actions - Actions that are important only to the current component context.

inf Informational - Represents information display or actions that, when triggered, reveal further details about the current context.

nav Navigation - Actions that triggers navigation.

sti Status indicators - Indicates the current item/component semantic status.

Troubleshooting

You can check if others are passing through similar issues here. Also feel free to open issues or contribute with pull requests.

Contributing

Check it out how to contribute with this project.

Tests

To execute our tests go to react/ folder and run yarn test