kibana/api_docs/navigation.devdocs.json

1230 lines
No EOL
49 KiB
JSON

{
"id": "navigation",
"client": {
"classes": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin",
"type": "Class",
"tags": [],
"label": "NavigationPublicPlugin",
"description": [],
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicPlugin",
"text": "NavigationPublicPlugin"
},
" implements ",
"Plugin",
"<",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicSetup",
"text": "NavigationPublicSetup"
},
", ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicStart",
"text": "NavigationPublicStart"
},
", ",
"NavigationPublicSetupDependencies",
", ",
"NavigationPublicStartDependencies",
">"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
"PluginInitializerContext",
"<object>"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
"CoreSetup",
"<{}, unknown>, deps: ",
"NavigationPublicSetupDependencies",
") => ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicSetup",
"text": "NavigationPublicSetup"
}
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreSetup",
"<{}, unknown>"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"NavigationPublicSetupDependencies"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
"CoreStart",
", depsStart: ",
"NavigationPublicStartDependencies",
") => ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.NavigationPublicStart",
"text": "NavigationPublicStart"
}
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreStart"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "depsStart",
"description": [],
"signature": [
"NavigationPublicStartDependencies"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/plugins/shared/navigation/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenu",
"type": "Function",
"tags": [],
"label": "TopNavMenu",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
"<QT>) => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenu.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
"<QT>"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuBadges",
"type": "Function",
"tags": [],
"label": "TopNavMenuBadges",
"description": [],
"signature": [
"({ badges }: { badges: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuBadgeProps",
"text": "TopNavMenuBadgeProps"
},
"[] | undefined; }) => React.JSX.Element | null"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_badges.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuBadges.$1",
"type": "Object",
"tags": [],
"label": "{ badges }",
"description": [],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_badges.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuBadges.$1.badges",
"type": "Array",
"tags": [],
"label": "badges",
"description": [],
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuBadgeProps",
"text": "TopNavMenuBadgeProps"
},
"[] | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_badges.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuItems",
"type": "Function",
"tags": [],
"label": "TopNavMenuItems",
"description": [],
"signature": [
"({ config, className, popoverBreakpoints, gutterSize, }: TopNavMenuItemsProps) => React.JSX.Element | null"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_items.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuItems.$1",
"type": "Object",
"tags": [],
"label": "{\n config,\n className,\n popoverBreakpoints = POPOVER_BREAKPOINTS,\n gutterSize = 'xs',\n}",
"description": [],
"signature": [
"TopNavMenuItemsProps"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_items.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData",
"type": "Interface",
"tags": [],
"label": "TopNavMenuData",
"description": [],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.run",
"type": "Function",
"tags": [],
"label": "run",
"description": [],
"signature": [
"(anchorElement: HTMLElement) => void"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.run.$1",
"type": "Object",
"tags": [],
"label": "anchorElement",
"description": [],
"signature": [
"HTMLElement"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.testId",
"type": "string",
"tags": [],
"label": "testId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.disableButton",
"type": "CompoundType",
"tags": [],
"label": "disableButton",
"description": [],
"signature": [
"boolean | (() => boolean) | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.tooltip",
"type": "CompoundType",
"tags": [],
"label": "tooltip",
"description": [],
"signature": [
"string | (() => string | undefined) | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.badge",
"type": "CompoundType",
"tags": [],
"label": "badge",
"description": [],
"signature": [
"(",
"CommonProps",
" & ",
"DisambiguateSet",
"<(",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsNode, LabelAsString> & LabelAsString) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<(",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsString, LabelAsNode> & ",
"DisambiguateSet",
"<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithSpanProps, (",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">)> & ",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\"> & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsNode, LabelAsString> & LabelAsString) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithSpanProps, (",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">)> & ",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\"> & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsString, LabelAsNode> & ",
"DisambiguateSet",
"<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithSpanProps, (",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">)> & ",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\"> & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsString, LabelAsNode> & ",
"DisambiguateSet",
"<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithSpanProps, (",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">)> & ",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\"> & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsNode, LabelAsString> & LabelAsString) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithSpanProps, (",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">)> & ",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\"> & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsString, LabelAsNode> & ",
"DisambiguateSet",
"<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (",
"CommonProps",
" & ",
"DisambiguateSet",
"<WithSpanProps, (",
"DisambiguateSet",
"<WithButtonProps, WithAnchorProps> & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLAnchorElement>, \"color\" | \"onClick\" | \"href\">) | (",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\">)> & ",
"DisambiguateSet",
"<WithAnchorProps, WithButtonProps> & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; onClickAriaLabel?: string | undefined; } & Omit<React.HTMLAttributes<HTMLButtonElement>, \"color\" | \"onClick\"> & { iconType?: ",
"IconType",
" | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ",
"ToolTipPositions",
" | undefined; anchorProps?: (",
"CommonProps",
" & React.HTMLAttributes<HTMLSpanElement>) | undefined; title?: string | undefined; color?: \"warning\" | \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ",
"DisambiguateSet",
"<LabelAsString, LabelAsNode> & ",
"DisambiguateSet",
"<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.emphasize",
"type": "CompoundType",
"tags": [],
"label": "emphasize",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.fill",
"type": "CompoundType",
"tags": [],
"label": "fill",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.isLoading",
"type": "CompoundType",
"tags": [],
"label": "isLoading",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.iconType",
"type": "string",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.iconSide",
"type": "CompoundType",
"tags": [],
"label": "iconSide",
"description": [],
"signature": [
"\"right\" | \"left\" | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.iconOnly",
"type": "CompoundType",
"tags": [],
"label": "iconOnly",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.target",
"type": "string",
"tags": [],
"label": "target",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.href",
"type": "string",
"tags": [],
"label": "href",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuData.intl",
"type": "Object",
"tags": [],
"label": "intl",
"description": [],
"signature": [
"IntlShape",
" | undefined"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_data.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "navigation",
"id": "def-public.AddSolutionNavigationArg",
"type": "Type",
"tags": [],
"label": "AddSolutionNavigationArg",
"description": [],
"signature": [
"Omit<",
"SolutionNavigation",
", \"sideNavComponent\"> & { dataTestSubj?: string | undefined; }"
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "navigation",
"id": "def-public.SolutionType",
"type": "Type",
"tags": [],
"label": "SolutionType",
"description": [],
"signature": [
"\"security\" | \"analytics\" | \"es\" | \"oblt\""
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuBadgeProps",
"type": "Type",
"tags": [],
"label": "TopNavMenuBadgeProps",
"description": [],
"signature": [
"EuiBadgeProps",
" & { badgeText: string; toolTipProps?: Partial<",
"EuiToolTipProps",
"> | undefined; renderCustomBadge?: ((props: { badgeText: string; }) => React.ReactElement<any, string | React.JSXElementConstructor<any>>) | undefined; }"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_badges.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "navigation",
"id": "def-public.TopNavMenuProps",
"type": "Type",
"tags": [],
"label": "TopNavMenuProps",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.StatefulSearchBarProps",
"text": "StatefulSearchBarProps"
},
"<QT>, \"kibana\" | \"intl\" | \"timeHistory\"> & { config?: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuData",
"text": "TopNavMenuData"
},
"[] | undefined; badges?: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuBadgeProps",
"text": "TopNavMenuBadgeProps"
},
"[] | undefined; showSearchBar?: boolean | undefined; showQueryInput?: boolean | undefined; showDatePicker?: boolean | undefined; showFilterBar?: boolean | undefined; unifiedSearch?: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
},
" | undefined; className?: string | undefined; visible?: boolean | undefined; gutterSize?: \"m\" | \"s\" | \"l\" | \"xs\" | \"xxs\" | undefined; setMenuMountPoint?: ((menuMount: ",
"MountPoint",
"<HTMLElement> | undefined) => void) | undefined; popoverBreakpoints?: string[] | undefined; }"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicSetup",
"type": "Interface",
"tags": [],
"label": "NavigationPublicSetup",
"description": [],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicSetup.registerMenuItem",
"type": "Function",
"tags": [],
"label": "registerMenuItem",
"description": [],
"signature": [
"(menuItem: ",
"RegisteredTopNavMenuData",
") => void"
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicSetup.registerMenuItem.$1",
"type": "Object",
"tags": [],
"label": "menuItem",
"description": [],
"signature": [
"RegisteredTopNavMenuData"
],
"path": "src/platform/plugins/shared/navigation/public/top_nav_menu/top_nav_menu_extensions_registry.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicStart",
"type": "Interface",
"tags": [],
"label": "NavigationPublicStart",
"description": [],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicStart.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [],
"signature": [
"{ TopNavMenu: (props: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
">) => React.ReactElement<any, string | React.JSXElementConstructor<any>>; AggregateQueryTopNavMenu: (props: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
">) => React.ReactElement<any, string | React.JSXElementConstructor<any>>; createTopNavWithCustomContext: (customUnifiedSearch?: ",
{
"pluginId": "unifiedSearch",
"scope": "public",
"docId": "kibUnifiedSearchPluginApi",
"section": "def-public.UnifiedSearchPublicPluginStart",
"text": "UnifiedSearchPublicPluginStart"
},
" | undefined, customExtensions?: ",
"RegisteredTopNavMenuData",
"[] | undefined) => <QT extends ",
{
"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"
},
" = ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
">(props: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.TopNavMenuProps",
"text": "TopNavMenuProps"
},
"<QT>) => React.JSX.Element; }"
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicStart.addSolutionNavigation",
"type": "Function",
"tags": [],
"label": "addSolutionNavigation",
"description": [
"Add a solution navigation to the header nav switcher."
],
"signature": [
"(solutionNavigationAgg: ",
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.AddSolutionNavigationArg",
"text": "AddSolutionNavigationArg"
},
") => void"
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicStart.addSolutionNavigation.$1",
"type": "CompoundType",
"tags": [],
"label": "solutionNavigationAgg",
"description": [],
"signature": [
{
"pluginId": "navigation",
"scope": "public",
"docId": "kibNavigationPluginApi",
"section": "def-public.AddSolutionNavigationArg",
"text": "AddSolutionNavigationArg"
}
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "navigation",
"id": "def-public.NavigationPublicStart.isSolutionNavEnabled$",
"type": "Object",
"tags": [],
"label": "isSolutionNavEnabled$",
"description": [
"Flag to indicate if the solution navigation is enabled."
],
"signature": [
"Observable",
"<boolean>"
],
"path": "src/platform/plugins/shared/navigation/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTE_UI_SETTING_ID",
"type": "string",
"tags": [],
"label": "DEFAULT_ROUTE_UI_SETTING_ID",
"description": [],
"signature": [
"\"defaultRoute\""
],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTES",
"type": "Object",
"tags": [],
"label": "DEFAULT_ROUTES",
"description": [],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTES.classic",
"type": "string",
"tags": [],
"label": "classic",
"description": [],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTES.es",
"type": "string",
"tags": [],
"label": "es",
"description": [],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTES.oblt",
"type": "string",
"tags": [],
"label": "oblt",
"description": [],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTES.security",
"type": "string",
"tags": [],
"label": "security",
"description": [],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "navigation",
"id": "def-common.DEFAULT_ROUTES.chat",
"type": "string",
"tags": [],
"label": "chat",
"description": [],
"path": "src/platform/plugins/shared/navigation/common/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}