文檔API
Storybook 文檔

API 參考文檔

所有 Storybook 可用 API 參考文檔的概覽。

設定

名稱描述
main.js|ts

Storybook 的主要設定檔,指定 Storybook 專案的行為,包括 stories 的位置、您使用的擴充套件、功能標誌和其他專案特定的設定。

preview.js|jsx|ts|tsx

此設定檔控制 stories 的渲染方式。您也可以使用它來執行適用於所有 stories 的程式碼。

manager.js|ts

此設定檔控制 Storybook UI (管理器) 的行為。

CLI

Storybook 是一個 CLI 工具。您可以在開發模式下啟動 Storybook,或建置 Storybook 的靜態版本。

Stories

名稱描述
CSF

組件 Story 格式 (CSF) 是撰寫 stories 的 API。它是一個基於 ES6 模組的開放標準,可攜性超越 Storybook。

ArgTypes

ArgTypes 指定args的行為。透過指定 arg 的類型,您可以約束其可接受的值,並提供有關未明確設定的 args 的資訊。

Parameters

Parameters 是用於在 Storybook 中設定您的stories擴充套件的靜態中繼資料。它們在 story、meta(組件)、專案(全域)層級指定。

文檔

名稱描述
文檔區塊

Storybook 提供了多種文檔區塊,以協助您記錄組件和專案的其他方面。