Components

ClassSource

Components()

The collection of components. This centralized component renderer will provide the components with proper memory.

Arguments

No argument is needed.

Methods

get_headers

v_1: str = self.get_headers()

Format components as headers during the page rendering.

Returns

Name	Type	Description
v_1	str	The header texts containing multiple import lines of the MDX components.

---

icon_obj

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

The protocol of the subtitle icon.

Requires

Name	Type	Required	Description
type	Literal["method", "op", "param", "package", "module", "class", "func", "type"]		The name determining the icon.
text	str		An optional text after the icon. If it is empty, will only display the icon.

Returns

Name	Type	Description
v_1	str	The MDX code of the icon-text.

---

inline_icon

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

The protocol of special single icon.

Requires

Name	Type	Required	Description
icon	Literal["check"]		The name determining the icon.

Returns

Name	Type	Description
v_1	str	The MDX code of the icon.

Properties

apibar

apibar: type[ComponentAPIBar] = self.apibar

The API top bar component. It is an MDX API bar synthesizer.