diff --git a/packages/discuz-plugin-center/README.md b/packages/discuz-plugin-center/README.md index e8f6c77f33d2303188500e436d00f7f2cdde389a..185f5fdbd4543082249706452104b0cc1c5b8472 100644 --- a/packages/discuz-plugin-center/README.md +++ b/packages/discuz-plugin-center/README.md @@ -33,6 +33,7 @@ - 页面标识列表 - [x] [commonProps](./docs/hooks/common_props.md) - 通用属性 - [x] [pluginSystemHooks](./docs/hooks/plugin_system_hooks.md) - 全局 + - [x] [pluginGlobalHooks](./docs/hooks/plugin_global_hooks.md) - 公共 - [x] [pluginIndexHooks](./docs/hooks/plugin_index_hooks.md) - 首页 - [x] [pluginDetailHooks](./docs/hooks/plugin_detail_hooks.md) - 帖子详情页 - [x] [pluginPostHooks](./docs/hooks/plugin_post_hooks.md) - 发帖页 diff --git a/packages/discuz-plugin-center/docs/hooks/plugin_global_hooks.md b/packages/discuz-plugin-center/docs/hooks/plugin_global_hooks.md new file mode 100644 index 0000000000000000000000000000000000000000..07b31b3e68bdab7b1c372c64616ad5306283b695 --- /dev/null +++ b/packages/discuz-plugin-center/docs/hooks/plugin_global_hooks.md @@ -0,0 +1,42 @@ +# 公共(plugin_global) hooks列表 + +## header_replace_hook +替换全局公共的头部 +#### 类型 +替换型 +#### 支持平台 +pc、h5 +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | +| message.totalUnread | object.number | 当前用户的未读消息数 | +| onSearch | function | 触发搜索 | + +## footer_replace_hook +替换全局公共的底部 +#### 类型 +替换型 +#### 支持平台 +h5、小程序 +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | +| message.totalUnread | object.number | 当前用户的未读消息数 | diff --git a/packages/discuz-plugin-center/docs/hooks/plugin_index_hooks.md b/packages/discuz-plugin-center/docs/hooks/plugin_index_hooks.md index 9de2396c2724b4062c9b5f14fea06bd93e403b7f..6694c94363b866c0898d93d206fadb62585f8161 100644 --- a/packages/discuz-plugin-center/docs/hooks/plugin_index_hooks.md +++ b/packages/discuz-plugin-center/docs/hooks/plugin_index_hooks.md @@ -16,3 +16,266 @@ > recomputeRowHeights函数传入参数为updateListThreadIndexes函数调用的返回值。 > tomValue是当前插件的数据体,可以参考renderData传入的内容进行修改 + + +## header_insert_before_hook +在首页顶部上方区域插入相关内容 +#### 类型 +插入型 +#### 支持平台 +h5、小程序 +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + +## header_insert_after_hook +在首页顶部下方区域插入相关内容 +#### 类型 +插入型 +#### 支持平台 +h5、小程序 +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + +## header_replace_hook +替换原有的首页顶部区域 +#### 类型 +替换型 +#### 支持平台 +h5、小程序 + +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + +## tabs_replace_hook +替换原有的首页条件选区域 +#### 类型 +替换型 +#### 支持平台 +h5、小程序、pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + +## topping_insert_before_hook +在首页置顶区域上方插入内容 +#### 类型 +插入型 +#### 支持平台 +h5、小程序、pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + +## topping_insert_after_hook +在首页置顶区域下方插入内容 +#### 类型 +插入型 +#### 支持平台 +h5、小程序、pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + +## topping_replace_hook +替换原有的首页置顶区域 +#### 类型 +替换型 +#### 支持平台 +h5、小程序、pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + + +## left_replace_hook +替换原有的首页左侧区域 +#### 类型 +替换型 +#### 支持平台 +pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | +| categories | array | 分类信息 | +| defaultFisrtIndex | string | 默认选择的一级分类 | +| defaultSecondIndex | string | 默认选择的二级分类 | +| totalThreads | number | 总帖子数量 | +| onNavigationClick | function | 导航点击事件 | +| isError | boolean | 是否分类请求错误 | +| errorText | string | 请求错误信息 | + + + +## right_replace_hook +替换原有的首页右侧区域 +#### 类型 +替换型 +#### 支持平台 +pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + + +## recommend_replace_hook +替换原有的首页推荐区域 +#### 类型 +替换型 +#### 支持平台 +pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + + +## qrcode_replace_hook +替换原有的首页二维码区域 +#### 类型 +替换型型 +#### 支持平台 +pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + + + + +## copyright_replace_hook +替换原有的首页备案号区域 +#### 类型 +替换型 +#### 支持平台 +pc +#### 参数 +| 属性 | 值类型 | 描述 | +| :- | :- | :- | +| siteData | object | 站点配置信息,由/apiv3/forum接口,返回数据 | +| userInfo | object | 当前用户信息(没有登录为null) | +| isLogin | function(): boolean | 是否登录 | +| pluginStore | object | 插件全局存放数据 | +| pluginAction | object | 操作插件数据操作 | +| dzqRouter | object | 当前路由信息对象 | +| dzqRequest | object | 发起网络请求的对象 | +| dzqRequestHandleError | function | 请求错误统一处理函数 | +| _pluginInfo | object | 当前插件信息 | + +