From a4d8ef4b71837c90b53fd1dac669043d70464126 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=AB=E9=9B=A8=E6=B0=B4=E8=BF=87=E6=BB=A4=E7=9A=84?= =?UTF-8?q?=E7=A9=BA=E6=B0=94-Rain?= <958414905@qq.com> Date: Fri, 21 Jul 2023 10:40:36 +0800 Subject: [PATCH] docs: add doc for Theme Editor (#2280) * docs: add doc for Theme Editor * chore: update src of img * chore: increase image height * chore: optimize img --- packages/plugins/theme-editor/README.md | 55 +++++++++++++++++++ packages/plugins/theme-editor/README.zh-CN.md | 55 +++++++++++++++++++ 2 files changed, 110 insertions(+) create mode 100644 packages/plugins/theme-editor/README.md create mode 100644 packages/plugins/theme-editor/README.zh-CN.md diff --git a/packages/plugins/theme-editor/README.md b/packages/plugins/theme-editor/README.md new file mode 100644 index 0000000000..950de6b167 --- /dev/null +++ b/packages/plugins/theme-editor/README.md @@ -0,0 +1,55 @@ +English | [中文](./README.zh-CN.md) + +> 当前主题功能是在 antd 5.x 版本的基础上实现的，所以在阅读本文之前最好先阅读一下[定制主题](https://ant.design/docs/react/customize-theme-cn#%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%BB%E9%A2%98)相关的概念。 + +## 介绍 + +目前支持编辑全局范围的 [SeedToken](https://ant.design/docs/react/customize-theme-cn#seedtoken)、[MapToken](https://ant.design/docs/react/customize-theme-cn#maptoken)、[AliasToken](https://ant.design/docs/react/customize-theme-cn#aliastoken)，和支持[切换](https://ant.design/docs/react/customize-theme-cn#%E4%BD%BF%E7%94%A8%E9%A2%84%E8%AE%BE%E7%AE%97%E6%B3%95)为 `暗黑模式` 和 `紧凑模式`。后期有可能会支持[组件级别](https://ant.design/docs/react/customize-theme-cn#%E4%BF%AE%E6%94%B9%E7%BB%84%E4%BB%B6%E5%8F%98%E9%87%8F-component-token)的主题定制。 + +## 如何使用 + +### 1、启用主题插件 + +首先把 NocoBase 更新到最新版本，然后会在[插件管理页面](http://localhost:13000/admin/pm/list/local/)看到 `theme-editor` 的卡片，点击卡片右下角的 `启用` 按钮等待页面刷新。 + + + +### 2、跳转到主题配置页面 + +启用之后点击卡片左下角的设置按钮，会跳转到主题编辑页面。默认会有三个主题选项，分别是 `antd 的默认主题`、`暗黑主题` 和 `紧凑主题`。 + + + +## 新增一个主题 + +点击 `添加新主题` 按钮，选择 `新增一个全新的主题`，然后会在页面右侧弹出一个 `主题编辑器`，支持编辑 `颜色`、`尺寸`、`风格`等。编辑好之后输入主题名称然后点击保存即可完成主题的新增。 + + + +## 应用新主题 + +可以把鼠标移到页面右上角，可以看到一个主题切换项，点击可以切换到其他主题，比如可以切换刚才新增的主题。 + + + +## 编辑已经存在的主题 + +点击卡片左下角的 `编辑` 按钮，如同新增主题一样，会在页面右侧弹出一个 `主题编辑器`，编辑好之后点击保存即可完成主题的编辑。 + +## 用户切换主题时的可选项 + +新添加的主题默认是允许非管理员用户切换的，如果不想让非管理员用户切换某个主题，可以关闭主题卡片右下角的 `可被用户选择` 开关，这样用户就无法切换到该主题了。 + + + +## 设置为默认主题（默认主题不可删除） + +在初始状态下，默认主题是 `antd 的默认主题`，如果想把某个主题设置为默认主题，可以开启卡片右下角的 `默认主题` 开关，这样当新用户第一次打开页面时应用的就是该默认主题。 + + + +## 删除主题 + +点击卡片下方的 `删除` 按钮，然后点击弹出的确认按钮即可删除主题。 + + diff --git a/packages/plugins/theme-editor/README.zh-CN.md b/packages/plugins/theme-editor/README.zh-CN.md new file mode 100644 index 0000000000..4c4316c8c0 --- /dev/null +++ b/packages/plugins/theme-editor/README.zh-CN.md @@ -0,0 +1,55 @@ +[English](./README.md) | 中文 + +> 当前主题功能是在 antd 5.x 版本的基础上实现的，所以在阅读本文之前最好先阅读一下[定制主题](https://ant.design/docs/react/customize-theme-cn#%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%BB%E9%A2%98)相关的概念。 + +## 介绍 + +目前支持编辑全局范围的 [SeedToken](https://ant.design/docs/react/customize-theme-cn#seedtoken)、[MapToken](https://ant.design/docs/react/customize-theme-cn#maptoken)、[AliasToken](https://ant.design/docs/react/customize-theme-cn#aliastoken)，和支持[切换](https://ant.design/docs/react/customize-theme-cn#%E4%BD%BF%E7%94%A8%E9%A2%84%E8%AE%BE%E7%AE%97%E6%B3%95)为 `暗黑模式` 和 `紧凑模式`。后期有可能会支持[组件级别](https://ant.design/docs/react/customize-theme-cn#%E4%BF%AE%E6%94%B9%E7%BB%84%E4%BB%B6%E5%8F%98%E9%87%8F-component-token)的主题定制。 + +## 如何使用 + +### 1、启用主题插件 + +首先把 NocoBase 更新到最新版本，然后会在[插件管理页面](http://localhost:13000/admin/pm/list/local/)看到 `theme-editor` 的卡片，点击卡片右下角的 `启用` 按钮等待页面刷新。 + + + +### 2、跳转到主题配置页面 + +启用之后点击卡片左下角的设置按钮，会跳转到主题编辑页面。默认会有三个主题选项，分别是 `antd 的默认主题`、`暗黑主题` 和 `紧凑主题`。 + + + +## 新增一个主题 + +点击 `添加新主题` 按钮，选择 `新增一个全新的主题`，然后会在页面右侧弹出一个 `主题编辑器`，支持编辑 `颜色`、`尺寸`、`风格`等。编辑好之后输入主题名称然后点击保存即可完成主题的新增。 + + + +## 应用新主题 + +可以把鼠标移到页面右上角，可以看到一个主题切换项，点击可以切换到其他主题，比如可以切换刚才新增的主题。 + + + +## 编辑已经存在的主题 + +点击卡片左下角的 `编辑` 按钮，如同新增主题一样，会在页面右侧弹出一个 `主题编辑器`，编辑好之后点击保存即可完成主题的编辑。 + +## 用户切换主题时的可选项 + +新添加的主题默认是允许非管理员用户切换的，如果不想让非管理员用户切换某个主题，可以关闭主题卡片右下角的 `可被用户选择` 开关，这样用户就无法切换到该主题了。 + + + +## 设置为默认主题（默认主题不可删除） + +在初始状态下，默认主题是 `antd 的默认主题`，如果想把某个主题设置为默认主题，可以开启卡片右下角的 `默认主题` 开关，这样当新用户第一次打开页面时应用的就是该默认主题。 + + + +## 删除主题 + +点击卡片下方的 `删除` 按钮，然后点击弹出的确认按钮即可删除主题。 + +