github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_shared_ux_chrome_navigation.devdocs.json

1067 lines
No EOL
38 KiB
JSON
Raw Blame History

{
"id": "@kbn/shared-ux-chrome-navigation",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.DefaultNavigation",
"type": "Function",
"tags": [],
"label": "DefaultNavigation",
"description": [],
"signature": [
"({ projectNavigationTree, navigationTree, dataTestSubj, }: React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.ProjectNavigationDefinition",
"text": "ProjectNavigationDefinition"
},
" & { dataTestSubj?: string | undefined; }>) => JSX.Element"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/default_navigation.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.DefaultNavigation.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n projectNavigationTree,\n navigationTree,\n dataTestSubj,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.ProjectNavigationDefinition",
"text": "ProjectNavigationDefinition"
},
" & { dataTestSubj?: string | undefined; }>"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/default_navigation.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets",
"type": "Function",
"tags": [],
"label": "getPresets",
"description": [],
"signature": [
"(preset: \"devtools\") => ",
{
"pluginId": "@kbn/default-nav-devtools",
"scope": "common",
"docId": "kibKbnDefaultNavDevtoolsPluginApi",
"section": "def-common.DevToolsNodeDefinition",
"text": "DevToolsNodeDefinition"
}
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets.$1",
"type": "string",
"tags": [],
"label": "preset",
"description": [],
"signature": [
"\"devtools\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets",
"type": "Function",
"tags": [],
"label": "getPresets",
"description": [],
"signature": [
"(preset: \"management\") => ",
{
"pluginId": "@kbn/default-nav-management",
"scope": "common",
"docId": "kibKbnDefaultNavManagementPluginApi",
"section": "def-common.ManagementNodeDefinition",
"text": "ManagementNodeDefinition"
}
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets.$1",
"type": "string",
"tags": [],
"label": "preset",
"description": [],
"signature": [
"\"management\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets",
"type": "Function",
"tags": [],
"label": "getPresets",
"description": [],
"signature": [
"(preset: \"ml\") => ",
{
"pluginId": "@kbn/default-nav-ml",
"scope": "common",
"docId": "kibKbnDefaultNavMlPluginApi",
"section": "def-common.MlNodeDefinition",
"text": "MlNodeDefinition"
}
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets.$1",
"type": "string",
"tags": [],
"label": "preset",
"description": [],
"signature": [
"\"ml\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets",
"type": "Function",
"tags": [],
"label": "getPresets",
"description": [],
"signature": [
"(preset: \"analytics\") => ",
{
"pluginId": "@kbn/default-nav-analytics",
"scope": "common",
"docId": "kibKbnDefaultNavAnalyticsPluginApi",
"section": "def-common.AnalyticsNodeDefinition",
"text": "AnalyticsNodeDefinition"
}
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets.$1",
"type": "string",
"tags": [],
"label": "preset",
"description": [],
"signature": [
"\"analytics\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets",
"type": "Function",
"tags": [],
"label": "getPresets",
"description": [],
"signature": [
"(preset: \"all\") => { analytics: ",
{
"pluginId": "@kbn/default-nav-analytics",
"scope": "common",
"docId": "kibKbnDefaultNavAnalyticsPluginApi",
"section": "def-common.AnalyticsNodeDefinition",
"text": "AnalyticsNodeDefinition"
},
"; devtools: ",
{
"pluginId": "@kbn/default-nav-devtools",
"scope": "common",
"docId": "kibKbnDefaultNavDevtoolsPluginApi",
"section": "def-common.DevToolsNodeDefinition",
"text": "DevToolsNodeDefinition"
},
"; ml: ",
{
"pluginId": "@kbn/default-nav-ml",
"scope": "common",
"docId": "kibKbnDefaultNavMlPluginApi",
"section": "def-common.MlNodeDefinition",
"text": "MlNodeDefinition"
},
"; management: ",
{
"pluginId": "@kbn/default-nav-management",
"scope": "common",
"docId": "kibKbnDefaultNavManagementPluginApi",
"section": "def-common.ManagementNodeDefinition",
"text": "ManagementNodeDefinition"
},
"; }"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets.$1",
"type": "string",
"tags": [],
"label": "preset",
"description": [],
"signature": [
"\"all\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets",
"type": "Function",
"tags": [],
"label": "getPresets",
"description": [],
"signature": [
"(preset: \"all\" | ",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.NavigationGroupPreset",
"text": "NavigationGroupPreset"
},
") => ",
{
"pluginId": "@kbn/default-nav-analytics",
"scope": "common",
"docId": "kibKbnDefaultNavAnalyticsPluginApi",
"section": "def-common.AnalyticsNodeDefinition",
"text": "AnalyticsNodeDefinition"
},
" | ",
{
"pluginId": "@kbn/default-nav-devtools",
"scope": "common",
"docId": "kibKbnDefaultNavDevtoolsPluginApi",
"section": "def-common.DevToolsNodeDefinition",
"text": "DevToolsNodeDefinition"
},
" | ",
{
"pluginId": "@kbn/default-nav-management",
"scope": "common",
"docId": "kibKbnDefaultNavManagementPluginApi",
"section": "def-common.ManagementNodeDefinition",
"text": "ManagementNodeDefinition"
},
" | ",
{
"pluginId": "@kbn/default-nav-ml",
"scope": "common",
"docId": "kibKbnDefaultNavMlPluginApi",
"section": "def-common.MlNodeDefinition",
"text": "MlNodeDefinition"
},
" | { analytics: ",
{
"pluginId": "@kbn/default-nav-analytics",
"scope": "common",
"docId": "kibKbnDefaultNavAnalyticsPluginApi",
"section": "def-common.AnalyticsNodeDefinition",
"text": "AnalyticsNodeDefinition"
},
"; devtools: ",
{
"pluginId": "@kbn/default-nav-devtools",
"scope": "common",
"docId": "kibKbnDefaultNavDevtoolsPluginApi",
"section": "def-common.DevToolsNodeDefinition",
"text": "DevToolsNodeDefinition"
},
"; ml: ",
{
"pluginId": "@kbn/default-nav-ml",
"scope": "common",
"docId": "kibKbnDefaultNavMlPluginApi",
"section": "def-common.MlNodeDefinition",
"text": "MlNodeDefinition"
},
"; management: ",
{
"pluginId": "@kbn/default-nav-management",
"scope": "common",
"docId": "kibKbnDefaultNavManagementPluginApi",
"section": "def-common.ManagementNodeDefinition",
"text": "ManagementNodeDefinition"
},
"; }"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.getPresets.$1",
"type": "CompoundType",
"tags": [],
"label": "preset",
"description": [],
"signature": [
"\"all\" | ",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.NavigationGroupPreset",
"text": "NavigationGroupPreset"
}
],
"path": "packages/shared-ux/chrome/navigation/src/ui/nav_tree_presets.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.Navigation",
"type": "Function",
"tags": [],
"label": "Navigation",
"description": [],
"signature": [
"({ children, unstyled = false, dataTestSubj }: Props) => JSX.Element"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/components/navigation.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.Navigation.$1",
"type": "Object",
"tags": [],
"label": "{ children, unstyled = false, dataTestSubj }",
"description": [],
"signature": [
"Props"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/components/navigation.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationKibanaProvider",
"type": "Function",
"tags": [],
"label": "NavigationKibanaProvider",
"description": [
"\nKibana-specific Provider that maps dependencies to services."
],
"signature": [
"({ children, ...dependencies }: React.PropsWithChildren<",
"NavigationKibanaDependencies",
">) => JSX.Element"
],
"path": "packages/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationKibanaProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n ...dependencies\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
"NavigationKibanaDependencies",
">"
],
"path": "packages/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationProvider",
"type": "Function",
"tags": [],
"label": "NavigationProvider",
"description": [
"\nA Context Provider that provides services to the component and its dependencies."
],
"signature": [
"({ children, ...services }: React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.NavigationServices",
"text": "NavigationServices"
},
">) => JSX.Element"
],
"path": "packages/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{ children, ...services }",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.NavigationServices",
"text": "NavigationServices"
},
">"
],
"path": "packages/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.GroupDefinition",
"type": "Interface",
"tags": [],
"label": "GroupDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.GroupDefinition",
"text": "GroupDefinition"
},
"<LinkId, Id, ChildrenId> extends ",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.NodeDefinition",
"text": "NodeDefinition"
},
"<LinkId, Id, ChildrenId>"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.GroupDefinition.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"navGroup\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.GroupDefinition.defaultIsCollapsed",
"type": "CompoundType",
"tags": [],
"label": "defaultIsCollapsed",
"description": [
"\nFlag to indicate if the group is initially collapsed or not.\n\n`undefined`: (Recommended) the group will be opened if any of its children nodes matches the current URL.\n\n`false`: the group will be opened event if none of its children nodes matches the current URL.\n\n`true`: the group will be collapsed event if any of its children nodes matches the current URL."
],
"signature": [
"boolean | undefined"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.GroupDefinition.preset",
"type": "CompoundType",
"tags": [],
"label": "preset",
"description": [],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.NavigationGroupPreset",
"text": "NavigationGroupPreset"
},
" | undefined"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices",
"type": "Interface",
"tags": [],
"label": "NavigationServices",
"description": [
"\nA list of services that are consumed by this component."
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.basePath",
"type": "Object",
"tags": [],
"label": "basePath",
"description": [],
"signature": [
"{ prepend: (url: string) => string; }"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.recentlyAccessed$",
"type": "Object",
"tags": [],
"label": "recentlyAccessed$",
"description": [],
"signature": [
"Observable",
"<",
"RecentItem",
"[]>"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.navLinks$",
"type": "Object",
"tags": [],
"label": "navLinks$",
"description": [],
"signature": [
"Observable",
"<readonly ",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.ChromeNavLink",
"text": "ChromeNavLink"
},
"[]>"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.navIsOpen",
"type": "boolean",
"tags": [],
"label": "navIsOpen",
"description": [],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.navigateToUrl",
"type": "Function",
"tags": [],
"label": "navigateToUrl",
"description": [],
"signature": [
"(url: string, options?: ",
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.NavigateToUrlOptions",
"text": "NavigateToUrlOptions"
},
" | undefined) => Promise<void>"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.navigateToUrl.$1",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"path": "packages/core/application/core-application-browser/src/contracts.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.navigateToUrl.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.NavigateToUrlOptions",
"text": "NavigateToUrlOptions"
},
" | undefined"
],
"path": "packages/core/application/core-application-browser/src/contracts.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.onProjectNavigationChange",
"type": "Function",
"tags": [],
"label": "onProjectNavigationChange",
"description": [],
"signature": [
"(chromeProjectNavigation: ",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.ChromeProjectNavigation",
"text": "ChromeProjectNavigation"
},
") => void"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.onProjectNavigationChange.$1",
"type": "Object",
"tags": [],
"label": "chromeProjectNavigation",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.ChromeProjectNavigation",
"text": "ChromeProjectNavigation"
}
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.activeNodes$",
"type": "Object",
"tags": [],
"label": "activeNodes$",
"description": [],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.ChromeProjectNavigationNode",
"text": "ChromeProjectNavigationNode"
},
"[][]>"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationServices.cloudLinks",
"type": "Object",
"tags": [],
"label": "cloudLinks",
"description": [],
"signature": [
"{ userAndRoles?: { title: string; href: string; } | undefined; performance?: { title: string; href: string; } | undefined; billingAndSub?: { title: string; href: string; } | undefined; deployment?: { title: string; href: string; } | undefined; }"
],
"path": "packages/shared-ux/chrome/navigation/types/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationTreeDefinition",
"type": "Interface",
"tags": [],
"label": "NavigationTreeDefinition",
"description": [],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationTreeDefinition.body",
"type": "Array",
"tags": [],
"label": "body",
"description": [
"\nMain content of the navigation. Can contain any number of \"cloudLink\", \"recentlyAccessed\"\nor \"group\" items. Be mindeful though, with great power comes great responsibility."
],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.RootNavigationItemDefinition",
"text": "RootNavigationItemDefinition"
},
"<",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.AppDeepLinkId",
"text": "AppDeepLinkId"
},
", string, string>[] | undefined"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationTreeDefinition.footer",
"type": "Array",
"tags": [],
"label": "footer",
"description": [
"\nFooter content of the navigation. Can contain any number of \"cloudLink\", \"recentlyAccessed\"\nor \"group\" items. Be mindeful though, with great power comes great responsibility."
],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.RootNavigationItemDefinition",
"text": "RootNavigationItemDefinition"
},
"<",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.AppDeepLinkId",
"text": "AppDeepLinkId"
},
", string, string>[] | undefined"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.ProjectNavigationDefinition",
"type": "Interface",
"tags": [],
"label": "ProjectNavigationDefinition",
"description": [],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.ProjectNavigationDefinition.projectNavigationTree",
"type": "Array",
"tags": [],
"label": "projectNavigationTree",
"description": [
"\nA navigation tree structure with object items containing labels, links, and sub-items\nfor a project. Use it if you only need to configure your project navigation and leave\nall the other navigation items to the default (Recently viewed items, Management, etc.)"
],
"signature": [
"ProjectNavigationTreeDefinition",
"<",
{
"pluginId": "@kbn/core-chrome-browser",
"scope": "common",
"docId": "kibKbnCoreChromeBrowserPluginApi",
"section": "def-common.AppDeepLinkId",
"text": "AppDeepLinkId"
},
", string, string> | undefined"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.ProjectNavigationDefinition.navigationTree",
"type": "Object",
"tags": [],
"label": "navigationTree",
"description": [
"\nA navigation tree structure with object items containing labels, links, and sub-items\nthat defines a complete side navigation. This configuration overrides `projectNavigationTree`\nif both are provided."
],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.NavigationTreeDefinition",
"text": "NavigationTreeDefinition"
},
" | undefined"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.RecentlyAccessedDefinition",
"type": "Interface",
"tags": [],
"label": "RecentlyAccessedDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.RecentlyAccessedDefinition",
"text": "RecentlyAccessedDefinition"
},
" extends ",
"Props"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.RecentlyAccessedDefinition.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"recentlyAccessed\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.NavigationGroupPreset",
"type": "Type",
"tags": [],
"label": "NavigationGroupPreset",
"description": [
"The preset that can be pass to the NavigationBucket component"
],
"signature": [
"\"ml\" | \"management\" | \"analytics\" | \"devtools\""
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-common.RootNavigationItemDefinition",
"type": "Type",
"tags": [],
"label": "RootNavigationItemDefinition",
"description": [],
"signature": [
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.RecentlyAccessedDefinition",
"text": "RecentlyAccessedDefinition"
},
" | ",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "common",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-common.GroupDefinition",
"text": "GroupDefinition"
},
"<LinkId, Id, ChildrenId>"
],
"path": "packages/shared-ux/chrome/navigation/src/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink