From f2296e02452dbfa60f2a72da56995a36a12dae64 Mon Sep 17 00:00:00 2001 From: ggdawson <37080130+ggdawson@users.noreply.github.com> Date: Thu, 1 Feb 2024 16:33:09 -0700 Subject: [PATCH] docs: add tsconfig note to @carbon/react README.md --- .all-contributorsrc | 9 +++++++++ README.md | 3 ++- packages/react/README.md | 19 +++++++++++++++++++ 3 files changed, 30 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 7d58177cff28..ca7d3bd37b89 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1406,6 +1406,15 @@ "contributions": [ "code" ] + }, + { + "login": "ggdawson", + "name": "Garrett Dawson", + "avatar_url": "https://avatars.githubusercontent.com/u/37080130?v=4", + "profile": "https://github.com/ggdawson", + "contributions": [ + "doc" + ] } ], "commitConvention": "none" diff --git a/README.md b/README.md index 3636d7c35e58..4eba264e5497 100644 --- a/README.md +++ b/README.md @@ -271,8 +271,9 @@ check out our [Contributing Guide](/.github/CONTRIBUTING.md) and our
SamChinellato

💻
stevenpatrick009

💻
HunterXalc

💻 -
Alexandr Ovchinnikov

💻
Matias Borghi

💻 +
Alexandr Ovchinnikov

💻 +
Garrett Dawson

📖 diff --git a/packages/react/README.md b/packages/react/README.md index 09bb47c58110..231335eee797 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -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