在 TypeScript 中使用

    请确保电脑上已经安装了最新版的 或者 npm

    使用 yarn 创建 项目。

    如果你使用的是 npm(接下来我们都会用 yarn 作为例子,如果你习惯用 npm 也没问题)。

    1. $ npx create-react-app antd-demo-ts --typescript

    然后我们进入项目并启动。

    1. $ cd antd-demo-ts
    2. $ yarn start

    此时浏览器会访问 http://localhost:3000/ ,看到 Welcome to React 的界面就算成功了。

    1. $ yarn add antd

    修改 src/App.tsx,引入 antd 的按钮组件。

    修改 src/App.css,在文件顶部引入 antd 的样式。

      antd 使用 TypeScript 书写并提供了完整的定义,你可以享受组件属性输入建议和定义检查的功能。

      这个例子在实际开发中还有一些优化的空间,比如无法进行主题配置。

      此时我们需要对 create-react-app 的默认配置进行自定义,这里我们使用 (一个对 create-react-app 进行自定义配置的社区解决方案)。

      现在我们安装 craco 并修改 package.json 里的 scripts 属性。

      1. $ yarn add @craco/craco
      1. /* package.json */
      2. "scripts": {
      3. - "start": "react-scripts start",
      4. - "build": "react-scripts build",
      5. - "test": "react-scripts test",
      6. + "start": "craco start",
      7. + "build": "craco build",
      8. + "test": "craco test",

      然后在项目根目录创建一个 用于修改默认配置。

      按照 配置主题 的要求,自定义主题需要用到类似 提供的 less 变量覆盖功能。我们可以引入 craco-antd 来帮助加载 less 样式和修改变量。

      1. /* src/App.ts */
      2. - import './App.css';
      3. + import './App.less';
      1. /* src/App.less */
      2. - @import '~antd/dist/antd.css';

      然后安装 craco-antd 并修改 craco.config.js 文件如下。

      1. $ yarn add craco-antd

      这里利用了 的 modifyVars 来进行主题配置,变量和其他配置方式可以参考 配置主题 文档。修改后重启 yarn start,如果看到一个绿色的按钮就说明配置成功了。

      antd 内建了深色主题和紧凑主题,你可以参照 进行接入。

      如果你已经按照 在 create-react-app 中使用 初始化了环境,可以参考官方文档里的 配置 TypeScript 开发环境。