@storybook/blocks 7.0.0-alpha.49 → 7.0.0-alpha.50

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import React, { FunctionComponent, ComponentProps, ReactNode, FC, ElementType, Context } from 'react';
-import { Conditional, Parameters, Framework, Store_PropDescriptor, StrictArgTypes, StoryId, ProjectAnnotations, BaseAnnotations, Store_ModuleExports, Store_Story, StoryAnnotations, Store_ModuleExport, ComponentTitle } from '@storybook/types';
+import { Conditional, Parameters, Renderer, Store_PropDescriptor, StrictArgTypes, StoryId, ProjectAnnotations, BaseAnnotations, Store_ModuleExports, Store_Story, StoryAnnotations, Store_ModuleExport, ComponentTitle } from '@storybook/types';
 import { DocsContextProps } from '@storybook/preview-web';
 export { DocsContextProps } from '@storybook/preview-web';
 import { SyntaxHighlighter, ActionItem, SyntaxHighlighterFormatTypes } from '@storybook/components';
@@ -174,7 +174,7 @@ interface AnchorProps {
 }
 declare const Anchor: FC<AnchorProps>;
 
-declare const DocsContext: Context<DocsContextProps<Framework>>;
+declare const DocsContext: Context<DocsContextProps<Renderer>>;
 
 declare const PRIMARY_STORY = "^";
 declare type Component = any;
@@ -256,7 +256,7 @@ declare type SourceStateProps = {
     state: SourceState;
 };
 declare type PureSourceProps = ComponentProps<typeof Source$1>;
-declare const getSourceProps: (props: SourceProps, docsContext: DocsContextProps<any>, sourceContext: SourceContextProps) => PureSourceProps & SourceStateProps;
+declare const useSourceProps: (props: SourceProps, docsContext: DocsContextProps<any>, sourceContext: SourceContextProps) => PureSourceProps & SourceStateProps;
 /**
  * Story source doc block renders source code if provided,
  * or the source for a story if `storyId` is provided, or
@@ -264,7 +264,7 @@ declare const getSourceProps: (props: SourceProps, docsContext: DocsContextProps
  */
 declare const Source: FC<PureSourceProps>;
 
-declare type CanvasProps = PreviewProps & {
+declare type CanvasProps = Omit<PreviewProps, 'isExpanded'> & {
     withSource?: SourceState;
     mdxSource?: string;
 };
@@ -286,7 +286,7 @@ interface DescriptionProps {
 declare const getDescriptionProps: ({ of, type, markdown, children }: DescriptionProps, { storyById }: DocsContextProps<any>) => DescriptionProps$1;
 declare const DescriptionContainer: FC<DescriptionProps>;
 
-declare type DocsProps<TFramework extends Framework = Framework> = {
+declare type DocsProps<TFramework extends Renderer = Renderer> = {
     docsParameter: Parameters;
     context: DocsContextProps<TFramework>;
 };
@@ -294,7 +294,7 @@ declare const Docs: FunctionComponent<DocsProps>;
 
 declare const DocsPage: FC;
 
-interface DocsContainerProps<TFramework extends Framework = Framework> {
+interface DocsContainerProps<TFramework extends Renderer = Renderer> {
     context: DocsContextProps<TFramework>;
     theme?: ThemeVars;
     children?: ReactNode;
@@ -303,7 +303,7 @@ declare const DocsContainer: FunctionComponent<DocsContainerProps>;
 
 declare const DocsStory: FC<DocsStoryProps>;
 
-declare type ExternalDocsProps<TFramework extends Framework = Framework> = {
+declare type ExternalDocsProps<TFramework extends Renderer = Renderer> = {
     projectAnnotationsList: ProjectAnnotations<TFramework>[];
 };
 declare const ExternalDocs: FunctionComponent<ExternalDocsProps>;
@@ -346,7 +346,6 @@ declare type CommonProps = StoryAnnotations & {
 };
 declare type StoryDefProps = {
     name: string;
-    children: ReactNode;
 };
 declare type StoryRefProps = {
     id?: string;
@@ -355,11 +354,10 @@ declare type StoryRefProps = {
 };
 declare type StoryImportProps = {
     name: string;
-    story: ElementType;
 };
 declare type StoryProps = (StoryDefProps | StoryRefProps | StoryImportProps) & CommonProps;
 declare const getStoryId: (props: StoryProps, context: DocsContextProps) => StoryId;
-declare const getStoryProps: <TFramework extends Framework>({ height, inline }: StoryProps, story: Store_Story<TFramework>) => PureStoryProps;
+declare const getStoryProps: <TFramework extends Renderer>({ height, inline }: StoryProps, story: Store_Story<TFramework>) => PureStoryProps;
 declare const Story: FC<StoryProps>;
 
 declare const Subheading: FC<HeadingProps>;
@@ -458,6 +456,11 @@ declare type Controls = Record<string, Control>;
 declare type ColorControlProps = ControlProps<ColorValue> & ColorConfig;
 
 declare type BooleanProps = ControlProps<BooleanValue> & BooleanConfig;
+/**
+ * # Boolean control
+ * Renders a switch toggle with "True" or "False".
+ * or if the value is `undefined`, renders a button to set the boolean.
+ */
 declare const BooleanControl: FC<BooleanProps>;
 
 declare const parseDate: (value: string) => Date;
@@ -506,4 +509,4 @@ declare type ColorProps = ColorControlProps;
 declare const LazyColorControl: React.LazyExoticComponent<React.FC<ColorControlProps>>;
 declare const ColorControl: (props: ComponentProps<typeof LazyColorControl>) => JSX.Element;
 
-export { AddContext, Anchor, AnchorMdx, AnchorProps, 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, Meta, NoControlsWarning, NormalizedOptionsConfig, NumberConfig, NumberControl, NumberValue, ObjectConfig, ObjectControl, ObjectProps, ObjectValue, 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, SourceState, Stories, Story, StoryData, StoryProps, StorySources, StoryTable, Subheading, Subtitle, TextConfig, TextControl, TextProps, TextValue, Title, Typeset, Wrapper, anchorBlockIdFromId, assertIsFn, extractComponentArgTypes, extractTitle, format, formatDate, formatTime, getComponent, getDescriptionProps, getSourceProps, getStoryId, getStoryProps, parse, parseDate, parseTime, storyBlockIdFromId };
+export { AddContext, Anchor, AnchorMdx, AnchorProps, 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, Meta, NoControlsWarning, NormalizedOptionsConfig, NumberConfig, NumberControl, NumberValue, ObjectConfig, ObjectControl, ObjectProps, ObjectValue, 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, SourceState, Stories, Story, StoryData, StoryProps, StorySources, StoryTable, Subheading, Subtitle, TextConfig, TextControl, TextProps, TextValue, Title, Typeset, Wrapper, anchorBlockIdFromId, assertIsFn, extractComponentArgTypes, extractTitle, format, formatDate, formatTime, getComponent, getDescriptionProps, getStoryId, getStoryProps, parse, parseDate, parseTime, storyBlockIdFromId, useSourceProps };