跳转到主要内容

Back to Component Library

Return to the main component library index
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg
Code Components
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg

代码组件

自定义代码块

高级代码块,支持占位符替换、前后注释以及可选的展开输出部分。 导入:
import { CustomCodeBlock } from "/snippets/components/content/code.jsx";
属性:
属性类型默认值必填描述
filenamestring-要在标题中显示的文件名称
iconstring-要在标题中显示的图标
languagestring-编程语言用于语法高亮
highlightstring-要高亮的行号/范围(例如,“1-3,5”)
codeStringstring""要显示的代码内容
placeholderValuestring""要替换的值
wrapbooleantrue是否换行长行
linesbooleantrue是否显示行号
preNotestring""在代码块之前显示的注释
postNotestring""在代码块之后显示的注释
outputobject-可选输出配置
output.codeStringstring-输出代码内容
output.filenamestring-输出文件名
output.iconstring-输出图标
output.languagestring-输出语言
示例:
example.js
const apiKey = 'your-key-here';

CodeComponent

简单的代码块包装组件。 导入:
import { CodeComponent } from "/snippets/components/content/code.jsx";
属性: 接受标准的 CodeBlock 属性(language, filename, icon 等) 注意: 这是 Mintlify 的 CodeBlock 组件的包装器。

ComplexCodeBlock

功能丰富的代码块,包括占位符替换和输出部分等多重功能。 导入:
import { ComplexCodeBlock } from "/snippets/components/content/code.jsx";
属性: 与 … 类似CustomCodeBlock 但具有额外的复杂性处理。

CodeSection

用于组织多个代码块的章节包装器。 导入:
import { CodeSection } from "/snippets/components/content/code.jsx";
属性:
属性类型默认必需描述
childrenReactNode-代码块以显示
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg
External Content
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg

外部内容

ExternalContent

用于显示外部 GitHub 内容的可重用组件,包含标题和可滚动容器。 导入:
import { ExternalContent } from "/snippets/components/content/external-content.jsx";
属性:
属性类型默认值必需描述
repoNamestring-仓库名称(例如,“livepeer/awesome-livepeer”)
githubUrlstring-完整的 GitHub 仓库 URL
maxHeightstring"1000px"可滚动容器的最大高度
iconstring"github"在标题中显示的图标
childrenReactNode-要显示的内容(通常导入的MDX)
示例:
livepeer/docsView on GitHub

External content from the Livepeer documentation repository.

  • Automatically styled container
  • Link to GitHub source
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg
API Response Fields
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg

API 响应字段

ValueResponseField

ResponseField 容器,用于显示带有可选标签和行样式的值。 导入:
import { ValueResponseField } from "/snippets/components/content/responseField.jsx";
属性:
属性类型默认值必需描述
descriptionstring|function-描述文本或返回描述的函数
postanynull描述后的显示值
labelstring"value"值的标签
linebooleantrue是否显示底部边框线
childrenReactNode-附加内容
...propsobject-CustomResponseField 的附加 ResponseField 属性(name、type、default、required 等)

自定义 ResponseField

ResponseField 容器,隐藏底部分隔线。 导入:
import { CustomResponseField } from "/snippets/components/content/responseField.jsx";
属性:
属性类型默认值必需描述
descriptionstring-描述文本
...propsobject-所有 ResponseField 属性(name、type、default、required、post 等)

ResponseFieldExpandable

在可展开部分中分组多个响应字段。 导入:
import { ResponseFieldExpandable } from "/snippets/components/content/responseField.jsx";
属性:
属性类型默认值必需描述
fieldsArray|Object{}字段定义的数组或对象
...propsobject-可展开组件的属性(标题等)

ResponseFieldAccordion

在可折叠组件中分组多个响应字段。 导入:
import { ResponseFieldAccordion } from "/snippets/components/content/responseField.jsx";
属性:
属性类型默认必需描述
fieldsArray|Object{}字段定义的数组或对象
...propsobject-折叠面板组件属性(标题等)

ResponseFieldGroup

运行时选择 accordion 或 expandable 布局的包装器。 导入:
import { ResponseFieldGroup } from "/snippets/components/content/responseField.jsx";
属性:
属性类型默认必需描述
componentstring"accordion"组件类型:“accordion” 或 “expandable”
fieldsArray|Object{}字段定义的数组或对象
...propsobject-组件属性(标题等)
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg
Data Display Components
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg

数据展示组件

博客卡片

专为博客文章设计的卡片组件,支持阅读时间和摘要。 导入:
import { BlogCard } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必需描述
titlestring-博客文章的标题
contentstring-要显示的HTML内容
hrefstring-博客文章的链接URL
authorstring"Livepeer Team"作者名称
datePostedstringnull发布日期
excerptstringnull简短摘录(如果链接到外部博客使用)
readingTimenumbernull预计阅读时间(分钟)
iconstring"book-open"卡片的图标
ctastring"Read More"行动呼吁按钮文本
imgstringnull可选图片URL

PostCard

用于显示论坛帖子或文章的卡片组件,包含作者、日期和元数据。 导入:
import { PostCard } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必填描述
titlestring-文章标题
contentstring-HTML 内容以显示
hrefstring-卡片的链接网址
authorstring"Unknown"作者名称
datePostedstringnull帖子发布的日期
iconstring"book-open"卡片上显示的图标
ctastring"Read More"行动呼吁按钮文本
imgstringnull卡片的可选图片 URL

CardBlogDataLayout

用于在垂直布局中显示多个 BlogCards 的布局组件。 导入:
import { CardBlogDataLayout } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必需描述
itemsArray[]BlogCard 属性对象数组
limitnumber-可选的项目数量限制

ColumnsBlogCardLayout

用于在列中显示多个 BlogCards 的布局组件。 导入:
import { ColumnsBlogCardLayout } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必填描述
itemsArray[]BlogCard 属性对象数组
colsnumber2列数
limitnumber-可选的项目数量限制

CardColumnsPostLayout

用于在列中显示多个 PostCards 的布局组件。 导入:
import { CardColumnsPostLayout } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必需描述
colsnumber2要显示的列数
itemsArray[]PostCard 属性对象数组
limitnumber-对项目数量的可选限制

Discord公告

从 discordAnnouncementsData.jsx 显示 Discord 公告。 导入:
import { DiscordAnnouncements } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必需描述
itemsArray[]公告对象数组
limitnumber-可选的公告数量限制
**注意:**需要数据来自 snippets/automations/discord/discordAnnouncementsData.jsx

LumaEvents

从 lumaEventsData.jsx 显示 Luma 事件。 导入:
import { LumaEvents } from "/snippets/components/content/data.jsx";
属性:
属性类型默认值必需描述
dataObject-包含即将开始和过去的事件数据对象
limitnumber-事件数量的可选限制
typestring"upcoming"事件类型:“upcoming”、“past” 或 “all”
注意: 需要来自snippets/automations/luma/lumaEventsData.jsx
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg
Version Components
/snippets/assets/logos/Livepeer-Logo-Symbol-Theme.svg

版本组件

最新版本

用于获取 go-livepeer 最新发布版本的 GitHub 操作封装。 导入:
import { LatestVersion } from "/snippets/components/content/release.jsx";
属性:
属性类型默认值必需描述
versionstring-版本字符串(通常来自 GitHub 操作)

Next: Layout Components

Continue to Layout Components →
Last modified on March 1, 2026