@storybook/addon-docs 7.0.0-alpha.5 → 7.0.0-alpha.50

package/dist/esm/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?.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/esm/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/esm/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/esm/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/esm/blocks/DocsStory.js

@@ -1,46 +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) {
-    description = 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/esm/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);
-};

package/dist/esm/blocks/Meta.js

@@ -1,31 +0,0 @@
-import React, { useContext } from 'react';
-import global from 'global';
-import { Anchor } from './Anchor';
-import { DocsContext } from './DocsContext';
-const {
-  document
-} = global;
-
-function getFirstStoryId(docsContext) {
-  const stories = docsContext.componentStories();
-  return stories.length > 0 ? stories[0].id : null;
-}
-
-function renderAnchor() {
-  const context = useContext(DocsContext);
-  const anchorId = getFirstStoryId(context) || context.id;
-  return /*#__PURE__*/React.createElement(Anchor, {
-    storyId: anchorId
-  });
-}
-/**
- * This component is used to declare component metadata in docs
- * and gets transformed into a default export underneath the hood.
- */
-
-
-export const Meta = () => {
-  const params = new URL(document.location).searchParams;
-  const isDocs = params.get('viewMode') === 'docs';
-  return isDocs ? renderAnchor() : null;
-};

package/dist/esm/blocks/Preview.js

@@ -1,9 +0,0 @@
-import React from 'react';
-import deprecate from 'util-deprecate';
-import dedent from 'ts-dedent';
-import { Canvas } from './Canvas';
-export const Preview = deprecate(props => /*#__PURE__*/React.createElement(Canvas, props), dedent`
-    Preview doc block has been renamed to Canvas.
-
-    https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#previewprops-renamed
-  `);

package/dist/esm/blocks/Primary.js

@@ -1,23 +0,0 @@
-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); }
-
-import React, { useContext } from 'react';
-import { DocsContext } from './DocsContext';
-import { DocsStory } from './DocsStory';
-export const Primary = ({
-  name
-}) => {
-  const {
-    componentStories: getComponentStories
-  } = useContext(DocsContext);
-  const componentStories = getComponentStories();
-  let story;
-
-  if (componentStories) {
-    story = name ? componentStories.find(s => s.name === name) : componentStories[0];
-  }
-
-  return story ? /*#__PURE__*/React.createElement(DocsStory, _extends({}, story, {
-    expanded: false,
-    withToolbar: true
-  })) : null;
-};

package/dist/esm/blocks/Props.js

@@ -1,14 +0,0 @@
-import React from 'react';
-import deprecate from 'util-deprecate';
-import dedent from 'ts-dedent';
-import { ArgsTable } from './ArgsTable';
-import { CURRENT_SELECTION } from './types';
-export const Props = deprecate(props => /*#__PURE__*/React.createElement(ArgsTable, props), dedent`
-    Props doc block has been renamed to ArgsTable.
-
-    https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#previewprops-renamed
-  `); // @ts-ignore
-
-Props.defaultProps = {
-  of: CURRENT_SELECTION
-};

package/dist/esm/blocks/Source.js

