@storybook/blocks 8.0.0-alpha.0 → 8.0.0-alpha.10

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-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, ModuleExport, Parameters as Parameters$1, StrictArgTypes, Renderer as Renderer$1, Args as Args$1, StoryId, StoryContextForLoaders, ResolvedModuleExportType, ResolvedModuleExportFromType, 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';
 import { PropDescriptor } from '@storybook/preview-api';
-import { SyntaxHighlighter, ActionItem, SyntaxHighlighterFormatTypes } from '@storybook/components';
+import { SupportedLanguage, SyntaxHighlighter, ActionItem, SyntaxHighlighterFormatTypes } from '@storybook/components';
 import { SourceType } from '@storybook/docs-tools';
 import { Channel } from '@storybook/channels';
 import { ThemeVars } from '@storybook/theming';
@@ -17,7 +17,7 @@ interface SourceCodeProps {
     /**
      * The language the syntax highlighter uses for your story’s code
      */
-    language?: string;
+    language?: SupportedLanguage;
     /**
      * Use this to override the content of the source block.
      */
@@ -250,22 +250,11 @@ 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`
      */
     type?: SourceType;
-    /**
-     * Transform the detected source for display
-     *
-     * @deprecated use `transform` prop instead
-     */
-    transformSource?: (code: string, storyContext: StoryContextForLoaders) => string;
     /**
      * Transform the detected source for display
      */
@@ -287,20 +276,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
@@ -309,24 +291,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
      *
@@ -373,33 +341,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
@@ -449,7 +395,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;
@@ -482,18 +428,6 @@ interface DescriptionProps {
      * If not specified, the description will be extracted from the meta of the attached CSF file.
      */
     of?: Of;
-    /**
-     * @deprecated Manually specifying description type is deprecated. See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#description-block-parametersnotes-and-parametersinfo
-     */
-    type?: DescriptionType;
-    /**
-     * @deprecated The 'markdown' prop on the Description block is deprecated. See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#description-block-parametersnotes-and-parametersinfo
-     */
-    markdown?: string;
-    /**
-     * @deprecated The 'children' prop on the Description block is deprecated. See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#description-block-parametersnotes-and-parametersinfo
-     */
-    children?: string;
 }
 declare const DescriptionContainer: FC<DescriptionProps>;
 
@@ -541,10 +475,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.
      */
@@ -715,4 +645,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, 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, 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 };