文件索引

分組項目

在指南中

使用於 the Guide index.

用法與介面

DocumentationIndex 依章節、分類或字母整理大型目錄，作為 Guide 與 Reference 的入口。學習路徑應使用完整說明，依名稱查找 API 或 utility 則使用精簡連結清單。兩種檢視包含相同的目標。

每個章節應提供穩定的 id、標題、說明與 groups；章節依順序編號。具有多個分類的群組會在章節標頭旁顯示原生錨點捷徑；每個群組都應有自己的穩定 id，讓分享網址在重新排序後仍有效。showDescriptions 啟用完整、可換行的摘要；預設使用精簡連結。related 提供前往另一份目錄的連結。

<DocumentationIndex  name="guide"  sections={[{    id: 'learn', title: 'Learn',    description: 'Start with a working example.',    groups: [{ entries: [{      id: 'intro', title: 'Introduction', category: 'Guide',      description: 'Write your first classes.',      url: 'https://rc.css.master.co/guide/introduction',    }] }],  }]}  showDescriptions  related={{ href: 'https://rc.css.master.co/reference', title: 'Reference',    description: 'Look up a utility.' }}/>

目錄以書籍目次的方式閱讀：先以細線呈現編號章節目錄，並以交叉連結收尾；再將各章節排成帶分隔線的跨頁形式，從 44rem 起，編號、名稱與摘要會保留在項目旁。有說明的項目是帶分隔線的列，指標移入時顯示箭頭；精簡連結以多欄排列；A–Z 檢視則像書末索引般按字母分欄。整體不使用框架，手機上的觸控列保持 44px。元件自帶容器與欄位版面，應放在閱讀欄中、測量示範之外。分類與 A–Z 控制項是帶有按下狀態的原生按鈕；字母與分類捷徑是真實片段連結，也支援直接進入的網址。公開目錄省略 idPrefix 以保留原有錨點；只有同一檢視頁顯示多份目錄時，才設定不同前綴。完整分類檢視會包含在伺服器呈現的 HTML 中，A–Z 切換則需要 JavaScript。索引檢視頁呈現目前的目錄。