@storybook/addon-docs 6.5.9 → 7.0.0-alpha.10

package/dist/cjs/blocks/utils.js

@@ -1,61 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getComponentName = void 0;
-exports.scrollToElement = scrollToElement;
-
-require("core-js/modules/es.array.join.js");
-
-require("core-js/modules/es.array.map.js");
-
-require("core-js/modules/es.regexp.exec.js");
-
-require("core-js/modules/es.string.split.js");
-
-require("core-js/modules/es.array.slice.js");
-
-require("core-js/modules/es.array.includes.js");
-
-require("core-js/modules/es.string.includes.js");
-
-require("core-js/modules/es.function.name.js");
-
-/* eslint-disable no-underscore-dangle */
-var titleCase = function titleCase(str) {
-  return str.split('-').map(function (part) {
-    return part.charAt(0).toUpperCase() + part.slice(1);
-  }).join('');
-};
-
-var getComponentName = function getComponentName(component) {
-  if (!component) {
-    return undefined;
-  }
-
-  if (typeof component === 'string') {
-    if (component.includes('-')) {
-      return titleCase(component);
-    }
-
-    return component;
-  }
-
-  if (component.__docgenInfo && component.__docgenInfo.displayName) {
-    return component.__docgenInfo.displayName;
-  }
-
-  return component.name;
-};
-
-exports.getComponentName = getComponentName;
-
-function scrollToElement(element) {
-  var block = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'start';
-  element.scrollIntoView({
-    behavior: 'smooth',
-    block: block,
-    inline: 'nearest'
-  });
-}

package/dist/esm/blocks/Anchor.js

@@ -1,11 +0,0 @@
-import React from 'react';
-export var anchorBlockIdFromId = function anchorBlockIdFromId(storyId) {
-  return "anchor--".concat(storyId);
-};
-export var Anchor = function Anchor(_ref) {
-  var storyId = _ref.storyId,
-      children = _ref.children;
-  return /*#__PURE__*/React.createElement("div", {
-    id: anchorBlockIdFromId(storyId)
-  }, children);
-};

package/dist/esm/blocks/ArgsTable.js

