使用 Vite 创建 React+TS+SW 项目并整合 AntDesign 、Scss 等组件或插件

简介: 本文记录了如何使用Vite创建一个React+TypeScript+Service Workers(SW)项目,并整合AntDesign组件库和Scss等插件,包括项目的创建、配置问题解决、AntDesign和Scss的整合方法。

前言

记录一下使用 Vite 创建 React+TS+SW 项目并整合 AntDesign 、Scss 等组件或插件。

一、使用 Vite 创建 React+TS+SW 项目

1.新建一个 temp 文件夹

(1)在桌面新建一个 temp 文件夹,然后在 VS Code 中打开此文件夹,打开一个终端;

2.创建一个 Vite 项目工程

(1)具体操作如下:

npm create vite@latest

(1) 输入项目名,如: vite-react-ts-scss-ant_design ,然后回车
? Project name: » vite-react-ts-scss-ant_design

(2) 选择 React 框架,回车
? Select a framework: » - Use arrow-keys. Return to submit.
    Vanilla
    Vue
>   React
    Preact
    Lit
    Svelte
    Others

(3) 选择数据类型,回车
? Select a variant: » - Use arrow-keys. Return to submit.
    TypeScript
>   TypeScript + SWC
    JavaScript
    JavaScript + SWC

(4) 创建完成,运行项目
Done. Now run: 

  cd vite-react-ts-scss-ant_design
  npm install
  npm run dev

二、解决一下配置问题

(1)找不到模块“vite”。你的意思是要将 \"moduleResolution\" 选项设置为 \"node\",还是要将别名添加到 \"paths\" 选项中?

(2)找不到模块“path”或其相应的类型声明。(执行 npm i @types/node -D 即可)

(3)未设置 "baseUrl" 时,不允许使用非相对路径。是否忘记了前导 "./"?

(4)解决方法,修改一下 vite.config.js、tsconfig.json、tsconfig.node.json 这三个配置文件即可。

【修改前】

vite.config.js

import {
    defineConfig } from 'vite'
import react from '@vitejs/plugin-react-swc'

// https://vitejs.dev/config/
export default defineConfig({
   
  plugins: [react()],
})

tsconfig.json

{
   
  "compilerOptions": {
   
    "target": "ES2020",
    "useDefineForClassFields": true,
    "lib": ["ES2020", "DOM", "DOM.Iterable"],
    "module": "ESNext",
    "skipLibCheck": true,

    /* Bundler mode */
    "moduleResolution": "bundler",
    "allowImportingTsExtensions": true,
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx",

    /* Linting */
    "strict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noFallthroughCasesInSwitch": true
  },
  "include": ["src"],
  "references": [{
    "path": "./tsconfig.node.json" }]
}

tsconfig.node.json

{
   
  "compilerOptions": {
   
    "composite": true,
    "skipLibCheck": true,
    "module": "ESNext",
    "moduleResolution": "bundler",
    "allowSyntheticDefaultImports": true
  },
  "include": ["vite.config.ts"]
}

【修改后】

vite.config.js

import {
    defineConfig } from 'vite'
import react from '@vitejs/plugin-react-swc'
import {
    resolve } from 'path'

// https://vitejs.dev/config/
export default defineConfig({
   
  plugins: [react()],
  resolve: {
   
    alias: {
   
      '@': resolve(__dirname, './src'),
    }
  },
})

tsconfig.json

