[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides store framework in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/storefront-development)

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework)

Store Framework

Store Framework is a front-end development framework designed to enhance and simplify the creation of ecommerce websites within VTEX. Built on the [VTEX IO development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [React](https://read.calvincode.net/reader?url=https://reactjs.org/) technology, the framework offers native storefront components in JSON format.

Store Framework relies on the following pillars:

| Aspect                        | Description                                                                                |
| ----------------------------- | ---------------------------------------------------------------------------------------------------- |
| Composability                 | Assemble pre-built and custom components to create a storefront tailored to specific business needs. |
| Flexibility and customization | Adapt storefronts to unique design requirements and functional preferences.                          |
| Workspaces                    | Create multiple store versions and test them to guarantee reliability and deploy changes safely.     |
| A/B tests                     | Experiment with different versions of a storefront to enhance user experience and performance.       |
| VTEX IO cloud infrastructure  | Develop in a fully managed auto-scalable infrastructure.                                             |

## Store Framework architecture

Codebase

Build process

Deployment

Customer touchpoint

User touchpoint

Cloud - AWS

VTEX IO apps

Builder Hub

Housekeeper

PWA

Webstore

CMS / Site Editor

Developer Tools

Development workspaces

VTEX IO CLI

A/B tests

Production workspaces

Edition apps

Builders

Admin

GraphQL

React

Store

Node

Pixel

Technologies

Node

React

Typescript

GraphQL

The diagram shows a typical Store Framework architectural flow, which includes the following components:

* **Codebase:** The source code for Store Framework and VTEX IO apps is cloud-native.
* **Build process:** The process of converting the source code into a deployable application, based on [VTEX IO Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).
* **Deployment:** The process of deploying the application to a production environment.
* **Business user touchpoint:** where administrative users interact with storefront settings, on CMS and Site Editor.
* **Customer touchpoint:** where customers interact with the storefront, usually on a webstore or PWA.

### Developer Tools

Developers using Store Framework can count on a set of tools:

* [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference): Interact with the VTEX platform using our command-line tool.
* [A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ab-tests): Compare traffic between two workspaces.
* [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app): Streamline your setup by installing a preset bundle of settings, policies, backend and frontend apps.
* [Development workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace): Test and preview your code in workspaces dedicated to development, without affecting the live store.
* [Production workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace): Run tests and quality assurance in a workspace that is ready to handle live traffic.
* [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders): Connect your apps to our services quickly using VTEX IO Builders.

### Technologies

To work with this framework, you should be familiar with the following technologies:

* [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io)
* [React](https://read.calvincode.net/reader?url=https://reactjs.org/)
* [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en)
* [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/)
* [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/)

## Quickstart

This quickstart guide is a brief introduction to the VTEX Store Framework. For more detailed step-by-step documentation, check [Store Framework - Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).

### 1\. Initial settings

1. [Install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install). You will need it to run commands in the following steps.
2. Log in to your VTEX account:
`1
vtex login {accountName}
`
3. Open a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support?/cultureInfo=en-us) to set up your account’s Edition app to `vtex.edition-store@3.x` or higher. Refer to the [Edition App article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) to identify the most suitable version for your scenario.
4. Install Intelligent Search (if the account’s Edition app is `vtex.edition-store@4.x` or lower) and integrate it with your store’s catalog according to [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites%23step-2-implementing-the-vtex-intelligent-search).

### 2\. Setting up the project

1. Navigate to a local file directory where you want our [boilerplate store theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme) to be saved:
`1
cd {folderName}
`
2. Start a new project:
`1
vtex init
`
3. Select `store` by navigating with your arrow keys and pressing `Enter`. When prompted to confirm, type `y` to clone the `minimum-boilerplate-theme` to your folder.
4. Create a workspace:
`1
vtex use {workspaceName}
`
5. Navigate to the `minimum-boilerplate-theme` directory:
`1
cd minimum-boilerplate-theme
`
6. Link your local repository with the workspace:
`1
vtex link
`
7. Access your workspace:
`1
vtex browse
`

Now you can make changes to the local repository and test them live in the workspace without altering the store's final public version.

## Next steps

### Customizing your theme

[Building your own store themeLearn how to create your store theme from scratch.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)[Building pagesCreate custom pages for your ecommerce.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page)[Using componentsLeverage from premade components to build your store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)[StylingCustomize your store's style.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)

### Deploying your changes

[Making your theme content publicPublish your new store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public)[Going liveMake your store available to shoppers.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework.md)

[Tracing the error source« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework//docs/guides/faststore/troubleshooting-tracing-the-error-source)[Store ThemeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework//docs/guides/vtex-io-documentation-store-theme)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

ON THIS PAGE

[Store Framework architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23store-framework-architecture)

[Developer Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23developer-tools)[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23technologies)

[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23quickstart)

[1\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%231-initial-settings)[2\. Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%232-setting-up-the-project)

[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23next-steps)

[Customizing your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23customizing-your-theme)[Deploying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23deploying-your-changes)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework.md)

Copy page

On this page

ON THIS PAGE

[Store Framework architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23store-framework-architecture)

[Developer Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23developer-tools)[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23technologies)

[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23quickstart)

[1\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%231-initial-settings)[2\. Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%232-setting-up-the-project)

[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23next-steps)

[Customizing your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23customizing-your-theme)[Deploying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework/docs/guides/store-framework%23deploying-your-changes)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides seller portal edition app in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/managing-edition-apps)

[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-edition-app)

[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-sponsor-account)

[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)

[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)

[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)

[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/managing-edition-apps)

[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-edition-app)

[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-sponsor-account)

[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)

[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)

[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)

[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/app-development)

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/managing-edition-apps)

[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app)

Seller Portal Edition App

Learn how marketplaces can configure their own Edition App to create a customized Seller Portal.

The [Seller Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/seller-portal-primeiros-passos--6w1vBdRH2uuBGmUqgNQjwK) is a VTEX platform edition used by sellers to connect and sell their products on VTEX marketplaces. What differentiates it from a regular VTEX Admin is the curation of pages: we have selected only the key pages from VTEX’s Admin that fit the most with a seller’s operations.

That selection is possible because Seller Portal is actually a VTEX IO app. All pages available on the Seller Portal are declared in an Edition App, built using VTEX IO. This means that all sellers added to the marketplace’s Seller Portal will see the same experience, which is defined in the edition app.

In this guide, we will review some key concepts around the Edition App’s architecture and point out how marketplaces can configure their own Edition App to create a customized Seller Portal.

## App sponsor

Every Seller Portal account is created from a VTEX IO [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app), which is defined by its [sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account). The sponsor is the entity responsible for defining which pages will be included in that edition. In the code, they are defined as the app’s vendor. The `vendor` field represents the sponsor, and the `name` field, the seller’s edition app.

`1

{

2

 "vendor": "vtex",

3

 "name": "edition-seller",

4

}

`

> It is not possible to create edition apps without a VTEX account as the sponsor.

Two entities can become an Edition app’s sponsor: VTEX or a VTEX marketplace.

### VTEX as the sponsor

In default Seller Portal environments, VTEX is the sponsor of the edition. This means that VTEX is responsible for:

* Selecting which pages would be included in Seller Portal’s default environment.
* Creating the edition app that will become the default Seller Portal.

VTEX has therefore defined its own edition for the Seller Portal, which includes the default pages that come within an account.

### Marketplace as the sponsor

It is also possible for marketplaces to create their own custom editions of Seller Portal by becoming sponsors of their own edition app. When a marketplace wishes to select extra pages to be included in the seller’s experience, they can create their custom editions of Seller Portal by becoming sponsors of a an edition app.

Marketplaces that choose to be sponsors of their own edition app usually want:

* To have all the default pages that come with VTEX’s Seller Portal edition included for their sellers in an easy and quick way.
* To automatically add specific pages that are not included in VTEX’s default edition to all their sellers using Seller Portal.

The edition app sponsored by the marketplace should become the app’s sponsor and add VTEX’s edition as a “dependency” field. We will go over the step-by-step process of building your app in the [Configuring your Edition App](#configuring-your-edition-app) section of this article.

> To sponsor an app, please open a ticket to VTEX Support so your account can be enabled as a sponsor.

### App dependencies

Making VTEX’s edition app a `dependency` automatically includes all of VTEX’s default pages, updates, and bug fixes. In this way, you don’t have to manually include all apps in the default experience. They can just import what is in VTEX’s edition.

Once VTEX’s edition is declared as a dependency, you can add your own desired pages in the edition/apps.json file.

`1

{

2

 "dependencies": {

3

 "vtex.edition-seller": "0.x"

4

 },

5

}

`

Every **Edition App** has a **dependency** declared, which imports pages from another edition app.

Applied edition

Applied edition

Applied edition

Applied edition

marketplace1.edition-seller

Default Apps from Seller Portal

Custom Apps from Marketplace 1

Dependency: vtex.edition-seller

vtex.edition-store

Default pages from Edition Store

vtex.edition-seller

Default Apps from Seller Portal

VTEX

Marketplace 1

Seller 1

Seller 2

Seller 3

## Configuring your Edition App

To configure your Edition app, follow these steps:

### Cloning the repository

1. Open the terminal and use the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) to log in to the desired VTEX account.
2. Run `vtex init`.
3. Choose the `edition app` option.

If you don't have VTEX IO CLI installed, you can also clone it manually:

`git clone https://github.com/vtex/edition-hello edition-hello`

`cd edition-hello`

### Defining the Manifest

After cloning the repository, follow the instructions below to configure your app:

1. In the `manifest.json`, change the `name` to `sponsor.edition-seller`.

> The name `sponsor.edition-seller` is mandatory, if another name is configured, the application will not work. By standard, VTEX adopts the edition-seller- prefix in all edition apps.

1. Change the `vendor` field to your store’s account name, to become the app’s sponsor.

> Make sure you request through VTEX Support that your store is enabled to become the app’s sponsor.

1. Set the appropriate parent edition in the `dependencies` field.

> The dependency must be published by the vendor's sponsor.

### Adding apps for sub-accounts

After configuring your manifest, you can specify apps to be installed in the sub-accounts that have this edition configured. You do that through the `edition/apps.json` file, adding an entry to the object under the `apps` key in the format:

`1

{

2

 "<vendor>.<name>": {

3

 "major": "<desired major>",

4

 "settings": "<initial settings>"

5

 },

6

}

`

The settings are optional and can be omitted, but they will define the initial settings that should be configured for the app when it is installed through the current edition.

E.g.: The contents of the `apps.json` file could be:

`1

{

2

 "apps": {

3

 "vtex.node-getting-started": { "major": 0 }

4

 }

5

}

`

### Testing

To test the app, make sure you have [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed.

Edition apps cannot be linked, so for testing, you need to launch a pre-release version and set them on test accounts or workspaces for validation. To do so:

1. Launch a pre-release of your edition: `vtex release patch beta`.
2. Check the edition of the current account/workspace: `vtex edition`.
3. Set the edition in the current account/workspace: `vtex edition set <edition>@<version>`.

All the apps configured in the `apps.json` file will be automatically installed in that workspace where the edition was set. You can validate that by inspecting the `vtex ls` command output.

## Multiple marketplaces using the same edition

There is another scenario where more than one marketplace, which is under the same parent company, wishes to operate with the same Seller Portal edition app.

In the example below we guide you through the architecture that enables this scenario.

### Scenario example

**Scenario:** Two separate marketplaces, with different sellers, wish to provide the same Seller Portal experience to their sellers, without the complexity of creating multiple edition apps.

We have two marketplaces: The **MKPSeller** and the **Cosmetics2**. They are both part of the same holding, but they're different marketplace accounts.

The **MKPSeller** has created an edition app, based on our default, **vtex.edition-seller**, and added other custom pages they wish to provide for their sellers. They called the edition they sponsored the `mkpseller.edition-seller` .

They declare the default edition that VTEX has sponsored, or `vtex.edition-seller`, as a dependency on their app’s code. This action automatically imports all the default Seller Portal apps to their edition app.

`1

{

2

 "vendor": "mkpseller",

3

 "name": "edition-seller",

4

 "version": "0.1.0",

5

 "title": "MKP Seller edition apps",

6

 "description": "VTEX IO edition for seller accounts",

7

 "builders": {

8

 "edition": "0.x"

9

 },

10

 "dependencies": {

11

 "vtex.edition-seller": "0.x"

12

 },

13

 "$schema": "https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema"

14

}

`

Meanwhile, **Cosmetics2** also wants to create an edition app, copying **MKPseller’s** edition, since they came to the conclusion that **MKPseller's** edition fits all their needs.

Instead of creating an edition app and manually adding the desired custom pages one by one, they can simply create their app, and declare **MKPSeller's** edition as a dependency.

`1

{

2

 "vendor": "cosmetics2",

3

 "name": "edition-seller",

4

 "version": "0.1.0",

5

 "title": "Cosmetics2 edition apps",

6

 "description": "VTEX IO edition for seller accounts",

7

 "builders": {

8

 "edition": "0.x"

9

 },

10

 "dependencies": {

11

 "mkpseller.edition-seller": "0.x"

12

 },

13

 "$schema": "https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema"

14

}

`

For the dependency to work, **MKPSeller** must be **Cosmetics2** app’s sponsor. This means that **Cosmetics2** has an edition belonging to **MKPSeller** associated to it.

> To know which edition is associated with an account, run `vtex edition get` on the terminal.

This way, **Cosmetics2** edition app will include everything declared in `mkpseller.edition-seller` . This means including:

* VTEX’s default apps, since they were declared as a dependency.
* The custom pages added by **MKPSeller**, since they created their custom edition.

Summing it up, to declare VTEX or another marketplace’s **Edition app** as a **dependency**, this dependency’s owner must be the app’s **sponsor**.

### Limitations for multiple marketplace architecture

The current multiple marketplace architecture has some limitations:

* The apps included in an edition can only belong to the same sponsor, or to VTEX. E.g. MKPSeller cannot add apps from Cosmetics2's edition.
* An edition cannot have more than one sponsor.
* For this architecture to work, we can only include an edition as a dependency if it belongs to the same app vendor, or to the vendor’s sponsor.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/seller-portal-edition-app.md)

[Updating Edition apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app//docs/guides/vtex-io-documentation-updating-edition-apps)[Frequently asked questionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app//docs/guides/vtex-io-documentation-frequently-asked-questions)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[App sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-sponsor)

[VTEX as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23vtex-as-the-sponsor)[Marketplace as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23marketplace-as-the-sponsor)[App dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-dependencies)

[Configuring your Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23configuring-your-edition-app)

[Cloning the repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23cloning-the-repository)[Defining the Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23defining-the-manifest)[Adding apps for sub-accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23adding-apps-for-sub-accounts)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23testing)

[Multiple marketplaces using the same edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23multiple-marketplaces-using-the-same-edition)

[Scenario example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23scenario-example)[Limitations for multiple marketplace architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23limitations-for-multiple-marketplace-architecture)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/managing-edition-apps/seller-portal-edition-app.md)

