README.md

Container

Description

Container is a VTEX component that is used to wrap code, applying custom styles in the process. Is used throughout the apps in the store to apply similar behavior. This component can be imported and used by any VTEX app.

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

Table of Contents

• Usage
  • Configuration
  • Styles API
    • CSS Namespaces

Usage

You should follow the usage instruction in the main README.

To import it into your code:

import { Container } from 'vtex.store-components'

You can use it in your code like a React component with the jsx tag: <Container>.

<Container className="my-section">
  My content
</Container>

Configuration

Prop name	Type	Description
className	String	The tachyons classes to be applied in the container
children	Node	The content to be wrapped

Styles API

You should follow the Styles API instruction in the main README.

CSS Namespaces

For now this component does not have any css namespaces.