@storybook/addon-docs 6.5.7 → 7.0.0-alpha.0

package/dist/modern/blocks/ArgsTable.js

@@ -1,292 +0,0 @@
-function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-
-import React, { useContext, useEffect, useState, useCallback } from 'react';
-import mapValues from 'lodash/mapValues';
-import { ArgsTable as PureArgsTable, ArgsTableError, TabbedArgsTable } from '@storybook/components';
-import { addons } from '@storybook/addons';
-import { filterArgTypes } from '@storybook/store';
-import Events from '@storybook/core-events';
-import { DocsContext } from './DocsContext';
-import { CURRENT_SELECTION, PRIMARY_STORY } from './types';
-import { getComponentName } from './utils';
-import { lookupStoryId } from './Story';
-import { useStory } from './useStory';
-
-const getContext = (storyId, context) => {
-  const story = context.storyById(storyId);
-
-  if (!story) {
-    throw new Error(`Unknown story: ${storyId}`);
-  }
-
-  return context.getStoryContext(story);
-};
-
-const useArgs = (storyId, context) => {
-  const channel = addons.getChannel();
-  const storyContext = getContext(storyId, context);
-  const [args, setArgs] = useState(storyContext.args);
-  useEffect(() => {
-    const cb = changed => {
-      if (changed.storyId === storyId) {
-        setArgs(changed.args);
-      }
-    };
-
-    channel.on(Events.STORY_ARGS_UPDATED, cb);
-    return () => channel.off(Events.STORY_ARGS_UPDATED, cb);
-  }, [storyId]);
-  const updateArgs = useCallback(updatedArgs => channel.emit(Events.UPDATE_STORY_ARGS, {
-    storyId,
-    updatedArgs
-  }), [storyId]);
-  const resetArgs = useCallback(argNames => channel.emit(Events.RESET_STORY_ARGS, {
-    storyId,
-    argNames
-  }), [storyId]);
-  return [args, updateArgs, resetArgs];
-};
-
-const useGlobals = (storyId, context) => {
-  const channel = addons.getChannel();
-  const storyContext = getContext(storyId, context);
-  const [globals, setGlobals] = useState(storyContext.globals);
-  useEffect(() => {
-    const cb = changed => {
-      setGlobals(changed.globals);
-    };
-
-    channel.on(Events.GLOBALS_UPDATED, cb);
-    return () => channel.off(Events.GLOBALS_UPDATED, cb);
-  }, []);
-  return [globals];
-};
-
-export const extractComponentArgTypes = (component, {
-  id,
-  storyById
-}, include, exclude) => {
-  const {
-    parameters
-  } = storyById(id);
-  const {
-    extractArgTypes
-  } = parameters.docs || {};
-
-  if (!extractArgTypes) {
-    throw new Error(ArgsTableError.ARGS_UNSUPPORTED);
-  }
-
-  let argTypes = extractArgTypes(component);
-  argTypes = filterArgTypes(argTypes, include, exclude);
-  return argTypes;
-};
-
-const isShortcut = value => {
-  return value && [CURRENT_SELECTION, PRIMARY_STORY].includes(value);
-};
-
-export const getComponent = (props = {}, {
-  id,
-  storyById
-}) => {
-  const {
-    of
-  } = props;
-  const {
-    story
-  } = props;
-  const {
-    component
-  } = storyById(id);
-
-  if (isShortcut(of) || isShortcut(story)) {
-    return component || null;
-  }
-
-  if (!of) {
-    throw new Error(ArgsTableError.NO_COMPONENT);
-  }
-
-  return of;
-};
-
-const addComponentTabs = (tabs, components, context, include, exclude, sort) => Object.assign({}, tabs, mapValues(components, comp => ({
-  rows: extractComponentArgTypes(comp, context, include, exclude),
-  sort
-})));
-
-export const StoryTable = props => {
-  const context = useContext(DocsContext);
-  const {
-    id: currentId,
-    componentStories
-  } = context;
-  const {
-    story: storyName,
-    component,
-    subcomponents,
-    showComponent,
-    include,
-    exclude,
-    sort
-  } = props;
-
-  try {
-    let storyId;
-
-    switch (storyName) {
-      case CURRENT_SELECTION:
-        {
-          storyId = currentId;
-          break;
-        }
-
-      case PRIMARY_STORY:
-        {
-          const primaryStory = componentStories()[0];
-          storyId = primaryStory.id;
-          break;
-        }
-
-      default:
-        {
-          storyId = lookupStoryId(storyName, context);
-        }
-    }
-
-    const story = useStory(storyId, context); // eslint-disable-next-line prefer-const
-
-    let [args, updateArgs, resetArgs] = useArgs(storyId, context);
-    const [globals] = useGlobals(storyId, context);
-    if (!story) return /*#__PURE__*/React.createElement(PureArgsTable, {
-      isLoading: true,
-      updateArgs: updateArgs,
-      resetArgs: resetArgs
-    });
-    const argTypes = filterArgTypes(story.argTypes, include, exclude);
-    const mainLabel = getComponentName(component) || 'Story';
-    let tabs = {
-      [mainLabel]: {
-        rows: argTypes,
-        args,
-        globals,
-        updateArgs,
-        resetArgs
-      }
-    }; // Use the dynamically generated component tabs if there are no controls
-
-    const storyHasArgsWithControls = argTypes && Object.values(argTypes).find(v => !!(v !== null && v !== void 0 && v.control));
-
-    if (!storyHasArgsWithControls) {
-      updateArgs = null;
-      resetArgs = null;
-      tabs = {};
-    }
-
-    if (component && (!storyHasArgsWithControls || showComponent)) {
-      tabs = addComponentTabs(tabs, {
-        [mainLabel]: component
-      }, context, include, exclude);
-    }
-
-    if (subcomponents) {
-      if (Array.isArray(subcomponents)) {
-        throw new Error(`Unexpected subcomponents array. Expected an object whose keys are tab labels and whose values are components.`);
-      }
-
-      tabs = addComponentTabs(tabs, subcomponents, context, include, exclude);
-    }
-
-    return /*#__PURE__*/React.createElement(TabbedArgsTable, {
-      tabs: tabs,
-      sort: sort
-    });
-  } catch (err) {
-    return /*#__PURE__*/React.createElement(PureArgsTable, {
-      error: err.message
-    });
-  }
-};
-export const ComponentsTable = props => {
-  const context = useContext(DocsContext);
-  const {
-    components,
-    include,
-    exclude,
-    sort
-  } = props;
-  const tabs = addComponentTabs({}, components, context, include, exclude);
-  return /*#__PURE__*/React.createElement(TabbedArgsTable, {
-    tabs: tabs,
-    sort: sort
-  });
-};
-export const ArgsTable = props => {
-  const context = useContext(DocsContext);
-  const {
-    id,
-    storyById
-  } = context;
-  const {
-    parameters: {
-      controls
-    },
-    subcomponents
-  } = storyById(id);
-  const {
-    include,
-    exclude,
-    components,
-    sort: sortProp
-  } = props;
-  const {
-    story: storyName
-  } = props;
-  const sort = sortProp || (controls === null || controls === void 0 ? void 0 : controls.sort);
-  const main = getComponent(props, context);
-
-  if (storyName) {
-    return /*#__PURE__*/React.createElement(StoryTable, _extends({}, props, {
-      component: main,
-      subcomponents,
-      sort
-    }));
-  }
-
-  if (!components && !subcomponents) {
-    let mainProps;
-
-    try {
-      mainProps = {
-        rows: extractComponentArgTypes(main, context, include, exclude)
-      };
-    } catch (err) {
-      mainProps = {
-        error: err.message
-      };
-    }
-
-    return /*#__PURE__*/React.createElement(PureArgsTable, _extends({}, mainProps, {
-      sort: sort
-    }));
-  }
-
-  if (components) {
-    return /*#__PURE__*/React.createElement(ComponentsTable, _extends({}, props, {
-      components,
-      sort
-    }));
-  }
-
-  const mainLabel = getComponentName(main);
-  return /*#__PURE__*/React.createElement(ComponentsTable, _extends({}, props, {
-    components: Object.assign({
-      [mainLabel]: main
-    }, subcomponents),
-    sort: sort
-  }));
-};
-ArgsTable.defaultProps = {
-  of: CURRENT_SELECTION
-};

