快速开始

基本开发环境需要 Node.js18 以上版本

安装方式-1 (推荐)

直接使用 npx create-antd-layout@latest your-project 安装，它提供许多已定制好的模版，方便快捷。

安装方式-2

集成到已有项目中

添加 @adminui.dev/antd-layout 到项目中

npm
pnpm
yarn
bun

npm i @adminui.dev/antd-layout

pnpm i @adminui.dev/antd-layout

yarn add @adminui.dev/antd-layout

bun add @adminui.dev/antd-layout

复制成功

添加相关依赖项

package.json

"dependencies": {
    "@adminui-dev/antd-layout": "^1.7.8",
    "@ant-design/colors": "^7.2.1",
    "nprogress": "^0.2.0",
    "antd": "^6.1.1",
    "react": "^19.2.0",
    "react-dom": "^19.2.0",
    "react-intl": "^8.0.4",
    "react-router": "^7.11.0",
    "react-router-dom": "^7.11.0",
    ...
}

复制成功

在布局文件中使用并配置组件

src/layouts/index.tsx

// src/layout/index.tsx
...
import { AntdLayout } from "@adminui-dev/antd-layout"
...
export default function(){      
    return(
        <>
            <AntdLayout layoutConfig={...} menuData={...} />
        </>
    )
}

复制成功

前提条件：需要node、ant-desing、react、react-dom环境