Copy page

On this page

ON THIS PAGE

[App sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-sponsor)

[VTEX as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23vtex-as-the-sponsor)[Marketplace as the sponsor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23marketplace-as-the-sponsor)[App dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23app-dependencies)

[Configuring your Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23configuring-your-edition-app)

[Cloning the repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23cloning-the-repository)[Defining the Manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23defining-the-manifest)[Adding apps for sub-accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23adding-apps-for-sub-accounts)[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23testing)

[Multiple marketplaces using the same edition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23multiple-marketplaces-using-the-same-edition)

[Scenario example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23scenario-example)[Limitations for multiple marketplace architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app/docs/guides/seller-portal-edition-app%23limitations-for-multiple-marketplace-architecture)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore organisms filter in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/molecules-overview)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-overview)

[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-banner-text)

[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-cart-sidebar)

[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-empty-state)

[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter-slider)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter)

[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-hero)

[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-image-gallery)

[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar-slider)

[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar)

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-newsletter)

[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-out-of-stock)

[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-payment-methods)

[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-price-range)

[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-grid)

[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-shelf)

[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-region-modal)

[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-search-input)

[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-shipping-simulation)

[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-slide-over)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/molecules-overview)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-overview)

[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-banner-text)

[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-cart-sidebar)

