This project serves as a compilation of examples that highlight the fundamental features of our framework. It is designed to complement our official documentation, providing users with practical demonstrations of how to leverage from FastStore framework.
Here you'll find examples of the following features:
The repository contains folders/files with code examples for the features mentioned above.
Follow Along with Documentation: As you run the examples, refer to the documentation to understand the concepts and implementation details of each part of the code. The documentation will guide you through the expected output and any configurations needed.
Experiment and Modify: Feel free to experiment with the code examples by making modifications. This will help you gain a deeper understanding of how each feature works.
Clone the repository in your local machine and start exploring:
- Open your terminal and clone the repository to your local machine by running the following command:
git clone https://github.com/vtex-sites/playground.store.git
- Navigate to the repository directory:
cd playground.store
- Install the necessary dependencies:
yarn install
- Run the application:
yarn dev
Overrides allow you to replace native components within sections with custom ones. This maintains the core functionalities of native components while allowing you to adjust their appearance and behavior to suit the needs of your store.
This example illustrates a common use case for getOverriddenSection in FastStore. It focuses on customizing the Headless CMS schema for a section to provide more icon options.
Add more icon options to the Alert, allowing editors to choose from a wider selection of icons supported by the @faststore/ui iconography library.
The native Alert section provides an icon prop for customization. It only accepts predefined icons, but you want more control and flexibility over the displayed content. In this example, we'll display a custom image instead.
If you need to retrieve data not natively provided by the FastStore API, you can achieve this by extending the FastStore API schema and incorporating new data into the existing queries.
This example illustrates the case where customers can see installment details (number, value, payment system) directly on the product page.
This example illustrates how to handle data from a Contact Us form and send it to a third-party API. We will create a Contact Us page with a Contact form.
In this project, we'll be using the following naming conventions:
- Stylesheet file names: kebab-case, e.g.,
custom-button.module.scss - Component files and Component exports: PascalCase, e.g.,
CustomButton.tsxandCustomButton - Function exports: camelCase, e.g.,
getCustomsButtonVariants - Constants: snake_case, e.g.,
BUTTON_VARIANTS