【Next】4. 全局通用布局快速搭建

2024-09-03 11:36

本文主要是介绍【Next】4. 全局通用布局快速搭建,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

笔记来源:编程导航

基础布局

Next.js 支持全局根布局(每个页面都会生效)以及嵌套布局(可以只对部分页面生效),详情可 参考文档。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

在 src 下新建 layouts 目录,用于存放项目中的各种布局。在该目录下新建一个布局 BasicLayout, 是一个文件夹,包括 index.tsx 页面和 index.css 样式文件。

可以直接使用 Ant Design Procomponents 的布局组件 快速实现包含导航栏、内容、底部栏的响应式布局。

在 app 目录下的 layout.tsx 全局布局文件(可以理解为页面入口)中引入 BasicLayout:

export default function RootLayout({children,
}: Readonly<{children: React.ReactNode;
}>) {return (<html lang="zh"><body><AntdRegistry><BasicLayout>{children}</BasicLayout></AntdRegistry></body></html>);
}

可以将 lang=“en” 改为 lang=“zh”,适配国内用户访问。

然后按需精简和修改 BasicLayout 中复制来的布局代码,直到项目可以正常运行并符合预期。

整个过程中,需要注意下面这些事项:

1)BasicLayout 和 layout.tsx 页面开头添加 “use client” 声明,表示客户端渲染

2)移除 useState(useState 只能在 客户端使用,否则会出现水合报错)、将获取 pathname 改为使用 Next.js 的 usePathname 钩子获取

3)移除无用代码,比如 token、siderMenuType

4)定义布局的 children 属性:

interface Props {children: React.ReactNode;
}export default function BasicLayout({ children }: Props) {// ...
}

5)修改菜单渲染函数:

// 菜单渲染
menuItemRender={(item, dom) => (<Link href={item.path || "/"} target={item.target}{dom}</Link>
)}

6)移除 window 对象的使用,解决服务端和客户端水合不一致的问题

全局底部栏

在 src 下新建 components 目录,表示全局公用组件。

创建全局底部栏 GlobalFooter,通常用于展示版权信息,然后在 ProLayout 中展示:

footerRender={() => <GlobalFooter />

需要在 BasicLayout 的样式文件中补充底部内边距,否则有些内容可能会被底部栏遮挡住。示例样式如下:

.ant-pro-layout .ant-pro-layout-content {padding-bottom: 96px !important;
}

全局顶部导航栏

可以直接利用 Ant Design Procomponents 的 ProLayout 组件实现,不用自己编写。

将 ProLayout 的 layout 属性设置为 top,可开启顶部导航栏:

<ProLayoutlayout="top"
/>

ProLayout 将顶部导航栏从左到右分为几个区:标题区、菜单区、操作区、头像区。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

1)标题区:用于展示网站图标和标题。该渲染函数有 logo 和 title 参数,可以在 ProLayout 中添加对应的属性,以展示网站图标和标题。

2)菜单区:用于展示导航栏的菜单,供用户切换页面。

3)操作区:可用于配置右侧的操作栏,比如搜索条、小按钮等。移动端可以不展示操作。

4)头像区:用于展示登录用户头像、用户昵称,鼠标悬浮上去还可以展示更多用户有关的操作按钮。

export default function BasicLayout({ children }: Props) {const pathname = usePathname();const loginUser = useSelector((state: RootState) => state.loginUser);return (<divid="basicLayout"style={{height: "100vh",overflow: "auto",}}><ProLayouttitle="面面 - 专为面试而生"layout="top"logo={<Imagesrc={"/assets/logo.png"}height={32}width={32}alt={"面面-只为面试而生"}/>}location={{pathname,}}avatarProps={{src: loginUser.userAvatar || "/assets/notLoginUser.png",size: "small",title: loginUser.userName || "访客",render: (props, dom) => {return (<Dropdownmenu={{items: [{key: "logout",icon: <LogoutOutlined />,label: "退出登录",},],}}>{dom}</Dropdown>);},}}// 操作渲染actionsRender={(props) => {if (props.isMobile) return [];return [<SearchInput key={"search"} />,<akey={"github"}href={"https://gitee.com/hao-xiugong/mianmian-frontend"}target={"_blank"}><GithubFilled key="GithubFilled" />,</a>,];}}headerTitleRender={(logo, title, _) => {return (<a>{logo}{title}</a>);}}footerRender={() => {return <GlobalFooter />;}}onMenuHeaderClick={(e) => console.log(e)}// 定义菜单menuDataRender={() => {return [{path: "/",name: "主页",target: "_blank"},{path: "/banks",name: "题库",target: "_blank"},];}}menuItemRender={(item, dom) => (<Link href={item.path || "/"} target={item.target}>{dom}</Link>)}>{children}</ProLayout></div>);
}

导航菜单配置

可以通过独立的配置文件更方便地修改导航菜单项,不用每次都修改布局代码。

实现步骤如下:

1)在 /config 目录下编写通用配置文件 menus.tsx,核心是菜单项数组,可以用 ProLayout 提供的 TypeScript 类型来规范:

