More Premium Hugo Themes Premium React Themes

Styleguide

The VTEX Design System and React component library.

Styleguide

The VTEX Design System and React component library.

Author Avatar Theme by vtex
Github Stars Github Stars: 168
Last Commit Last Commit: Aug 20, 2024 -
First Commit Created: Apr 29, 2023 -
default image

Overview:

The VTEX Styleguide is a project built for React components that can be used with both npm and VTEX IO. It includes a range of features and provides a guide for usage, developing, testing, and publishing.

Features:

  • React components for building user interfaces
  • Integration with Storybook environment for real-time component editing and testing
  • Support for developing new tests with react-testing-library

Installation:

To install the VTEX Styleguide in your project, follow these steps:

  1. Run the following command in the repository folder:
npm install styleguide
  1. In your project, import the desired components from the lib folder:
import Button from 'styleguide/Button'

Summary:

The VTEX Styleguide is a comprehensive tool for developers working with React components. It offers a range of features, including customizable icons and integration with the Storybook environment for real-time component editing and testing. The installation process is straightforward, using npm to install the package. With the provided documentation and resources, developers can easily utilize and incorporate the VTEX Styleguide into their projects.