@vtex-miss/styleguide-types

Motivation

In my day to day work with VTEX IO I use the lib vtex.styleguide a lot and i like to use Typescript, but the lib doesn't have all types defined. The oficial lib looks like than stoped to be maintained, so i decided to create this lib to help me and maybe help you too.

Usage

Access you react directory and install the lib:

yarn add @vtex-miss/styleguide-types

How this lib is only types, you need to guarantee that the lib vtex.styleguide@6.x is in your manifest.json in your VTEX IO APP.

{
  "dependencies": {
    // ...
    "vtex.styleguide": "6.x"
  }
}

includes this type in your tsconfig to overwrite the natives types

// tsconfig.json
{
  "compilerOptions": {
    // ...
    "include": [
      // ... 
      "node_modules/@vtex-miss/styleguide-types/src/index.d.ts"
    ]
  }
}