Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: incorporate chakra type generation in the workflow #1207

Merged
merged 9 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,22 @@ cd <project directory>
npm link ../smg-automotive-components-pkg
```

### Type generation

Chakra UI provides type generation for tokens. This is incorporated into the `typegen` script.
If you're adding new tokens you will need to re-generate the types:

```bash
$ npm run typegen
```

If you're heavily modifying the theme you can watch the changes with:
```bash
$ npm run typegen:watch
```

Since re-installing chakra ui will clean the generated types we're running the type generation as a post-install script.

## Theming

As agreed upon in the [RFC](https://github.com/smg-automotive/au-docs/discussions/3) we will handle the differences between AS24 and MS24 with two different themes. They can be then used via a theme provider that needs to wrap the application:
Expand Down
Loading