[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-empty-state)

[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter-slider)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter)

[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-hero)

[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-image-gallery)

[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar-slider)

[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-navbar)

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-newsletter)

[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-out-of-stock)

[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-payment-methods)

[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-price-range)

[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-grid)

[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-product-shelf)

[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-region-modal)

[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-search-input)

[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-shipping-simulation)

[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-slide-over)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/components-index)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-overview)

Filter

Filters products inside the Product Listing Page (PLP) and Search Page.

[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/Filter)

The `Filter` component is used to filter products inside the [Product Listing Page (PLP)](https://read.calvincode.net/reader?url=https://starter.vtex.app/office) and Search Page. The `Filter` component is a compound of the following:

* `Filter`: wraps an `Accordion` along with the component title.
* `FilterSlider`: `SlideOver` that wraps the `Filter` for small screen dimensions.
* `FilterFacets`: wraps an `AccordionItem` with its `AccordionButton` and an `AccordionPanel` for every Facet.
* `FilterFacetBoolean`: wraps the list of the `FilterFacetBooleanItem`.
* `FilterFacetBooleanItem`: wraps a `Checkbox` with its `Label` and the `Badge` that represents the child of the `FilterFacetBoolean`.
* `FilterFacetRange`: wraps a `PriceRange` for a given Facet with the Range type.

Example

Code

## Filters

Price

Category

Brand

Open Filters

---

## Usage

### Import the component

`1

import {

2

 Filter,

3

 FilterFacets,

4

 FilterFacetBoolean,

5

 FilterFacetBooleanItem,

6

 FilterFacetRange,

7

} from "@faststore/ui";

`

### Import styles

To apply styles, include the following in your stylesheet:

`1

@import "@faststore/ui/src/components/organisms/Filter/styles.scss";

`

For details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).

