storybook 9.1.0-alpha.5 → 9.1.0-alpha.7

package/dist/csf/index.d.ts

@@ -1,11 +1,4 @@
 import { StorybookTypes, Renderer as Renderer$1, ProjectAnnotations as ProjectAnnotations$1, NormalizedProjectAnnotations, Args as Args$1, ComponentAnnotations as ComponentAnnotations$1, StoryAnnotations as StoryAnnotations$1, ComposedStoryFn } from 'storybook/internal/types';
-import { ActionsTypes } from 'storybook/actions/preview';
-import { BackgroundTypes } from 'storybook/backgrounds/preview';
-import { HighlightTypes } from 'storybook/highlight/preview';
-import { MeasureTypes } from 'storybook/measure/preview';
-import { OutlineTypes } from 'storybook/outline/preview';
-import { TestTypes } from 'storybook/test/preview';
-import { ViewportTypes } from 'storybook/viewport/preview';
 import { AddonTypes as AddonTypes$1, StoryContext as StoryContext$1 } from 'storybook/internal/csf';
 
 declare global {
@@ -297,7 +290,254 @@ type SBOtherType = SBBaseType & {
 };
 type SBType = SBScalarType | SBEnumType | SBArrayType | SBObjectType | SBIntersectionType | SBUnionType | SBOtherType;
 
-type CoreTypes = StorybookTypes & ActionsTypes & BackgroundTypes & HighlightTypes & MeasureTypes & OutlineTypes & TestTypes & ViewportTypes;
+interface ActionsParameters {
+    /**
+     * Actions configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/actions#parameters
+     */
+    actions?: {
+        /**
+         * Create actions for each arg that matches the regex. (**NOT recommended, see below**)
+         *
+         * This is quite useful when your component has dozens (or hundreds) of methods and you do not
+         * want to manually apply the fn utility for each of those methods. However, this is not the
+         * recommended way of writing actions. That's because automatically inferred args are not
+         * available as spies in your play function. If you use argTypesRegex and your stories have play
+         * functions, you will need to also define args with the fn utility to test them in your play
+         * function.
+         *
+         * @example `argTypesRegex: '^on.*'`
+         */
+        argTypesRegex?: string;
+        /** Remove the addon panel and disable the addon's behavior */
+        disable?: boolean;
+        /**
+         * Binds a standard HTML event handler to the outermost HTML element rendered by your component
+         * and triggers an action when the event is called for a given selector. The format is
+         * `<eventname> <selector>`. The selector is optional; it defaults to all elements.
+         *
+         * **To enable this feature, you must use the `withActions` decorator.**
+         *
+         * @example `handles: ['mouseover', 'click .btn']`
+         *
+         * @see https://storybook.js.org/docs/essentials/actions#action-event-handlers
+         */
+        handles?: string[];
+    };
+}
+interface ActionsTypes {
+    parameters: ActionsParameters;
+}
+
+declare const PARAM_KEY = "backgrounds";
+
+interface Background {
+    name: string;
+    value: string;
+}
+type BackgroundMap = Record<string, Background>;
+interface GridConfig {
+    cellAmount: number;
+    cellSize: number;
+    opacity: number;
+    offsetX?: number;
+    offsetY?: number;
+}
+type GlobalState$1 = {
+    value: string | undefined;
+    grid?: boolean;
+};
+interface BackgroundsParameters {
+    /**
+     * Backgrounds configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/backgrounds#parameters
+     */
+    backgrounds?: {
+        /** Default background color */
+        default?: string;
+        /** Remove the addon panel and disable the addon's behavior */
+        disable?: boolean;
+        /** Configuration for the background grid */
+        grid?: GridConfig;
+        /** Available background colors */
+        options?: BackgroundMap;
+    };
+}
+interface BackgroundsGlobals {
+    /**
+     * Backgrounds configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/backgrounds#globals
+     */
+    [PARAM_KEY]?: GlobalState$1 | GlobalState$1['value'];
+}
+interface BackgroundTypes {
+    parameters: BackgroundsParameters;
+    globals: BackgroundsGlobals;
+}
+
+interface ControlsParameters {
+    /**
+     * Controls configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/controls#parameters-1
+     */
+    controls?: {
+        /** Remove the addon panel and disable the addon's behavior */
+        disable?: boolean;
+        /** Disable the ability to create or edit stories from the Controls panel */
+        disableSaveFromUI?: boolean;
+        /** Exclude specific properties from the Controls panel */
+        exclude?: string[] | RegExp;
+        /**
+         * Show the full documentation for each property in the Controls addon panel, including the
+         * description and default value.
+         */
+        expanded?: boolean;
+        /** Exclude only specific properties in the Controls panel */
+        include?: string[] | RegExp;
+        /**
+         * Custom control type matchers
+         *
+         * @see https://storybook.js.org/docs/essentials/controls#custom-control-type-matchers
+         */
+        matchers?: {
+            date?: RegExp;
+            color?: RegExp;
+        };
+        /**
+         * Preset color swatches for the color picker control
+         *
+         * @example PresetColors: [{ color: '#ff4785', title: 'Coral' }, 'rgba(0, 159, 183, 1)',
+         * '#fe4a49']
+         */
+        presetColors?: Array<string | {
+            color: string;
+            title?: string;
+        }>;
+        /** Controls sorting order */
+        sort?: 'none' | 'alpha' | 'requiredFirst';
+    };
+}
+interface ControlsTypes {
+    parameters: ControlsParameters;
+}
+
+interface HighlightTypes {
+    parameters: HighlightParameters;
+}
+interface HighlightParameters {
+    /**
+     * Highlight configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/highlight#parameters
+     */
+    highlight?: {
+        /** Remove the addon panel and disable the addon's behavior */
+        disable?: boolean;
+    };
+}
+
+interface MeasureParameters {
+    /**
+     * Measure configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/measure-and-outline#parameters
+     */
+    measure?: {
+        /** Remove the addon panel and disable the addon's behavior */
+        disable?: boolean;
+    };
+}
+interface MeasureTypes {
+    parameters: MeasureParameters;
+}
+
+interface OutlineParameters {
+    /**
+     * Outline configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/measure-and-outline#parameters
+     */
+    outline?: {
+        /** Remove the addon panel and disable the addon's behavior */
+        disable?: boolean;
+    };
+}
+interface OutlineTypes {
+    parameters: OutlineParameters;
+}
+
+interface TestParameters {
+    test?: {
+        /** Ignore unhandled errors during test execution */
+        dangerouslyIgnoreUnhandledErrors?: boolean;
+        /** Whether to throw exceptions coming from the play function */
+        throwPlayFunctionExceptions?: boolean;
+    };
+}
+interface TestTypes {
+    parameters: TestParameters;
+}
+
+interface Viewport {
+    name: string;
+    styles: ViewportStyles;
+    type?: 'desktop' | 'mobile' | 'tablet' | 'other';
+}
+interface ViewportStyles {
+    height: string;
+    width: string;
+}
+type GlobalState = {
+    /**
+     * When set, the viewport is applied and cannot be changed using the toolbar. Must match the key
+     * of one of the available viewports.
+     */
+    value: string | undefined;
+    /**
+     * When true the viewport applied will be rotated 90°, e.g. it will rotate from portrait to
+     * landscape orientation.
+     */
+    isRotated?: boolean;
+};
+interface ViewportParameters {
+    /**
+     * Viewport configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/viewport#parameters
+     */
+    viewport?: {
+        /**
+         * Remove the addon panel and disable the addon's behavior . If you wish to turn off this addon
+         * for the entire Storybook, you should do so when registering addon-essentials
+         *
+         * @see https://storybook.js.org/docs/essentials/index#disabling-addons
+         */
+        disable?: boolean;
+        /**
+         * Specify the available viewports. The width and height values must include the unit, e.g.
+         * '320px'.
+         */
+        options: Record<string, Viewport>;
+    };
+}
+interface ViewportGlobals {
+    /**
+     * Viewport configuration
+     *
+     * @see https://storybook.js.org/docs/essentials/viewport#globals
+     */
+    viewport?: GlobalState | GlobalState['value'];
+}
+interface ViewportTypes {
+    parameters: ViewportParameters;
+    globals: ViewportGlobals;
+}
+
+type CoreTypes = StorybookTypes & ActionsTypes & BackgroundTypes & ControlsTypes & HighlightTypes & MeasureTypes & OutlineTypes & TestTypes & ViewportTypes;
 declare function getCoreAnnotations(): any[];
 
 type StoryId = string;
@@ -670,7 +910,9 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
      *
      * By defining them each component will have its tab in the args table.
      */
-    subcomponents?: Record<string, TRenderer['component']>;
+    subcomponents?: Record<string, (TRenderer & {
+        T: any;
+    })['component']>;
     /** Function that is executed after the story is rendered. */
     play?: PlayFunction<TRenderer, TArgs>;
     /** Override the globals values for all stories in this component */