$3

> VTEX Styleguide React components (Docs)

- Usage
- Developing
- Setup
- Running
- Snapshots
- Developing using npm link
- Publishing
- Docs

Usage

$3

Add the styleguide to dependencies on manifest.json:

``sh
"dependencies": {
"vtex.styleguide": "5.x"
},
`

Importing components:

`js
import { Button } from 'vtex.styleguide'
`

$3

`sh
yarn add @vtex/styleguide --exact


or


npm install @vtex/styleguide --save-exact
`

Importing components:

`js
import Button from '@vtex/styleguide/lib/Button'
`

Developing

$3

`sh
yarn install
`

$3

`sh
yarn styleguide
`

$3

To save the components snapshots use:

`sh
yarn snap:test
`

Check the snapshots and to approve the changes use:

`sh
yarn snap:approve
`

You can use the option --filter to just test or approve a specific component. Example:

`sh
yarn snap:approve --filter "Button"
`

Developing using npm link

Run this in this repo:

`sh
yarn develop
`

In your project run:

`
npm link @vtex/styleguide
`

Import (case a component in lib):

`js
import Button from '@vtex/styleguide/lib/Button'
`

$3

We use releasy to publish our styleguide. To publish on both npm and render(VTEX IO), execute the command below:

`sh
releasy --stable --npm
`

Also, if you want to post the changelog on Github Release Notes, is required to configure a Personal Token. See more here. When you have the environment set, add a --notes flag, For example:

`sh
releasy --stable --npm --notes
`

$3

To update the docs:

`sh
yarn deploy
``

#### Known issues

* Your project has to run with webpack >= 2. Here's a guide for upgrading Webpack to v2.