Skip to content

Commit

Permalink
docs: Add tsconfig note to @carbon/react README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ggdawson committed Feb 1, 2024
1 parent 69a6edb commit c35333e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,25 @@ to include `node_modules` in its `includePaths` option. For more information,
checkout the [configuration](../styles/docs/sass.md#configuration) section in
our Sass docs.

### TypeScript

There is an ongoing project to add `*.d.ts` files to `@carbon/react`. Though not
all components have yet been typed, you can still use the project successfully
in a TypeScript setting, provided you amend to your `tsconfig.json` or
equivalent configuration file. Include the `skipLibCheck: true` compiler option:

```json
{
"compilerOptions": {
"skipLibCheck": true
}
}
```

To track the progress of TypeScript adoption, check out:

- [TypeScript Adoption](https://github.com/orgs/carbon-design-system/projects/53)

## Usage

The `@carbon/react` package provides components and icons for the Carbon Design
Expand Down

0 comments on commit c35333e

Please sign in to comment.