---

## Design tokens

### Title

| Local token                      | Default value/Global token linked |
| -------------------------------- | --------------------------------- |
| \--fs-filter-title-height        | var(--fs-spacing-6)               |
| \--fs-filter-title-margin-bottom | var(--fs-spacing-0)               |
| \--fs-filter-title-text-size     | var(--fs-text-size-2)             |
| \--fs-filter-title-line-height   | 1.25                              |

### Accordion

| Local token                                   | Default value/Global token linked |
| --------------------------------------------- | --------------------------------- |
| \--fs-filter-accordion-border-width-notebook  | var(--fs-border-width)            |
| \--fs-filter-accordion-border-color-notebook  | var(--fs-border-color-light)      |
| \--fs-filter-accordion-border-radius-notebook | var(--fs-border-radius)           |

### Accordion Item Button

| Local token                                          | Default value/Global token linked                        |
| ---------------------------------------------------- | -------------------------------------------------------- |
| \--fs-filter-accordion-button-text-size              | var(--fs-text-size-lead)                                 |
| \--fs-filter-accordion-button-text-weight            | var(--fs-text-weight-regular)                            |
| \--fs-filter-accordion-button-line-height            | 1.5                                                      |
| \--fs-filter-accordion-button-text-size-notebook     | var(--fs-text-size-2)                                    |
| \--fs-filter-accordion-button-line-height-notebook   | 1.25                                                     |
| \--fs-filter-accordion-button-padding-right-notebook | var(--fs-spacing-4)                                      |
| \--fs-filter-accordion-button-padding-left-notebook  | var(--fs-filter-accordion-button-padding-right-notebook) |

