ナビゲーション

ドキュメント

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>

これらの読解用コンポーネントはデモの測定領域外に置きます。上の短い例は、公開 export 型の定義を複製せず参照しています。完全な宣言はパッケージカタログから現在のソースへリンクします。Compiler、Runtime、Tooling の完全な例を参照してください。