@storybook/addon-docs 7.0.0-alpha.4 → 7.0.0-alpha.40

package/dist/cjs/blocks/Description.js

@@ -1,126 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getDescriptionProps = exports.DescriptionType = exports.Description = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _components = require("@storybook/components");
-
-var _docsTools = require("@storybook/docs-tools");
-
-var _DocsContext = require("./DocsContext");
-
-var _types = require("./types");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-let DescriptionType;
-exports.DescriptionType = DescriptionType;
-
-(function (DescriptionType) {
-  DescriptionType["INFO"] = "info";
-  DescriptionType["NOTES"] = "notes";
-  DescriptionType["DOCGEN"] = "docgen";
-  DescriptionType["LEGACY_5_2"] = "legacy-5.2";
-  DescriptionType["AUTO"] = "auto";
-})(DescriptionType || (exports.DescriptionType = DescriptionType = {}));
-
-const getNotes = notes => notes && (typeof notes === 'string' ? notes : (0, _docsTools.str)(notes.markdown) || (0, _docsTools.str)(notes.text));
-
-const getInfo = info => info && (typeof info === 'string' ? info : (0, _docsTools.str)(info.text));
-
-const noDescription = component => null;
-
-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 === _types.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))
-      };
-  }
-};
-
-exports.getDescriptionProps = getDescriptionProps;
-
-const DescriptionContainer = props => {
-  const context = (0, _react.useContext)(_DocsContext.DocsContext);
-  const {
-    markdown
-  } = getDescriptionProps(props, context);
-  return markdown ? /*#__PURE__*/_react.default.createElement(_components.Description, {
-    markdown: markdown
-  }) : null;
-}; // since we are in the docs blocks, assume default description if for primary component story
-
-
-exports.Description = DescriptionContainer;
-DescriptionContainer.defaultProps = {
-  of: '.'
-};

package/dist/cjs/blocks/DocsContainer.js

@@ -1,127 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocsContainer = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _global = _interopRequireDefault(require("global"));
-
-var _utilDeprecate = _interopRequireDefault(require("util-deprecate"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _react2 = require("@mdx-js/react");
-
-var _theming = require("@storybook/theming");
-
-var _components = require("@storybook/components");
-
-var _DocsContext = require("./DocsContext");
-
-var _Anchor = require("./Anchor");
-
-var _Story = require("./Story");
-
-var _SourceContainer = require("./SourceContainer");
-
-var _mdx = require("./mdx");
-
-var _utils = require("./utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-const {
-  document,
-  window: globalWindow
-} = _global.default;
-const defaultComponents = Object.assign({}, _components.components, {
-  code: _mdx.CodeOrSourceMdx,
-  a: _mdx.AnchorMdx
-}, _mdx.HeadersMdx);
-const warnOptionsTheme = (0, _utilDeprecate.default)(() => {}, (0, _tsDedent.default)`
-    Deprecated parameter: options.theme => docs.theme
-
-    https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/theming.md#storybook-theming
-`);
-
-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 = (0, _theming.ensure)(themeVars);
-  const allComponents = Object.assign({}, defaultComponents, docs.components);
-  (0, _react.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(() => {
-          (0, _utils.scrollToElement)(element);
-        }, 200);
-      }
-    } else {
-      const element = document.getElementById((0, _Anchor.anchorBlockIdFromId)(storyId)) || document.getElementById((0, _Story.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(() => {
-          (0, _utils.scrollToElement)(scrollTarget, 'start');
-        }, 200);
-      }
-    }
-  }, [storyId]);
-  return /*#__PURE__*/_react.default.createElement(_DocsContext.DocsContext.Provider, {
-    value: context
-  }, /*#__PURE__*/_react.default.createElement(_SourceContainer.SourceContainer, null, /*#__PURE__*/_react.default.createElement(_theming.ThemeProvider, {
-    theme: theme
-  }, /*#__PURE__*/_react.default.createElement(_react2.MDXProvider, {
-    components: allComponents
-  }, /*#__PURE__*/_react.default.createElement(_components.DocsWrapper, {
-    className: "sbdocs sbdocs-wrapper"
-  }, /*#__PURE__*/_react.default.createElement(_components.DocsContent, {
-    className: "sbdocs sbdocs-content"
-  }, children))))));
-};
-
-exports.DocsContainer = DocsContainer;

package/dist/cjs/blocks/DocsContext.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocsContext = void 0;
-
-var _react = require("react");
-
-var _global = require("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 (_global.window && _global.window.__DOCS_CONTEXT__ === undefined) {
-  _global.window.__DOCS_CONTEXT__ = /*#__PURE__*/(0, _react.createContext)({});
-  _global.window.__DOCS_CONTEXT__.displayName = 'DocsContext';
-}
-
-const DocsContext = _global.window ? _global.window.__DOCS_CONTEXT__ : /*#__PURE__*/(0, _react.createContext)({});
-exports.DocsContext = DocsContext;