package/dist/modern/blocks/Canvas.js

@@ -1,83 +0,0 @@
-const _excluded = ["withSource", "mdxSource", "children"];
-
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-
-import React, { useContext } from 'react';
-import { MDXProvider } from '@mdx-js/react';
-import { toId, storyNameFromExport } from '@storybook/csf';
-import { resetComponents, Preview as PurePreview, PreviewSkeleton } from '@storybook/components';
-import { DocsContext } from './DocsContext';
-import { SourceContext } from './SourceContainer';
-import { getSourceProps, SourceState } from './Source';
-import { useStories } from './useStory';
-import { CURRENT_SELECTION } from './types';
-export { SourceState };
-
-const getPreviewProps = (_ref, docsContext, sourceContext) => {
-  let {
-    withSource,
-    mdxSource,
-    children
-  } = _ref,
-      props = _objectWithoutPropertiesLoose(_ref, _excluded);
-
-  const {
-    mdxComponentAnnotations,
-    mdxStoryNameToKey
-  } = docsContext;
-  let sourceState = withSource;
-  let isLoading = false;
-
-  if (sourceState === SourceState.NONE) {
-    return {
-      isLoading,
-      previewProps: props
-    };
-  }
-
-  if (mdxSource) {
-    return {
-      isLoading,
-      previewProps: Object.assign({}, props, {
-        withSource: getSourceProps({
-          code: decodeURI(mdxSource)
-        }, docsContext, sourceContext)
-      })
-    };
-  }
-
-  const childArray = Array.isArray(children) ? children : [children];
-  const storyChildren = childArray.filter(c => c.props && (c.props.id || c.props.name));
-  const targetIds = storyChildren.map(s => s.props.id || toId(mdxComponentAnnotations.id || mdxComponentAnnotations.title, storyNameFromExport(mdxStoryNameToKey[s.props.name])));
-  const sourceProps = getSourceProps({
-    ids: targetIds
-  }, docsContext, sourceContext);
-  if (!sourceState) sourceState = sourceProps.state;
-  const storyIds = targetIds.map(targetId => targetId === CURRENT_SELECTION ? docsContext.id : targetId);
-  const stories = useStories(storyIds, docsContext);
-  isLoading = stories.some(s => !s);
-  return {
-    isLoading,
-    previewProps: Object.assign({}, props, {
-      // pass through columns etc.
-      withSource: sourceProps,
-      isExpanded: sourceState === SourceState.OPEN
-    })
-  };
-};
-
-export const Canvas = props => {
-  const docsContext = useContext(DocsContext);
-  const sourceContext = useContext(SourceContext);
-  const {
-    isLoading,
-    previewProps
-  } = getPreviewProps(props, docsContext, sourceContext);
-  const {
-    children
-  } = props;
-  if (isLoading) return /*#__PURE__*/React.createElement(PreviewSkeleton, null);
-  return /*#__PURE__*/React.createElement(MDXProvider, {
-    components: resetComponents
-  }, /*#__PURE__*/React.createElement(PurePreview, previewProps, children));
-};

