Logo for jsDocs.io

@types/storybook__addon-info

  • Version 5.2.8
  • Published
  • 8.36 kB
  • 4 dependencies
  • MIT license

Install

npm i @types/storybook__addon-info
yarn add @types/storybook__addon-info
pnpm add @types/storybook__addon-info

Overview

TypeScript definitions for @storybook/addon-info

Index

Functions

Interfaces

Functions

function setDefaults

setDefaults: (newDefaults: Options) => Options;

  • Deprecated

    setDefaults is deprecated. Instead, you can pass options into withInfo(options) directly, or use the info parameter.

function withInfo

withInfo: {
    <A = unknown>(
        story: StoryFn<A>,
        context: StoryContext<{ component: any; storyResult: A }>
    ): ReturnType<DecoratorFunction<A>>;
    (textOrOptions?: string | Options): (
        storyFn: StoryFn
    ) => (context?: object) => ReactElement<WrapStoryProps>;
};

  • Deprecated

    withInfo wrapper is deprecated, use the info parameter globally or on each story

Interfaces

interface Options

interface Options {}

    property components

    components?:
        | {
              [key: string]: ComponentType<any>;
          }
        | undefined;

      property excludedPropTypes

      excludedPropTypes?: string[] | undefined;

        property header

        header?: boolean | undefined;

          property inline

          inline?: boolean | undefined;

            property marksyConf

            marksyConf?: object | undefined;

            • Deprecated

              "marksyConf" option has been renamed to "components"

            property maxPropArrayLength

            maxPropArrayLength?: number | undefined;

              property maxPropObjectKeys

              maxPropObjectKeys?: number | undefined;

                property maxPropsIntoLine

                maxPropsIntoLine?: number | undefined;

                  property maxPropStringLength

                  maxPropStringLength?: number | undefined;

                    property propTables

                    propTables?: Array<ComponentType<any>> | false | undefined;

                      property propTablesExclude

                      propTablesExclude?: Array<ComponentType<any>> | undefined;

                        property source

                        source?: boolean | undefined;

                          property styles

                          styles?: object | undefined;

                            property TableComponent

                            TableComponent?: ComponentType<TableComponentOptionProps> | undefined;

                              property text

                              text?: string | undefined;

                                interface TableComponentOptionProps

                                interface TableComponentOptionProps {}

                                  property propDefinitions

                                  propDefinitions: Array<{
                                      property: string;
                                      propType: object | string; // TODO: info about what this object is...
                                      required: boolean;
                                      description: string;
                                      defaultValue: any;
                                  }>;

                                    interface WrapStoryProps

                                    interface WrapStoryProps {}

                                      property context

                                      context?: object | undefined;

                                        property options

                                        options?: object | undefined;

                                          property storyFn

                                          storyFn?: StoryFn | undefined;

                                            Package Files (1)

                                            Dependencies (4)

                                            Dev Dependencies (0)

                                            No dev dependencies.

                                            Peer Dependencies (0)

                                            No peer dependencies.

                                            Badge

                                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/storybook__addon-info.

                                            • Markdown
                                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/storybook__addon-info)
                                            • HTML
                                              <a href="https://www.jsdocs.io/package/@types/storybook__addon-info"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>