# @antdp/config

> 路由配置

Latest version **2.1.2** (published 2025-02-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install @antdp/config
pnpm add @antdp/config
yarn add @antdp/config
bun add @antdp/config
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2025-02-11 |
| First published | 2020-05-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 48.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 18 |
| Author | antdp |
| Maintainers | uiwjs, wcjiang |
| Keywords | config, antdp, umi |

## Links

- npm: https://www.npmjs.com/package/@antdp/config
- Repository: https://github.com/antdpro/antdp.git#master
- Homepage: https://antdpro.github.io/antdp
- Issues: https://github.com/antdpro/antdp/issues
- npm.io page: https://npm.io/package/@antdp/config

## Dependencies (4)

- [@umijs/max](https://npm.io/package/@umijs/max.md) ~4.0.47
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ~7.20.1
- [@ant-design/icons](https://npm.io/package/@ant-design/icons.md) ~5.3.5
- [umi-plugin-antd-icon-config](https://npm.io/package/umi-plugin-antd-icon-config.md) 3.0.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 2.1.2 (latest) — 2025-02-11
- 2.0.0-bate.5 (bate) — 2023-04-01
- 2.1.1 — 2024-03-28
- 2.1.0 — 2024-03-28
- 2.0.24 — 2024-03-28
- 2.0.23 — 2023-11-10
- 2.0.22 — 2023-10-11
- 2.0.21 — 2023-08-22
- 2.0.20 — 2023-06-21
- 2.0.19 — 2023-06-12
- 2.0.18 — 2023-06-10
- 2.0.17 — 2023-06-09
- 2.0.16 — 2023-06-07
- 2.0.15 — 2023-05-30
- 2.0.14 — 2023-05-29
- … 125 more at https://npm.io/package/@antdp/config/versions

## README

@antdp/config
---

[![npm](https://img.shields.io/npm/v/@antdp/config.svg?maxAge=3600)](https://www.npmjs.com/package/@antdp/config)
[![npm download](https://img.shields.io/npm/dm/@antdp/config.svg?style=flat)](https://www.npmjs.com/package/@antdp/config)

我们已将 umi 配置包裹了一层， 如果需要antdp中能使用自定义配置，你可以使用项目根目录的  `config/config.ts`/`config/config.js`进行配置

## Installation

```bash
npm i @antdp/config --save-dev
```

## Basic Usage

```js
// config/config.{js|ts}

//二次封装的umi配置
import config from '@antdp/config';
// 路由数据
import router from './router.json';
/**开发代理配置*/
import proxy from './proxy';

export default config(router, {
  proxy,
});
```

## Interface

```typescript
import { IConfig, IRoute } from '@umijs/max';

export interface Options extends Omit<IConfig, 'routes'> {
  routes: IRoute;
}

export interface Config {
  (routes?: IRoute, optiosn?: Options): IConfig;
}

declare var config: Config;
export default config;
```

## define配置

### ANTD_IS_TABS

是否显示 Tab 选项卡，默认值`true`显示

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_IS_TABS: true
  },
);
```

### ANTD_IS_IFRAME_RENDER

是否使用 iframe 展示内容，默认值`true`开启

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_IS_IFRAME_RENDER: true
  },
);
```
### ANTD_IS_BREADCRUMB
是否展示面包屑, Tab 选项卡优先级大于面包屑

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_IS_BREADCRUMB: true
  },
);
```

### ANTD_AUTH_CONF

是否开启权限验证 默认值`false`不启用

- `auth_menu` 储存菜单路由权限---本地keys 默认值`authMenu`
- `auth_btn` 储存按钮路径权限---本地keys 默认值 `authBtn`
- `auth_check_url` 判断路径是否有权限的字段 默认值`menuUrl`,如果字段设置为`undefined`则`auth_menu`和`auth_btn`储存形式为 `["/web"]`,反之储存形式为`[{menuUrl:"/web"}]`,

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_AUTH_CONF: {
+      auth_menu:"authMenu",
+      auth_btn:"authBtn",
+      auth_check_url:undefined
    }
  },
);

```

### ANTD_MENU_IS_SHOW

是否显示 左侧菜单,默认值`true`

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_MENU_IS_SHOW: true
  },
);
```

### ANTD_HEAD_IS_SHOW

是否显示 head头部，默认值`true`

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_HEAD_IS_SHOW: true
  },
);
```

### ANTD_MENU_SEARCH_IS_SHOW

是否开启菜单栏搜索，默认值`false`

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {
+    ANTD_MENU_SEARCH_IS_SHOW: true
  },
);
```
## locale配置


```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
  locale: {
    // 默认使用 src/locales/zh-CN.ts 作为多语言文件
+    default: 'zh-CN',
+    antd: true,
    // default true, when it is true, will use `navigator.language` overwrite default
    // baseNavigator: true,
    /**
     * [国际化] 控制台提示 Warning: The current popular language does not exist, please check the locales folder! 警告信息
     * https://github.com/umijs/umi/issues/4363#issuecomment-616134434
     * 警用 `baseNavigator` 和 `title` 两个配置项 可以解决国际化警告问题
     */
+    baseNavigator: false,
+    title: false,
  },
  },
);
```

## @umijs/max配置

### request

开启 `useRequest` 和 `request`，默认`未开启`

- `dataField` 该配置的默认值是 data。该配置的主要目的是方便 useRequest 直接消费数据。如果你想要在消费数据时拿到后端的原始数据，需要在这里配置 `dataField` 为 ''

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
+  request:{}
);
```

### react-query

开启`react-query`，默认`未开启`

- `devtool`: boolean，是否开启 react query 官方 devtool 工具，默认 `true`
- `queryClient`: boolean, 是否注册全局的 QueryClient 和 QueryClientProvier，默认 `true`

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
+  reactQuery: {
     // 是否开启 react query 官方 devtool 工具
+    devtool: false,
+    queryClient: true,
  },
);
```

### useModel

开启`useModel`，默认`未开启`

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
+  model: {},
);
```

### dva

开启`dva`，默认`未开启`

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
+  dva: {},
);
```

### styled-components

[styled-components](https://styled-components.com/) 样式方案

- `babelPlugin`: Object，开启 styled-components 的 babel 插件，仅 dev 模式有效
比如：

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
+  styledComponents: {},
);
```

### valtio

`valtio` 数据流方案

```diff
import config from '@antdp/config';
import proxy from './proxy';
import router from './router.json';
export default config(router, {
  proxy,
  define: {},
+  valtio: {},
);
```


[更多配置参考 umi](https://umijs.org/docs/api/config)

---
_Source: https://npm.io/package/@antdp/config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._