package/dist/modern/blocks/Description.js

@@ -1,107 +0,0 @@
-import React, { useContext } from 'react';
-import { Description } from '@storybook/components';
-import { str } from '@storybook/docs-tools';
-import { DocsContext } from './DocsContext';
-import { CURRENT_SELECTION } from './types';
-export let DescriptionType;
-
-(function (DescriptionType) {
-  DescriptionType["INFO"] = "info";
-  DescriptionType["NOTES"] = "notes";
-  DescriptionType["DOCGEN"] = "docgen";
-  DescriptionType["LEGACY_5_2"] = "legacy-5.2";
-  DescriptionType["AUTO"] = "auto";
-})(DescriptionType || (DescriptionType = {}));
-
-const getNotes = notes => notes && (typeof notes === 'string' ? notes : str(notes.markdown) || str(notes.text));
-
-const getInfo = info => info && (typeof info === 'string' ? info : str(info.text));
-
-const noDescription = component => null;
-
-export const getDescriptionProps = ({
-  of,
-  type,
-  markdown,
-  children
-}, {
-  id,
-  storyById
-}) => {
-  const {
-    component,
-    parameters
-  } = storyById(id);
-
-  if (children || markdown) {
-    return {
-      markdown: children || markdown
-    };
-  }
-
-  const {
-    notes,
-    info,
-    docs
-  } = parameters;
-  const {
-    extractComponentDescription = noDescription,
-    description
-  } = docs || {};
-  const target = of === CURRENT_SELECTION ? component : of; // override component description
-
-  const componentDescriptionParameter = description === null || description === void 0 ? void 0 : description.component;
-
-  if (componentDescriptionParameter) {
-    return {
-      markdown: componentDescriptionParameter
-    };
-  }
-
-  switch (type) {
-    case DescriptionType.INFO:
-      return {
-        markdown: getInfo(info)
-      };
-
-    case DescriptionType.NOTES:
-      return {
-        markdown: getNotes(notes)
-      };
-    // FIXME: remove in 6.0
-
-    case DescriptionType.LEGACY_5_2:
-      return {
-        markdown: `
-${getNotes(notes) || getInfo(info) || ''}
-
-${extractComponentDescription(target) || ''}
-`.trim()
-      };
-
-    case DescriptionType.DOCGEN:
-    case DescriptionType.AUTO:
-    default:
-      return {
-        markdown: extractComponentDescription(target, Object.assign({
-          component
-        }, parameters))
-      };
-  }
-};
-
-const DescriptionContainer = props => {
-  const context = useContext(DocsContext);
-  const {
-    markdown
-  } = getDescriptionProps(props, context);
-  return markdown ? /*#__PURE__*/React.createElement(Description, {
-    markdown: markdown
-  }) : null;
-}; // since we are in the docs blocks, assume default description if for primary component story
-
-
-DescriptionContainer.defaultProps = {
-  of: '.'
-};
-export { DescriptionContainer as Description };