@@ -1,341 +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); }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-import "core-js/modules/es.array.includes.js";
-import "core-js/modules/es.string.includes.js";
-import "core-js/modules/es.object.assign.js";
-import "core-js/modules/es.array.sort.js";
-import "core-js/modules/es.array.find.js";
-import "core-js/modules/es.object.to-string.js";
-import "core-js/modules/es.object.values.js";
-import "core-js/modules/es.symbol.js";
-import "core-js/modules/es.symbol.description.js";
-import "core-js/modules/es.symbol.iterator.js";
-import "core-js/modules/es.array.iterator.js";
-import "core-js/modules/es.string.iterator.js";
-import "core-js/modules/web.dom-collections.iterator.js";
-import "core-js/modules/es.array.slice.js";
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.array.from.js";
-import "core-js/modules/es.regexp.exec.js";
-
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
-
-function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-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';
-
-var getContext = function getContext(storyId, context) {
-  var story = context.storyById(storyId);
-
-  if (!story) {
-    throw new Error("Unknown story: ".concat(storyId));
-  }
-
-  return context.getStoryContext(story);
-};
-
-var useArgs = function useArgs(storyId, context) {
-  var channel = addons.getChannel();
-  var storyContext = getContext(storyId, context);
-
-  var _useState = useState(storyContext.args),
-      _useState2 = _slicedToArray(_useState, 2),
-      args = _useState2[0],
-      setArgs = _useState2[1];
-
-  useEffect(function () {
-    var cb = function cb(changed) {
-      if (changed.storyId === storyId) {
-        setArgs(changed.args);
-      }
-    };
-
-    channel.on(Events.STORY_ARGS_UPDATED, cb);
-    return function () {
-      return channel.off(Events.STORY_ARGS_UPDATED, cb);
-    };
-  }, [storyId]);
-  var updateArgs = useCallback(function (updatedArgs) {
-    return channel.emit(Events.UPDATE_STORY_ARGS, {
-      storyId: storyId,
-      updatedArgs: updatedArgs
-    });
-  }, [storyId]);
-  var resetArgs = useCallback(function (argNames) {
-    return channel.emit(Events.RESET_STORY_ARGS, {
-      storyId: storyId,
-      argNames: argNames
-    });
-  }, [storyId]);
-  return [args, updateArgs, resetArgs];
-};
-
-var useGlobals = function useGlobals(storyId, context) {
-  var channel = addons.getChannel();
-  var storyContext = getContext(storyId, context);
-
-  var _useState3 = useState(storyContext.globals),
-      _useState4 = _slicedToArray(_useState3, 2),
-      globals = _useState4[0],
-      setGlobals = _useState4[1];
-
-  useEffect(function () {
-    var cb = function cb(changed) {
-      setGlobals(changed.globals);
-    };
-
-    channel.on(Events.GLOBALS_UPDATED, cb);
-    return function () {
-      return channel.off(Events.GLOBALS_UPDATED, cb);
-    };
-  }, []);
-  return [globals];
-};
-
-export var extractComponentArgTypes = function extractComponentArgTypes(component, _ref, include, exclude) {
-  var id = _ref.id,
-      storyById = _ref.storyById;
-
-  var _storyById = storyById(id),
-      parameters = _storyById.parameters;
-
-  var _ref2 = parameters.docs || {},
-      extractArgTypes = _ref2.extractArgTypes;
-
-  if (!extractArgTypes) {
-    throw new Error(ArgsTableError.ARGS_UNSUPPORTED);
-  }
-
-  var argTypes = extractArgTypes(component);
-  argTypes = filterArgTypes(argTypes, include, exclude);
-  return argTypes;
-};
-
-var isShortcut = function isShortcut(value) {
-  return value && [CURRENT_SELECTION, PRIMARY_STORY].includes(value);
-};
-
-export var getComponent = function getComponent() {
-  var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-  var _ref3 = arguments.length > 1 ? arguments[1] : undefined,
-      id = _ref3.id,
-      storyById = _ref3.storyById;
-
-  var _ref4 = props,
-      of = _ref4.of;
-  var _ref5 = props,
-      story = _ref5.story;
-
-  var _storyById2 = storyById(id),
-      component = _storyById2.component;
-
-  if (isShortcut(of) || isShortcut(story)) {
-    return component || null;
-  }
-
-  if (!of) {
-    throw new Error(ArgsTableError.NO_COMPONENT);
-  }
-
-  return of;
-};
-
-var addComponentTabs = function addComponentTabs(tabs, components, context, include, exclude, sort) {
-  return Object.assign({}, tabs, mapValues(components, function (comp) {
-    return {
-      rows: extractComponentArgTypes(comp, context, include, exclude),
-      sort: sort
-    };
-  }));
-};
-
-export var StoryTable = function StoryTable(props) {
-  var context = useContext(DocsContext);
-  var currentId = context.id,
-      componentStories = context.componentStories;
-  var storyName = props.story,
-      component = props.component,
-      subcomponents = props.subcomponents,
-      showComponent = props.showComponent,
-      include = props.include,
-      exclude = props.exclude,
-      sort = props.sort;
-
-  try {
-    var storyId;
-
-    switch (storyName) {
-      case CURRENT_SELECTION:
-        {
-          storyId = currentId;
-          break;
-        }
-
-      case PRIMARY_STORY:
-        {
-          var primaryStory = componentStories()[0];
-          storyId = primaryStory.id;
-          break;
-        }
-
-      default:
-        {
-          storyId = lookupStoryId(storyName, context);
-        }
-    }
-
-    var story = useStory(storyId, context); // eslint-disable-next-line prefer-const
-
-    var _useArgs = useArgs(storyId, context),
-        _useArgs2 = _slicedToArray(_useArgs, 3),
-        args = _useArgs2[0],
-        updateArgs = _useArgs2[1],
-        resetArgs = _useArgs2[2];
-
-    var _useGlobals = useGlobals(storyId, context),
-        _useGlobals2 = _slicedToArray(_useGlobals, 1),
-        globals = _useGlobals2[0];
-
-    if (!story) return /*#__PURE__*/React.createElement(PureArgsTable, {
-      isLoading: true,
-      updateArgs: updateArgs,
-      resetArgs: resetArgs
-    });
-    var argTypes = filterArgTypes(story.argTypes, include, exclude);
-    var mainLabel = getComponentName(component) || 'Story';
-
-    var tabs = _defineProperty({}, mainLabel, {
-      rows: argTypes,
-      args: args,
-      globals: globals,
-      updateArgs: updateArgs,
-      resetArgs: resetArgs
-    }); // Use the dynamically generated component tabs if there are no controls
-
-
-    var storyHasArgsWithControls = argTypes && Object.values(argTypes).find(function (v) {
-      return !!(v !== null && v !== void 0 && v.control);
-    });
-
-    if (!storyHasArgsWithControls) {
-      updateArgs = null;
-      resetArgs = null;
-      tabs = {};
-    }
-
-    if (component && (!storyHasArgsWithControls || showComponent)) {
-      tabs = addComponentTabs(tabs, _defineProperty({}, 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 var ComponentsTable = function ComponentsTable(props) {
-  var context = useContext(DocsContext);
-  var components = props.components,
-      include = props.include,
-      exclude = props.exclude,
-      sort = props.sort;
-  var tabs = addComponentTabs({}, components, context, include, exclude);
-  return /*#__PURE__*/React.createElement(TabbedArgsTable, {
-    tabs: tabs,
-    sort: sort
-  });
-};
-export var ArgsTable = function ArgsTable(props) {
-  var context = useContext(DocsContext);
-  var id = context.id,
-      storyById = context.storyById;
-
-  var _storyById3 = storyById(id),
-      controls = _storyById3.parameters.controls,
-      subcomponents = _storyById3.subcomponents;
-
-  var _ref6 = props,
-      include = _ref6.include,
-      exclude = _ref6.exclude,
-      components = _ref6.components,
-      sortProp = _ref6.sort;
-  var _ref7 = props,
-      storyName = _ref7.story;
-  var sort = sortProp || (controls === null || controls === void 0 ? void 0 : controls.sort);
-  var main = getComponent(props, context);
-
-  if (storyName) {
-    return /*#__PURE__*/React.createElement(StoryTable, _extends({}, props, {
-      component: main,
-      subcomponents: subcomponents,
-      sort: sort
-    }));
-  }
-
-  if (!components && !subcomponents) {
-    var 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: components,
-      sort: sort
-    }));
-  }
-
-  var mainLabel = getComponentName(main);
-  return /*#__PURE__*/React.createElement(ComponentsTable, _extends({}, props, {
-    components: Object.assign(_defineProperty({}, mainLabel, main), subcomponents),
-    sort: sort
-  }));
-};
-ArgsTable.defaultProps = {
-  of: CURRENT_SELECTION
-};

package/dist/esm/blocks/Canvas.js

@@ -1,95 +0,0 @@
-import "core-js/modules/es.object.keys.js";
-import "core-js/modules/es.symbol.js";
-var _excluded = ["withSource", "mdxSource", "children"];
-import "core-js/modules/es.object.assign.js";
-import "core-js/modules/es.array.filter.js";
-import "core-js/modules/es.object.to-string.js";
-import "core-js/modules/es.function.name.js";
-import "core-js/modules/es.array.map.js";
-
-function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-
-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 };
-
-var getPreviewProps = function getPreviewProps(_ref, docsContext, sourceContext) {
-  var withSource = _ref.withSource,
-      mdxSource = _ref.mdxSource,
-      children = _ref.children,
-      props = _objectWithoutProperties(_ref, _excluded);
-
-  var mdxComponentAnnotations = docsContext.mdxComponentAnnotations,
-      mdxStoryNameToKey = docsContext.mdxStoryNameToKey;
-  var sourceState = withSource;
-  var isLoading = false;
-
-  if (sourceState === SourceState.NONE) {
-    return {
-      isLoading: isLoading,
-      previewProps: props
-    };
-  }
-
-  if (mdxSource) {
-    return {
-      isLoading: isLoading,
-      previewProps: Object.assign({}, props, {
-        withSource: getSourceProps({
-          code: decodeURI(mdxSource)
-        }, docsContext, sourceContext)
-      })
-    };
-  }
-
-  var childArray = Array.isArray(children) ? children : [children];
-  var storyChildren = childArray.filter(function (c) {
-    return c.props && (c.props.id || c.props.name);
-  });
-  var targetIds = storyChildren.map(function (s) {
-    return s.props.id || toId(mdxComponentAnnotations.id || mdxComponentAnnotations.title, storyNameFromExport(mdxStoryNameToKey[s.props.name]));
-  });
-  var sourceProps = getSourceProps({
-    ids: targetIds
-  }, docsContext, sourceContext);
-  if (!sourceState) sourceState = sourceProps.state;
-  var storyIds = targetIds.map(function (targetId) {
-    return targetId === CURRENT_SELECTION ? docsContext.id : targetId;
-  });
-  var stories = useStories(storyIds, docsContext);
-  isLoading = stories.some(function (s) {
-    return !s;
-  });
-  return {
-    isLoading: isLoading,
-    previewProps: Object.assign({}, props, {
-      // pass through columns etc.
-      withSource: sourceProps,
-      isExpanded: sourceState === SourceState.OPEN
-    })
-  };
-};
-
-export var Canvas = function Canvas(props) {
-  var docsContext = useContext(DocsContext);
-  var sourceContext = useContext(SourceContext);
-
-  var _getPreviewProps = getPreviewProps(props, docsContext, sourceContext),
-      isLoading = _getPreviewProps.isLoading,
-      previewProps = _getPreviewProps.previewProps;
-
-  var children = props.children;
-  if (isLoading) return /*#__PURE__*/React.createElement(PreviewSkeleton, null);
-  return /*#__PURE__*/React.createElement(MDXProvider, {
-    components: resetComponents
-  }, /*#__PURE__*/React.createElement(PurePreview, previewProps, children));
-};

package/dist/esm/blocks/Description.js

@@ -1,113 +0,0 @@
-import "core-js/modules/es.symbol.js";
-import "core-js/modules/es.symbol.description.js";
-import "core-js/modules/es.string.trim.js";
-import "core-js/modules/es.array.concat.js";
-import "core-js/modules/es.object.assign.js";
-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 var DescriptionType;
-
-(function (DescriptionType) {
-  DescriptionType["INFO"] = "info";
-  DescriptionType["NOTES"] = "notes";
-  DescriptionType["DOCGEN"] = "docgen";
-  DescriptionType["LEGACY_5_2"] = "legacy-5.2";
-  DescriptionType["AUTO"] = "auto";
-})(DescriptionType || (DescriptionType = {}));
-
-var getNotes = function getNotes(notes) {
-  return notes && (typeof notes === 'string' ? notes : str(notes.markdown) || str(notes.text));
-};
-
-var getInfo = function getInfo(info) {
-  return info && (typeof info === 'string' ? info : str(info.text));
-};
-
-var noDescription = function noDescription(component) {
-  return null;
-};
-
-export var getDescriptionProps = function getDescriptionProps(_ref, _ref2) {
-  var of = _ref.of,
-      type = _ref.type,
-      markdown = _ref.markdown,
-      children = _ref.children;
-  var id = _ref2.id,
-      storyById = _ref2.storyById;
-
-  var _storyById = storyById(id),
-      component = _storyById.component,
-      parameters = _storyById.parameters;
-
-  if (children || markdown) {
-    return {
-      markdown: children || markdown
-    };
-  }
-
-  var notes = parameters.notes,
-      info = parameters.info,
-      docs = parameters.docs;
-
-  var _ref3 = docs || {},
-      _ref3$extractComponen = _ref3.extractComponentDescription,
-      extractComponentDescription = _ref3$extractComponen === void 0 ? noDescription : _ref3$extractComponen,
-      description = _ref3.description;
-
-  var target = of === CURRENT_SELECTION ? component : of; // override component description
-
-  var 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: "\n".concat(getNotes(notes) || getInfo(info) || '', "\n\n").concat(extractComponentDescription(target) || '', "\n").trim()
-      };
-
-    case DescriptionType.DOCGEN:
-    case DescriptionType.AUTO:
-    default:
-      return {
-        markdown: extractComponentDescription(target, Object.assign({
-          component: component
-        }, parameters))
-      };
-  }
-};
-
-var DescriptionContainer = function DescriptionContainer(props) {
-  var context = useContext(DocsContext);
-
-  var _getDescriptionProps = getDescriptionProps(props, context),
-      markdown = _getDescriptionProps.markdown;
-
-  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 };