📢 Use this project, contribute to it or open issues to help evolve it using Store Discussion.

All ContributorsAll Contributors

Store Icons

Build StatusBuild Status

All Store icons components.

Table of Contents


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


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

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

There are two different ways to use the icons available here. If you're developing a store's theme, you should use the icon block for the icon you want to render, which behaves just like any other block and expects to receive the props exposed by its API. But if you're developing custom components and want to use icons defined here, just follow the instructions below.

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.



Any icon can receive the following props:

PropertyDescriptionTypeDefault value
idThe ID for the desired iconString''
sizeDesired sizeNumber16
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


IconSocialsocial🚫🚫🚫square | rounded | circle

High Priority Actions


Medium Priority Actions

IconEyesighteyesightfilled | outline🚫on | off🚫
IconMinusminusfilled | outline | line🚫🚫 brands
IconPlusplusfilled | outline | line🚫🚫🚫
IconBookmarkbookmarkfilled | outline🚫🚫🚫
IconPlayplayfilled | outline🚫🚫🚫
IconPausepausefilled | outline🚫🚫🚫


IconCaretcaret🚫up | down | left | right🚫🚫

Status Indicators

IconCloseclosefilled | outline🚫🚫🚫
IconCheckcheckfilled | outline | line🚫🚫🚫
IconVolumeOnvolume-onfilled | outline | line🚫🚫🚫
IconVolumeOffvolume-offfilled | outline | line🚫🚫🚫


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).


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

Where the modifiers follows the rule:

🤓 ? 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.

CSS Customization

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on Using CSS Handles for store customization.

CSS Handles

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Did this page help you?