package/dist/cjs/blocks/DocsPage.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocsPage = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Title = require("./Title");
-
-var _Subtitle = require("./Subtitle");
-
-var _Description = require("./Description");
-
-var _Primary = require("./Primary");
-
-var _types = require("./types");
-
-var _ArgsTable = require("./ArgsTable");
-
-var _Stories = require("./Stories");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const DocsPage = () => /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_Title.Title, null), /*#__PURE__*/_react.default.createElement(_Subtitle.Subtitle, null), /*#__PURE__*/_react.default.createElement(_Description.Description, null), /*#__PURE__*/_react.default.createElement(_Primary.Primary, null), /*#__PURE__*/_react.default.createElement(_ArgsTable.ArgsTable, {
-  story: _types.PRIMARY_STORY
-}), /*#__PURE__*/_react.default.createElement(_Stories.Stories, null));
-
-exports.DocsPage = DocsPage;

package/dist/cjs/blocks/DocsStory.js

@@ -1,68 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocsStory = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _utilDeprecate = _interopRequireDefault(require("util-deprecate"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _Subheading = require("./Subheading");
-
-var _Anchor = require("./Anchor");
-
-var _Description = require("./Description");
-
-var _Story = require("./Story");
-
-var _Canvas = require("./Canvas");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const warnStoryDescription = (0, _utilDeprecate.default)(() => {}, (0, _tsDedent.default)`
-    Deprecated parameter: docs.storyDescription => docs.description.story
-      
-    https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#docs-description-parameter
-  `);
-
-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.default.createElement(_Anchor.Anchor, {
-    storyId: id
-  }, subheading && /*#__PURE__*/_react.default.createElement(_Subheading.Subheading, null, subheading), description && /*#__PURE__*/_react.default.createElement(_Description.Description, {
-    markdown: description
-  }), /*#__PURE__*/_react.default.createElement(_Canvas.Canvas, {
-    withToolbar: withToolbar
-  }, /*#__PURE__*/_react.default.createElement(_Story.Story, {
-    id: id,
-    parameters: parameters
-  })));
-};
-
-exports.DocsStory = DocsStory;

package/dist/cjs/blocks/Heading.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Heading = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _components = require("@storybook/components");
-
-var _mdx = require("./mdx");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const Heading = ({
-  children,
-  disableAnchor
-}) => {
-  if (disableAnchor || typeof children !== 'string') {
-    return /*#__PURE__*/_react.default.createElement(_components.H2, null, children);
-  }
-
-  const tagID = children.toLowerCase().replace(/[^a-z0-9]/gi, '-');
-  return /*#__PURE__*/_react.default.createElement(_mdx.HeaderMdx, {
-    as: "h2",
-    id: tagID
-  }, children);
-};
-
-exports.Heading = Heading;

package/dist/cjs/blocks/Meta.js

@@ -1,50 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Meta = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _global = _interopRequireDefault(require("global"));
-
-var _Anchor = require("./Anchor");
-
-var _DocsContext = require("./DocsContext");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-const {
-  document
-} = _global.default;
-
-function getFirstStoryId(docsContext) {
-  const stories = docsContext.componentStories();
-  return stories.length > 0 ? stories[0].id : null;
-}
-
-function renderAnchor() {
-  const context = (0, _react.useContext)(_DocsContext.DocsContext);
-  const anchorId = getFirstStoryId(context) || context.id;
-  return /*#__PURE__*/_react.default.createElement(_Anchor.Anchor, {
-    storyId: anchorId
-  });
-}
-/**
- * This component is used to declare component metadata in docs
- * and gets transformed into a default export underneath the hood.
- */
-
-
-const Meta = () => {
-  const params = new URL(document.location).searchParams;
-  const isDocs = params.get('viewMode') === 'docs';
-  return isDocs ? renderAnchor() : null;
-};
-
-exports.Meta = Meta;

package/dist/cjs/blocks/Preview.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Preview = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _utilDeprecate = _interopRequireDefault(require("util-deprecate"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _Canvas = require("./Canvas");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const Preview = (0, _utilDeprecate.default)(props => /*#__PURE__*/_react.default.createElement(_Canvas.Canvas, props), (0, _tsDedent.default)`
-    Preview doc block has been renamed to Canvas.
-
-    https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#previewprops-renamed
-  `);
-exports.Preview = Preview;

package/dist/cjs/blocks/Primary.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Primary = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _DocsContext = require("./DocsContext");
-
-var _DocsStory = require("./DocsStory");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); }
-
-const Primary = ({
-  name
-}) => {
-  const {
-    componentStories: getComponentStories
-  } = (0, _react.useContext)(_DocsContext.DocsContext);
-  const componentStories = getComponentStories();
-  let story;
-
-  if (componentStories) {
-    story = name ? componentStories.find(s => s.name === name) : componentStories[0];
-  }
-
-  return story ? /*#__PURE__*/_react.default.createElement(_DocsStory.DocsStory, _extends({}, story, {
-    expanded: false,
-    withToolbar: true
-  })) : null;
-};
-
-exports.Primary = Primary;

package/dist/cjs/blocks/Props.js

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Props = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _utilDeprecate = _interopRequireDefault(require("util-deprecate"));
-
-var _tsDedent = _interopRequireDefault(require("ts-dedent"));
-
-var _ArgsTable = require("./ArgsTable");
-
-var _types = require("./types");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const Props = (0, _utilDeprecate.default)(props => /*#__PURE__*/_react.default.createElement(_ArgsTable.ArgsTable, props), (0, _tsDedent.default)`
-    Props doc block has been renamed to ArgsTable.
-
-    https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#previewprops-renamed
-  `); // @ts-ignore
-
-exports.Props = Props;
-Props.defaultProps = {
-  of: _types.CURRENT_SELECTION
-};