Horizon UI TypeScript 项目教程

1. 项目的目录结构及介绍

horizon-ui-chakra-ts/
├── public/
│   ├── index.html
│   └── ...
├── src/
│   ├── assets/
│   ├── components/
│   ├── layouts/
│   ├── pages/
│   ├── styles/
│   ├── App.tsx
│   ├── index.tsx
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── prettier.config.js
└── tsconfig.json

目录结构介绍

• public/: 存放静态资源文件，如 index.html。
• src/: 项目的源代码目录，包含以下子目录：
  • assets/: 存放静态资源，如图片、字体等。
  • components/: 存放React组件。
  • layouts/: 存放页面布局组件。
  • pages/: 存放页面组件。
  • styles/: 存放样式文件。
  • App.tsx: 应用的主组件。
  • index.tsx: 项目的入口文件。
• .gitignore: Git忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目的依赖和脚本配置。
• prettier.config.js: Prettier代码格式化配置。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

index.tsx

index.tsx 是项目的入口文件，负责渲染应用的主组件 App.tsx 到 public/index.html 中的 root 元素。

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
  document.getElementById('root')
);

App.tsx

App.tsx 是应用的主组件，负责组织和渲染整个应用的UI结构。

import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import Home from './pages/Home';
import About from './pages/About';

function App() {
  return (
    <Router>
      <Switch>
        <Route path="/" exact component={Home} />
        <Route path="/about" component={About} />
      </Switch>
    </Router>
  );
}

export default App;

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "horizon-ui-chakra-ts",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3",
    "chakra-ui": "^1.6.5"
  },
  "devDependencies": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3",
    "typescript": "^4.3.2"
  }
}

tsconfig.json

tsconfig.json 文件是TypeScript的配置文件，定义了TypeScript编译器的选项。

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noFallthroughCasesInSwitch": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx"
  },
  "include": ["src"]
}

prettier.config.js

prettier.config.js 文件是Prettier代码格式化工具的配置文件。

module.exports = {
  singleQuote: true,
  trailingComma: 'all',
  printWidth: 80,
  tabWidth: 2,
};

通过以上配置，你可以快速启动和配置Horizon UI TypeScript项目，开始构建你的Web应用。