@@ -1,144 +0,0 @@
-import React, { useContext } from 'react';
-import { Source as PureSource, SourceError } from '@storybook/components';
-import { DocsContext } from './DocsContext';
-import { SourceContext } from './SourceContainer';
-import { CURRENT_SELECTION } from './types';
-import { SourceType } from '../shared';
-import { enhanceSource } from './enhanceSource';
-import { useStories } from './useStory';
-export let SourceState;
-
-(function (SourceState) {
-  SourceState["OPEN"] = "open";
-  SourceState["CLOSED"] = "closed";
-  SourceState["NONE"] = "none";
-})(SourceState || (SourceState = {}));
-
-const getSourceState = stories => {
-  const states = stories.map(story => story.parameters.docs?.source?.state).filter(Boolean);
-  if (states.length === 0) return SourceState.CLOSED; // FIXME: handling multiple stories is a pain
-
-  return states[0];
-};
-
-const getStorySource = (storyId, sourceContext) => {
-  const {
-    sources
-  } = sourceContext; // source rendering is async so source is unavailable at the start of the render cycle,
-  // so we fail gracefully here without warning
-
-  return sources?.[storyId] || {
-    code: '',
-    format: false
-  };
-};
-
-const getSnippet = (snippet, story) => {
-  if (!story) {
-    return snippet;
-  }
-
-  const {
-    parameters
-  } = story; // eslint-disable-next-line no-underscore-dangle
-
-  const isArgsStory = parameters.__isArgsStory;
-  const type = parameters.docs?.source?.type || SourceType.AUTO; // if user has hard-coded the snippet, that takes precedence
-
-  const userCode = parameters.docs?.source?.code;
-
-  if (userCode !== undefined) {
-    return userCode;
-  } // if user has explicitly set this as dynamic, use snippet
-
-
-  if (type === SourceType.DYNAMIC) {
-    return parameters.docs?.transformSource?.(snippet, story) || snippet;
-  } // if this is an args story and there's a snippet
-
-
-  if (type === SourceType.AUTO && snippet && isArgsStory) {
-    return parameters.docs?.transformSource?.(snippet, story) || snippet;
-  } // otherwise, use the source code logic
-
-
-  const enhanced = enhanceSource(story) || parameters;
-  return enhanced?.docs?.source?.code || '';
-};
-
-export const getSourceProps = (props, docsContext, sourceContext) => {
-  const {
-    id: currentId,
-    storyById
-  } = docsContext;
-  const {
-    parameters
-  } = storyById(currentId);
-  const codeProps = props;
-  const singleProps = props;
-  const multiProps = props;
-  let source = codeProps.code; // prefer user-specified code
-
-  let {
-    format
-  } = codeProps; // prefer user-specified code
-
-  const targetIds = multiProps.ids || [singleProps.id || currentId];
-  const storyIds = targetIds.map(targetId => targetId === CURRENT_SELECTION ? currentId : targetId);
-  const stories = useStories(storyIds, docsContext);
-
-  if (!stories.every(Boolean)) {
-    return {
-      error: SourceError.SOURCE_UNAVAILABLE,
-      state: SourceState.NONE
-    };
-  }
-
-  if (!source) {
-    // just take the format from the first story, given how they're all concatinated together...
-    // TODO: we should consider sending an event with all the sources separately, instead of concatenating them here
-    ({
-      format
-    } = getStorySource(storyIds[0], sourceContext));
-    source = storyIds.map((storyId, idx) => {
-      const {
-        code: storySource
-      } = getStorySource(storyId, sourceContext);
-      const storyObj = stories[idx];
-      return getSnippet(storySource, storyObj);
-    }).join('\n\n');
-  }
-
-  const state = getSourceState(stories);
-  const {
-    docs: docsParameters = {}
-  } = parameters;
-  const {
-    source: sourceParameters = {}
-  } = docsParameters;
-  const {
-    language: docsLanguage = null
-  } = sourceParameters;
-  return source ? {
-    code: source,
-    state,
-    format,
-    language: props.language || docsLanguage || 'jsx',
-    dark: props.dark || false
-  } : {
-    error: SourceError.SOURCE_UNAVAILABLE,
-    state
-  };
-};
-/**
- * Story source doc block renders source code if provided,
- * or the source for a story if `storyId` is provided, or
- * the source for the current story if nothing is provided.
- */
-
-export const Source = props => {
-  const sourceContext = useContext(SourceContext);
-  const docsContext = useContext(DocsContext);
-  const sourceProps = getSourceProps(props, docsContext, sourceContext);
-  return /*#__PURE__*/React.createElement(PureSource, sourceProps);
-};

package/dist/esm/blocks/SourceContainer.js

@@ -1,44 +0,0 @@
-import React, { createContext, useEffect, useState } from 'react';
-import deepEqual from 'fast-deep-equal';
-import { addons } from '@storybook/addons';
-import { SNIPPET_RENDERED } from '../shared';
-export const SourceContext = /*#__PURE__*/createContext({
-  sources: {}
-});
-export const SourceContainer = ({
-  children
-}) => {
-  const [sources, setSources] = useState({});
-  const channel = addons.getChannel();
-  useEffect(() => {
-    const handleSnippetRendered = (id, newSource, format = false) => {
-      // optimization: if the source is the same, ignore the incoming event
-      if (sources[id] && sources[id].code === newSource) {
-        return;
-      }
-
-      setSources(current => {
-        const newSources = Object.assign({}, current, {
-          [id]: {
-            code: newSource,
-            format
-          }
-        });
-
-        if (!deepEqual(current, newSources)) {
-          return newSources;
-        }
-
-        return current;
-      });
-    };
-
-    channel.on(SNIPPET_RENDERED, handleSnippetRendered);
-    return () => channel.off(SNIPPET_RENDERED, handleSnippetRendered);
-  }, []);
-  return /*#__PURE__*/React.createElement(SourceContext.Provider, {
-    value: {
-      sources
-    }
-  }, children);
-};

package/dist/esm/blocks/Stories.js

@@ -1,30 +0,0 @@
-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); }
-
-import React, { useContext } from 'react';
-import { DocsContext } from './DocsContext';
-import { DocsStory } from './DocsStory';
-import { Heading } from './Heading';
-export const Stories = ({
-  title,
-  includePrimary = false
-}) => {
-  const {
-    componentStories
-  } = useContext(DocsContext);
-  let stories = componentStories();
-  stories = stories.filter(story => !story.parameters?.docs?.disable);
-  if (!includePrimary) stories = stories.slice(1);
-
-  if (!stories || stories.length === 0) {
-    return null;
-  }
-
-  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Heading, null, title), stories.map(story => story && /*#__PURE__*/React.createElement(DocsStory, _extends({
-    key: story.id
-  }, story, {
-    expanded: true
-  }))));
-};
-Stories.defaultProps = {
-  title: 'Stories'
-};