安裝擴充功能
Storybook 有數百個可重複使用的擴充功能,以 NPM 模組的形式封裝。讓我們逐步了解如何透過安裝和註冊擴充功能來擴展 Storybook。
自動安裝
Storybook 包含一個 storybook add
命令,可自動設定擴充功能。可以使用此命令新增數個社群主導的擴充功能,但預設擴充功能除外。我們建議您閱讀擴充功能的文件,以瞭解其安裝過程的詳細資訊。
使用您選擇的套件管理員執行 storybook add
命令,CLI 將會更新您的 Storybook 設定,以包含該擴充功能並安裝任何必要的相依性。
npx storybook@latest add @storybook/addon-a11y
如果您嘗試一次安裝多個擴充功能,則只會安裝指定的第一個擴充功能。這是目前實作的已知限制,將在未來的版本中解決。
手動安裝
Storybook 擴充功能一律透過 addons
設定陣列在 .storybook/main.js|ts
中新增。以下範例顯示如何手動將 可及性擴充功能新增至 Storybook。
使用您選擇的套件管理員執行下列命令來安裝擴充功能。
npm install @storybook/addon-a11y --save-dev
接下來,將 .storybook/main.js|ts
更新為下列內容
.storybook/main.ts
// Replace your-framework with the framework you are using (e.g., react-webpack5, vue3-vite)
import type { StorybookConfig } from '@storybook/your-framework';
const config: StorybookConfig = {
framework: '@storybook/your-framework',
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
addons: [
// Other Storybook addons
'@storybook/addon-a11y', //👈 The a11y addon goes here
],
};
export default config;
當您執行 Storybook 時,將會啟用可及性測試擴充功能。
移除擴充功能
若要從 Storybook 中移除擴充功能,您可以選擇手動解除安裝並從設定檔 (即 .storybook/main.js|ts
) 中移除,或選擇透過 CLI 使用 remove
命令自動執行。例如,若要使用 CLI 從 Storybook 中移除可及性擴充功能,請執行下列命令
npx storybook@latest remove @storybook/addon-a11y