diff --git a/docs/react/customize-theme.en-US.md b/docs/react/customize-theme.en-US.md index 04cb08f06d..2b2b4fddf6 100644 --- a/docs/react/customize-theme.en-US.md +++ b/docs/react/customize-theme.en-US.md @@ -113,7 +113,7 @@ It's possible to configure webpack to load an alternate less file: ```ts new webpack.NormalModuleReplacementPlugin( /node_modules\/antd\/lib\/style\/index\.less/, path.resolve(rootDir, 'src/myStylesReplacement.less') ) -#antd { @import '~antd/lib/style/core/index.less'; @import '~antd/lib/style/themes/default.less'; } +#antd { @import '~antd/es/style/core/index.less'; @import '~antd/es/style/themes/default.less'; } ``` Where the src/myStylesReplacement.less file loads the same files as the index.less file, but loads them within the scope of a top-level selector : the result is that all of the "global" styles are being applied with the #antd scope. diff --git a/docs/react/faq.en-US.md b/docs/react/faq.en-US.md index f0d0193c7f..5baf1b503a 100644 --- a/docs/react/faq.en-US.md +++ b/docs/react/faq.en-US.md @@ -13,7 +13,7 @@ No, actually, you can convert Less to Sass/Stylus(etc...) with tools (which you ### `Select Dropdown DatePicker TimePicker Popover Popconfirm` disappear when I click another popup component inside it, How to resolve it? -This has been fixed since 3.11.x. If you're still using old version, you can use ` trigger.parentNode}>` to render component inside Popover. (Or other getXxxxContainer props) https://ant.design/components/select/#Select-props @@ -44,8 +44,8 @@ You can override its style, but we don't recommend doing so. antd is not only a Try [babel-plugin-import](https://github.com/ant-design/babel-plugin-import), or import what you need in this way: ```jsx -import Menu from 'antd/lib/menu'; -import 'antd/lib/menu/style/css'; +import Menu from 'antd/es/menu'; +import 'antd/es/menu/style/css'; ``` or (ES6 way with tree shaking): diff --git a/docs/react/faq.zh-CN.md b/docs/react/faq.zh-CN.md index 086a6be067..089752b539 100644 --- a/docs/react/faq.zh-CN.md +++ b/docs/react/faq.zh-CN.md @@ -13,7 +13,7 @@ title: FAQ ### 当我点击 `Select Dropdown DatePicker TimePicker Popover Popconfirm` 内的另一个 popup 组件时它会消失,如何解决? -该问题在 3.11.0 后已经解决。如果你仍在使用旧版本,你可以通过 ` trigger.parentNode}>` 来在 Popover 中渲染组件,或者使用其他的 getXxxxContainer 参数。 https://ant.design/components/select/#Select-props @@ -44,8 +44,8 @@ https://ant.design/components/select/#Select-props 试试 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import),或者用下面这种方式来按需加载: ```jsx -import Menu from 'antd/lib/menu'; -import 'antd/lib/menu/style/css'; +import Menu from 'antd/es/menu'; +import 'antd/es/menu/style/css'; ``` 或者(ES6 支持的 tree shaking 方式): diff --git a/docs/react/getting-started.en-US.md b/docs/react/getting-started.en-US.md index 18193c00fd..ea5bfff19f 100755 --- a/docs/react/getting-started.en-US.md +++ b/docs/react/getting-started.en-US.md @@ -135,13 +135,13 @@ You are using a whole package of antd, please use https://www.npmjs.com/package/ However, we can import individual components on demand: ```jsx -import Button from 'antd/lib/button'; -import 'antd/lib/button/style'; // or antd/lib/button/style/css for css format file +import Button from 'antd/es/button'; +import 'antd/es/button/style'; // or antd/es/button/style/css for css format file ``` -> `antd/es/button` to import es version module for tree shaking. +> Note: antd support ES6 tree shaking, so `import { Button } from 'antd';` will drop the js code you don't use too. -We strongly recommend using [babel-plugin-import](https://github.com/ant-design/babel-plugin-import), which can convert the following code to the 'antd/lib/xxx' way: +We strongly recommend using [babel-plugin-import](https://github.com/ant-design/babel-plugin-import), which can convert the following code to the 'antd/es/xxx' way: ```jsx import { Button } from 'antd'; diff --git a/docs/react/getting-started.zh-CN.md b/docs/react/getting-started.zh-CN.md index bfc231bb1d..6f724f5c45 100755 --- a/docs/react/getting-started.zh-CN.md +++ b/docs/react/getting-started.zh-CN.md @@ -28,7 +28,7 @@ import React from 'react'; import ReactDOM from 'react-dom'; import { LocaleProvider, DatePicker, message } from 'antd'; // 由于 antd 组件的默认文案是英文,所以需要修改为中文 -import zhCN from 'antd/lib/locale-provider/zh_CN'; +import zhCN from 'antd/es/locale-provider/zh_CN'; import moment from 'moment'; import 'moment/locale/zh-cn'; import 'antd/dist/antd.css'; @@ -140,11 +140,11 @@ You are using a whole package of antd, please use https://www.npmjs.com/package/ 可以通过以下的写法来按需加载组件。 ```jsx -import Button from 'antd/lib/button'; -import 'antd/lib/button/style'; // 或者 antd/lib/button/style/css 加载 css 文件 +import Button from 'antd/es/button'; +import 'antd/es/button/style'; // 或者 antd/es/button/style/css 加载 css 文件 ``` -> `antd/es/button` 可以加载 ES 版本的模块,方便进一步 Tree Shake. +> 注意:antd 默认支持基于 ES module 的 tree shaking,对于 js 部分,直接引入 `import { Button } from 'antd'` 也会有按需加载的效果。 如果你使用了 babel,那么可以使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 来进行按需加载,加入这个插件后。你可以仍然这么写: @@ -152,7 +152,7 @@ import 'antd/lib/button/style'; // 或者 antd/lib/button/style/css 加载 css import { Button } from 'antd'; ``` -插件会帮你转换成 `antd/lib/xxx` 的写法。另外此插件配合 [style](https://github.com/ant-design/babel-plugin-import#usage) 属性可以做到模块样式的按需自动加载。 +插件会帮你转换成 `antd/es/xxx` 的写法。另外此插件配合 [style](https://github.com/ant-design/babel-plugin-import#usage) 属性可以做到模块样式的按需自动加载。 > 注意,babel-plugin-import 的 `style` 属性除了引入对应组件的样式,也会引入一些必要的全局样式。如果你不需要它们,建议不要使用此属性。你可以 `import 'antd/dist/antd.css'` 手动引入,并覆盖全局样式。 diff --git a/docs/react/i18n.en-US.md b/docs/react/i18n.en-US.md index 46c1af0e5d..fb6d6627cb 100644 --- a/docs/react/i18n.en-US.md +++ b/docs/react/i18n.en-US.md @@ -11,7 +11,7 @@ antd provides a React Component [LocaleProvider](/components/locale-provider) fo ```jsx import { LocaleProvider } from 'antd'; -import frFR from 'antd/lib/locale-provider/fr_FR'; +import frFR from 'antd/es/locale-provider/fr_FR'; return ( diff --git a/docs/react/i18n.zh-CN.md b/docs/react/i18n.zh-CN.md index a5c07cd0e2..b337837f46 100644 --- a/docs/react/i18n.zh-CN.md +++ b/docs/react/i18n.zh-CN.md @@ -10,7 +10,7 @@ title: 国际化 antd 提供了一个 React 组件 [LocaleProvider](/components/locale-provider) 用于全局配置国际化文案。 ```jsx -import zhCN from 'antd/lib/locale-provider/zh_CN'; +import zhCN from 'antd/es/locale-provider/zh_CN'; return ( diff --git a/docs/react/introduce.en-US.md b/docs/react/introduce.en-US.md index c2defcfca7..ca23d9ba3c 100644 --- a/docs/react/introduce.en-US.md +++ b/docs/react/introduce.en-US.md @@ -85,6 +85,8 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' ### Use modularized antd +> Note: antd support ES6 tree shaking by default even without the below plugin. + - Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (Recommended) ```js @@ -106,9 +108,9 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' - Manually import ```jsx - import DatePicker from 'antd/lib/date-picker'; // for js - import 'antd/lib/date-picker/style/css'; // for css - // import 'antd/lib/date-picker/style'; // that will import less + import DatePicker from 'antd/es/date-picker'; // for js + import 'antd/es/date-picker/style/css'; // for css + // import 'antd/es/date-picker/style'; // that will import less ``` ### TypeScript diff --git a/docs/react/introduce.zh-CN.md b/docs/react/introduce.zh-CN.md index 4ff065983a..7ce39323c4 100644 --- a/docs/react/introduce.zh-CN.md +++ b/docs/react/introduce.zh-CN.md @@ -85,6 +85,8 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' ### 按需加载 +> 注意:antd 默认支持基于 ES module 的 tree shaking,不使用以下插件也会有按需加载的效果。 + 下面两种方式都可以只加载用到的组件。 - 使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)(推荐)。 @@ -112,9 +114,9 @@ import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' - 手动引入 ```jsx - import DatePicker from 'antd/lib/date-picker'; // 加载 JS - import 'antd/lib/date-picker/style/css'; // 加载 CSS - // import 'antd/lib/date-picker/style'; // 加载 LESS + import DatePicker from 'antd/es/date-picker'; // 加载 JS + import 'antd/es/date-picker/style/css'; // 加载 CSS + // import 'antd/es/date-picker/style'; // 加载 LESS ``` ## 链接 diff --git a/docs/react/use-in-typescript.en-US.md b/docs/react/use-in-typescript.en-US.md index a6a77235c2..39f0730af9 100644 --- a/docs/react/use-in-typescript.en-US.md +++ b/docs/react/use-in-typescript.en-US.md @@ -42,7 +42,7 @@ Modify `src/App.tsx`, import Button component from `antd`. ```jsx import React, { Component } from 'react'; -import Button from 'antd/lib/button'; +import Button from 'antd/es/button'; import './App.css'; class App extends Component { @@ -134,7 +134,7 @@ Remove the `@import '~antd/dist/antd.css';` statement added before because `babe ```diff // src/App.js import React, { Component } from 'react'; -- import Button from 'antd/lib/button'; +- import Button from 'antd/es/button'; + import { Button } from 'antd'; import './App.css'; diff --git a/docs/react/use-in-typescript.zh-CN.md b/docs/react/use-in-typescript.zh-CN.md index 09db1d6d1f..631732ce93 100644 --- a/docs/react/use-in-typescript.zh-CN.md +++ b/docs/react/use-in-typescript.zh-CN.md @@ -42,7 +42,7 @@ $ yarn add antd ```jsx import React, { Component } from 'react'; -import Button from 'antd/lib/button'; +import Button from 'antd/es/button'; import './App.css'; class App extends Component { @@ -134,7 +134,7 @@ $ yarn add babel-plugin-import ```diff // src/App.tsx import React, { Component } from 'react'; -- import Button from 'antd/lib/button'; +- import Button from 'antd/es/button'; + import { Button } from 'antd'; import './App.css'; diff --git a/docs/react/use-with-create-react-app.en-US.md b/docs/react/use-with-create-react-app.en-US.md index 978a3797a2..8064f5906c 100644 --- a/docs/react/use-with-create-react-app.en-US.md +++ b/docs/react/use-with-create-react-app.en-US.md @@ -56,7 +56,7 @@ Modify `src/App.js`, import Button component from `antd`. ```jsx import React, { Component } from 'react'; -import Button from 'antd/lib/button'; +import Button from 'antd/es/button'; import './App.css'; class App extends Component { @@ -121,6 +121,8 @@ module.exports = function override(config, env) { ### Use babel-plugin-import +> Note: antd support ES6 tree shaking by default even without this babel plugin for js part. + [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) is a babel plugin for importing components on demand ([How does it work?](/docs/react/getting-started#Import-on-Demand)). We are now trying to install it and modify `config-overrides.js`. ```bash @@ -148,7 +150,7 @@ Remove the `@import '~antd/dist/antd.css';` statement added before because `babe ```diff // src/App.js import React, { Component } from 'react'; -- import Button from 'antd/lib/button'; +- import Button from 'antd/es/button'; + import { Button } from 'antd'; import './App.css'; diff --git a/docs/react/use-with-create-react-app.zh-CN.md b/docs/react/use-with-create-react-app.zh-CN.md index bc894b956f..66399977d7 100644 --- a/docs/react/use-with-create-react-app.zh-CN.md +++ b/docs/react/use-with-create-react-app.zh-CN.md @@ -56,7 +56,7 @@ $ yarn add antd ```jsx import React, { Component } from 'react'; -import Button from 'antd/lib/button'; +import Button from 'antd/es/button'; import './App.css'; class App extends Component { @@ -121,6 +121,8 @@ module.exports = function override(config, env) { ### 使用 babel-plugin-import +> 注意:antd 默认支持基于 ES module 的 tree shaking,js 代码部分不使用这个插件也会有按需加载的效果。 + [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 是一个用于按需加载组件代码和样式的 babel 插件([原理](/docs/react/getting-started#按需加载)),现在我们尝试安装它并修改 `config-overrides.js` 文件。 ```bash @@ -148,7 +150,7 @@ $ yarn add babel-plugin-import ```diff // src/App.js import React, { Component } from 'react'; -- import Button from 'antd/lib/button'; +- import Button from 'antd/es/button'; + import { Button } from 'antd'; import './App.css'; diff --git a/docs/spec/colors.en-US.md b/docs/spec/colors.en-US.md index e8081254cb..e6c51796c9 100644 --- a/docs/spec/colors.en-US.md +++ b/docs/spec/colors.en-US.md @@ -59,7 +59,7 @@ We provide Less and JavaScript usage for developers. - **Less** ```less - @import '~antd/lib/style/themes/default.less', .selector { + @import '~antd/es/style/themes/default.less', .selector { color: @blue-5; background-color: @gold-2; } diff --git a/docs/spec/colors.zh-CN.md b/docs/spec/colors.zh-CN.md index cea69b1a66..f0f0acc54c 100644 --- a/docs/spec/colors.zh-CN.md +++ b/docs/spec/colors.zh-CN.md @@ -67,7 +67,7 @@ ReactDOM.render(, mountNode); - **Less** ```less - @import '~antd/lib/style/themes/default.less', .selector { + @import '~antd/es/style/themes/default.less', .selector { color: @blue-5; background-color: @gold-2; }