package/dist/modern/blocks/DocsContainer.js

@@ -1,98 +0,0 @@
-import React, { useEffect } from 'react';
-import global from 'global';
-import deprecate from 'util-deprecate';
-import dedent from 'ts-dedent';
-import { MDXProvider } from '@mdx-js/react';
-import { ThemeProvider, ensure as ensureTheme } from '@storybook/theming';
-import { DocsWrapper, DocsContent, components as htmlComponents } from '@storybook/components';
-import { DocsContext } from './DocsContext';
-import { anchorBlockIdFromId } from './Anchor';
-import { storyBlockIdFromId } from './Story';
-import { SourceContainer } from './SourceContainer';
-import { CodeOrSourceMdx, AnchorMdx, HeadersMdx } from './mdx';
-import { scrollToElement } from './utils';
-const {
-  document,
-  window: globalWindow
-} = global;
-const defaultComponents = Object.assign({}, htmlComponents, {
-  code: CodeOrSourceMdx,
-  a: AnchorMdx
-}, HeadersMdx);
-const warnOptionsTheme = deprecate(() => {}, dedent`
-    Deprecated parameter: options.theme => docs.theme
-
-    https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/theming.md#storybook-theming
-`);
-export const DocsContainer = ({
-  context,
-  children
-}) => {
-  const {
-    id: storyId,
-    storyById
-  } = context;
-  const {
-    parameters: {
-      options = {},
-      docs = {}
-    }
-  } = storyById(storyId);
-  let themeVars = docs.theme;
-
-  if (!themeVars && options.theme) {
-    warnOptionsTheme();
-    themeVars = options.theme;
-  }
-
-  const theme = ensureTheme(themeVars);
-  const allComponents = Object.assign({}, defaultComponents, docs.components);
-  useEffect(() => {
-    let url;
-
-    try {
-      url = new URL(globalWindow.parent.location);
-    } catch (err) {
-      return;
-    }
-
-    if (url.hash) {
-      const element = document.getElementById(url.hash.substring(1));
-
-      if (element) {
-        // Introducing a delay to ensure scrolling works when it's a full refresh.
-        setTimeout(() => {
-          scrollToElement(element);
-        }, 200);
-      }
-    } else {
-      const element = document.getElementById(anchorBlockIdFromId(storyId)) || document.getElementById(storyBlockIdFromId(storyId));
-
-      if (element) {
-        const allStories = element.parentElement.querySelectorAll('[id|="anchor-"]');
-        let scrollTarget = element;
-
-        if (allStories && allStories[0] === element) {
-          // Include content above first story
-          scrollTarget = document.getElementById('docs-root');
-        } // Introducing a delay to ensure scrolling works when it's a full refresh.
-
-
-        setTimeout(() => {
-          scrollToElement(scrollTarget, 'start');
-        }, 200);
-      }
-    }
-  }, [storyId]);
-  return /*#__PURE__*/React.createElement(DocsContext.Provider, {
-    value: context
-  }, /*#__PURE__*/React.createElement(SourceContainer, null, /*#__PURE__*/React.createElement(ThemeProvider, {
-    theme: theme
-  }, /*#__PURE__*/React.createElement(MDXProvider, {
-    components: allComponents
-  }, /*#__PURE__*/React.createElement(DocsWrapper, {
-    className: "sbdocs sbdocs-wrapper"
-  }, /*#__PURE__*/React.createElement(DocsContent, {
-    className: "sbdocs sbdocs-content"
-  }, children))))));
-};

