{ "id": "kibanaReact", "client": { "classes": [ { "id": "def-public.TableListView", "type": "Class", "tags": [], "label": "TableListView", "description": [], "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.TableListView", "text": "TableListView" }, " extends React.Component<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.TableListViewProps", "text": "TableListViewProps" }, ", ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.TableListViewState", "text": "TableListViewState" }, ", any>" ], "children": [ { "id": "def-public.TableListView.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.TableListViewProps", "text": "TableListViewProps" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 90 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 90 } }, { "id": "def-public.TableListView.UNSAFE_componentWillMount", "type": "Function", "label": "UNSAFE_componentWillMount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 111 } }, { "id": "def-public.TableListView.componentWillUnmount", "type": "Function", "label": "componentWillUnmount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 115 } }, { "id": "def-public.TableListView.componentDidMount", "type": "Function", "label": "componentDidMount", "signature": [ "() => void" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 120 } }, { "tags": [], "id": "def-public.TableListView.debouncedFetch", "type": "Function", "label": "debouncedFetch", "description": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 124 }, "signature": [ "((filter: string) => Promise) & _.Cancelable" ] }, { "id": "def-public.TableListView.fetchItems", "type": "Function", "children": [], "signature": [ "() => void" ], "description": [], "label": "fetchItems", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 156 }, "tags": [], "returnComment": [] }, { "id": "def-public.TableListView.deleteSelectedItems", "type": "Function", "children": [], "signature": [ "() => Promise" ], "description": [], "label": "deleteSelectedItems", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 166 }, "tags": [], "returnComment": [] }, { "id": "def-public.TableListView.closeDeleteModal", "type": "Function", "children": [], "signature": [ "() => void" ], "description": [], "label": "closeDeleteModal", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 196 }, "tags": [], "returnComment": [] }, { "id": "def-public.TableListView.openDeleteModal", "type": "Function", "children": [], "signature": [ "() => void" ], "description": [], "label": "openDeleteModal", "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 200 }, "tags": [], "returnComment": [] }, { "id": "def-public.TableListView.setFilter", "type": "Function", "label": "setFilter", "signature": [ "({ queryText }: { queryText: string; }) => void" ], "description": [], "children": [ { "id": "def-public.TableListView.setFilter.{-queryText }", "type": "Object", "label": "{ queryText }", "tags": [], "description": [], "children": [ { "tags": [], "id": "def-public.TableListView.setFilter.{-queryText }.queryText", "type": "string", "label": "queryText", "description": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 204 } } ], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 204 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 204 } }, { "id": "def-public.TableListView.hasNoItems", "type": "Function", "label": "hasNoItems", "signature": [ "() => boolean" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 215 } }, { "id": "def-public.TableListView.renderConfirmDeleteModal", "type": "Function", "label": "renderConfirmDeleteModal", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 223 } }, { "id": "def-public.TableListView.renderListingLimitWarning", "type": "Function", "label": "renderListingLimitWarning", "signature": [ "() => JSX.Element | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 277 } }, { "id": "def-public.TableListView.renderFetchError", "type": "Function", "label": "renderFetchError", "signature": [ "() => JSX.Element | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 319 } }, { "id": "def-public.TableListView.renderNoItemsMessage", "type": "Function", "label": "renderNoItemsMessage", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 350 } }, { "id": "def-public.TableListView.renderToolsLeft", "type": "Function", "label": "renderToolsLeft", "signature": [ "() => JSX.Element | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 364 } }, { "id": "def-public.TableListView.renderTable", "type": "Function", "label": "renderTable", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 395 } }, { "id": "def-public.TableListView.renderListingOrEmptyState", "type": "Function", "label": "renderListingOrEmptyState", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 475 } }, { "id": "def-public.TableListView.renderListing", "type": "Function", "label": "renderListing", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 483 } }, { "id": "def-public.TableListView.renderPageContent", "type": "Function", "label": "renderPageContent", "signature": [ "() => JSX.Element | undefined" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 528 } }, { "id": "def-public.TableListView.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 540 } } ], "source": { "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "lineNumber": 86 }, "initialIsOpen": false }, { "id": "def-public.ValidatedDualRange", "type": "Class", "tags": [], "label": "ValidatedDualRange", "description": [], "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.ValidatedDualRange", "text": "ValidatedDualRange" }, " extends React.Component" ], "children": [ { "id": "def-public.ValidatedDualRange.defaultProps", "type": "Object", "tags": [], "children": [ { "tags": [], "id": "def-public.ValidatedDualRange.defaultProps.allowEmptyRange", "type": "boolean", "label": "allowEmptyRange", "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 41 }, "signature": [ "true" ] }, { "tags": [], "id": "def-public.ValidatedDualRange.defaultProps.fullWidth", "type": "boolean", "label": "fullWidth", "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 42 }, "signature": [ "false" ] }, { "tags": [], "id": "def-public.ValidatedDualRange.defaultProps.compressed", "type": "boolean", "label": "compressed", "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 43 }, "signature": [ "false" ] } ], "description": [], "label": "defaultProps", "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 40 } }, { "id": "def-public.ValidatedDualRange.getDerivedStateFromProps", "type": "Function", "label": "getDerivedStateFromProps", "signature": [ "typeof ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.ValidatedDualRange", "text": "ValidatedDualRange" }, ".getDerivedStateFromProps" ], "description": [], "children": [ { "type": "Object", "label": "nextProps", "isRequired": true, "signature": [ "Props" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 46 } }, { "type": "Object", "label": "prevState", "isRequired": true, "signature": [ "State" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 46 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 46 } }, { "id": "def-public.ValidatedDualRange.state", "type": "Object", "tags": [], "children": [], "description": [], "label": "state", "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 66 } }, { "id": "def-public.ValidatedDualRange._onChange", "type": "Function", "children": [ { "type": "Object", "label": "value", "isRequired": true, "signature": [ "[React.ReactText, React.ReactText]" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 68 } } ], "signature": [ "(value: [React.ReactText, React.ReactText]) => void" ], "description": [], "label": "_onChange", "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 68 }, "tags": [], "returnComment": [] }, { "id": "def-public.ValidatedDualRange.render", "type": "Function", "label": "render", "signature": [ "() => JSX.Element" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 87 } } ], "source": { "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", "lineNumber": 39 }, "initialIsOpen": false } ], "functions": [ { "id": "def-public.CodeEditor", "type": "Function", "children": [ { "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ "React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.Props", "text": "Props" }, ">" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", "lineNumber": 22 } } ], "signature": [ "(props: React.PropsWithChildren<", "Props", ">) => JSX.Element" ], "description": [], "label": "CodeEditor", "source": { "path": "src/plugins/kibana_react/public/code_editor/index.tsx", "lineNumber": 22 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.createKibanaReactContext", "type": "Function", "children": [ { "type": "Uncategorized", "label": "services", "isRequired": true, "signature": [ "Services" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 46 } } ], "signature": [ ">(services: Services) => ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.KibanaReactContext", "text": "KibanaReactContext" }, "" ], "description": [], "label": "createKibanaReactContext", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 45 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.createNotifications", "type": "Function", "children": [ { "type": "Object", "label": "services", "isRequired": true, "signature": [ "Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ">" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", "lineNumber": 14 } } ], "signature": [ "(services: Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ">) => ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.KibanaReactNotifications", "text": "KibanaReactNotifications" } ], "description": [], "label": "createNotifications", "source": { "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", "lineNumber": 14 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.createReactOverlays", "type": "Function", "children": [ { "type": "Object", "label": "services", "isRequired": true, "signature": [ "Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ">" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", "lineNumber": 14 } } ], "signature": [ "(services: Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.CoreStart", "text": "CoreStart" }, ">) => ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.KibanaReactOverlays", "text": "KibanaReactOverlays" } ], "description": [], "label": "createReactOverlays", "source": { "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", "lineNumber": 14 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.FieldButton", "type": "Function", "label": "FieldButton", "signature": [ "({\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}: ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.FieldButtonProps", "text": "FieldButtonProps" }, ") => JSX.Element" ], "description": [], "children": [ { "type": "Object", "label": "{\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.FieldButtonProps", "text": "FieldButtonProps" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 68 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 68 }, "initialIsOpen": false }, { "id": "def-public.FieldIcon", "type": "Function", "label": "FieldIcon", "signature": [ "({\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}: ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.FieldIconProps", "text": "FieldIconProps" }, ") => JSX.Element" ], "description": [ "\nField token icon used across the app" ], "children": [ { "type": "Object", "label": "{\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.FieldIconProps", "text": "FieldIconProps" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", "lineNumber": 53 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", "lineNumber": 53 }, "initialIsOpen": false }, { "id": "def-public.KibanaContextProvider", "type": "Function", "label": "KibanaContextProvider", "tags": [], "description": [], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 76 }, "signature": [ "React.FC<{ services?: {} | undefined; }>" ], "initialIsOpen": false }, { "id": "def-public.Markdown", "type": "Function", "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.MarkdownProps", "text": "MarkdownProps" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", "lineNumber": 28 } } ], "signature": [ "(props: ", "MarkdownProps", ") => JSX.Element" ], "description": [], "label": "Markdown", "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", "lineNumber": 28 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.MarkdownSimple", "type": "Function", "children": [ { "type": "Object", "label": "props", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.MarkdownSimpleProps", "text": "MarkdownSimpleProps" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", "lineNumber": 21 } } ], "signature": [ "(props: ", "MarkdownSimpleProps", ") => JSX.Element" ], "description": [], "label": "MarkdownSimple", "source": { "path": "src/plugins/kibana_react/public/markdown/index.tsx", "lineNumber": 21 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.MountPointPortal", "type": "Function", "children": [ { "type": "CompoundType", "label": "{ children, setMountPoint }", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", "lineNumber": 22 } } ], "signature": [ "({ children, setMountPoint }: React.PropsWithChildren) => React.ReactPortal | null" ], "description": [ "\nUtility component to portal a part of a react application into the provided `MountPoint`." ], "label": "MountPointPortal", "source": { "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", "lineNumber": 22 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.OverviewPageFooter", "type": "Function", "children": [ { "type": "CompoundType", "label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", "lineNumber": 28 } } ], "signature": [ "({ addBasePath, path, onSetDefaultRoute, onChangeDefaultRoute, }: React.PropsWithChildren) => JSX.Element" ], "description": [], "label": "OverviewPageFooter", "source": { "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", "lineNumber": 28 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.OverviewPageHeader", "type": "Function", "children": [ { "type": "CompoundType", "label": "{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", "lineNumber": 35 } } ], "signature": [ "({ hideToolbar, iconType, overlap, showDevToolsLink, showManagementLink, title, addBasePath, }: React.PropsWithChildren) => JSX.Element" ], "description": [], "label": "OverviewPageHeader", "source": { "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", "lineNumber": 35 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.Panel", "type": "Function", "label": "Panel", "signature": [ "({ children, className, initialWidth = 100, style = {} }: ", "Props", ") => JSX.Element" ], "description": [], "children": [ { "type": "Object", "label": "{ children, className, initialWidth = 100, style = {} }", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.Props", "text": "Props" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", "lineNumber": 23 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", "lineNumber": 23 }, "initialIsOpen": false }, { "id": "def-public.PanelsContainer", "type": "Function", "label": "PanelsContainer", "signature": [ "({\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}: ", "Props", ") => JSX.Element" ], "description": [], "children": [ { "type": "Object", "label": "{\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}", "isRequired": true, "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.Props", "text": "Props" } ], "description": [], "source": { "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", "lineNumber": 32 } } ], "tags": [], "returnComment": [], "source": { "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", "lineNumber": 32 }, "initialIsOpen": false }, { "id": "def-public.reactRouterNavigate", "type": "Function", "children": [ { "type": "CompoundType", "label": "history", "isRequired": true, "signature": [ "History", " | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ScopedHistory", "text": "ScopedHistory" }, "" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 27 } }, { "type": "CompoundType", "label": "to", "isRequired": true, "signature": [ "string | LocationObject" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 28 } }, { "type": "Object", "label": "onClickCallback", "isRequired": false, "signature": [ "Function | undefined" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 29 } } ], "signature": [ "(history: ", "History", " | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ScopedHistory", "text": "ScopedHistory" }, ", to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: any) => void; }" ], "description": [], "label": "reactRouterNavigate", "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 26 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.reactRouterOnClickHandler", "type": "Function", "children": [ { "type": "CompoundType", "label": "history", "isRequired": true, "signature": [ "History", " | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ScopedHistory", "text": "ScopedHistory" }, "" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 36 } }, { "type": "CompoundType", "label": "to", "isRequired": true, "signature": [ "string | LocationObject" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 37 } }, { "type": "Object", "label": "onClickCallback", "isRequired": false, "signature": [ "Function | undefined" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 38 } } ], "signature": [ "(history: ", "History", " | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", "section": "def-public.ScopedHistory", "text": "ScopedHistory" }, ", to: string | LocationObject, onClickCallback?: Function | undefined) => (event: any) => void" ], "description": [], "label": "reactRouterOnClickHandler", "source": { "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", "lineNumber": 35 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.reactToUiComponent", "type": "Function", "children": [ { "type": "CompoundType", "label": "ReactComp", "isRequired": true, "signature": [ "React.ComponentType" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", "lineNumber": 19 } } ], "signature": [ "(ReactComp: React.ComponentType) => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.UiComponent", "text": "UiComponent" }, "" ], "description": [ "\nTransform a React component into a `UiComponent`.\n" ], "label": "reactToUiComponent", "source": { "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", "lineNumber": 18 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.RedirectAppLinks", "type": "Function", "children": [ { "type": "CompoundType", "label": "{\n application,\n children,\n className,\n ...otherProps\n}", "isRequired": true, "signature": [ "React.PropsWithChildren" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", "lineNumber": 38 } } ], "signature": [ "({ application, children, className, ...otherProps }: React.PropsWithChildren) => JSX.Element" ], "description": [ "\nUtility component that will intercept click events on children anchor (``) elements to call\n`application.navigateToUrl` with the link's href. This will trigger SPA friendly navigation\nwhen the link points to a valid Kibana app.\n" ], "label": "RedirectAppLinks", "source": { "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", "lineNumber": 38 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.toMountPoint", "type": "Function", "children": [ { "type": "CompoundType", "label": "node", "isRequired": false, "signature": [ "React.ReactNode" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", "lineNumber": 19 } } ], "signature": [ "(node: React.ReactNode) => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.MountPoint", "text": "MountPoint" }, "" ], "description": [ "\nMountPoint converter for react nodes.\n" ], "label": "toMountPoint", "source": { "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", "lineNumber": 19 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.ToolbarButton", "type": "Function", "children": [ { "type": "CompoundType", "label": "{\n children,\n className,\n fontWeight = 'normal',\n size = 'm',\n hasArrow = true,\n groupPosition = 'none',\n dataTestSubj = '',\n ...rest\n}", "isRequired": true, "signature": [ "React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.ToolbarButtonProps", "text": "ToolbarButtonProps" }, ">" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx", "lineNumber": 49 } } ], "signature": [ "({ children, className, fontWeight, size, hasArrow, groupPosition, dataTestSubj, ...rest }: React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.ToolbarButtonProps", "text": "ToolbarButtonProps" }, ">) => JSX.Element" ], "description": [], "label": "ToolbarButton", "source": { "path": "src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx", "lineNumber": 49 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.uiToReactComponent", "type": "Function", "children": [ { "type": "Function", "label": "Comp", "isRequired": true, "signature": [ { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.UiComponent", "text": "UiComponent" }, "" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", "lineNumber": 16 } }, { "type": "string", "label": "as", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", "lineNumber": 17 } } ], "signature": [ "(Comp: ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", "section": "def-common.UiComponent", "text": "UiComponent" }, ", as?: string) => React.FC" ], "description": [ "\nTransforms `UiComponent` into a React component." ], "label": "uiToReactComponent", "source": { "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", "lineNumber": 15 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.UrlTemplateEditor", "type": "Function", "children": [ { "type": "CompoundType", "label": "{\n height = 105,\n value,\n variables,\n onChange,\n onEditor,\n Editor = CodeEditor,\n}", "isRequired": true, "signature": [ "React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.UrlTemplateEditorProps", "text": "UrlTemplateEditorProps" }, ">" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", "lineNumber": 40 } } ], "signature": [ "({ height, value, variables, onChange, onEditor, Editor, }: React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.UrlTemplateEditorProps", "text": "UrlTemplateEditorProps" }, ">) => JSX.Element" ], "description": [], "label": "UrlTemplateEditor", "source": { "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", "lineNumber": 40 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.useKibana", "type": "Function", "children": [], "signature": [ "() => ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.KibanaReactContextValue", "text": "KibanaReactContextValue" }, " & Extra>" ], "description": [], "label": "useKibana", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 24 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.UseKibana", "type": "Function", "children": [ { "type": "CompoundType", "label": "{ children }", "isRequired": true, "signature": [ "React.PropsWithChildren<{ children: (kibana: ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.KibanaReactContextValue", "text": "KibanaReactContextValue" }, ") => React.ReactNode; }>" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 43 } } ], "signature": [ "({ children }: React.PropsWithChildren<{ children: (kibana: ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.KibanaReactContextValue", "text": "KibanaReactContextValue" }, ") => React.ReactNode; }>) => JSX.Element" ], "description": [], "label": "UseKibana", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 41 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.useUiSetting", "type": "Function", "children": [ { "type": "string", "label": "key", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 22 } }, { "type": "Uncategorized", "label": "defaultValue", "isRequired": false, "signature": [ "T | undefined" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 22 } } ], "signature": [ "(key: string, defaultValue?: T | undefined) => T" ], "description": [ "\nReturns the current UI-settings value.\n\nUsage:\n\n```js\nconst darkMode = useUiSetting('theme:darkMode');\n```" ], "label": "useUiSetting", "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 22 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.useUiSetting$", "type": "Function", "children": [ { "type": "string", "label": "key", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 47 } }, { "type": "Uncategorized", "label": "defaultValue", "isRequired": false, "signature": [ "T | undefined" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 47 } } ], "signature": [ "(key: string, defaultValue?: T | undefined) => [T, Setter]" ], "description": [ "\nReturns a 2-tuple, where first entry is the setting value and second is a\nfunction to update the setting value.\n\nSynchronously returns the most current value of the setting and subscribes\nto all subsequent updates, which will re-render your component on new values.\n\nUsage:\n\n```js\nconst [darkMode, setDarkMode] = useUiSetting$('theme:darkMode');\n```" ], "label": "useUiSetting$", "source": { "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", "lineNumber": 47 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { "id": "def-public.withKibana", "type": "Function", "children": [ { "type": "CompoundType", "label": "type", "isRequired": true, "signature": [ "React.ComponentType" ], "description": [], "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 32 } } ], "signature": [ "; }>(type: React.ComponentType) => React.FC>>" ], "description": [], "label": "withKibana", "source": { "path": "src/plugins/kibana_react/public/context/context.tsx", "lineNumber": 31 }, "tags": [], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "id": "def-public.ExitFullScreenButtonProps", "type": "Interface", "label": "ExitFullScreenButtonProps", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.ExitFullScreenButtonProps.onExitFullScreenMode", "type": "Function", "label": "onExitFullScreenMode", "description": [], "source": { "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", "lineNumber": 15 }, "signature": [ "() => void" ] } ], "source": { "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", "lineNumber": 14 }, "initialIsOpen": false }, { "id": "def-public.FieldButtonProps", "type": "Interface", "label": "FieldButtonProps", "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", "section": "def-public.FieldButtonProps", "text": "FieldButtonProps" }, " extends React.HTMLAttributes" ], "description": [], "tags": [], "children": [ { "tags": [], "id": "def-public.FieldButtonProps.fieldName", "type": "CompoundType", "label": "fieldName", "description": [ "\nLabel for the button" ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 18 }, "signature": [ "React.ReactNode" ] }, { "tags": [], "id": "def-public.FieldButtonProps.fieldIcon", "type": "CompoundType", "label": "fieldIcon", "description": [ "\nIcon representing the field type.\nRecommend using FieldIcon" ], "source": { "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", "lineNumber": 23 }, "signature": [ "React.ReactNode" ] }, { "tags": [], "id": "def-public.FieldButtonProps.fieldInfoIcon", "type": "CompoundType", "label": "fieldInfoIcon", "description": [ "\nAn optional node to place inside and at the end of the