{
   
  "compilerOptions": {
   
    "target": "ES2020",
    "useDefineForClassFields": true,
    "lib": ["ES2020", "DOM", "DOM.Iterable"],
    "module": "ESNext",
    "skipLibCheck": true,

    /* Bundler mode */
    "moduleResolution": "Node",
    "allowSyntheticDefaultImports": true,
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "baseUrl": ".", // 未设置 "baseUrl" 时,不允许使用非相对路径。是否忘记了前导 "./"?
    "jsx": "react-jsx",
    "paths": {
   
      "@": ["src"],
      "@/*": ["src/*"]
    },

    /* Linting */
    "strict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noFallthroughCasesInSwitch": true
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src"],
  "references": [{
    "path": "./tsconfig.node.json" }]
}

tsconfig.node.json

{
   
  "compilerOptions": {
   
    "composite": true,
    "skipLibCheck": true,
    "module": "ESNext",
    "moduleResolution": "Node",
    "allowSyntheticDefaultImports": true
  },
  "include": ["vite.config.ts"]
}

三、整合 AntDesign 框架/UI组件库

1.导入依赖

npm i antd -D

2.按需引入

(1)修改 src/App.tsx,如引入 antd 的按钮组件,保存即可在页面看到效果。

import React from 'react'
import {
    Button } from 'antd'

const App = () => (
  <div className="App">
    <Button type="primary">Button</Button>
  </div>
)

export default App

四、整合 SCSS 插件

1.导入依赖

npm i sass -D
npm i scss -D

2.使用方式

(1)例如对 App.tsx 进行使用,首先修改 App.tsx 文件,然后新建 App.module.scss 文件,将 scss 样式引入 App.tsx 文件即可。

App.tsx

import {
    Button } from 'antd'
import style from './App.module.scss'

function App() {
   
  return (
    <>
      <div className={
   style.appContainer}>
        <div className={
   style.box}>
          <h1 className={
   style.welcome}>Vite + React</h1>
          <Button type="primary">Button</Button>
        </div>
      </div>
    </>
  )
}

export default App

App.module.scss

.appContainer {
   
  position: relative;
  width: 100%;
  height: 100%;
  overflow: hidden;
  text-align: center;

  .box {
   
    display: inline-table;
    width: 100%;
    height: auto;
    position: absolute;
    margin: auto;
    left: 0;
    right: 0;
    top: 0;
    bottom: 0;

    .welcome {
   
      padding-bottom: 10px;
      color: rgb(0, 255, 115);
      font-weight: normal;
    }

    :global(.ant-btn) {
   
      width: 250px;
    }
  }
}

到此项目整合完毕,传送门如下。

vite-react-ts-scss-ant_design: 这是一个基于 Vite 构建的 React + TS 项目,以及整合了 Scss、AntDesign5 等组件或插件。

目录
相关文章
|
5天前
|
前端开发 Java API
React 进度条组件 ProgressBar 详解
本文介绍了如何在 React 中创建进度条组件,从基础实现到常见问题及解决方案,包括动态更新、状态管理、性能优化、高级动画效果和响应式设计等方面,帮助开发者构建高效且用户体验良好的进度条。
32 18
|
19天前
|
存储 前端开发 测试技术
React组件的最佳实践
React组件的最佳实践
|
18天前
|
前端开发 API 开发者
React 文件上传组件 File Upload
本文详细介绍了如何在 React 中实现文件上传组件,从基础的文件选择和上传到服务器,再到解决文件大小、类型限制、并发上传等问题,以及实现多文件上传、断点续传和文件预览等高级功能,帮助开发者高效构建可靠的应用。
47 12
|
13天前
|
存储 前端开发 JavaScript
React 表单输入组件 Input:常见问题、易错点及解决方案
本文介绍了在 React 中使用表单输入组件 `Input` 的基础概念,包括受控组件与非受控组件的区别及其优势。通过具体代码案例,详细探讨了创建受控组件、处理多个输入字段、输入验证和格式化的方法,并指出了常见易错点及避免方法,旨在提升表单的健壮性和用户体验。
25 4
|
20天前
|
前端开发 JavaScript API
React 文件下载组件 File Download
本文介绍了在React中实现文件下载组件的方法,包括使用`a`标签和JavaScript动态生成文件,解决了文件路径、文件类型、大文件下载及文件名乱码等问题,并展示了使用第三方库`file-saver`和生成CSV文件的高级用法。
31 6
|
17天前
|
前端开发 JavaScript API
React 文件下载组件:File Download
本文详细介绍了如何在React应用中实现文件下载组件,包括基本概念、实现步骤和代码示例。同时,探讨了常见问题如文件类型不匹配、文件名乱码等及其解决方法,旨在提升用户体验和代码可维护性。
34 2
|
21天前
|
存储 前端开发 JavaScript
React 文件上传组件 File Upload
本文介绍了如何在 React 中实现文件上传组件,包括基本的概念、实现步骤、常见问题及解决方案。通过 `&lt;input type=&quot;file&quot;&gt;` 元素选择文件,使用 `fetch` 发送请求,处理文件类型和大小限制,以及多文件上传和进度条显示等高级功能,帮助开发者构建高效、可靠的文件上传组件。
55 2
|
1月前
|
前端开发 JavaScript 开发者
颠覆传统:React框架如何引领前端开发的革命性变革
【10月更文挑战第32天】本文以问答形式探讨了React框架的特性和应用。React是一款由Facebook推出的JavaScript库,以其虚拟DOM机制和组件化设计,成为构建高性能单页面应用的理想选择。文章介绍了如何开始一个React项目、组件化思想的体现、性能优化方法、表单处理及路由实现等内容,帮助开发者更好地理解和使用React。
75 9
|
2月前
|
前端开发
深入解析React Hooks:构建高效且可维护的前端应用
本文将带你走进React Hooks的世界,探索这一革新特性如何改变我们构建React组件的方式。通过分析Hooks的核心概念、使用方法和最佳实践,文章旨在帮助你充分利用Hooks来提高开发效率,编写更简洁、更可维护的前端代码。我们将通过实际代码示例,深入了解useState、useEffect等常用Hooks的内部工作原理,并探讨如何自定义Hooks以复用逻辑。
|
22天前
|
监控 前端开发 数据可视化
3D架构图软件 iCraft Editor 正式发布 @icraft/player-react 前端组件, 轻松嵌入3D架构图到您的项目,实现数字孪生
@icraft/player-react 是 iCraft Editor 推出的 React 组件库,旨在简化3D数字孪生场景的前端集成。它支持零配置快速接入、自定义插件、丰富的事件和方法、动画控制及实时数据接入,帮助开发者轻松实现3D场景与React项目的无缝融合。
82 8
3D架构图软件 iCraft Editor 正式发布 @icraft/player-react 前端组件, 轻松嵌入3D架构图到您的项目,实现数字孪生