配置
学习如何配置 TanStarter 模板
本文档提供了配置 TanStarter 模板的详细参考。
配置结构
配置被分割到 src/config 目录中的几个文件中,每个文件负责配置网站的特定方面。
website.ts
navbar-config.ts
footer-config.ts
sidebar-config.ts
avatar-config.ts
social-config.ts
配置文件
配置文件用于定义网站的结构和内容。
共享数据类型
配置在不同菜单中使用一致的数据类型:
MenuItemConfig
具有以下属性的基本菜单项:
| 属性 | 类型 | 描述 |
|---|---|---|
title | string | 菜单项的显示文本 |
description | string? | 下拉项的可选描述 |
icon | TablerIcon? | 可选的 Tabler Icons 图标组件 |
href | string? | 链接 URL 目标 |
external | boolean? | 链接是否在新标签页中打开 |
authorizeOnly | string[]? | 可以看到此项的用户角色 |
items | MenuItemConfig[]? | 下拉菜单的子菜单项 |
最佳实践
- 统一使用来自 Tabler Icons 中的图标,以确保一致性
- 对于基于特定角色可见的菜单项,可以使用
authorizeOnly属性来限制可见性 - 使用
Routes对象(在src/lib/routes.ts中)定义常用的链接,以确保一致性
下一步
现在您了解了配置结构,请探索其他相关主题:
TanStarter 文档