抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 组件概述
  • 基础内容
  • 视图容器
  • 表单
  • 导航
  • 媒体
  • 画布
  • 地图
  • 开放能力
  • 行业开放
  • 交易系统
  • 评价
  • 电商(即将废弃)
  • 原生组件
  • 拓展组件
  • 讨论列表

    收藏
    我的收藏
    bnpm搜索:@byted-ent/publicity

    功能介绍

    DiscussionList 组件用于渲染一个功能完整的讨论场(评论场),包括讨论列表展示、排序切换、加载更多、回复、点赞、长按管理等核心功能。它遵循标准的“自定义模块”开发范式,通过 Adapter 模式注入业务逻辑,实现了 UI 与业务的高度解耦。
      •讨论列表展示:支持按“推荐”、“最热”、“最新”等多种方式排序和展示讨论列表。
      •无限滚动加载:用户滚动到列表底部时,自动加载更多讨论。
      •丰富的交互:支持对单条讨论进行点赞、跳转回复、查看图片等操作。
      •业务逻辑注入:通过 adapter 属性注入数据请求、用户交互等业务逻辑,使组件本身保持业务无关。
      •灵活的 UI 定制:可通过 theme 和 styles 属性定制组件的主题色和关键 UI 样式。
      •空态与错误处理:内置了加载中、网络错误、列表为空等多种状态的 UI 展示。

    组件样式

    Props API

    组件接受以下 props 来控制其行为和外观:
    参数名
    类型
    是否必传
    默认值
    说明
    discussionId
    string
    是
    -
    讨论场的唯一标识,通常是圈子 ID。用于数据请求和状态管理。
    showInput
    boolean
    是
    -
    是否显示底部的评论发布输入框。
    handlePublishDiscussionSuccess
    (discussion: Discussion) => void
    是
    -
    发布讨论成功后的回调函数,参数为新发布的讨论内容对象。
    scene
    Scene (enum)
    否
    Scene.WorksDetail
    当前所在的业务场景,如 Scene.Fandom。用于区分埋点参数、接口请求参数等。
    forceLogin
    () => boolean
    否
    -
    一个函数,当用户未登录时尝试触发登录流程。如果登录成功,应返回 true。
    trackParams
    Record<string, any>
    否
    {}
    透传给组件内部所有埋点事件的额外参数。
    overwriteSortBy
    DiscussionSortby (enum)
    否
    -
    由外部强制控制的排序方式。当此 Prop 变化时,组件会切换到对应的排序并刷新列表。
    defaultSortby
    DiscussionSortby (enum)
    否
    DiscussionSortby.Recommend
    列表初始化的默认排序方式。
    topDiscussionConfig
    { commentId: string; previewCommentId?: string; }
    否
    -
    置顶评论的配置。用于在列表首次加载时将特定评论插入到顶部。commentId 为正式评论 ID,previewCommentId 为平台预览用的临时 ID。
    publishConfig
    PublishConfig (object)
    否
    -
    发布相关的配置,包含转评赞的锚点(anchor)、话题(challenge)和文案(text)等。
    createAwemeParams
    Record<string, any>
    否
    -
    创建作品时需要透传给发布器的参数。
    authInfo
    FandomAuthInfo (object)
    否
    -
    用户权限信息,包含是否为管理员(is_admin)、是否被禁言(ban_comment)等。
    showFansclubBadge
    boolean
    否
    false
    是否在讨论单元格中显示粉丝团勋章。在圈层场景中,此值通常由服务端数据决定。
    toExecutedTasks
    Array<TaskOptions>
    否
    -
    一个任务选项数组,用于在组件挂载时注册需要执行的自动化任务(如自动拉起输入框、发布讨论等)。
    customClass / customStyle
    string / CSSProperties
    否
    -
    自定义的类名和样式,会应用到组件的根元素上。
    onRenderStatusChange
    (status: 'loading' | 'empty' | 'netError' | 'list') => void
    否
    -
    当组件的渲染状态发生变化时(如从加载中变为空态),触发此回调。

    基本用法

    下面是一个基础的 DiscussionList 组件使用示例,展示了如何渲染一个基本的签到日历。
    <DiscussionList key={fandomSortBy} themeMode="light" handlePublishDiscussionSuccess={handlePublishDiscussionSuccess} customClass="fandom-discussion-list" inputViewCardCls="fandom-discussion-view-card" showInput={tabSelectedIndex === 1} discussionId={fandomId} scene={Scene.Fandom} onScroll={onScroll} // 圈层内由服务端控制是否下发粉丝标签 showFansclubBadge={true} topDiscussionConfig={{ commentId: comment_id ?? '', previewCommentId: lynx?.__globalProps?.queryItems?.preview_comment_id ?? '', }} overwriteSortBy={fandomSortBy} fandomGroupId={discussGroupId} customStyle={{ height: '100vh' }} publishConfig={{ text: { title: `我在「${metaData?.title ?? ''}」说`, }, anchor: getMicroAppAnchor(anchorInfo), challenge: defaultChallengeIdList.length > 0 ? { challenge_id_list: defaultChallengeIdList, } : {}, }} createAwemeParams={getFandomAwemeParams({ fandom_id: fandomId ?? '', app_id: APP_ID, })} isFandomMiniApp={true} forceLogin={forceLogin} authInfo={authInfoStore} toExecutedTasks={toExecutedTasksFromSchema} />
    ​