Skip to content

Add shared utilities API docs for plugins #522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 6, 2025
Merged

Add shared utilities API docs for plugins #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5e9e94
Add shared utilities API docs for plugins
ruibaby Nov 5, 2025
6d0a0e1
docs: add dayjs() method to utils section in shared API reference
ruibaby Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/developer-guide/plugin/api-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,19 @@ description: 记录每一个版本的插件 API 变更记录，方便开发者

## 2.22.0

WIP
### `@halo-dev/console-shared` 工具库

在 2.22.0 中，Halo 在 `@halo-dev/console-shared` 包中提供一些常用工具，用于减少部分业务的开发工作量，目前提供：

1. `stores`
1. `currentUser`：用于获取当前用户信息
2. `globalInfo`：用于获取网站一些公开的信息，比如外部访问地址
2. utils
1. `date`：时间日期格式化工具
2. `permission`：用户权限检查工具
3. `id`：uuid 生成工具
4. `attachment`：附件相关工具，比如获取附件缩略图地址
3. events
1. `core:plugin:configMap:updated`：用于监听插件配置变更

详细文档可查阅：[共享工具库](./api-reference/ui/shared.md)
Loading