package/dist/modern/blocks/DocsContext.js

@@ -1,16 +0,0 @@
-import { createContext } from 'react';
-import { window as globalWindow } from 'global';
-
-// We add DocsContext to window. The reason is that in case DocsContext.ts is
-// imported multiple times (maybe once directly, and another time from a minified bundle)
-// we will have multiple DocsContext definitions - leading to lost context in
-// the React component tree.
-// This was specifically a problem with the Vite builder.
-
-/* eslint-disable no-underscore-dangle */
-if (globalWindow && globalWindow.__DOCS_CONTEXT__ === undefined) {
-  globalWindow.__DOCS_CONTEXT__ = /*#__PURE__*/createContext({});
-  globalWindow.__DOCS_CONTEXT__.displayName = 'DocsContext';
-}
-
-export const DocsContext = globalWindow ? globalWindow.__DOCS_CONTEXT__ : /*#__PURE__*/createContext({});

package/dist/modern/blocks/DocsPage.js

@@ -1,11 +0,0 @@
-import React from 'react';
-import { Title } from './Title';
-import { Subtitle } from './Subtitle';
-import { Description } from './Description';
-import { Primary } from './Primary';
-import { PRIMARY_STORY } from './types';
-import { ArgsTable } from './ArgsTable';
-import { Stories } from './Stories';
-export const DocsPage = () => /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Title, null), /*#__PURE__*/React.createElement(Subtitle, null), /*#__PURE__*/React.createElement(Description, null), /*#__PURE__*/React.createElement(Primary, null), /*#__PURE__*/React.createElement(ArgsTable, {
-  story: PRIMARY_STORY
-}), /*#__PURE__*/React.createElement(Stories, null));

package/dist/modern/blocks/DocsStory.js

@@ -1,48 +0,0 @@
-import React from 'react';
-import deprecate from 'util-deprecate';
-import dedent from 'ts-dedent';
-import { Subheading } from './Subheading';
-import { Anchor } from './Anchor';
-import { Description } from './Description';
-import { Story } from './Story';
-import { Canvas } from './Canvas';
-const warnStoryDescription = deprecate(() => {}, dedent`
-    Deprecated parameter: docs.storyDescription => docs.description.story
-      
-    https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#docs-description-parameter
-  `);
-export const DocsStory = ({
-  id,
-  name,
-  expanded = true,
-  withToolbar = false,
-  parameters = {}
-}) => {
-  let description;
-  const {
-    docs
-  } = parameters;
-
-  if (expanded && docs) {
-    var _docs$description;
-
-    description = (_docs$description = docs.description) === null || _docs$description === void 0 ? void 0 : _docs$description.story;
-
-    if (!description) {
-      description = docs.storyDescription;
-      if (description) warnStoryDescription();
-    }
-  }
-
-  const subheading = expanded && name;
-  return /*#__PURE__*/React.createElement(Anchor, {
-    storyId: id
-  }, subheading && /*#__PURE__*/React.createElement(Subheading, null, subheading), description && /*#__PURE__*/React.createElement(Description, {
-    markdown: description
-  }), /*#__PURE__*/React.createElement(Canvas, {
-    withToolbar: withToolbar
-  }, /*#__PURE__*/React.createElement(Story, {
-    id: id,
-    parameters: parameters
-  })));
-};

package/dist/modern/blocks/Heading.js

@@ -1,17 +0,0 @@
-import React from 'react';
-import { H2 } from '@storybook/components';
-import { HeaderMdx } from './mdx';
-export const Heading = ({
-  children,
-  disableAnchor
-}) => {
-  if (disableAnchor || typeof children !== 'string') {
-    return /*#__PURE__*/React.createElement(H2, null, children);
-  }
-
-  const tagID = children.toLowerCase().replace(/[^a-z0-9]/gi, '-');
-  return /*#__PURE__*/React.createElement(HeaderMdx, {
-    as: "h2",
-    id: tagID
-  }, children);
-};