网站导航

文档

API 声明

API 声明的可用示例与编写接口。

DocumentAPIIndex 将 import 路径、export 名称与用途放在一起。这是由服务器渲染的导航列表:标识符会在路径分隔处与词边界换行,但不会改变复制的文字;每个目标都是可通过键盘操作的普通链接。放在 DocumentDisclosure 中的符号列表应使用 compact 变体。

导出项示例
export type EngineFactory =  typeof import("@master/css").createEngine;
export type CompileOptions =  import("@master/css-compiler").MasterCSSCompileOptions;

DocumentDeclaration 复用服务器端语法高亮与共用的键盘复制控件。超过 40 行的声明会使用原生折叠区域,完整文字仍保留在文档与可移植导出中。长代码行只在区块内滚动。组件不会编译或执行 TypeScript。复制控件会在客户端初始化后启用,阅读与原生展开功能则在此之前就能使用。

<DocumentAPIIndex label="Import paths" entries={[  { name: '@master/css', href: 'https://rc.css.master.co/reference/packages#css',    description: 'Engine sessions and class rendering.' }]} /><DocumentDeclaration label="Engine factory">{declaration}</DocumentDeclaration>

这些阅读用组件应放在示例的测量区域之外。上方的小示例只引用公开导出的类型,不复制其定义。包目录会链接到当前源代码,以提供完整声明。完整示例请参阅 Compiler、Runtime 和 Tooling。