mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-27 12:39:49 +08:00
docs: add farm with antd (#48923)
Co-authored-by: liangchaofei <liangchaofei@liangchaofeideMacBook-Pro.local>
This commit is contained in:
parent
89e50e2994
commit
08e39ba2e4
71
docs/react/use-with-farm.en-US.md
Normal file
71
docs/react/use-with-farm.en-US.md
Normal file
@ -0,0 +1,71 @@
|
||||
---
|
||||
group:
|
||||
title: Basic Usage
|
||||
order: 6
|
||||
title: Usage with Farm
|
||||
tag: New
|
||||
---
|
||||
|
||||
[Farm](https://www.farmfe.org/) is a Rust-Based Web Building Engine to Facilitate Your Web Program and JavaScript Library. This article will try to use `Farm` to create a project and import antd.
|
||||
|
||||
## Install and Initialization
|
||||
|
||||
Before all start, you may need install [yarn](https://github.com/yarnpkg/yarn) or [pnpm](https://pnpm.io) or [bun](https://bun.sh).
|
||||
|
||||
<InstallDependencies npm='$ npm create farm@latest' yarn='$ yarn create farm@latest' pnpm='$ pnpm create farm@latest' bun='$ bun create farm@latest'></InstallDependencies>
|
||||
|
||||
During the initialization process, `farm` provides a series of templates for us to choose, We need choose the `React` template.
|
||||
|
||||
The tool will create and initialize environment and dependencies automatically, please try config your proxy setting or use another npm registry if any network errors happen during it.
|
||||
|
||||
Then we go inside project and start it.
|
||||
|
||||
```bash
|
||||
$ cd farm-project
|
||||
$ npm install
|
||||
$ npm start
|
||||
```
|
||||
|
||||
Open the browser at http://localhost:9000. It renders a title saying `Farm with React` on the page, which is considered successful.
|
||||
|
||||
## Import antd
|
||||
|
||||
Now we install `antd` from yarn or npm or pnpm or bun.
|
||||
|
||||
<InstallDependencies npm='$ npm install antd --save' yarn='$ yarn add antd' pnpm='$ pnpm install antd --save' bun='$ bun add antd'></InstallDependencies>
|
||||
|
||||
Modify `src/main.tsx`, import Button component from `antd`.
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { Button } from 'antd';
|
||||
|
||||
export function Main() {
|
||||
return (
|
||||
<div>
|
||||
<Button type="primary">Button</Button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
OK, you should now see a blue primary button displayed on the page. Next you can choose any components of `antd` to develop your application. Visit other workflows of `Farm` at its [Official documentation](https://www.farmfe.org).
|
||||
|
||||
### Customize Theme
|
||||
|
||||
Ref to the [Customize Theme documentation](/docs/react/customize-theme). Modify theme with ConfigProvider:
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { Button, ConfigProvider } from 'antd';
|
||||
|
||||
export function Main() {
|
||||
return (
|
||||
<ConfigProvider theme={{ token: { colorPrimary: '#00b96b' } }}>
|
||||
<Button type="primary">Button</Button>
|
||||
</ConfigProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
We are successfully running the antd components using Rsbuild now, let’s start build your own application!
|
71
docs/react/use-with-farm.zh-CN.md
Normal file
71
docs/react/use-with-farm.zh-CN.md
Normal file
@ -0,0 +1,71 @@
|
||||
---
|
||||
group:
|
||||
title: 如何使用
|
||||
order: 6
|
||||
title: 在 Farm 中使用
|
||||
tag: New
|
||||
---
|
||||
|
||||
[Farm](https://www.farmfe.org/) 是一个基于 Rust 实现的极速构建引擎,帮助您更快地构建 Web 程序 和 JavaScript 库,本文会尝试使用 `Farm` 创建一个项目,并引入 antd。
|
||||
|
||||
## 安装和初始化
|
||||
|
||||
在开始之前,你可能需要安装 [yarn](https://github.com/yarnpkg/yarn) 或者 [pnpm](https://pnpm.io/zh) 或者 [bun](https://bun.sh)。
|
||||
|
||||
<InstallDependencies npm='$ npm create farm@latest' yarn='$ yarn create farm@latest' pnpm='$ pnpm create farm@latest' bun='$ bun create farm@latest'></InstallDependencies>
|
||||
|
||||
在初始化的过程中,`farm` 提供了一系列模板供我们选择,这里我们选择 `React` 模板。
|
||||
|
||||
工具会自动初始化一个脚手架并安装 React 项目的各种必要依赖,如果在过程中出现网络问题,请尝试配置代理或使用其他 npm registry。
|
||||
|
||||
然后我们进入项目并启动。
|
||||
|
||||
```bash
|
||||
$ cd farm-project
|
||||
$ npm install
|
||||
$ npm start
|
||||
```
|
||||
|
||||
此时访问浏览器 http://localhost:9000, 看到 `Farm with React` 的界面就算成功了。
|
||||
|
||||
## 引入 antd
|
||||
|
||||
现在从 yarn 或 npm 或 pnpm 或 bun 安装并引入 antd。
|
||||
|
||||
<InstallDependencies npm='$ npm install antd --save' yarn='$ yarn add antd' pnpm='$ pnpm install antd --save' bun='$ bun add antd'></InstallDependencies>
|
||||
|
||||
修改 `src/main.tsx`,引入 antd 的 Button 组件。
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { Button } from 'antd';
|
||||
|
||||
export function Main() {
|
||||
return (
|
||||
<div>
|
||||
<Button type="primary">Button</Button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
好了,现在你应该能看到页面上已经有了 antd 的蓝色按钮组件,接下来就可以继续选用其他组件开发应用了。其它开发流程你可以参考 Farm 的[官方文档](https://www.farmfe.org/zh/)。
|
||||
|
||||
### 自定义主题
|
||||
|
||||
参考 [配置主题](/docs/react/customize-theme),通过 ConfigProvider 进行主题配置:
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { Button, ConfigProvider } from 'antd';
|
||||
|
||||
export function Main() {
|
||||
return (
|
||||
<ConfigProvider theme={{ token: { colorPrimary: '#00b96b' } }}>
|
||||
<Button type="primary">Button</Button>
|
||||
</ConfigProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
我们现在已经把 antd 组件成功使用 Farm 运行起来了,开始开发你的应用吧!
|
Loading…
Reference in New Issue
Block a user