Components

类源码

Components()

组件的集合。这一集中式的组件渲染器、透过合理维护缓存、提供局部所需的组件。

参数

该类的初始化无需参数。

方法

get_headers

v_1: str = self.get_headers()

在页面渲染时，将组件渲染为页面标头代码。

输出

参数	类型	说明
v_1	str	所渲染的标头文字，包含多行导入，每行导入一个 MDX 组件。

---

icon_obj

v_1: str = self.icon_obj(
    type: Literal[
        "method", "op", "param", "package", "module", "class", "func", "type"
    ],
    text: str = "",
)

用来插入子标题图标的协议实现。

输入

参数	类型	必选	说明
type	Literal["method", "op", "param", "package", "module", "class", "func", "type"]		该类型名称用来决定图标。
text	str		跟随在图标后面的可选文字。如果留空，则只会显示图标。

输出

参数	类型	说明
v_1	str	图标–文字的 MDX 代码。

---

inline_icon

v_1: str = self.inline_icon(icon: Literal["check"])

用来插入特殊图标的协议实现。

输入

参数	类型	必选	说明
icon	Literal["check"]		该类型名称用来决定图标。

输出

参数	类型	说明
v_1	str	图标的 MDX 代码。

属性

apibar

apibar: type[ComponentAPIBar] = self.apibar

顶部 API 导航条。返回值是一个用来合成 MDX 格式 API 导航条的合成器。