kibana/api_docs/kbn_storybook.devdocs.json

731 lines
No EOL
26 KiB
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.mergeWebpackFinal",
"type": "Function",
"tags": [],
"label": "mergeWebpackFinal",
"description": [],
"signature": [
"(extraConfig: ",
"Configuration",
") => { webpackFinal: (config: ",
"Configuration",
") => ",
"Configuration",
"; }"
],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.mergeWebpackFinal.$1",
"type": "Object",
"tags": [],
"label": "extraConfig",
"description": [],
"signature": [
"Configuration"
],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.runStorybookCli",
"type": "Function",
"tags": [],
"label": "runStorybookCli",
"description": [],
"signature": [
"({ configDir, name }: { configDir: string; name: string; }) => void"
],
"path": "packages/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": "packages/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": "packages/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": "packages/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": [
"\nThe interface for Storybook configuration in `main.ts` files."
],
"signature": [
"StorybookConfig"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.addons",
"type": "Array",
"tags": [],
"label": "addons",
"description": [
"\nSets the addons you want to use with Storybook.\n"
],
"signature": [
"Preset",
"[] | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.core",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreConfig",
" | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.staticDirs",
"type": "Array",
"tags": [],
"label": "staticDirs",
"description": [
"\nSets a list of directories of static files to be loaded by Storybook server\n"
],
"signature": [
"(string | DirectoryMapping)[] | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.logLevel",
"type": "string",
"tags": [],
"label": "logLevel",
"description": [],
"signature": [
"string | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.features",
"type": "Object",
"tags": [],
"label": "features",
"description": [],
"signature": [
"{ postcss?: boolean | undefined; emotionAlias?: boolean | undefined; buildStoriesJson?: boolean | undefined; previewCsfV3?: boolean | undefined; modernInlineRender?: boolean | undefined; storyStoreV7?: boolean | undefined; breakingChangesV7?: boolean | undefined; interactionsDebugger?: boolean | undefined; babelModeV7?: boolean | undefined; argTypeTargetsV7?: boolean | undefined; warnOnLegacyHierarchySeparator?: boolean | undefined; previewMdx2?: boolean | undefined; } | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.stories",
"type": "Array",
"tags": [],
"label": "stories",
"description": [
"\nTells Storybook where to find stories.\n"
],
"signature": [
"StoriesEntry",
"[]"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.framework",
"type": "CompoundType",
"tags": [],
"label": "framework",
"description": [
"\nFramework, e.g. '@storybook/react', required in v7"
],
"signature": [
"Preset",
" | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.typescript",
"type": "Object",
"tags": [],
"label": "typescript",
"description": [
"\nControls how Storybook handles TypeScript files."
],
"signature": [
"Partial<",
"TypescriptOptions",
"> | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.refs",
"type": "CompoundType",
"tags": [],
"label": "refs",
"description": [
"\nReferences external Storybooks"
],
"signature": [
"StorybookRefs | ((config: ",
"Configuration",
", options: ",
"Options",
") => StorybookRefs) | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.webpackFinal",
"type": "Function",
"tags": [],
"label": "webpackFinal",
"description": [
"\nModify or return a custom Webpack config."
],
"signature": [
"((config: ",
"Configuration",
", options: ",
"Options",
") => ",
"Configuration",
" | Promise<",
"Configuration",
">) | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.webpackFinal.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Configuration"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.webpackFinal.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.config",
"type": "Function",
"tags": [
"deprecated"
],
"label": "config",
"description": [
"\nAdd additional scripts to run in the preview a la `.storybook/preview.js`\n"
],
"signature": [
"((entries: string[], options: ",
"Options",
") => string[]) | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.config.$1",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
"string[]"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.config.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.previewAnnotations",
"type": "Function",
"tags": [],
"label": "previewAnnotations",
"description": [
"\nAdd additional scripts to run in the preview a la `.storybook/preview.js`"
],
"signature": [
"((entries: string[], options: ",
"Options",
") => string[]) | undefined"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.previewAnnotations.$1",
"type": "Array",
"tags": [],
"label": "entries",
"description": [],
"signature": [
"string[]"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.StorybookConfig.previewAnnotations.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"Options"
],
"path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfig",
"type": "Object",
"tags": [],
"label": "defaultConfig",
"description": [],
"path": "packages/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[]"
],
"path": "packages/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": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfig.typescript",
"type": "Object",
"tags": [],
"label": "typescript",
"description": [],
"path": "packages/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": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfig.features",
"type": "Object",
"tags": [],
"label": "features",
"description": [],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfig.features.postcss",
"type": "boolean",
"tags": [],
"label": "postcss",
"description": [],
"signature": [
"false"
],
"path": "packages/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": [
"// @ts-expect-error StorybookConfig type is incomplete\n// https://storybook.js.org/docs/react/configure/babel#custom-configuration"
],
"signature": [
"(options: any) => Promise<any>"
],
"path": "packages/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": "options",
"description": [],
"signature": [
"any"
],
"path": "packages/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",
") => { resolve: { alias: { '@emotion/core': string; '@emotion/styled': string; 'emotion-theming': string; }; modules?: string[] | undefined; descriptionFiles?: string[] | undefined; mainFields?: string[] | string[][] | undefined; aliasFields?: string[] | string[][] | undefined; mainFiles?: string[] | undefined; extensions?: string[] | undefined; enforceExtension?: boolean | undefined; unsafeCache?: boolean | {} | undefined; cachePredicate?: ((data: { path: string; request: string; }) => boolean) | undefined; plugins?: ",
"ResolvePlugin",
"[] | undefined; symlinks?: boolean | undefined; cacheWithContext?: boolean | undefined; roots?: string[] | undefined; }; mode?: \"none\" | \"production\" | \"development\" | undefined; name?: string | undefined; context?: string | undefined; entry?: string | string[] | ",
"Entry",
" | ",
"EntryFunc",
" | undefined; devtool?: ",
"Options",
".Devtool | undefined; output?: ",
"Output",
" | undefined; module?: ",
"Module",
" | undefined; resolveLoader?: ",
"ResolveLoader",
" | undefined; externals?: ",
"ExternalsElement",
" | ",
"ExternalsElement",
"[] | undefined; target?: \"node\" | \"web\" | \"webworker\" | \"async-node\" | \"node-webkit\" | \"atom\" | \"electron\" | \"electron-renderer\" | \"electron-preload\" | \"electron-main\" | ((compiler?: any) => void) | undefined; bail?: boolean | undefined; profile?: boolean | undefined; cache?: boolean | object | undefined; watch?: boolean | undefined; watchOptions?: ",
"ICompiler",
".WatchOptions | undefined; node?: false | ",
"Node",
" | undefined; amd?: { [moduleName: string]: boolean; } | undefined; recordsPath?: string | undefined; recordsInputPath?: string | undefined; recordsOutputPath?: string | undefined; plugins?: ",
"Plugin",
"[] | undefined; stats?: ",
"Stats",
".ToStringOptions | undefined; performance?: false | ",
"Options",
".Performance | undefined; parallelism?: number | undefined; optimization?: ",
"Options",
".Optimization | undefined; infrastructureLogging?: ",
"Options",
".InfrastructureLogging | undefined; devServer?: ",
"Configuration",
" | undefined; }"
],
"path": "packages/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": "packages/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": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfigWebFinal",
"type": "Object",
"tags": [],
"label": "defaultConfigWebFinal",
"description": [],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfigWebFinal.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfigWebFinal.webpackFinal",
"type": "Function",
"tags": [],
"label": "webpackFinal",
"description": [],
"signature": [
"(config: ",
"Configuration",
") => ",
"Configuration",
" & ",
"ConfigurationMergeFunction"
],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/storybook",
"id": "def-common.defaultConfigWebFinal.webpackFinal.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Configuration"
],
"path": "packages/kbn-storybook/src/lib/default_config.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
]
}
}