### Accordion Item Panel

| Local token                                              | Default value/Global token linked                            |
| -------------------------------------------------------- | ------------------------------------------------------------ |
| \--fs-filter-accordion-item-panel-padding-right-notebook | var(--fs-spacing-4)                                          |
| \--fs-filter-accordion-item-panel-padding-left-notebook  | var(--fs-filter-accordion-item-panel-padding-right-notebook) |

### Accordion Item List

| Local token                      | Default value/Global token linked |
| -------------------------------- | --------------------------------- |
| \--fs-filter-list-padding-bottom | var(--fs-spacing-3)               |

### List Item

| Local token                                   | Default value/Global token linked |
| --------------------------------------------- | --------------------------------- |
| \--fs-filter-list-item-not-last-margin-bottom | var(--fs-spacing-3)               |

### List Item Checkbox

| Local token                            | Default value/Global token linked         |
| -------------------------------------- | ----------------------------------------- |
| \--fs-filter-list-item-checkbox-width  | 1.25rem                                   |
| \--fs-filter-list-item-checkbox-height | var(--fs-filter-list-item-checkbox-width) |

### List Item Label

| Local token                              | Default value/Global token linked |
| ---------------------------------------- | --------------------------------- |
| \--fs-filter-list-item-label-width       | 100%                              |
| \--fs-filter-list-item-label-margin-left | var(--fs-spacing-1)               |
| \--fs-filter-list-item-label-text-size   | var(--fs-text-size-2)             |
| \--fs-filter-list-item-label-line-height | 1.25                              |

### List Item Badge

| Local token                              | Default value/Global token linked |
| ---------------------------------------- | --------------------------------- |
| \--fs-filter-list-item-badge-margin-left | var(--fs-spacing-1)               |

---

## Data attributes

You can target and override `Filter` styles using the following data attributes:

`data-fs-filter`

`data-fs-filter-title`

`data-fs-filter-accordion`

`data-fs-filter-accordion-item`

`data-fs-filter-list`

`data-fs-filter-list-item`

`data-fs-filter-list-item-checkbox`

