如何禁用故事书中的“文档”选项卡？

Question

如何在每个故事的基础上禁用“文档”（插件文档）选项卡？

我尝试将下面的关键值添加到故事中，但似乎没有任何效果。

parameters: {
  docs: { disable: true, hidden: true }
},

我正在运行 Storybook 5.3.8。

Answer 1

在MyStory.stories.j[t]sx文件中

要隐藏“文档”选项卡：

export default {
    title: 'YourTitle',
    parameters: {
        previewTabs: {
            'storybook/docs/panel': { hidden: true }
        },
        viewMode: 'canvas',
    }
};

要隐藏“画布”选项卡：

export default {
    title: 'YourTitle',
    parameters: {
        previewTabs: {
            canvas: { hidden: true},
        },
        viewMode: 'docs',
    }
};

有viewMode: 'docs/canvas'必要在该视图中设置默认选项卡，否则 Storybook 将显示上一个视图中打开的最后一个选项卡。

Answer 2

这将隐藏文档面板并仅显示画布：

  parameters: {
    previewTabs: {
      'storybook/docs/panel': {
        hidden: true,
      },
    },
  },

如果您只有一个标签，标签容器将被隐藏

Answer 3

旧答案为您提供了隐藏的技术，但如果有人将 URL 从故事更改为文档，它会显示结果，所以我为您提供完美文档选项卡的docs方法。remove

第一种方法

如果您将@storybook/addon-docs包添加到您的package.json并将其添加到.storybook/main.js（ addon array ）中，则删除它和restart您的故事书 webpack 服务器。

第二种方法

在最新版本中storybook，建议添加essentials来自storybook包含多个插件的插件包，例如actions, backgrounds, controls, docs, viewport, toolbars.

因此，如果您安装了该软件包并将其添加到.storybook/main.js插件数组中，则可以使用以下代码禁用它。

替换您的代码

module.exports = {
  addons: [
    ...,
    '@storybook/addon-essentials',
  ],
};

到

module.exports = {
  addons: [
    ...,
    {
      name: '@storybook/addon-essentials',
      options: {
        docs: false,
      },
    },
  ],
};

Answer 4

我设法用v6.0.0-alpha.28( @storybook/*@next) 和新参数做到了：

  previewTabs: {
    docs: { hidden: true },
  }

我添加了默认配置preview.js：

addParameters({
  previewTabs: {
    docs: {
      hidden: false
    },
    canvas: {
      title: 'Story',
      hidden: false,
    },
  },
})

并将文档重新定位为第一个选项卡manager.js：

import { addons } from '@storybook/addons';

addons.setConfig({
  previewTabs: {
    'storybook/docs/panel': { index: -1 },
  },
});

希望它长期有效:) 享受！