Skip to content

Commit

Permalink
Merge pull request #253 from zopaUK/docs/212-exported-types
Browse files Browse the repository at this point in the history
Document how to access typings πŸ•΅πŸ»β€β™‚οΈ
  • Loading branch information
ubbe-xyz committed Mar 12, 2020
2 parents 128f36e + 018e140 commit 8819fb4
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,16 @@ The aim of this project is to share with the frontend community how we code in Z

We think it might be useful for someone who wants to start a new react components library and want to re-use some of our code.

### Migration
### Types

- Check [how to migrate to v2](./etc/docs/migration-v2.md) πŸƒπŸ»
You can access typings for specific components under `@zopauk/react-components/types`:

```tsx
import { Button } from '@zopauk/react-components';
import { IButtonProps } from '@zopauk/react-components/types/components/atoms/Button';
```

To inspect the folder structure within `@zopauk/react-components/types` you can run `yarn compile:types` and navigate the generated `types/` folder in the project root.

## Contributing

Expand Down

0 comments on commit 8819fb4

Please sign in to comment.