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。