文档
Storybook 文档

功能和行为

要控制 Storybook UI 的布局,您可以使用 addons.setConfig 在您的 .storybook/manager.js

.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数字 (像素)显示 story 列表的侧边栏大小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