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

3045 lines
No EOL
115 KiB
JSON
Raw Blame History

{
"id": "kibanaReact",
"client": {
"classes": [
{
"parentPluginId": "kibanaReact",
"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<Props, {}, any>"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.defaultProps",
"type": "Object",
"tags": [],
"label": "defaultProps",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.defaultProps.allowEmptyRange",
"type": "boolean",
"tags": [],
"label": "allowEmptyRange",
"description": [],
"signature": [
"true"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.defaultProps.fullWidth",
"type": "boolean",
"tags": [],
"label": "fullWidth",
"description": [],
"signature": [
"false"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.defaultProps.compressed",
"type": "boolean",
"tags": [],
"label": "compressed",
"description": [],
"signature": [
"false"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.getDerivedStateFromProps",
"type": "Function",
"tags": [],
"label": "getDerivedStateFromProps",
"description": [],
"signature": [
"(nextProps: Props, prevState: State) => { value: [string | number, string | number] | undefined; prevValue: [string | number, string | number] | undefined; isValid: boolean; errorMessage: string; } | null"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.getDerivedStateFromProps.$1",
"type": "Object",
"tags": [],
"label": "nextProps",
"description": [],
"signature": [
"Props"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.getDerivedStateFromProps.$2",
"type": "Object",
"tags": [],
"label": "prevState",
"description": [],
"signature": [
"State"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"children": []
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange._onChange",
"type": "Function",
"tags": [],
"label": "_onChange",
"description": [],
"signature": [
"(value: [string | number, string | number]) => void"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange._onChange.$1",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"signature": [
"[string | number, string | number]"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ValidatedDualRange.render",
"type": "Function",
"tags": [],
"label": "render",
"description": [],
"signature": [
"() => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.createKibanaReactContext",
"type": "Function",
"tags": [],
"label": "createKibanaReactContext",
"description": [],
"signature": [
"<Services extends Partial<",
"CoreStart",
">>(services: Services) => ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContext",
"text": "KibanaReactContext"
},
"<Services>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.createKibanaReactContext.$1",
"type": "Uncategorized",
"tags": [],
"label": "services",
"description": [],
"signature": [
"Services"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.createNotifications",
"type": "Function",
"tags": [],
"label": "createNotifications",
"description": [],
"signature": [
"(services: Partial<",
"CoreStart",
">) => ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactNotifications",
"text": "KibanaReactNotifications"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/create_notifications.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.createNotifications.$1",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"Partial<",
"CoreStart",
">"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/create_notifications.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.createReactOverlays",
"type": "Function",
"tags": [],
"label": "createReactOverlays",
"description": [],
"signature": [
"(services: Partial<",
"CoreStart",
">) => ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactOverlays",
"text": "KibanaReactOverlays"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/create_react_overlays.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.createReactOverlays.$1",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"Partial<",
"CoreStart",
">"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/create_react_overlays.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ElasticAgentCard",
"type": "Function",
"tags": [],
"label": "ElasticAgentCard",
"description": [
"\nApplies extra styling to a typical EuiAvatar"
],
"signature": [
"({ solution, recommended, title, href, button, layout, category, ...cardRest }: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ElasticAgentCardProps",
"text": "ElasticAgentCardProps"
},
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_card/elastic_agent_card.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ElasticAgentCard.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n solution,\n recommended,\n title,\n href,\n button,\n layout,\n category,\n ...cardRest\n}",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ElasticAgentCardProps",
"text": "ElasticAgentCardProps"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_card/elastic_agent_card.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaContextProvider",
"type": "Function",
"tags": [],
"label": "KibanaContextProvider",
"description": [],
"signature": [
"React.FunctionComponent<React.PropsWithChildren<{ services?: {} | undefined; }>>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaContextProvider.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaContextProvider.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaPageTemplateSolutionNavAvatar",
"type": "Function",
"tags": [],
"label": "KibanaPageTemplateSolutionNavAvatar",
"description": [
"\nApplies extra styling to a typical EuiAvatar"
],
"signature": [
"({ className, size, ...rest }: ",
"KibanaPageTemplateSolutionNavAvatarProps",
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/solution_nav/solution_nav_avatar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaPageTemplateSolutionNavAvatar.$1",
"type": "CompoundType",
"tags": [],
"label": "{ className, size, ...rest }",
"description": [],
"signature": [
"KibanaPageTemplateSolutionNavAvatarProps"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/solution_nav/solution_nav_avatar.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaThemeProvider",
"type": "Function",
"tags": [
"deprecated"
],
"label": "KibanaThemeProvider",
"description": [],
"signature": [
"({ children, theme$, userProfile, modify, }: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
},
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaThemeProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n theme$,\n userProfile,\n modify,\n}",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.Markdown",
"type": "Function",
"tags": [],
"label": "Markdown",
"description": [],
"signature": [
"(props: ",
"MarkdownProps",
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/markdown/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.Markdown.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"MarkdownProps"
],
"path": "src/platform/plugins/shared/kibana_react/public/markdown/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.MarkdownSimple",
"type": "Function",
"tags": [],
"label": "MarkdownSimple",
"description": [],
"signature": [
"(props: ",
"MarkdownSimpleProps",
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/markdown/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.MarkdownSimple.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"MarkdownSimpleProps"
],
"path": "src/platform/plugins/shared/kibana_react/public/markdown/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataCard",
"type": "Function",
"tags": [],
"label": "NoDataCard",
"description": [],
"signature": [
"({ recommended, title, button, layout, ...cardRest }: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageActions",
"text": "NoDataPageActions"
},
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_card/no_data_card.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataCard.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n recommended,\n title,\n button,\n layout,\n ...cardRest\n}",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageActions",
"text": "NoDataPageActions"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_card/no_data_card.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPage",
"type": "Function",
"tags": [],
"label": "NoDataPage",
"description": [],
"signature": [
"({ solution, logo, actions, docsLink, pageTitle, ...rest }: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageProps",
"text": "NoDataPageProps"
},
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPage.$1",
"type": "Object",
"tags": [],
"label": "{\n solution,\n logo,\n actions,\n docsLink,\n pageTitle,\n ...rest\n}",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageProps",
"text": "NoDataPageProps"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.overviewPageActions",
"type": "Function",
"tags": [],
"label": "overviewPageActions",
"description": [],
"signature": [
"({ addDataHref, application, devToolsHref, hidden, managementHref, showDevToolsLink, showManagementLink, }: Props) => (React.JSX.Element | null)[]"
],
"path": "src/platform/plugins/shared/kibana_react/public/overview_page/overview_page_actions/overview_page_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.overviewPageActions.$1",
"type": "Object",
"tags": [],
"label": "{\n addDataHref,\n application,\n devToolsHref,\n hidden,\n managementHref,\n showDevToolsLink,\n showManagementLink,\n}",
"description": [],
"signature": [
"Props"
],
"path": "src/platform/plugins/shared/kibana_react/public/overview_page/overview_page_actions/overview_page_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.OverviewPageFooter",
"type": "Function",
"tags": [],
"label": "OverviewPageFooter",
"description": [],
"signature": [
"({ addBasePath, path, onSetDefaultRoute, onChangeDefaultRoute, }: Props) => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.OverviewPageFooter.$1",
"type": "Object",
"tags": [],
"label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}",
"description": [],
"signature": [
"Props"
],
"path": "src/platform/plugins/shared/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterNavigate",
"type": "Function",
"tags": [],
"label": "reactRouterNavigate",
"description": [],
"signature": [
"(history: ",
"ScopedHistory",
"<unknown> | ",
"History",
"<unknown>, to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: React.MouseEvent<Element, MouseEvent>) => void; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterNavigate.$1",
"type": "CompoundType",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown> | ",
"History",
"<unknown>"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterNavigate.$2",
"type": "CompoundType",
"tags": [],
"label": "to",
"description": [],
"signature": [
"string | LocationObject"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterNavigate.$3",
"type": "Object",
"tags": [],
"label": "onClickCallback",
"description": [],
"signature": [
"Function | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterOnClickHandler",
"type": "Function",
"tags": [],
"label": "reactRouterOnClickHandler",
"description": [],
"signature": [
"(history: ",
"ScopedHistory",
"<unknown> | ",
"History",
"<unknown>, to: string | LocationObject, onClickCallback?: Function | undefined) => (event: React.MouseEvent<Element, MouseEvent>) => void"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterOnClickHandler.$1",
"type": "CompoundType",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown> | ",
"History",
"<unknown>"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterOnClickHandler.$2",
"type": "CompoundType",
"tags": [],
"label": "to",
"description": [],
"signature": [
"string | LocationObject"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.reactRouterOnClickHandler.$3",
"type": "Object",
"tags": [],
"label": "onClickCallback",
"description": [],
"signature": [
"Function | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/react_router_navigate/react_router_navigate.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.toMountPoint",
"type": "Function",
"tags": [
"deprecated"
],
"label": "toMountPoint",
"description": [],
"signature": [
"(node: React.ReactNode, { analytics, theme$, userProfile }?: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ToMountPointOptions",
"text": "ToMountPointOptions"
},
") => ",
"MountPoint",
"<HTMLElement>"
],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "monitoring",
"path": "x-pack/platform/plugins/private/monitoring/public/components/header_menu/header_menu_portal.tsx"
},
{
"plugin": "monitoring",
"path": "x-pack/platform/plugins/private/monitoring/public/components/header_menu/header_menu_portal.tsx"
},
{
"plugin": "observabilityShared",
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/header_menu/header_menu_portal.tsx"
},
{
"plugin": "observabilityShared",
"path": "x-pack/solutions/observability/plugins/observability_shared/public/components/header_menu/header_menu_portal.tsx"
}
],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.toMountPoint.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"React.ReactNode"
],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.toMountPoint.$2",
"type": "Object",
"tags": [],
"label": "{ analytics, theme$, userProfile }",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ToMountPointOptions",
"text": "ToMountPointOptions"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditor",
"type": "Function",
"tags": [],
"label": "UrlTemplateEditor",
"description": [],
"signature": [
"({ height, fitToContent, value, variables, onChange, placeholder, onEditor, Editor, }: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.UrlTemplateEditorProps",
"text": "UrlTemplateEditorProps"
},
") => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditor.$1",
"type": "Object",
"tags": [],
"label": "{\n height = 105,\n fitToContent,\n value,\n variables,\n onChange,\n placeholder,\n onEditor,\n Editor = CodeEditor,\n}",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.UrlTemplateEditorProps",
"text": "UrlTemplateEditorProps"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useDarkMode",
"type": "Function",
"tags": [
"deprecated"
],
"label": "useDarkMode",
"description": [
"\nThis should only be used to pass the darkMode to a theme provider which is outside\nof the global theme provider scope. For example when used with `EuiThemeProvider`.\n"
],
"signature": [
"(defaultValue?: boolean | undefined) => boolean"
],
"path": "src/platform/plugins/shared/kibana_react/public/dark_mode/use_dark_mode.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/app/app.tsx"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/app/app.tsx"
}
],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.useDarkMode.$1",
"type": "CompoundType",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/dark_mode/use_dark_mode.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useExecutionContext",
"type": "Function",
"tags": [],
"label": "useExecutionContext",
"description": [
"\nSet and clean up application level execution context"
],
"signature": [
"(executionContext: ",
"ExecutionContextSetup",
" | undefined, context: ",
"KibanaExecutionContext",
") => void"
],
"path": "src/platform/plugins/shared/kibana_react/public/use_execution_context/use_execution_context.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.useExecutionContext.$1",
"type": "Object",
"tags": [],
"label": "executionContext",
"description": [],
"signature": [
"ExecutionContextSetup",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/use_execution_context/use_execution_context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useExecutionContext.$2",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"KibanaExecutionContext"
],
"path": "src/platform/plugins/shared/kibana_react/public/use_execution_context/use_execution_context.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useGlobalUiSetting",
"type": "Function",
"tags": [],
"label": "useGlobalUiSetting",
"description": [
"\nReturns the current global UI-settings value.\n\nUsage:\n\n```js\nconst customBranding = useGlobalUiSetting('customBranding:pageTitle');\n```"
],
"signature": [
"<T>(key: string, defaultValue?: T | undefined) => T"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.useGlobalUiSetting.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useGlobalUiSetting.$2",
"type": "Uncategorized",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useGlobalUiSetting$",
"type": "Function",
"tags": [],
"label": "useGlobalUiSetting$",
"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 [customBranding, setCustomBranding] = useGlobalUiSetting$('customBranding:pageTitle');\n```"
],
"signature": [
"<T>(key: string, defaultValue?: T | undefined) => [T, Setter<T>]"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.useGlobalUiSetting$.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useGlobalUiSetting$.$2",
"type": "Uncategorized",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useKibana",
"type": "Function",
"tags": [],
"label": "useKibana",
"description": [],
"signature": [
"<Extra extends object = {}>() => ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<Partial<",
"CoreStart",
"> & Extra>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useUiSetting",
"type": "Function",
"tags": [],
"label": "useUiSetting",
"description": [
"\nReturns the current UI-settings value.\n\nUsage:\n\n```js\nconst darkMode = useUiSetting('theme:darkMode');\n```"
],
"signature": [
"<T>(key: string, defaultValue?: T | undefined) => T"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.useUiSetting.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useUiSetting.$2",
"type": "Uncategorized",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useUiSetting$",
"type": "Function",
"tags": [],
"label": "useUiSetting$",
"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```"
],
"signature": [
"<T>(key: string, defaultValue?: T | undefined) => [T, Setter<T>]"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.useUiSetting$.$1",
"type": "string",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.useUiSetting$.$2",
"type": "Uncategorized",
"tags": [],
"label": "defaultValue",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/ui_settings/use_ui_setting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.withKibana",
"type": "Function",
"tags": [],
"label": "withKibana",
"description": [],
"signature": [
"<Props extends { kibana: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<{}>; }>(type: React.ComponentType<Props>) => React.FC<Omit<Props, \"kibana\">>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.withKibana.$1",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"React.ComponentType<Props>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.wrapWithTheme",
"type": "Function",
"tags": [
"deprecated"
],
"label": "wrapWithTheme",
"description": [],
"signature": [
"(node: React.ReactNode, theme$: ",
"Observable",
"<",
{
"pluginId": "@kbn/react-kibana-context-common",
"scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
"section": "def-common.KibanaTheme",
"text": "KibanaTheme"
},
">, userProfile?: ",
"UserProfileService",
" | undefined) => React.JSX.Element"
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "observabilityAiAssistantManagement",
"path": "x-pack/platform/plugins/private/observability_ai_assistant_management/public/app.tsx"
},
{
"plugin": "observabilityAiAssistantManagement",
"path": "x-pack/platform/plugins/private/observability_ai_assistant_management/public/app.tsx"
},
{
"plugin": "aiAssistantManagementSelection",
"path": "src/platform/plugins/shared/ai_assistant_management/selection/public/management_section/mount_section.tsx"
},
{
"plugin": "aiAssistantManagementSelection",
"path": "src/platform/plugins/shared/ai_assistant_management/selection/public/management_section/mount_section.tsx"
}
],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.wrapWithTheme.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"React.ReactNode"
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.wrapWithTheme.$2",
"type": "Object",
"tags": [],
"label": "theme$",
"description": [],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/react-kibana-context-common",
"scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
"section": "def-common.KibanaTheme",
"text": "KibanaTheme"
},
">"
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.wrapWithTheme.$3",
"type": "Object",
"tags": [],
"label": "userProfile",
"description": [],
"signature": [
"UserProfileService",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext",
"type": "Interface",
"tags": [],
"label": "KibanaReactContext",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContext",
"text": "KibanaReactContext"
},
"<T>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext.value",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<T>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext.Provider",
"type": "Function",
"tags": [],
"label": "Provider",
"description": [],
"signature": [
"React.FunctionComponent<React.PropsWithChildren<{ services?: T | undefined; }>>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext.Provider.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext.Provider.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext.Consumer",
"type": "Function",
"tags": [],
"label": "Consumer",
"description": [],
"signature": [
"React.ExoticComponent<React.ConsumerProps<",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<T>>>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContext.Consumer.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContextValue",
"type": "Interface",
"tags": [],
"label": "KibanaReactContextValue",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<Services>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContextValue.services",
"type": "Uncategorized",
"tags": [],
"label": "services",
"description": [],
"signature": [
"Services"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContextValue.overlays",
"type": "Object",
"tags": [],
"label": "overlays",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactOverlays",
"text": "KibanaReactOverlays"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactContextValue.notifications",
"type": "Object",
"tags": [],
"label": "notifications",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactNotifications",
"text": "KibanaReactNotifications"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactNotifications",
"type": "Interface",
"tags": [],
"label": "KibanaReactNotifications",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactNotifications.toasts",
"type": "Object",
"tags": [],
"label": "toasts",
"description": [],
"signature": [
"{ show: (input: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ToastInput",
"text": "ToastInput"
},
") => void; success: (input: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ToastInput",
"text": "ToastInput"
},
") => void; warning: (input: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ToastInput",
"text": "ToastInput"
},
") => void; danger: (input: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.ToastInput",
"text": "ToastInput"
},
") => void; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays",
"type": "Interface",
"tags": [],
"label": "KibanaReactOverlays",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays.openFlyout",
"type": "Function",
"tags": [],
"label": "openFlyout",
"description": [],
"signature": [
"(node: React.ReactNode, options?: ",
"OverlayFlyoutOpenOptions",
" | undefined) => ",
"OverlayRef"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays.openFlyout.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"React.ReactNode"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays.openFlyout.$2",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"OverlayFlyoutOpenOptions",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays.openModal",
"type": "Function",
"tags": [],
"label": "openModal",
"description": [],
"signature": [
"(node: React.ReactNode, options?: ",
"OverlayModalOpenOptions",
" | undefined) => ",
"OverlayRef"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays.openModal.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"React.ReactNode"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaReactOverlays.openModal.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"OverlayModalOpenOptions",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/overlays/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageProps",
"type": "Interface",
"tags": [],
"label": "NoDataPageProps",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageProps",
"text": "NoDataPageProps"
},
" extends ",
"CommonProps"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageProps.solution",
"type": "string",
"tags": [],
"label": "solution",
"description": [
"\nSingle name for the current solution, used to auto-generate the title, logo, description, and button label"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageProps.logo",
"type": "string",
"tags": [],
"label": "logo",
"description": [
"\nOptionally replace the auto-generated logo"
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageProps.docsLink",
"type": "string",
"tags": [],
"label": "docsLink",
"description": [
"\nRequired to set the docs link for the whole solution"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageProps.pageTitle",
"type": "string",
"tags": [],
"label": "pageTitle",
"description": [
"\nOptionally replace the auto-generated page title (h1)"
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageProps.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [
"\nAn object of `NoDataPageActions` configurations with unique primary keys.\nUse `elasticAgent` or `beats` as the primary key for pre-configured cards of this type.\nOtherwise use a custom key that contains `EuiCard` props."
],
"signature": [
"{ [x: string]: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageActions",
"text": "NoDataPageActions"
},
"; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput",
"type": "Interface",
"tags": [],
"label": "ToastInput",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput.title",
"type": "CompoundType",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput.body",
"type": "CompoundType",
"tags": [],
"label": "body",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput.color",
"type": "CompoundType",
"tags": [],
"label": "color",
"description": [],
"signature": [
"\"success\" | \"warning\" | \"primary\" | \"danger\" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput.iconType",
"type": "CompoundType",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"IconType",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput.toastLifeTimeMs",
"type": "number",
"tags": [],
"label": "toastLifeTimeMs",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToastInput.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/notifications/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToMountPointOptions",
"type": "Interface",
"tags": [
"deprecated"
],
"label": "ToMountPointOptions",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToMountPointOptions.analytics",
"type": "Object",
"tags": [],
"label": "analytics",
"description": [],
"signature": [
"AnalyticsServiceStart",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToMountPointOptions.theme$",
"type": "Object",
"tags": [],
"label": "theme$",
"description": [],
"signature": [
"Observable",
"<",
"CoreTheme",
"> | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.ToMountPointOptions.userProfile",
"type": "Object",
"tags": [],
"label": "userProfile",
"description": [],
"signature": [
"UserProfileService",
" | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/util/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps",
"type": "Interface",
"tags": [],
"label": "UrlTemplateEditorProps",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.value",
"type": "string",
"tags": [],
"label": "value",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.height",
"type": "CompoundType",
"tags": [],
"label": "height",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.fitToContent",
"type": "Object",
"tags": [],
"label": "fitToContent",
"description": [],
"signature": [
"{ minLines?: number | undefined; maxLines?: number | undefined; } | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.variables",
"type": "Array",
"tags": [],
"label": "variables",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.UrlTemplateEditorVariable",
"text": "UrlTemplateEditorVariable"
},
"[] | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [],
"signature": [
"((value: string, event: ",
"editor",
".IModelContentChangedEvent) => void) | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.onEditor",
"type": "Function",
"tags": [],
"label": "onEditor",
"description": [],
"signature": [
"((editor: ",
"editor",
".IStandaloneCodeEditor) => void) | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.onEditor.$1",
"type": "Object",
"tags": [],
"label": "editor",
"description": [],
"signature": [
"editor",
".IStandaloneCodeEditor"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.placeholder",
"type": "string",
"tags": [],
"label": "placeholder",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorProps.Editor",
"type": "CompoundType",
"tags": [],
"label": "Editor",
"description": [],
"signature": [
"React.ComponentType<",
{
"pluginId": "@kbn/code-editor",
"scope": "common",
"docId": "kibKbnCodeEditorPluginApi",
"section": "def-common.CodeEditorProps",
"text": "CodeEditorProps"
},
"> | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorVariable",
"type": "Interface",
"tags": [],
"label": "UrlTemplateEditorVariable",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorVariable.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorVariable.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorVariable.documentation",
"type": "string",
"tags": [],
"label": "documentation",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorVariable.kind",
"type": "CompoundType",
"tags": [],
"label": "kind",
"description": [],
"signature": [
"languages",
".CompletionItemKind | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.UrlTemplateEditorVariable.sortText",
"type": "string",
"tags": [],
"label": "sortText",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/kibana_react/public/url_template_editor/url_template_editor.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.ElasticAgentCardProps",
"type": "Type",
"tags": [],
"label": "ElasticAgentCardProps",
"description": [],
"signature": [
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageActions",
"text": "NoDataPageActions"
},
" & { solution: string; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_card/elastic_agent_card.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaServices",
"type": "Type",
"tags": [],
"label": "KibanaServices",
"description": [],
"signature": [
"{ analytics?: ",
"AnalyticsServiceStart",
" | undefined; application?: ",
"ApplicationStart",
" | undefined; chrome?: ",
"ChromeStart",
" | undefined; customBranding?: ",
"CustomBrandingStart",
" | undefined; docLinks?: ",
"DocLinksStart",
" | undefined; executionContext?: ",
"ExecutionContextSetup",
" | undefined; featureFlags?: ",
"FeatureFlagsStart",
" | undefined; http?: ",
"HttpSetup",
" | undefined; savedObjects?: ",
"SavedObjectsStart",
" | undefined; i18n?: ",
"I18nStart",
" | undefined; notifications?: ",
"NotificationsStart",
" | undefined; overlays?: ",
"OverlayStart",
" | undefined; uiSettings?: ",
"IUiSettingsClient",
" | undefined; settings?: ",
"SettingsStart",
" | undefined; fatalErrors?: ",
"FatalErrorsSetup",
" | undefined; deprecations?: ",
"DeprecationsServiceStart",
" | undefined; theme?: ",
"ThemeServiceSetup",
" | undefined; plugins?: ",
"PluginsServiceStart",
" | undefined; pricing?: ",
"PricingServiceStart",
" | undefined; security?: ",
"SecurityServiceStart",
" | undefined; userProfile?: ",
"UserProfileService",
" | undefined; rendering?: ",
"RenderingService",
" | undefined; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.KibanaThemeProviderProps",
"type": "Type",
"tags": [
"deprecated"
],
"label": "KibanaThemeProviderProps",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "@kbn/react-kibana-context-theme",
"scope": "common",
"docId": "kibKbnReactKibanaContextThemePluginApi",
"section": "def-common.KibanaThemeProviderProps",
"text": "KibanaThemeProviderProps"
},
", \"children\" | \"userProfile\" | \"modify\"> & ",
{
"pluginId": "@kbn/react-kibana-context-common",
"scope": "common",
"docId": "kibKbnReactKibanaContextCommonPluginApi",
"section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
],
"path": "src/platform/plugins/shared/kibana_react/public/theme.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NO_DATA_RECOMMENDED",
"type": "string",
"tags": [],
"label": "NO_DATA_RECOMMENDED",
"description": [],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageActions",
"type": "Type",
"tags": [],
"label": "NoDataPageActions",
"description": [],
"signature": [
"Partial<",
"EuiCardProps",
"> & { recommended?: boolean | undefined; button?: React.ReactNode; onClick?: React.MouseEventHandler<HTMLElement> | undefined; category?: string | undefined; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.NoDataPageActionsProps",
"type": "Type",
"tags": [],
"label": "NoDataPageActionsProps",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.NoDataPageActions",
"text": "NoDataPageActions"
},
"; }"
],
"path": "src/platform/plugins/shared/kibana_react/public/page_template/no_data_page/no_data_page.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-public.Value",
"type": "Type",
"tags": [],
"label": "Value",
"description": [],
"signature": [
"[string | number, string | number]"
],
"path": "src/platform/plugins/shared/kibana_react/public/validated_range/validated_dual_range.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "kibanaReact",
"id": "def-public.context",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"React.Context<",
{
"pluginId": "kibanaReact",
"scope": "public",
"docId": "kibKibanaReactPluginApi",
"section": "def-public.KibanaReactContextValue",
"text": "KibanaReactContextValue"
},
"<Partial<",
"CoreStart",
">>>"
],
"path": "src/platform/plugins/shared/kibana_react/public/context/context.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.createGlobalStyle",
"type": "Function",
"tags": [],
"label": "createGlobalStyle",
"description": [
"/** see https://styled-components.com/docs/api#createglobalstyle */"
],
"signature": [
"<P extends object = {}>(first: TemplateStringsArray | ",
"CSSObject",
" | ",
"InterpolationFunction",
"<",
"ThemedStyledProps",
"<P, ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">>, ...interpolations: ",
"Interpolation",
"<",
"ThemedStyledProps",
"<P, ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">>[]) => ",
"GlobalStyleComponent",
"<P, ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.createGlobalStyle.$1",
"type": "CompoundType",
"tags": [],
"label": "first",
"description": [],
"signature": [
"TemplateStringsArray | ",
"CSSObject",
" | ",
"InterpolationFunction",
"<",
"ThemedStyledProps",
"<P, T>>"
],
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.createGlobalStyle.$2",
"type": "Array",
"tags": [],
"label": "interpolations",
"description": [],
"signature": [
"Interpolation",
"<",
"ThemedStyledProps",
"<P, T>>[]"
],
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.css",
"type": "Function",
"tags": [],
"label": "css",
"description": [
"/** see https://styled-components.com/docs/api#css-prop */"
],
"signature": [
"BaseThemedCssFunction",
"<",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.euiStyled",
"type": "Function",
"tags": [],
"label": "euiStyled",
"description": [
"/** see https://styled-components.com/docs/api#styled */"
],
"signature": [
"ThemedBaseStyledInterface",
"<",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.keyframes",
"type": "Function",
"tags": [],
"label": "keyframes",
"description": [
"/** see https://styled-components.com/docs/api#keyframes */"
],
"signature": [
"(strings: TemplateStringsArray | ",
"CSSKeyframes",
", ...interpolations: ",
"SimpleInterpolation",
"[]) => ",
"Keyframes"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.keyframes.$1",
"type": "CompoundType",
"tags": [],
"label": "strings",
"description": [],
"signature": [
"TemplateStringsArray | ",
"CSSKeyframes"
],
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.keyframes.$2",
"type": "Array",
"tags": [],
"label": "interpolations",
"description": [],
"signature": [
"SimpleInterpolation",
"[]"
],
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.KibanaStyledComponentsThemeProvider",
"type": "Function",
"tags": [],
"label": "KibanaStyledComponentsThemeProvider",
"description": [
"\nA `styled-components` `ThemeProvider` that incorporates EUI dark mode."
],
"signature": [
"<OuterTheme extends ",
"DefaultTheme",
" = ",
"DefaultTheme",
">({ darkMode, ...otherProps }: Omit<",
"ThemeProviderProps",
"<OuterTheme, OuterTheme & ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">, \"theme\"> & { darkMode?: boolean | undefined; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.KibanaStyledComponentsThemeProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n darkMode = false,\n ...otherProps\n}",
"description": [],
"signature": [
"Omit<",
"ThemeProviderProps",
"<OuterTheme, OuterTheme & ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">, \"theme\"> & { darkMode?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.KibanaStyledComponentsThemeProviderDecorator",
"type": "Function",
"tags": [
"deprecated"
],
"label": "KibanaStyledComponentsThemeProviderDecorator",
"description": [
"\nStorybook decorator using the EUI theme provider. Uses the value from\n`globals` provided by the Storybook theme switcher.\n"
],
"signature": [
"(storyFn: ",
"PartialStoryFn",
"<",
"R",
", ",
"StrictArgs",
">, { globals }: ",
"StoryContext",
"<",
"R",
", ",
"StrictArgs",
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/react-kibana-context-styled",
"path": "src/platform/packages/shared/react/kibana_context/styled/index.ts"
}
],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.KibanaStyledComponentsThemeProviderDecorator.$1",
"type": "Function",
"tags": [],
"label": "storyFn",
"description": [],
"signature": [
"PartialStoryFn",
"<",
"R",
", ",
"StrictArgs",
">"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.KibanaStyledComponentsThemeProviderDecorator.$2",
"type": "Object",
"tags": [],
"label": "{ globals }",
"description": [],
"signature": [
"StoryContext",
"<",
"R",
", ",
"StrictArgs",
">"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.withTheme",
"type": "Function",
"tags": [],
"label": "withTheme",
"description": [
"/** see https://styled-components.com/docs/api#withtheme */"
],
"signature": [
"<C extends React.ComponentType<any>>(component: React.ComponentProps<C> extends { theme?: ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
" | undefined; } ? C : never) => React.ForwardRefExoticComponent<WithOptionalTheme<React.ComponentPropsWithRef<C>, ",
{
"pluginId": "@kbn/react-kibana-context-styled",
"scope": "common",
"docId": "kibKbnReactKibanaContextStyledPluginApi",
"section": "def-common.EuiTheme",
"text": "EuiTheme"
},
">>"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.withTheme.$1",
"type": "Uncategorized",
"tags": [],
"label": "component",
"description": [],
"signature": [
"React.ComponentProps<C> extends { theme?: T | undefined; } ? C : never"
],
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.EuiTheme",
"type": "Interface",
"tags": [],
"label": "EuiTheme",
"description": [
"\nA `deprecated` structure representing a Kibana theme containing variables from the current EUI theme."
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "kibanaReact",
"id": "def-common.EuiTheme.eui",
"type": "Object",
"tags": [],
"label": "eui",
"description": [
"EUI theme vars that automaticall adjust to light and dark mode."
],
"signature": [
"{ euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; accentSecondary: string; neutral: string; success: string; warning: string; risk: string; danger: string; ghost: string; text: string; }; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; accentSecondary: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiColorVisAsTextLight0: string; euiColorVisAsTextLight1: string; euiColorVisAsTextLight2: string; euiColorVisAsTextLight3: string; euiColorVisAsTextLight4: string; euiColorVisAsTextLight5: string; euiColorVisAsTextLight6: string; euiColorVisAsTextDark0: string; euiColorVisAsTextDark1: string; euiColorVisAsTextDark2: string; euiColorVisAsTextDark3: string; euiColorVisAsTextDark4: string; euiColorVisAsTextDark5: string; euiColorVisAsTextDark6: string; euiColorVisSuccess0: string; euiColorVisSuccess1: string; euiColorVisWarning0: string; euiColorVisDanger0: string; euiColorVisDanger1: string; euiColorVisNeutral0: string; euiColorVisGrey0: string; euiColorVisGrey1: string; euiColorVisGrey2: string; euiColorVisGrey3: string; euiColorVisWarm0: string; euiColorVisWarm1: string; euiColorVisWarm2: string; euiColorVisCool0: string; euiColorVisCool1: string; euiColorVisCool2: string; euiColorVisComplementary0: string; euiColorVisComplementary1: string; euiColorSeverityUnknown: string; euiColorSeverityNeutral: string; euiColorSeveritySuccess: string; euiColorSeverityWarning: string; euiColorSeverityRisk: string; euiColorSeverityDanger: string; euiColorChartLines: string; euiColorChartBand: string; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorAccentSecondary: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorPlainLight: string; euiColorPlainDark: string; euiColorTextPrimary: string; euiColorTextAccent: string; euiColorTextAccentSecondary: string; euiColorTextNeutral: string; euiColorTextSuccess: string; euiColorTextWarning: string; euiColorTextRisk: string; euiColorTextDanger: string; euiColorTextParagraph: string; euiColorTextHeading: string; euiColorTextSubdued: string; euiColorTextDisabled: string; euiColorTextInverse: string; euiColorBackgroundBasePrimary: string; euiColorBackgroundBaseAccent: string; euiColorBackgroundBaseAccentSecondary: string; euiColorBackgroundBaseNeutral: string; euiColorBackgroundBaseSuccess: string; euiColorBackgroundBaseWarning: string; euiColorBackgroundBaseRisk: string; euiColorBackgroundBaseDanger: string; euiColorBackgroundBaseSubdued: string; euiColorBackgroundBasePlain: string; euiColorBackgroundBaseDisabled: string; euiColorBackgroundBaseHighlighted: string; euiColorBackgroundBaseFormsPrepend: string; euiColorBackgroundBaseFormsControlDisabled: string; euiColorBackgroundBaseInteractiveHover: string; euiColorBackgroundBaseInteractiveSelect: string; euiColorBackgroundBaseInteractiveOverlay: string; euiColorBackgroundBaseSkeletonEdge: string; euiColorBackgroundBaseSkeletonMiddle: string; euiColorBackgroundLightPrimary: string; euiColorBackgroundLightAccent: string; euiColorBackgroundLightAccentSecondary: string; euiColorBackgroundLightNeutral: string; euiColorBackgroundLightSuccess: string; euiColorBackgroundLightWarning: string; euiColorBackgroundLightRisk: string; euiColorBackgroundLightDanger: string; euiColorBackgroundLightText: string; euiColorBackgroundFilledPrimary: string; euiColorBackgroundFilledAccent: string; euiColorBackgroundFilledAccentSecondary: string; euiColorBackgroundFilledNeutral: string; euiColorBackgroundFilledSuccess: string; euiColorBackgroundFilledWarning: string; euiColorBackgroundFilledRisk: string; euiColorBackgroundFilledDanger: string; euiColorBackgroundFilledText: string; euiColorBorderBasePrimary: string; euiColorBorderBaseAccent: string; euiColorBorderBaseAccentSecondary: string; euiColorBorderBaseNeutral: string; euiColorBorderBaseSuccess: string; euiColorBorderBaseWarning: string; euiColorBorderBaseRisk: string; euiColorBorderBaseDanger: string; euiColorBorderBasePlain: string; euiColorBorderBaseSubdued: string; euiColorBorderBaseDisabled: string; euiColorBorderBaseFloating: string; euiColorBorderBaseFormsColorSwatch: string; euiColorBorderBaseFormsControl: string; euiColorBorderStrongPrimary: string; euiColorBorderStrongAccent: string; euiColorBorderStrongAccentSecondary: string; euiColorBorderStrongNeutral: string; euiColorBorderStrongSuccess: string; euiColorBorderStrongWarning: string; euiColorBorderStrongRisk: string; euiColorBorderStrongDanger: string; }"
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "kibanaReact",
"id": "def-common.EuiTheme.darkMode",
"type": "boolean",
"tags": [],
"label": "darkMode",
"description": [
"True if the theme is in \"dark\" mode, false otherwise."
],
"path": "src/platform/packages/shared/react/kibana_context/styled/styled_provider.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink