kibana/api_docs/kbn_code_editor_mocks.devdocs.json

499 lines
No EOL
20 KiB
JSON

{
"id": "@kbn/code-editor-mocks",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock",
"type": "Class",
"tags": [],
"label": "CodeEditorStorybookMock",
"description": [
"\nStorybook mock for the `CodeEditor` component"
],
"signature": [
{
"pluginId": "@kbn/code-editor-mocks",
"scope": "common",
"docId": "kibKbnCodeEditorMocksPluginApi",
"section": "def-common.CodeEditorStorybookMock",
"text": "CodeEditorStorybookMock"
},
" extends ",
{
"pluginId": "@kbn/shared-ux-storybook-mock",
"scope": "common",
"docId": "kibKbnSharedUxStorybookMockPluginApi",
"section": "def-common.AbstractStorybookMock",
"text": "AbstractStorybookMock"
},
"<",
"Props",
", {}, PropArguments, {}>"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments",
"type": "Object",
"tags": [],
"label": "propArguments",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.languageId",
"type": "Object",
"tags": [],
"label": "languageId",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.languageId.control",
"type": "Object",
"tags": [],
"label": "control",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.languageId.control.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.languageId.options",
"type": "Array",
"tags": [],
"label": "options",
"description": [],
"signature": [
"string[]"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.languageId.defaultValue",
"type": "string",
"tags": [],
"label": "defaultValue",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.value",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.value.control",
"type": "Object",
"tags": [],
"label": "control",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.value.control.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.value.defaultValue",
"type": "string",
"tags": [],
"label": "defaultValue",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.arialabel",
"type": "Object",
"tags": [],
"label": "'aria-label'",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.arialabel.control",
"type": "Object",
"tags": [],
"label": "control",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.arialabel.control.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.arialabel.defaultValue",
"type": "string",
"tags": [],
"label": "defaultValue",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.allowFullScreen",
"type": "Object",
"tags": [],
"label": "allowFullScreen",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.allowFullScreen.control",
"type": "Object",
"tags": [],
"label": "control",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.allowFullScreen.control.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.allowFullScreen.defaultValue",
"type": "boolean",
"tags": [],
"label": "defaultValue",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.transparentBackground",
"type": "Object",
"tags": [],
"label": "transparentBackground",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.transparentBackground.control",
"type": "Object",
"tags": [],
"label": "control",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.transparentBackground.control.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.transparentBackground.defaultValue",
"type": "boolean",
"tags": [],
"label": "defaultValue",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.placeholder",
"type": "Object",
"tags": [],
"label": "placeholder",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.placeholder.control",
"type": "Object",
"tags": [],
"label": "control",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.placeholder.control.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.propArguments.placeholder.defaultValue",
"type": "string",
"tags": [],
"label": "defaultValue",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
]
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.serviceArguments",
"type": "Object",
"tags": [],
"label": "serviceArguments",
"description": [],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": []
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.dependencies",
"type": "Array",
"tags": [],
"label": "dependencies",
"description": [],
"signature": [
"never[]"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.getProps",
"type": "Function",
"tags": [],
"label": "getProps",
"description": [],
"signature": [
"(params?: ",
{
"pluginId": "@kbn/code-editor-mocks",
"scope": "common",
"docId": "kibKbnCodeEditorMocksPluginApi",
"section": "def-common.Params",
"text": "Params"
},
" | undefined) => ",
"Props"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.getProps.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "@kbn/code-editor-mocks",
"scope": "common",
"docId": "kibKbnCodeEditorMocksPluginApi",
"section": "def-common.Params",
"text": "Params"
},
" | undefined"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.CodeEditorStorybookMock.getServices",
"type": "Function",
"tags": [],
"label": "getServices",
"description": [],
"signature": [
"() => { width?: string | number | undefined; height?: string | number | undefined; languageId: enum; value: string; onChange?: ((value: string, event: ",
"editor",
".IModelContentChangedEvent) => void) | undefined; options?: ",
"editor",
".IStandaloneEditorConstructionOptions | undefined; suggestionProvider?: ",
"languages",
".CompletionItemProvider | undefined; signatureProvider?: ",
"languages",
".SignatureHelpProvider | undefined; hoverProvider?: ",
"languages",
".HoverProvider | undefined; languageConfiguration?: ",
"languages",
".LanguageConfiguration | undefined; editorWillMount?: (() => void) | undefined; overrideEditorWillMount?: (() => void) | undefined; editorDidMount?: ((editor: ",
"editor",
".IStandaloneCodeEditor) => void) | undefined; useDarkTheme?: boolean | undefined; transparentBackground?: boolean | undefined; fullWidth?: boolean | undefined; placeholder?: string | undefined; 'aria-label'?: string | undefined; isCopyable?: boolean | undefined; allowFullScreen?: boolean | undefined; }"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/code-editor-mocks",
"id": "def-common.Params",
"type": "Type",
"tags": [],
"label": "Params",
"description": [],
"signature": [
"{ value: any; placeholder: any; \"aria-label\": any; allowFullScreen: any; languageId: any; transparentBackground: any; }"
],
"path": "packages/shared-ux/code_editor/mocks/storybook.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}