@storybook/addon-docs 9.0.0-beta.9 → 9.0.0-rc.0

package/dist/blocks.d.ts

@@ -1,47 +1,14 @@
+import * as React from 'react';
+import React__default, { FC, ComponentProps, FunctionComponent, PropsWithChildren, ReactElement, Context, ReactNode } from 'react';
 import { Conditional, DocsContextProps, PreparedStory, ModuleExports, Renderer as Renderer$1, Args as Args$1, StoryId, ModuleExport, ResolvedModuleExportType, ResolvedModuleExportFromType, Parameters as Parameters$1, ProjectAnnotations, BaseAnnotations, ComponentTitle } from 'storybook/internal/types';
 export { DocsContextProps } from 'storybook/internal/types';
-import * as React from 'react';
-import React__default, { ComponentProps, FunctionComponent, PropsWithChildren, FC, Context, ReactElement, ReactNode } from 'react';
+import { Channel } from 'storybook/internal/channels';
 import { Renderer } from 'storybook/internal/csf';
 import { PropDescriptor } from 'storybook/preview-api';
 import { SupportedLanguage, SyntaxHighlighter, ActionItem, SyntaxHighlighterFormatTypes } from 'storybook/internal/components';
 import { SourceType } from 'storybook/internal/docs-tools';
 import { ThemeVars } from 'storybook/theming';
 
