{ "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 ", { "pluginId": "@kbn/core-plugins-browser", "scope": "public", "docId": "kibKbnCorePluginsBrowserPluginApi", "section": "def-public.Plugin", "text": "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/plugins/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/plugins/navigation/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "navigation", "id": "def-public.NavigationPublicPlugin.Unnamed.$1", "type": "Object", "tags": [], "label": "initializerContext", "description": [], "signature": [ { "pluginId": "@kbn/core-plugins-browser", "scope": "public", "docId": "kibKbnCorePluginsBrowserPluginApi", "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, "" ], "path": "src/plugins/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: ", { "pluginId": "@kbn/core-lifecycle-browser", "scope": "public", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, ") => ", { "pluginId": "navigation", "scope": "public", "docId": "kibNavigationPluginApi", "section": "def-public.NavigationPublicSetup", "text": "NavigationPublicSetup" } ], "path": "src/plugins/navigation/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "navigation", "id": "def-public.NavigationPublicPlugin.setup.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-browser", "scope": "public", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-public.CoreSetup", "text": "CoreSetup" }, "" ], "path": "src/plugins/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: ", { "pluginId": "@kbn/core-lifecycle-browser", "scope": "public", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ", depsStart: ", "NavigationPublicStartDependencies", ") => ", { "pluginId": "navigation", "scope": "public", "docId": "kibNavigationPluginApi", "section": "def-public.NavigationPublicStart", "text": "NavigationPublicStart" } ], "path": "src/plugins/navigation/public/plugin.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "navigation", "id": "def-public.NavigationPublicPlugin.start.$1", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-browser", "scope": "public", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-public.CoreStart", "text": "CoreStart" } ], "path": "src/plugins/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/plugins/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/plugins/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" }, ") => React.ReactElement> | null" ], "path": "src/plugins/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" }, "" ], "path": "src/plugins/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; }) => JSX.Element | null" ], "path": "src/plugins/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/plugins/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/plugins/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, }: { config: ", { "pluginId": "navigation", "scope": "public", "docId": "kibNavigationPluginApi", "section": "def-public.TopNavMenuData", "text": "TopNavMenuData" }, "[] | undefined; className?: string | undefined; }) => JSX.Element | null" ], "path": "src/plugins/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}", "description": [], "path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_items.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "navigation", "id": "def-public.TopNavMenuItems.$1.config", "type": "Array", "tags": [], "label": "config", "description": [], "signature": [ { "pluginId": "navigation", "scope": "public", "docId": "kibNavigationPluginApi", "section": "def-public.TopNavMenuData", "text": "TopNavMenuData" }, "[] | undefined" ], "path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_items.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "navigation", "id": "def-public.TopNavMenuItems.$1.className", "type": "string", "tags": [], "label": "className", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu_items.tsx", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "navigation", "id": "def-public.TopNavMenuData", "type": "Interface", "tags": [], "label": "TopNavMenuData", "description": [], "path": "src/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & LabelAsString) | (", "CommonProps", " & ", "DisambiguateSet", "<(", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & ", "DisambiguateSet", "<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (", "CommonProps", " & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & LabelAsString) | (", "CommonProps", " & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & ", "DisambiguateSet", "<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (", "CommonProps", " & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & ", "DisambiguateSet", "<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | (", "CommonProps", " & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & LabelAsString) | (", "CommonProps", " & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & ", "DisambiguateSet", "<{ title: string; tooltipContent?: React.ReactNode; }, { tooltipContent: React.ReactNode; title?: string | undefined; }> & { tooltipContent: React.ReactNode; title?: string | undefined; } & { label: React.ReactNode; }) | (", "CommonProps", " & ", "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", " | undefined; anchorProps?: (", "CommonProps", " & React.HTMLAttributes) | undefined; title?: string | undefined; color?: \"subdued\" | \"accent\" | \"hollow\" | undefined; size?: \"m\" | \"s\" | undefined; alignment?: \"middle\" | \"baseline\" | undefined; } & ", "DisambiguateSet", " & ", "DisambiguateSet", "<{ tooltipContent: React.ReactNode; title?: string | undefined; }, { title: string; tooltipContent?: React.ReactNode; }> & { title: string; tooltipContent?: React.ReactNode; } & { label: React.ReactNode; }) | undefined" ], "path": "src/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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; panelContentProvider?: ", { "pluginId": "@kbn/shared-ux-chrome-navigation", "scope": "public", "docId": "kibKbnSharedUxChromeNavigationPluginApi", "section": "def-public.ContentProvider", "text": "ContentProvider" }, " | undefined; }" ], "path": "src/plugins/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/plugins/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>) | undefined; }" ], "path": "src/plugins/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" }, ", \"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; setMenuMountPoint?: ((menuMount: ", { "pluginId": "@kbn/core-mount-utils-browser", "scope": "public", "docId": "kibKbnCoreMountUtilsBrowserPluginApi", "section": "def-public.MountPoint", "text": "MountPoint" }, " | undefined) => void) | undefined; }" ], "path": "src/plugins/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/plugins/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/plugins/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/plugins/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/plugins/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>; 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>; createTopNavWithCustomContext: (customUnifiedSearch?: ", { "pluginId": "unifiedSearch", "scope": "public", "docId": "kibUnifiedSearchPluginApi", "section": "def-public.UnifiedSearchPublicPluginStart", "text": "UnifiedSearchPublicPluginStart" }, " | undefined, customExtensions?: ", "RegisteredTopNavMenuData", "[] | undefined) => (props: ", { "pluginId": "navigation", "scope": "public", "docId": "kibNavigationPluginApi", "section": "def-public.TopNavMenuProps", "text": "TopNavMenuProps" }, ") => JSX.Element; }" ], "path": "src/plugins/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/plugins/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/plugins/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", "" ], "path": "src/plugins/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/plugins/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/plugins/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/plugins/navigation/common/constants.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "navigation", "id": "def-common.DEFAULT_ROUTES.es", "type": "string", "tags": [], "label": "es", "description": [], "path": "src/plugins/navigation/common/constants.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "navigation", "id": "def-common.DEFAULT_ROUTES.oblt", "type": "string", "tags": [], "label": "oblt", "description": [], "path": "src/plugins/navigation/common/constants.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "navigation", "id": "def-common.DEFAULT_ROUTES.security", "type": "string", "tags": [], "label": "security", "description": [], "path": "src/plugins/navigation/common/constants.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ] } }