kibana/api_docs/kbn_storybook.devdocs.json

{
  "id": "@kbn/storybook",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/storybook",
        "id": "def-common.runStorybookCli",
        "type": "Function",
        "tags": [],
        "label": "runStorybookCli",
        "description": [],
        "signature": [
          "({ configDir, name }: { configDir: string; name: string; }) => void"
        ],
        "path": "src/platform/packages/shared/kbn-storybook/src/lib/run_storybook_cli.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.runStorybookCli.$1",
            "type": "Object",
            "tags": [],
            "label": "{ configDir, name }",
            "description": [],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/run_storybook_cli.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.runStorybookCli.$1.configDir",
                "type": "string",
                "tags": [],
                "label": "configDir",
                "description": [],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/run_storybook_cli.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.runStorybookCli.$1.name",
                "type": "string",
                "tags": [],
                "label": "name",
                "description": [],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/run_storybook_cli.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/storybook",
        "id": "def-common.StorybookConfig",
        "type": "Interface",
        "tags": [],
        "label": "StorybookConfig",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/storybook",
            "scope": "common",
            "docId": "kibKbnStorybookPluginApi",
            "section": "def-common.StorybookConfig",
            "text": "StorybookConfig"
          },
          " extends ",
          "StorybookConfig"
        ],
        "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.StorybookConfig.typescript",
            "type": "Object",
            "tags": [],
            "label": "typescript",
            "description": [],
            "signature": [
              "{ check?: boolean | undefined; skipCompiler?: boolean | undefined; reactDocgen?: false | \"react-docgen-typescript\" | \"react-docgen\" | undefined; reactDocgenTypescriptOptions?: ",
              "PluginOptions",
              " | undefined; }"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/storybook",
        "id": "def-common.DEFAULT_THEME",
        "type": "CompoundType",
        "tags": [],
        "label": "DEFAULT_THEME",
        "description": [],
        "signature": [
          "\"borealis.light\" | \"borealis.dark\" | \"amsterdam.light\" | \"amsterdam.dark\""
        ],
        "path": "src/platform/packages/shared/kbn-storybook/src/lib/themes.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/storybook",
        "id": "def-common.defaultConfig",
        "type": "Object",
        "tags": [],
        "label": "defaultConfig",
        "description": [],
        "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.addons",
            "type": "Array",
            "tags": [],
            "label": "addons",
            "description": [],
            "signature": [
              "(string | { name: string; options: { rules: ({ test: RegExp; use: string[]; } | { test: RegExp; exclude: RegExp; use: ({ loader: string; } | { loader: string; options: { importLoaders: number; }; } | { loader: string; options: { postcssOptions: { config: string; }; }; } | { loader: string; options: { additionalData(content: string, loaderContext: any): string; implementation: any; sassOptions: { includePaths: string[]; quietDeps: boolean; }; }; })[]; })[]; }; })[]"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.stories",
            "type": "Array",
            "tags": [],
            "label": "stories",
            "description": [],
            "signature": [
              "string[]"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.framework",
            "type": "Object",
            "tags": [],
            "label": "framework",
            "description": [],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.framework.name",
                "type": "string",
                "tags": [],
                "label": "name",
                "description": [],
                "signature": [
                  "\"@storybook/react-webpack5\""
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.framework.options",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "children": []
              }
            ]
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.typescript",
            "type": "Object",
            "tags": [],
            "label": "typescript",
            "description": [],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.typescript.reactDocgen",
                "type": "boolean",
                "tags": [],
                "label": "reactDocgen",
                "description": [],
                "signature": [
                  "false"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.core",
            "type": "Object",
            "tags": [],
            "label": "core",
            "description": [],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.core.disableTelemetry",
                "type": "boolean",
                "tags": [],
                "label": "disableTelemetry",
                "description": [],
                "signature": [
                  "true"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.babel",
            "type": "Function",
            "tags": [],
            "label": "babel",
            "description": [],
            "signature": [
              "(config: any, options: any) => Promise<any>"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.babel.$1",
                "type": "Any",
                "tags": [],
                "label": "config",
                "description": [],
                "signature": [
                  "any"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.babel.$2",
                "type": "Any",
                "tags": [],
                "label": "options",
                "description": [],
                "signature": [
                  "any"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.webpackFinal",
            "type": "Function",
            "tags": [],
            "label": "webpackFinal",
            "description": [],
            "signature": [
              "(config: ",
              "Configuration",
              ", options: ",
              "Options",
              ") => ",
              "Configuration"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.webpackFinal.$1",
                "type": "Object",
                "tags": [],
                "label": "config",
                "description": [],
                "signature": [
                  "Configuration"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.webpackFinal.$2",
                "type": "CompoundType",
                "tags": [],
                "label": "options",
                "description": [],
                "signature": [
                  "Options"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.previewHead",
            "type": "Function",
            "tags": [],
            "label": "previewHead",
            "description": [],
            "signature": [
              "(head: string | undefined) => string"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/storybook",
                "id": "def-common.defaultConfig.previewHead.$1",
                "type": "string",
                "tags": [],
                "label": "head",
                "description": [],
                "signature": [
                  "string | undefined"
                ],
                "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/storybook",
            "id": "def-common.defaultConfig.staticDirs",
            "type": "Array",
            "tags": [],
            "label": "staticDirs",
            "description": [],
            "signature": [
              "(string | { from: string; to: string; })[]"
            ],
            "path": "src/platform/packages/shared/kbn-storybook/src/lib/default_config.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/storybook",
        "id": "def-common.THEMES",
        "type": "Object",
        "tags": [],
        "label": "THEMES",
        "description": [],
        "signature": [
          "readonly [\"borealis.light\", \"borealis.dark\", \"amsterdam.light\", \"amsterdam.dark\"]"
        ],
        "path": "src/platform/packages/shared/kbn-storybook/src/lib/themes.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ]
  }
}