-declare enum SourceError {
-    NO_STORY = "There\u2019s no story here.",
-    SOURCE_UNAVAILABLE = "Oh no! The source is not available."
-}
-interface SourceCodeProps {
-    /** The language the syntax highlighter uses for your story’s code */
-    language?: SupportedLanguage;
-    /** Use this to override the content of the source block. */
-    code?: string;
-    /** The formatter the syntax highlighter uses for your story’s code. */
-    format?: ComponentProps<typeof SyntaxHighlighter>['format'];
-    /** Display the source snippet in a dark mode. */
-    dark?: boolean;
-}
-interface SourceProps$1 extends SourceCodeProps {
-    isLoading?: boolean;
-    error?: SourceError;
-}
-/** Syntax-highlighted source code for a component (or anything!) */
-declare const Source$1: FunctionComponent<SourceProps$1>;
-
-type PreviewProps = PropsWithChildren<{
-    isLoading?: true;
-    layout?: Layout;
-    isColumn?: boolean;
-    columns?: number;
-    withSource?: SourceProps$1;
-    isExpanded?: boolean;
-    withToolbar?: boolean;
-    className?: string;
-    additionalActions?: ActionItem[];
-}>;
-type Layout = 'padded' | 'fullscreen' | 'centered';
-
 interface ArgType {
     name?: string;
     description?: string;
@@ -107,6 +74,41 @@ type ArgsTableProps = ArgsTableOptionProps & (ArgsTableDataProps | ArgsTableErro
  */
 declare const ArgsTable: FC<ArgsTableProps>;
 
+declare enum SourceError {
+    NO_STORY = "There\u2019s no story here.",
+    SOURCE_UNAVAILABLE = "Oh no! The source is not available."
+}
+interface SourceCodeProps {
+    /** The language the syntax highlighter uses for your story’s code */
+    language?: SupportedLanguage;
+    /** Use this to override the content of the source block. */
+    code?: string;
+    /** The formatter the syntax highlighter uses for your story’s code. */
+    format?: ComponentProps<typeof SyntaxHighlighter>['format'];
+    /** Display the source snippet in a dark mode. */
+    dark?: boolean;
+}
+interface SourceProps$1 extends SourceCodeProps {
+    isLoading?: boolean;
+    error?: SourceError;
+}
+/** Syntax-highlighted source code for a component (or anything!) */
+declare const Source$1: FunctionComponent<SourceProps$1>;
+
+type PreviewProps = PropsWithChildren<{
+    isLoading?: true;
+    layout?: Layout;
+    inline?: boolean;
+    isColumn?: boolean;
+    columns?: number;
+    withSource?: SourceProps$1;
+    isExpanded?: boolean;
+    withToolbar?: boolean;
+    className?: string;
+    additionalActions?: ActionItem[];
+}>;
+type Layout = 'padded' | 'fullscreen' | 'centered';
+
 interface CommonProps {
     story: PreparedStory;
     inline: boolean;
@@ -172,6 +174,45 @@ interface IconGalleryProps {
 /** Show a grid of icons, as specified by `IconItem`. */
 declare const IconGallery: FunctionComponent<IconGalleryProps>;
 
+interface TocbotOptions {
+    tocSelector: string;
+    contentSelector: string;
+    headingSelector: string;
+    ignoreSelector?: string;
+    headingsOffset?: number;
+    scrollSmoothOffset?: number;
+    orderedList?: boolean;
+    onClick?: (e: MouseEvent) => void;
+    scrollEndCallback?: () => void;
+    [key: string]: unknown;
+}
+interface TocParameters {
+    /** CSS selector for the container to search for headings. */
+    contentsSelector?: string;
+    /**
+     * When true, hide the TOC. We still show the empty container (as opposed to showing nothing at
+     * all) because it affects the page layout and we want to preserve the layout across pages.
+     */
+    disable?: boolean;
+    /** CSS selector to match headings to list in the TOC. */
+    headingSelector?: string;
+    /** Headings that match the ignoreSelector will be skipped. */
+    ignoreSelector?: string;
+    /** Custom title ReactElement or string to display above the TOC. */
+    title?: ReactElement | string | null;
+    /**
+     * TocBot options, not guaranteed to be available in future versions.
+     *
+     * @see tocbot docs {@link https://tscanlin.github.io/tocbot/#usage}
+     */
+    unsafeTocbotOptions?: Omit<TocbotOptions, 'onClick' | 'scrollEndCallback'>;
+}
+type TableOfContentsProps = React__default.PropsWithChildren<TocParameters & {
+    className?: string;
+    channel: Channel;
+}>;
+declare const TableOfContents: ({ title, disable, headingSelector, contentsSelector, ignoreSelector, unsafeTocbotOptions, channel, className, }: TableOfContentsProps) => React__default.JSX.Element;
+
 declare const anchorBlockIdFromId: (storyId: string) => string;
 interface AnchorProps {
     storyId: string;
@@ -1028,4 +1069,4 @@ type ColorProps = ColorControlProps;
 declare const LazyColorControl: React__default.LazyExoticComponent<React__default.FC<ColorControlProps>>;
 declare const ColorControl: (props: ComponentProps<typeof LazyColorControl>) => React__default.JSX.Element;
 
-export { AddContext, Anchor, AnchorMdx, AnchorProps, ArgTypes, BooleanConfig, BooleanControl, BooleanProps, BooleanValue, Canvas, CodeOrSourceMdx, ColorConfig, ColorControl, ColorItem, ColorPalette, ColorProps, ColorValue, Component, Control, ControlProps, ControlType, Controls, DateConfig, DateControl, DateProps, DateValue, DescriptionContainer as Description, DescriptionType, Docs, DocsContainer, DocsContainerProps, DocsContext, DocsPage, DocsProps, DocsStory, DocsStoryProps, ExternalDocs, ExternalDocsContainer, ExternalDocsProps, FilesControl, FilesControlProps, HeaderMdx, HeadersMdx, Heading, HeadingProps, IconGallery, IconItem, Markdown, Meta, NormalizedOptionsConfig, NumberConfig, NumberControl, NumberValue, ObjectConfig, ObjectControl, ObjectProps, ObjectValue, Of, Options, OptionsArray, OptionsConfig, OptionsControl, OptionsControlType, OptionsMultiSelection, OptionsObject, OptionsProps, OptionsSelection, OptionsSingleSelection, PRIMARY_STORY, PresetColor, Primary, ArgsTable as PureArgsTable, RangeConfig, RangeControl, SortType, Source, SourceContainer, SourceContext, SourceContextProps, SourceItem, SourceParameters, SourceProps, Stories, Story, StoryProps, StorySources, Subheading, Subtitle, TextConfig, TextControl, TextProps, TextValue, Title, Typeset, UNKNOWN_ARGS_HASH, Unstyled, Wrapper, anchorBlockIdFromId, argsHash, assertIsFn, extractTitle, format, formatDate, formatTime, getStoryId, getStoryProps, parse, parseDate, parseTime, slugs, useOf, useSourceProps };
+export { AddContext, Anchor, AnchorMdx, AnchorProps, ArgTypes, BooleanConfig, BooleanControl, BooleanProps, BooleanValue, Canvas, CodeOrSourceMdx, ColorConfig, ColorControl, ColorItem, ColorPalette, ColorProps, ColorValue, Component, Control, ControlProps, ControlType, Controls, DateConfig, DateControl, DateProps, DateValue, DescriptionContainer as Description, DescriptionType, Docs, DocsContainer, DocsContainerProps, DocsContext, DocsPage, DocsProps, DocsStory, DocsStoryProps, ExternalDocs, ExternalDocsContainer, ExternalDocsProps, FilesControl, FilesControlProps, HeaderMdx, HeadersMdx, Heading, HeadingProps, IconGallery, IconItem, Markdown, Meta, NormalizedOptionsConfig, NumberConfig, NumberControl, NumberValue, ObjectConfig, ObjectControl, ObjectProps, ObjectValue, Of, Options, OptionsArray, OptionsConfig, OptionsControl, OptionsControlType, OptionsMultiSelection, OptionsObject, OptionsProps, OptionsSelection, OptionsSingleSelection, PRIMARY_STORY, PresetColor, Primary, ArgsTable as PureArgsTable, RangeConfig, RangeControl, SortType, Source, SourceContainer, SourceContext, SourceContextProps, SourceItem, SourceParameters, SourceProps, Stories, Story, StoryProps, StorySources, Subheading, Subtitle, TableOfContents, TextConfig, TextControl, TextProps, TextValue, Title, Typeset, UNKNOWN_ARGS_HASH, Unstyled, Wrapper, anchorBlockIdFromId, argsHash, assertIsFn, extractTitle, format, formatDate, formatTime, getStoryId, getStoryProps, parse, parseDate, parseTime, slugs, useOf, useSourceProps };