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

647 lines
No EOL
23 KiB
JSON
Raw Blame History

{
"id": "@kbn/shared-ux-chrome-navigation",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.Navigation",
"type": "Function",
"tags": [],
"label": "Navigation",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "public",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-public.Props",
"text": "Props"
},
">"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/navigation.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.Navigation.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.Navigation.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationKibanaProvider",
"type": "Function",
"tags": [],
"label": "NavigationKibanaProvider",
"description": [
"\nKibana-specific Provider that maps dependencies to services."
],
"signature": [
"({ children, ...dependencies }: React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "public",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-public.NavigationKibanaDependencies",
"text": "NavigationKibanaDependencies"
},
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationKibanaProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n ...dependencies\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "public",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-public.NavigationKibanaDependencies",
"text": "NavigationKibanaDependencies"
},
">"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.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": "public",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-public.NavigationServices",
"text": "NavigationServices"
},
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n ...services\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "public",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-public.NavigationServices",
"text": "NavigationServices"
},
">"
],
"path": "src/platform/packages/shared/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-public.NavigationKibanaDependencies",
"type": "Interface",
"tags": [],
"label": "NavigationKibanaDependencies",
"description": [
"\nAn interface containing a collection of Kibana dependencies required to\nrender this component"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationKibanaDependencies.core",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"{ application: { navigateToUrl: (url: string, options?: ",
"NavigateToUrlOptions",
" | undefined) => Promise<void>; }; chrome: { recentlyAccessed: { get$: () => ",
"Observable",
"<",
"ChromeRecentlyAccessedHistoryItem",
"[]>; }; navLinks: { getNavLinks$: () => ",
"Observable",
"<readonly ",
"ChromeNavLink",
"[]>; }; sideNav: { getIsCollapsed$: () => ",
"Observable",
"<boolean>; getPanelSelectedNode$: () => ",
"Observable",
"<",
"PanelSelectedNode",
" | null>; setPanelSelectedNode(node: string | ",
"PanelSelectedNode",
" | null): void; getIsFeedbackBtnVisible$: () => ",
"Observable",
"<boolean>; }; }; http: { basePath: ",
"BasePathService",
"; getLoadingCount$(): ",
"Observable",
"<number>; }; analytics: { reportEvent: (eventType: string, eventData: object) => void; }; }"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationKibanaDependencies.activeNodes$",
"type": "Object",
"tags": [],
"label": "activeNodes$",
"description": [],
"signature": [
"Observable",
"<",
"ChromeProjectNavigationNode",
"[][]>"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices",
"type": "Interface",
"tags": [],
"label": "NavigationServices",
"description": [
"\nA list of services that are consumed by this component."
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.basePath",
"type": "Object",
"tags": [],
"label": "basePath",
"description": [],
"signature": [
"{ prepend: (url: string) => string; remove: (url: string) => string; }"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.recentlyAccessed$",
"type": "Object",
"tags": [],
"label": "recentlyAccessed$",
"description": [],
"signature": [
"Observable",
"<",
"ChromeRecentlyAccessedHistoryItem",
"[]>"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.navigateToUrl",
"type": "Function",
"tags": [],
"label": "navigateToUrl",
"description": [],
"signature": [
"(url: string, options?: ",
"NavigateToUrlOptions",
" | undefined) => Promise<void>"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.navigateToUrl.$1",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"path": "src/core/packages/application/browser/src/contracts.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.navigateToUrl.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"NavigateToUrlOptions",
" | undefined"
],
"path": "src/core/packages/application/browser/src/contracts.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.activeNodes$",
"type": "Object",
"tags": [],
"label": "activeNodes$",
"description": [],
"signature": [
"Observable",
"<",
"ChromeProjectNavigationNode",
"[][]>"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.isSideNavCollapsed",
"type": "boolean",
"tags": [],
"label": "isSideNavCollapsed",
"description": [],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.eventTracker",
"type": "Object",
"tags": [],
"label": "eventTracker",
"description": [],
"signature": [
"EventTracker"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.selectedPanelNode",
"type": "CompoundType",
"tags": [],
"label": "selectedPanelNode",
"description": [],
"signature": [
"PanelSelectedNode",
" | null | undefined"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.setSelectedPanelNode",
"type": "Function",
"tags": [],
"label": "setSelectedPanelNode",
"description": [],
"signature": [
"((node: ",
"PanelSelectedNode",
" | null) => void) | undefined"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.setSelectedPanelNode.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"PanelSelectedNode",
" | null"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.NavigationServices.isFeedbackBtnVisible$",
"type": "Object",
"tags": [],
"label": "isFeedbackBtnVisible$",
"description": [],
"signature": [
"Observable",
"<boolean>"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelComponentProps",
"type": "Interface",
"tags": [],
"label": "PanelComponentProps",
"description": [],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelComponentProps.closePanel",
"type": "Function",
"tags": [],
"label": "closePanel",
"description": [
"Handler to close the panel"
],
"signature": [
"() => void"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelComponentProps.selectedNode",
"type": "Object",
"tags": [],
"label": "selectedNode",
"description": [
"The node in the main panel that opens the secondary panel"
],
"signature": [
"{ id: string; title?: string | undefined; children?: ",
"ChromeProjectNavigationNode",
"[] | undefined; path: string; sideNavStatus?: ",
"SideNavNodeStatus",
" | undefined; deepLink?: ",
"ChromeNavLink",
" | undefined; }"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelComponentProps.activeNodes",
"type": "Array",
"tags": [],
"label": "activeNodes",
"description": [
"Jagged array of active nodes that match the current URL location"
],
"signature": [
"ChromeProjectNavigationNode",
"[][]"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelContent",
"type": "Interface",
"tags": [],
"label": "PanelContent",
"description": [],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelContent.title",
"type": "CompoundType",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.PanelContent.content",
"type": "CompoundType",
"tags": [],
"label": "content",
"description": [],
"signature": [
"React.ComponentType<",
{
"pluginId": "@kbn/shared-ux-chrome-navigation",
"scope": "public",
"docId": "kibKbnSharedUxChromeNavigationPluginApi",
"section": "def-public.PanelComponentProps",
"text": "PanelComponentProps"
},
"> | undefined"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/components/panel/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.Props",
"type": "Interface",
"tags": [],
"label": "Props",
"description": [],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/navigation.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.Props.navigationTree$",
"type": "Object",
"tags": [],
"label": "navigationTree$",
"description": [],
"signature": [
"Observable",
"<",
"NavigationTreeDefinitionUI",
">"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/navigation.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.Props.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/ui/navigation.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.FieldType",
"type": "Enum",
"tags": [],
"label": "FieldType",
"description": [],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/analytics/event_tracker.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/shared-ux-chrome-navigation",
"id": "def-public.EventType",
"type": "string",
"tags": [],
"label": "EventType",
"description": [],
"path": "src/platform/packages/shared/shared-ux/chrome/navigation/src/analytics/event_tracker.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"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