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

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';
@@ -20,7 +20,7 @@ interface SourceCodeProps {
     format?: ComponentProps<typeof SyntaxHighlighter>['format'];
     dark?: boolean;
 }
-declare type SourceProps$1 = SourceErrorProps & SourceCodeProps;
+type SourceProps$1 = SourceErrorProps & SourceCodeProps;
 /**
  * Syntax-highlighted source code for a component (or anything!)
  */
@@ -55,7 +55,7 @@ interface ArgTypes {
 interface Args {
     [key: string]: any;
 }
-declare type Globals = {
+type Globals = {
     [name: string]: any;
 };
 
@@ -63,7 +63,7 @@ declare enum ArgsTableError {
     NO_COMPONENT = "No component found.",
     ARGS_UNSUPPORTED = "Args unsupported. See Args documentation for your framework."
 }
-declare type SortType = 'alpha' | 'requiredFirst' | 'none';
+type SortType = 'alpha' | 'requiredFirst' | 'none';
 interface ArgsTableOptionProps {
     children?: React.ReactNode;
     updateArgs?: (args: Args) => void;
@@ -85,7 +85,7 @@ interface ArgsTableErrorProps {
 interface ArgsTableLoadingProps {
     isLoading: true;
 }
-declare type ArgsTableProps$1 = ArgsTableOptionProps & (ArgsTableDataProps | ArgsTableErrorProps | ArgsTableLoadingProps);
+type ArgsTableProps$1 = 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.
@@ -106,8 +106,8 @@ interface InlineStoryProps extends CommonProps$2 {
     parameters: Parameters;
     storyFn: ElementType;
 }
-declare type IFrameStoryProps = CommonProps$2;
-declare type StoryProps$2 = InlineStoryProps | IFrameStoryProps;
+type IFrameStoryProps = CommonProps$2;
+type StoryProps$2 = InlineStoryProps | IFrameStoryProps;
 /**
  * A story element, either rendered inline or in an iframe,
  * with configurable height.
@@ -130,7 +130,7 @@ interface TypesetProps {
  */
 declare const Typeset: FC<TypesetProps>;
 
-declare type Colors = string[] | {
+type Colors = string[] | {
     [key: string]: string;
 };
 interface ColorItemProps {
@@ -174,17 +174,17 @@ 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;
+type Component = any;
 interface StoryData {
     id?: string;
     kind?: string;
     name?: string;
     parameters?: any;
 }
-declare type DocsStoryProps = StoryData & {
+type DocsStoryProps = StoryData & {
     expanded?: boolean;
     withToolbar?: boolean;
 };
@@ -194,19 +194,19 @@ interface BaseProps {
     exclude?: Store_PropDescriptor;
     sort?: SortType;
 }
-declare type OfProps = BaseProps & {
+type OfProps = BaseProps & {
     of: '^' | Component;
 };
-declare type ComponentsProps = BaseProps & {
+type ComponentsProps = BaseProps & {
     components: {
         [label: string]: Component;
     };
 };
-declare type StoryProps$1 = BaseProps & {
+type StoryProps$1 = BaseProps & {
     story: '.' | '^' | string;
     showComponent?: boolean;
 };
-declare type ArgsTableProps = BaseProps | OfProps | ComponentsProps | StoryProps$1;
+type ArgsTableProps = BaseProps | OfProps | ComponentsProps | StoryProps$1;
 declare const extractComponentArgTypes: (component: Component, context: DocsContextProps, include?: Store_PropDescriptor, exclude?: Store_PropDescriptor) => StrictArgTypes;
 declare const getComponent: (props: ArgsTableProps, context: DocsContextProps) => Component;
 declare const StoryTable: FC<StoryProps$1 & {
@@ -220,7 +220,7 @@ interface SourceItem {
     code: string;
     format: SyntaxHighlighterFormatTypes;
 }
-declare type StorySources = Record<StoryId, SourceItem>;
+type StorySources = Record<StoryId, SourceItem>;
 interface SourceContextProps {
     sources: StorySources;
     setSource?: (id: StoryId, item: SourceItem) => void;
@@ -241,22 +241,22 @@ interface CommonProps$1 {
     format?: PureSourceProps['format'];
     code?: string;
 }
-declare type SingleSourceProps = {
+type SingleSourceProps = {
     id: string;
 } & CommonProps$1;
-declare type MultiSourceProps = {
+type MultiSourceProps = {
     ids: string[];
 } & CommonProps$1;
-declare type CodeProps = {
+type CodeProps = {
     code: string;
 } & CommonProps$1;
-declare type NoneProps = CommonProps$1;
-declare type SourceProps = SingleSourceProps | MultiSourceProps | CodeProps | NoneProps;
-declare type SourceStateProps = {
+type NoneProps = CommonProps$1;
+type SourceProps = SingleSourceProps | MultiSourceProps | CodeProps | NoneProps;
+type SourceStateProps = {
     state: SourceState;
 };
-declare type PureSourceProps = ComponentProps<typeof Source$1>;
-declare const getSourceProps: (props: SourceProps, docsContext: DocsContextProps<any>, sourceContext: SourceContextProps) => PureSourceProps & SourceStateProps;
+type PureSourceProps = ComponentProps<typeof Source$1>;
+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 & {
+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> = {
+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> = {
+type ExternalDocsProps<TFramework extends Renderer = Renderer> = {
     projectAnnotationsList: ProjectAnnotations<TFramework>[];
 };
 declare const ExternalDocs: FunctionComponent<ExternalDocsProps>;
@@ -318,7 +318,7 @@ interface HeadingProps {
 }
 declare const Heading: FC<HeadingProps>;
 
-declare type MetaProps = BaseAnnotations & {
+type MetaProps = BaseAnnotations & {
     of?: Store_ModuleExports;
 };
 /**
@@ -339,27 +339,25 @@ interface StoriesProps {
 declare const Stories: FC<StoriesProps>;
 
 declare const storyBlockIdFromId: (storyId: string) => string;
-declare type PureStoryProps = ComponentProps<typeof Story$1>;
-declare type CommonProps = StoryAnnotations & {
+type PureStoryProps = ComponentProps<typeof Story$1>;
+type CommonProps = StoryAnnotations & {
     height?: string;
     inline?: boolean;
 };
-declare type StoryDefProps = {
+type StoryDefProps = {
     name: string;
-    children: ReactNode;
 };
-declare type StoryRefProps = {
+type StoryRefProps = {
     id?: string;
     of?: Store_ModuleExport;
     meta?: Store_ModuleExports;
 };
-declare type StoryImportProps = {
+type StoryImportProps = {
     name: string;
-    story: ElementType;
 };
-declare type StoryProps = (StoryDefProps | StoryRefProps | StoryImportProps) & CommonProps;
+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>;
@@ -404,11 +402,11 @@ interface ControlProps<T> {
     onFocus?: (evt: any) => void;
     onBlur?: (evt: any) => void;
 }
-declare type BooleanValue = boolean;
+type BooleanValue = boolean;
 interface BooleanConfig {
 }
-declare type ColorValue = string;
-declare type PresetColor = ColorValue | {
+type ColorValue = string;
+type PresetColor = ColorValue | {
     color: ColorValue;
     title?: string;
 };
@@ -420,26 +418,26 @@ interface ColorConfig {
      */
     startOpen?: boolean;
 }
-declare type DateValue = Date | number;
+type DateValue = Date | number;
 interface DateConfig {
 }
-declare type NumberValue = number;
+type NumberValue = number;
 interface NumberConfig {
     min?: number;
     max?: number;
     step?: number;
 }
-declare type RangeConfig = NumberConfig;
-declare type ObjectValue = any;
+type RangeConfig = NumberConfig;
+type ObjectValue = any;
 interface ObjectConfig {
 }
-declare type OptionsSingleSelection = any;
-declare type OptionsMultiSelection = any[];
-declare type OptionsSelection = OptionsSingleSelection | OptionsMultiSelection;
-declare type OptionsArray = any[];
-declare type OptionsObject = Record<string, any>;
-declare type Options = OptionsArray | OptionsObject;
-declare type OptionsControlType = 'radio' | 'inline-radio' | 'check' | 'inline-check' | 'select' | 'multi-select';
+type OptionsSingleSelection = any;
+type OptionsMultiSelection = any[];
+type OptionsSelection = OptionsSingleSelection | OptionsMultiSelection;
+type OptionsArray = any[];
+type OptionsObject = Record<string, any>;
+type Options = OptionsArray | OptionsObject;
+type OptionsControlType = 'radio' | 'inline-radio' | 'check' | 'inline-check' | 'select' | 'multi-select';
 interface OptionsConfig {
     labels: Record<any, string>;
     type: OptionsControlType;
@@ -447,43 +445,48 @@ interface OptionsConfig {
 interface NormalizedOptionsConfig {
     options: OptionsObject;
 }
-declare type TextValue = string;
+type TextValue = string;
 interface TextConfig {
     maxLength?: number;
 }
-declare type ControlType = 'array' | 'boolean' | 'color' | 'date' | 'number' | 'range' | 'object' | OptionsControlType | 'text';
-declare type Control = BooleanConfig | ColorConfig | DateConfig | NumberConfig | ObjectConfig | OptionsConfig | RangeConfig | TextConfig;
-declare type Controls = Record<string, Control>;
+type ControlType = 'array' | 'boolean' | 'color' | 'date' | 'number' | 'range' | 'object' | OptionsControlType | 'text';
+type Control = BooleanConfig | ColorConfig | DateConfig | NumberConfig | ObjectConfig | OptionsConfig | RangeConfig | TextConfig;
+type Controls = Record<string, Control>;
 
-declare type ColorControlProps = ControlProps<ColorValue> & ColorConfig;
+type ColorControlProps = ControlProps<ColorValue> & ColorConfig;
 
-declare type BooleanProps = ControlProps<BooleanValue> & BooleanConfig;
+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;
 declare const parseTime: (value: string) => Date;
 declare const formatDate: (value: Date | number) => string;
 declare const formatTime: (value: Date | number) => string;
-declare type DateProps = ControlProps<DateValue> & DateConfig;
+type DateProps = ControlProps<DateValue> & DateConfig;
 declare const DateControl: FC<DateProps>;
 
-declare type NumberProps = ControlProps<NumberValue | null> & NumberConfig;
+type NumberProps = ControlProps<NumberValue | null> & NumberConfig;
 declare const parse: (value: string) => number;
 declare const format: (value: NumberValue) => string;
 declare const NumberControl: FC<NumberProps>;
 
-declare type OptionsProps = ControlProps<OptionsSelection> & OptionsConfig;
+type OptionsProps = ControlProps<OptionsSelection> & OptionsConfig;
 declare const OptionsControl: FC<OptionsProps>;
 
-declare type ObjectProps = ControlProps<ObjectValue> & ObjectConfig & {
+type ObjectProps = ControlProps<ObjectValue> & ObjectConfig & {
     theme: any;
 };
 declare const ObjectControl: FC<ObjectProps>;
 
-declare type RangeProps = ControlProps<NumberValue | null> & RangeConfig;
+type RangeProps = ControlProps<NumberValue | null> & RangeConfig;
 declare const RangeControl: FC<RangeProps>;
 
-declare type TextProps = ControlProps<TextValue | undefined> & TextConfig;
+type TextProps = ControlProps<TextValue | undefined> & TextConfig;
 declare const TextControl: FC<TextProps>;
 
 interface FilesControlProps extends ControlProps<string[]> {
@@ -502,8 +505,8 @@ interface FilesControlProps extends ControlProps<string[]> {
 }
 declare const FilesControl: FC<FilesControlProps>;
 
-declare type ColorProps = ColorControlProps;
+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 };