`data-fs-filter-list-item-label`

`data-fs-filter-list-item-badge`

`data-fs-filter-facet-range`

---

## Props

### Filter

| Name                    | Type                    | Description                                                                            | Default |
| ----------------------- | ----------------------- | -------------------------------------------------------------------------------------- | ------- |
| **testId\***            | string                  | ID to find this component in testing tools (e.g.: cypress, testing-library, and jest). |         |
| **title**               | string                  | Title for the \`Filter\` component.                                                    |         |
| **indicesExpanded\***   | Set<number>             | The expanded items from the \`Accordion\`.                                             |         |
| **onAccordionChange\*** | (index: number) => void | This function is called when \`Accordion\` is expanded or collapsed.                   |         |

### FilterFacets

| Name            | Type   | Description                                                                            | Default |
| --------------- | ------ | -------------------------------------------------------------------------------------- | ------- |
| **testId\***    | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). |         |
| **index\***     | number | Current Facet's position in a list of facets.                                          |         |
| **type\***      | string | Current Facet's type, usually \`StoreFacetBoolean\` or \`StoreFacetRange\`.            |         |
| **label\***     | string | The text displayed to identify the Facet.                                              |         |
| **description** | string | The description displayed to identify the Facet.                                       |         |

### FilterFacetBooleanItem

| Name                | Type                  | Description                                                                            | Default  |    |                          |                             |                     |             |                                                        |
| ------------------- | --------------------- | -------------------------------------------------------------------------------------- | -------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | ------------------------------------------------------ |
| **testId\***        | string                | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). |          |    |                          |                             |                     |             |                                                        |
| **label\***         | string \| number      | false                                                                                | true     | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | The text displayed to identify the Boolean Facet Item. |
| **value\***         | string                | Value to be emitted when Checkbox is clicked.                                          |          |    |                          |                             |                     |             |                                                        |
| **selected\***      | false \| true         | Boolean that represents the Checkbox checked state.                                    |          |    |                          |                             |                     |             |                                                        |
| **quantity**        | number                | Counter badge shown besides the Facet Item.                                            |          |    |                          |                             |                     |             |                                                        |
| **id\***            | string                | ID to identify the Checkbox and corresponding label.                                   |          |    |                          |                             |                     |             |                                                        |
| **facetKey\***      | string                | String that identifies the current Facet key.                                          |          |    |                          |                             |                     |             |                                                        |
| **onFacetChange\*** | OnFacetChange         | This function is called when \`Checkbox\` from the facet changes.                      |          |    |                          |                             |                     |             |                                                        |
| **type**            | "checkbox" \| "radio" | Type of the Facet Item.                                                                | checkbox |    |                          |                             |                     |             |                                                        |

### FilterFacetRange

| Name                | Type                                    | Description                                                             | Default |
| ------------------- | --------------------------------------- | ----------------------------------------------------------------------- | ------- |
| **min\***           | { selected: number; absolute: number; } | The minimum value of the Slider Range Facet                             |         |
| **max\***           | { selected: number; absolute: number; } | The maximum value of the Slider Range Facet                             |         |
| **facetKey\***      | string                                  | String that identifies the current Facet key.                           |         |
| **formatter\***     | (value: number) => string               | Formatter function that transforms the raw value and render the result. |         |
| **onFacetChange\*** | OnFacetChange                           | This function is called when \`Checkbox\` from the facet changes.       |         |

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/filter.mdx)

[FilterSlider« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter-slider)[HeroNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-hero)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-styles)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23design-tokens)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23title)[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion)[Accordion Item Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-button)[Accordion Item Panel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-panel)[Accordion Item List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-list)[List Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item)[List Item Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-checkbox)[List Item Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-label)[List Item Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-badge)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23data-attributes)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23props)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filter)[FilterFacets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacets)[FilterFacetBooleanItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetbooleanitem)[FilterFacetRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetrange)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/organisms/filter.mdx)

Copy page

On this page

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23import-styles)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23design-tokens)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23title)[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion)[Accordion Item Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-button)[Accordion Item Panel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-panel)[Accordion Item List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23accordion-item-list)[List Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item)[List Item Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-checkbox)[List Item Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-label)[List Item Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23list-item-badge)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23data-attributes)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23props)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filter)[FilterFacets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacets)[FilterFacetBooleanItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetbooleanitem)[FilterFacetRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-filter/docs/guides/faststore/organisms-filter%23filterfacetrange)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)