Skip to content

首页(plugin_index) hooks列表

首页钩子位置图示

移动端首页钩子示例

thread_extension_display_hook

帖子扩展区,生效在所有内置组件的最后进行展示

平台支持

平台是否支持
PC
H5
Mini

参数

属性值类型描述
renderDataobject当前符合插件提交的数据,用于数据展示
threadDataobject插件所有帖子信息
updateThreadfunction(tomId, tomValue): void更新帖子信息
updateListThreadIndexesfunction(threadId, tomId, tomValue): object更新帖子列表中的信息
recomputeRowHeightsfunction(): booleanweb端有效,更新虚拟滚动的高度

recomputeRowHeights函数传入参数为updateListThreadIndexes函数调用的返回值。 tomValue是当前插件的数据体,可以参考renderData传入的内容进行修改

header_insert_before_hook

在首页顶部上方区域插入相关内容

平台支持

平台是否支持
PC
H5

参数

通用参数

header_insert_after_hook

在首页顶部下方区域插入相关内容

支持平台

平台是否支持
H5
Mini

参数

通用参数

header_replace_hook

替换原有的首页顶部区域

支持平台

平台是否支持
H5
Mini

参数

通用参数

tabs_replace_hook

替换原有的首页条件选区域

支持平台

平台是否支持
PC
H5
Mini

参数

属性值类型描述
通用参数
renderData.categoriesarray分类列表,仅h5和小程序下提供
changeFilterfunction({types, sort, essence, attention, sequence}):void改变过滤条件,触发列表请求,详见参数类型说明

changeFilter中的参数都为非必须,由于后台接口字段调整,sequence参数类型说明scope字段的含义

topping_insert_before_hook

在首页置顶区域上方插入内容

支持平台

平台是否支持
PC
H5
Mini

参数

通用参数

topping_insert_after_hook

在首页置顶区域下方插入内容

支持平台

平台是否支持
PC
H5
Mini

参数

通用参数

topping_replace_hook

替换原有的首页置顶区域

支持平台

平台是否支持
PC
H5
Mini

参数

属性值类型描述
通用参数
renderData.sticksarray置顶列表

left_replace_hook

替换原有的首页左侧区域

支持平台

平台是否支持
PC

参数

属性值类型描述
通用参数
renderData.categoriesarray分类信息
renderData.defaultFisrtIndexstring默认选择的一级分类
renderData.defaultSecondIndexstring默认选择的二级分类
renderData.totalThreadsnumber总帖子数量
renderData.isErrorboolean是否分类请求错误
renderData.errorTextstring请求错误信息
onNavigationClickfunction({ categoryIds }): void导航点击事件,触发列表请求

categoryIds为包含一级分类、二级分类id数组,例如:[1,2]

right_replace_hook

替换原有的首页右侧区域

支持平台

平台是否支持
PC

参数

属性值类型描述
通用参数
recommendsarray推荐列表
urlstring站点链接
onGetRecommendsfunction获取推荐列表

recommend_replace_hook

替换原有的首页推荐区域

支持平台

平台是否支持
PC

参数

属性值类型描述
通用参数
recommendsarray推荐列表
onGetRecommendsfunction():array获取推荐列表

qrcode_replace_hook

替换原有的首页二维码区域

支持平台

平台是否支持
PC

参数

属性值类型描述
通用参数
urlstring站点链接

替换原有的首页备案号区域

支持平台

平台是否支持
PC

参数

通用参数

相关版权信息可在通用参数中的siteData.webConfig.setSite中获取

Released under the MIT License.