github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_unified_tabs.devdocs.json

482 lines
No EOL
16 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/unified-tabs",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContent",
"type": "Function",
"tags": [],
"label": "TabbedContent",
"description": [],
"signature": [
"({ initialItems, initialSelectedItemId, maxItemsCount, services, renderContent, createItem, onChanged, getPreviewData, }: ",
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabbedContentProps",
"text": "TabbedContentProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContent.$1",
"type": "Object",
"tags": [],
"label": "{\n initialItems,\n initialSelectedItemId,\n maxItemsCount,\n services,\n renderContent,\n createItem,\n onChanged,\n getPreviewData,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabbedContentProps",
"text": "TabbedContentProps"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.useNewTabProps",
"type": "Function",
"tags": [],
"label": "useNewTabProps",
"description": [],
"signature": [
"({ numberOfInitialItems }: { numberOfInitialItems: number; }) => { getNewTabDefaultProps: () => Pick<",
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
},
", \"id\" | \"label\">; }"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/hooks/use_new_tab_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.useNewTabProps.$1",
"type": "Object",
"tags": [],
"label": "{ numberOfInitialItems }",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/hooks/use_new_tab_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.useNewTabProps.$1.numberOfInitialItems",
"type": "number",
"tags": [],
"label": "numberOfInitialItems",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/hooks/use_new_tab_props.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps",
"type": "Interface",
"tags": [],
"label": "TabbedContentProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabbedContentProps",
"text": "TabbedContentProps"
},
" extends Pick<",
"TabsBarProps",
", \"maxItemsCount\">"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.initialItems",
"type": "Array",
"tags": [],
"label": "initialItems",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.initialSelectedItemId",
"type": "string",
"tags": [],
"label": "initialSelectedItemId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.services",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"TabsServices"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.renderContent",
"type": "Function",
"tags": [],
"label": "renderContent",
"description": [],
"signature": [
"(selectedItem: ",
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
},
") => React.ReactNode"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.renderContent.$1",
"type": "Object",
"tags": [],
"label": "selectedItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.createItem",
"type": "Function",
"tags": [],
"label": "createItem",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.onChanged",
"type": "Function",
"tags": [],
"label": "onChanged",
"description": [],
"signature": [
"(state: ",
"TabbedContentState",
") => void"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.onChanged.$1",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
"TabbedContentState"
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.getPreviewData",
"type": "Function",
"tags": [],
"label": "getPreviewData",
"description": [],
"signature": [
"(item: ",
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
},
") => ",
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabPreviewData",
"text": "TabPreviewData"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabbedContentProps.getPreviewData.$1",
"type": "Object",
"tags": [],
"label": "item",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabItem",
"text": "TabItem"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/components/tabbed_content/tabbed_content.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabItem",
"type": "Interface",
"tags": [],
"label": "TabItem",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabItem.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabItem.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabPreviewData",
"type": "Interface",
"tags": [],
"label": "TabPreviewData",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabPreviewData.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabPreviewData.status",
"type": "Enum",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-tabs",
"scope": "public",
"docId": "kibKbnUnifiedTabsPluginApi",
"section": "def-public.TabStatus",
"text": "TabStatus"
}
],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/unified-tabs",
"id": "def-public.TabStatus",
"type": "Enum",
"tags": [],
"label": "TabStatus",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-tabs/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink