| id | title |
|---|---|
adding-typescript |
Adding TypeScript |
Note: this feature is available with
react-scripts@2.1.0and higher.
TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
To start a new Create React App project with TypeScript, you can run:
npx create-react-app my-app --template typescript
# or
yarn create react-app my-app --template typescriptIf you've previously installed
create-react-appglobally vianpm install -g create-react-app, we recommend you uninstall the package usingnpm uninstall -g create-react-appto ensure thatnpxalways uses the latest version.Global installs of
create-react-appare no longer supported.
To add TypeScript to a Create React App project, first install it:
npm install --save typescript @types/node @types/react @types/react-dom @types/jest
# or
yarn add typescript @types/node @types/react @types/react-dom @types/jestNext, rename any file to be a TypeScript file (e.g. src/index.js to src/index.tsx) and restart your development server!
Type errors will show up in the same console as the build one. You'll have to fix these type errors before you continue development or build your project. For advanced configuration, see here.
You are not required to make a tsconfig.json file, one will be made for you. You are allowed to edit the generated TypeScript configuration.
- TypeScript Handbook
- TypeScript Example on React
- React + TypeScript Cheatsheets has a good overview on how to use React with TypeScript
If your project is not created with TypeScript enabled, npx may be using a cac
56BD
hed version of create-react-app. Remove previously installed versions with npm uninstall -g create-react-app (see #6119).
If you are currently using create-react-app-typescript, see this blog post for instructions on how to migrate to Create React App.
Constant enums and namespaces are not supported, you can learn about the constraints of using Babel with TypeScript here.