wix-storybook-utils/src/typings/story-config.ts

Utilities for automated component documentation within Storybook

import * as React from 'react';
import { Metadata } from './metadata';
import { Config } from './config';
import { StorySection } from './story-section';
import { StoryContent, StoryDemo, StoryExamples, StoryTabs } from './story';
import { ComponentsHints } from './components-hints';

export interface StoryConfig {
  metadata: Metadata;
  config: Config;
  storyName?: string;
  component?: React.ReactNode;
  componentPath?: string;
  componentProps?: any;
  componentWrapper?: any;
  /*
   * list of props that should not be displayed in playground
   */
  hiddenProps?: string[];
  displayName?: string;
  exampleProps?: any;

  /**
   * custom string to be displayed in place of import example
   * usually something like `import Component from 'module/Component';`
   */
  exampleImport?: string;
  examples?: any;

  /**
   * currently only bool possible. later same property shall be used for configuring code example
   * */
  codeExample?: boolean;
  sections?: StorySection[];

  story?: {
    loading?: boolean;
    config: {
      status: 'wip' | 'deprecated';
      statusMessage: string;
    };
    content: StoryContent;
    examples: StoryExamples;
    demo: StoryDemo;
    tabs: StoryTabs;
    examplesPreviewWrapper?(api: {
      component: React.ReactElement;
    }): React.ReactElement;
  };
  hints?: ComponentsHints;
}