文件
Storybook 文件

功能與行為

若要控制 Storybook UI 的版面配置,您可以在 .storybook/manager.js 中使用 addons.setConfig

.storybook/manager.js
import { addons } from '@storybook/manager-api';
 
addons.setConfig({
  navSize: 300,
  bottomPanelHeight: 300,
  rightPanelWidth: 300,
  panelPosition: 'bottom',
  enableShortcuts: true,
  showToolbar: true,
  theme: undefined,
  selectedPanel: undefined,
  initialActive: 'sidebar',
  sidebar: {
    showRoots: false,
    collapsedRoots: ['other'],
  },
  toolbar: {
    title: { hidden: false },
    zoom: { hidden: false },
    eject: { hidden: false },
    copy: { hidden: false },
    fullscreen: { hidden: false },
  },
});

下表詳細說明如何使用 API 值

名稱類型描述範例值
navSize數字 (像素)顯示 stories 清單的側邊欄大小300
bottomPanelHeight數字 (像素)位於底部位置時,擴充套件面板的大小200
rightPanelWidth數字 (像素)位於右側位置時,擴充套件面板的大小200
panelPosition字串顯示擴充套件面板的位置'bottom''right'
enableShortcuts布林值啟用/停用快捷鍵true
showToolbar布林值顯示/隱藏工具列true
theme物件Storybook 主題,請參閱下一節undefined
selectedPanel字串選取擴充套件面板的 ID'storybook/actions/panel'
initialActive字串在行動裝置上選取預設的活動索引標籤'sidebar''canvas''addons'
sidebar物件側邊欄選項,請參閱下方{ showRoots: false }
toolbar物件使用擴充套件 ID 修改工具列中的工具{ fullscreen: { hidden: false } }

以下選項可在 sidebar 命名空間下設定

名稱類型描述範例值
showRoots布林值在側邊欄中將最上層節點顯示為「根目錄」false
collapsedRoots陣列預設視覺上要摺疊的根節點 ID 集['misc', 'other']
renderLabel函式為樹狀節點建立自訂標籤;必須傳回 ReactNode(item, api) => <abbr title="...">{item.name}</abbr>

以下選項可在 toolbar 命名空間下設定

名稱類型描述範例值
id字串切換工具列項目的可見性{ hidden: false }

透過 URL 參數設定

您可以使用 URL 參數來設定某些可用的功能

設定選項查詢參數支援的值
enableShortcutsshortcutsfalse
--- (全螢幕)fulltrue, false
--- (顯示側邊欄)navtrue, false
--- (顯示面板)panelfalse, 'right', 'bottom'
selectedPaneladdonPanel任何面板 ID
showTabstabstrue
---instrumentfalse, true