@storybook/blocks 8.0.0-alpha.8 → 8.0.0-beta.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Conditional, DocsContextProps, PreparedStory, ModuleExports, ModuleExport, Parameters as Parameters$1, StrictArgTypes, Renderer as Renderer$1, Args as Args$1, StoryId, StoryContextForLoaders, StoryAnnotations, ResolvedModuleExportType, ResolvedModuleExportFromType, ProjectAnnotations, BaseAnnotations, ComponentTitle } from '@storybook/types';
+import { Conditional, DocsContextProps, PreparedStory, ModuleExports, Renderer as Renderer$1, Args as Args$1, StoryId, ModuleExport, StoryContextForLoaders, ResolvedModuleExportType, ResolvedModuleExportFromType, Parameters as Parameters$1, ProjectAnnotations, BaseAnnotations, ComponentTitle } from '@storybook/types';
 export { DocsContextProps } from '@storybook/types';
 import React, { ComponentProps, FunctionComponent, ReactNode, FC, PropsWithChildren, Context, ReactElement } from 'react';
 import { Renderer } from '@storybook/csf';
@@ -97,12 +97,12 @@ interface ArgsTableErrorProps {
 interface ArgsTableLoadingProps {
     isLoading: boolean;
 }
-type ArgsTableProps$1 = ArgsTableOptionProps & (ArgsTableDataProps | ArgsTableErrorProps | ArgsTableLoadingProps);
+type ArgsTableProps = ArgsTableOptionProps & (ArgsTableDataProps | ArgsTableErrorProps | ArgsTableLoadingProps);
 /**
  * Display the props for a component as a props table. Each row is a collection of
  * ArgDefs, usually derived from docgen info for the component.
  */
-declare const ArgsTable$1: FC<ArgsTableProps$1>;
+declare const ArgsTable: FC<ArgsTableProps>;
 
 interface CommonProps {
     story: PreparedStory;
@@ -120,12 +120,12 @@ interface IFrameStoryProps extends CommonProps {
     inline: false;
     height: string;
 }
-type StoryProps$2 = InlineStoryProps | IFrameStoryProps;
+type StoryProps$1 = InlineStoryProps | IFrameStoryProps;
 /**
  * A story element, either rendered inline or in an iframe,
  * with configurable height.
  */
-declare const Story$1: FunctionComponent<StoryProps$2>;
+declare const Story$1: FunctionComponent<StoryProps$1>;
 
 interface TypesetProps {
     fontFamily?: string;
@@ -193,44 +193,6 @@ type ArgTypesProps = ArgTypesParameters & {
 };
 declare const ArgTypes: FC<ArgTypesProps>;
 
-declare const PRIMARY_STORY = "^";
-type Component = any;
-type DocsStoryProps = {
-    of: ModuleExport;
-    expanded?: boolean;
-    withToolbar?: boolean;
-    __forceInitialArgs?: boolean;
-    __primary?: boolean;
-};
-
-interface BaseProps {
-    include?: PropDescriptor;
-    exclude?: PropDescriptor;
-    sort?: SortType;
-}
-type OfProps = BaseProps & {
-    of: '^' | Component;
-};
-type ComponentsProps = BaseProps & {
-    parameters: Parameters$1;
-    components: {
-        [label: string]: Component;
-    };
-};
-type StoryProps$1 = BaseProps & {
-    story: '.' | '^' | string;
-    showComponent?: boolean;
-};
-type ArgsTableProps = BaseProps | OfProps | ComponentsProps | StoryProps$1;
-declare const extractComponentArgTypes: (component: Component, parameters: Parameters$1, include?: PropDescriptor, exclude?: PropDescriptor) => StrictArgTypes;
-declare const getComponent: (props: ArgsTableProps, component: Component) => Component;
-declare const StoryTable: FC<StoryProps$1 & {
-    component: Component;
-    subcomponents: Record<string, Component>;
-}>;
-declare const ComponentsTable: FC<ComponentsProps>;
-declare const ArgsTable: FC<ArgsTableProps>;
-
 declare const DocsContext: Context<DocsContextProps<Renderer$1>>;
 
 type ArgsHash = string;
@@ -250,11 +212,6 @@ declare const SourceContainer: FC<PropsWithChildren<{
     channel: Channel;
 }>>;
 
-declare enum SourceState {
-    OPEN = "open",
-    CLOSED = "closed",
-    NONE = "none"
-}
 type SourceParameters = SourceCodeProps & {
     /**
      * Where to read the source code from, see `SourceType`
@@ -281,20 +238,13 @@ type SourceProps = SourceParameters & {
      * ```
      */
     of?: ModuleExport;
-    /** @deprecated use of={storyExport} instead */
-    id?: string;
-    /** @deprecated use of={storyExport} instead */
-    ids?: string[];
     /**
      * Internal prop to control if a story re-renders on args updates
      */
     __forceInitialArgs?: boolean;
 };
-type SourceStateProps = {
-    state: SourceState;
-};
 type PureSourceProps = ComponentProps<typeof Source$1>;
-declare const useSourceProps: (props: SourceProps, docsContext: DocsContextProps<any>, sourceContext: SourceContextProps) => PureSourceProps & SourceStateProps;
+declare const useSourceProps: (props: SourceProps, docsContext: DocsContextProps<any>, sourceContext: SourceContextProps) => PureSourceProps;
 /**
  * Story source doc block renders source code if provided,
  * or the source for a story if `storyId` is provided, or
@@ -303,24 +253,10 @@ declare const useSourceProps: (props: SourceProps, docsContext: DocsContextProps
 declare const Source: FC<SourceProps>;
 
 type PureStoryProps = ComponentProps<typeof Story$1>;
-/**
- * Props to define a story
- *
- * @deprecated Define stories in CSF files
- */
-type StoryDefProps = StoryAnnotations;
 /**
  * Props to reference another story
  */
 type StoryRefProps = {
-    /**
-     * @deprecated Use of={storyExport} instead
-     */
-    id?: string;
-    /**
-     * @deprecated Use of={storyExport} and define the story in the CSF file
-     */
-    story?: StoryAnnotations;
     /**
      * Pass the export defining a story to render that story
      *
@@ -367,33 +303,11 @@ type StoryParameters = {
      */
     __primary?: boolean;
 };
-type StoryProps = (StoryDefProps | StoryRefProps) & StoryParameters;
+type StoryProps = StoryRefProps & StoryParameters;
 declare const getStoryId: (props: StoryProps, context: DocsContextProps) => StoryId;
 declare const getStoryProps: <TFramework extends Renderer$1>(props: StoryParameters, story: PreparedStory<TFramework>, context: DocsContextProps<TFramework>) => PureStoryProps;
 declare const Story: FC<StoryProps>;
 
-type DeprecatedCanvasProps = {
-    /**
-     * @deprecated multiple stories are not supported
-     */
-    isColumn?: boolean;
-    /**
-     * @deprecated multiple stories are not supported
-     */
-    columns?: number;
-    /**
-     * @deprecated use `sourceState` instead
-     */
-    withSource?: SourceState;
-    /**
-     * @deprecated use `source.code` instead
-     */
-    mdxSource?: string;
-    /**
-     * @deprecated reference stories with the `of` prop instead
-     */
-    children?: ReactNode;
-};
 type CanvasProps = Pick<PreviewProps, 'withToolbar' | 'additionalActions' | 'className'> & {
     /**
      * Pass the export defining a story to render that story
@@ -443,7 +357,7 @@ type CanvasProps = Pick<PreviewProps, 'withToolbar' | 'additionalActions' | 'cla
      */
     story?: Pick<StoryProps, 'inline' | 'height' | 'autoplay' | '__forceInitialArgs' | '__primary'>;
 };
-declare const Canvas: FC<CanvasProps & DeprecatedCanvasProps>;
+declare const Canvas: FC<CanvasProps>;
 
 type ControlsParameters = {
     include?: PropDescriptor;
@@ -493,6 +407,16 @@ interface DocsContainerProps<TFramework extends Renderer$1 = Renderer$1> {
 }
 declare const DocsContainer: FC<PropsWithChildren<DocsContainerProps>>;
 
+declare const PRIMARY_STORY = "^";
+type Component = any;
+type DocsStoryProps = {
+    of: ModuleExport;
+    expanded?: boolean;
+    withToolbar?: boolean;
+    __forceInitialArgs?: boolean;
+    __primary?: boolean;
+};
+
 declare const DocsStory: FC<DocsStoryProps>;
 
 type ExternalDocsProps<TRenderer extends Renderer$1 = Renderer$1> = {
@@ -523,10 +447,6 @@ type MetaProps = BaseAnnotations & {
 declare const Meta: FC<MetaProps>;
 
 interface PrimaryProps {
-    /**
-     * @deprecated Primary block should only be used to render the primary story, which is automatically found.
-     */
-    name?: string;
     /**
      * Specify where to get the primary story from.
      */
@@ -697,4 +617,4 @@ type ColorProps = ColorControlProps;
 declare const LazyColorControl: React.LazyExoticComponent<React.FC<ColorControlProps>>;
 declare const ColorControl: (props: ComponentProps<typeof LazyColorControl>) => React.JSX.Element;
 
-export { AddContext, Anchor, AnchorMdx, AnchorProps, ArgTypes, ArgsTable, BooleanConfig, BooleanControl, BooleanProps, BooleanValue, Canvas, CodeOrSourceMdx, ColorConfig, ColorControl, ColorItem, ColorPalette, ColorProps, ColorValue, Component, ComponentsTable, 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$1 as PureArgsTable, RangeConfig, RangeControl, SortType, Source, SourceContainer, SourceContext, SourceContextProps, SourceItem, SourceProps, SourceState, Stories, Story, StoryProps, StorySources, StoryTable, Subheading, Subtitle, TextConfig, TextControl, TextProps, TextValue, Title, Typeset, UNKNOWN_ARGS_HASH, Unstyled, Wrapper, anchorBlockIdFromId, argsHash, assertIsFn, extractComponentArgTypes, extractTitle, format, formatDate, formatTime, getComponent, getStoryId, getStoryProps, parse, parseDate, parseTime, 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, 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, useOf, useSourceProps };