ProtocolComponent

类型源码

ProtocolComponent(*args: Any, **kwargs: Any)

注意

该协议类型只用作类型提示，不在运行时实现任何功能。

用来提供组件的协议。该协议的实现为renderer.components。

参数

该类未指定初始化方法。

协议方法

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 导航条的协议。返回值是一个 PyDantic 模型类型。