storybook-addon-compodoc

在 Storybook 中顯示從選取的故事的 Angular 元件的 Compodoc 頁面

運作方式？

注意：這僅適用於 Angular 元件！

此擴充套件會新增一個面板，顯示與選取的故事中的元件相關的 Compodoc 頁面。

安裝

npm install storybook-addon-compodoc --save-dev (或 --save-optional 或任何適合您的)

組態設定

註冊擴充套件

別忘了在您的 addons.js 檔案中註冊擴充套件。要執行此操作，應在此處包含 import 'storybook-addon-compodoc/register; 行。

在 config.js 中

在您的 config.js Storybook 檔案中，使用 configureCompodoc 提供您 Compodoc 產生文件部署的 URL，並使用 addDecorator(withCompodoc()) 新增全域裝飾器，例如：

import {configureCompodoc,withCompodoc} from 'storybook-addon-compodoc';
...
configureCompodoc({
  compodocUrl:'https://example.com/compodoc'
});
addDecorator(withCompodoc());

在每個故事中

在每個故事檔案中，您必須提供帶有元件類別名稱的參數，最好的方法是使用 addParameters 方法，例如：

const stories = storiesOf("Components/MyComponent", module);

stories.addParameters({
  componentClassName: "MyComponent"
});

待辦事項

• 初始工作版本
• 妥善處理錯誤和遺失的組態設定
• 至少為公用方法提供類型定義 (組態設定物件)
• 嘗試在無需手動提供元件名稱的情況下取得元件名稱
• 更新待辦事項