import { MenuDataItem } from "@ant-design/pro-layout";
import { CrownOutlined } from "@ant-design/icons";// 菜单列表
const menus = [{path: "/",name: "主页",},{path: "/banks",name: "题库",},{path: "/questions",name: "题目",},{path: "/admin",name: "管理",icon: <CrownOutlined />,children: [{path: "/admin/user",name: "用户管理",}],},
] as MenuDataItem[];// 导出
export default menus;

2)在全局布局的 ProLayout 中引入菜单数据。

3)同步路由的更新到菜单项高亮。

同步高亮原理:可以使用 usePathname 客户端钩子函数获取到当前页面路径,然后传递给 ProLayout 的 location 属性即可自动匹配到对应 path 的菜单项。

4)扩展能力:在 ProLayout 的菜单渲染函数中可以根据菜单项的属性来自定义菜单项渲染逻辑,比如支持配置超链接是否在新页面打开。target 的值为 _blank 表示在新页面打开。

这篇关于【Next】4. 全局通用布局快速搭建的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1132856

相关文章

shell脚本快速检查192.168.1网段ip是否在用的方法

《shell脚本快速检查192.168.1网段ip是否在用的方法》该Shell脚本通过并发ping命令检查192.168.1网段中哪些IP地址正在使用,脚本定义了网络段、超时时间和并行扫描数量,并使用... 目录脚本:检查 192.168.1 网段 IP 是否在用脚本说明使用方法示例输出优化建议总结检查 1

Mycat搭建分库分表方式

《Mycat搭建分库分表方式》文章介绍了如何使用分库分表架构来解决单表数据量过大带来的性能和存储容量限制的问题,通过在一对主从复制节点上配置数据源,并使用分片算法将数据分配到不同的数据库表中,可以有效... 目录分库分表解决的问题分库分表架构添加数据验证结果 总结分库分表解决的问题单表数据量过大带来的性能

Java汇编源码如何查看环境搭建

《Java汇编源码如何查看环境搭建》:本文主要介绍如何在IntelliJIDEA开发环境中搭建字节码和汇编环境,以便更好地进行代码调优和JVM学习,首先,介绍了如何配置IntelliJIDEA以方... 目录一、简介二、在IDEA开发环境中搭建汇编环境2.1 在IDEA中搭建字节码查看环境2.1.1 搭建步

Rust中的Option枚举快速入门教程

《Rust中的Option枚举快速入门教程》Rust中的Option枚举用于表示可能不存在的值,提供了多种方法来处理这些值,避免了空指针异常,文章介绍了Option的定义、常见方法、使用场景以及注意事... 目录引言Option介绍Option的常见方法Option使用场景场景一:函数返回可能不存在的值场景

你的华为手机升级了吗? 鸿蒙NEXT多连推5.0.123版本变化颇多

《你的华为手机升级了吗?鸿蒙NEXT多连推5.0.123版本变化颇多》现在的手机系统更新可不仅仅是修修补补那么简单了,华为手机的鸿蒙系统最近可是动作频频,给用户们带来了不少惊喜... 为了让用户的使用体验变得很好,华为手机不仅发布了一系列给力的新机,还在操作系统方面进行了疯狂的发力。尤其是近期,不仅鸿蒙O

Python基于火山引擎豆包大模型搭建QQ机器人详细教程(2024年最新)

《Python基于火山引擎豆包大模型搭建QQ机器人详细教程(2024年最新)》:本文主要介绍Python基于火山引擎豆包大模型搭建QQ机器人详细的相关资料,包括开通模型、配置APIKEY鉴权和SD... 目录豆包大模型概述开通模型付费安装 SDK 环境配置 API KEY 鉴权Ark 模型接口Prompt

详解Python中通用工具类与异常处理

《详解Python中通用工具类与异常处理》在Python开发中,编写可重用的工具类和通用的异常处理机制是提高代码质量和开发效率的关键,本文将介绍如何将特定的异常类改写为更通用的ValidationEx... 目录1. 通用异常类:ValidationException2. 通用工具类:Utils3. 示例文

鸿蒙开发搭建flutter适配的开发环境

《鸿蒙开发搭建flutter适配的开发环境》文章详细介绍了在Windows系统上如何创建和运行鸿蒙Flutter项目,包括使用flutterdoctor检测环境、创建项目、编译HAP包以及在真机上运... 目录环境搭建创建运行项目打包项目总结环境搭建1.安装 DevEco Studio NEXT IDE

HarmonyOS学习(七)——UI(五)常用布局总结

自适应布局 1.1、线性布局(LinearLayout) 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列,Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距,达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式,且在各类尺寸屏幕上表现一致,其中交叉轴为垂直时,取值为Vert

电脑桌面文件删除了怎么找回来?别急,快速恢复攻略在此

在日常使用电脑的过程中,我们经常会遇到这样的情况:一不小心,桌面上的某个重要文件被删除了。这时,大多数人可能会感到惊慌失措,不知所措。 其实,不必过于担心,因为有很多方法可以帮助我们找回被删除的桌面文件。下面,就让我们一起来了解一下这些恢复桌面文件的方法吧。 一、使用撤销操作 如果我们刚刚删除了桌面上的文件,并且还没有进行其他操作,那么可以尝试使用撤销操作来恢复文件。在键盘上同时按下“C