kibana/api_docs/kbn_management_settings_application.devdocs.json

261 lines
No EOL
9.3 KiB
JSON

{
"id": "@kbn/management-settings-application",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.KibanaSettingsApplication",
"type": "Function",
"tags": [],
"label": "KibanaSettingsApplication",
"description": [],
"signature": [
"({ docLinks, i18n, notifications, settings, userProfile, theme, history, sectionRegistry, application, chrome, spaces, }: ",
{
"pluginId": "@kbn/management-settings-application",
"scope": "public",
"docId": "kibKbnManagementSettingsApplicationPluginApi",
"section": "def-public.SettingsApplicationKibanaDependencies",
"text": "SettingsApplicationKibanaDependencies"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.KibanaSettingsApplication.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n docLinks,\n i18n,\n notifications,\n settings,\n userProfile,\n theme,\n history,\n sectionRegistry,\n application,\n chrome,\n spaces,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/management-settings-application",
"scope": "public",
"docId": "kibKbnManagementSettingsApplicationPluginApi",
"section": "def-public.SettingsApplicationKibanaDependencies",
"text": "SettingsApplicationKibanaDependencies"
}
],
"path": "src/platform/packages/shared/kbn-management/settings/application/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplication",
"type": "Function",
"tags": [],
"label": "SettingsApplication",
"description": [
"\nComponent for displaying the {@link SettingsApplication} component."
],
"signature": [
"() => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/application.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplicationKibanaProvider",
"type": "Function",
"tags": [],
"label": "SettingsApplicationKibanaProvider",
"description": [
"\nKibana-specific Provider that maps dependencies to services."
],
"signature": [
"({ children, ...dependencies }: React.PropsWithChildren<",
{
"pluginId": "@kbn/management-settings-application",
"scope": "public",
"docId": "kibKbnManagementSettingsApplicationPluginApi",
"section": "def-public.SettingsApplicationKibanaDependencies",
"text": "SettingsApplicationKibanaDependencies"
},
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplicationKibanaProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{ children, ...dependencies }",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/management-settings-application",
"scope": "public",
"docId": "kibKbnManagementSettingsApplicationPluginApi",
"section": "def-public.SettingsApplicationKibanaDependencies",
"text": "SettingsApplicationKibanaDependencies"
},
">"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplicationProvider",
"type": "Function",
"tags": [],
"label": "SettingsApplicationProvider",
"description": [
"\nA Context Provider that provides services to the component and its dependencies."
],
"signature": [
"({ children, ...services }: React.PropsWithChildren<",
{
"pluginId": "@kbn/management-settings-application",
"scope": "public",
"docId": "kibKbnManagementSettingsApplicationPluginApi",
"section": "def-public.SettingsApplicationServices",
"text": "SettingsApplicationServices"
},
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplicationProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n ...services\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/management-settings-application",
"scope": "public",
"docId": "kibKbnManagementSettingsApplicationPluginApi",
"section": "def-public.SettingsApplicationServices",
"text": "SettingsApplicationServices"
},
">"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplicationKibanaDependencies",
"type": "Type",
"tags": [],
"label": "SettingsApplicationKibanaDependencies",
"description": [],
"signature": [
"KibanaDependencies",
" & KibanaDependencies & ",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "public",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-public.KibanaDependencies",
"text": "KibanaDependencies"
},
" & ",
{
"pluginId": "@kbn/management-settings-components-field-input",
"scope": "public",
"docId": "kibKbnManagementSettingsComponentsFieldInputPluginApi",
"section": "def-public.FieldInputKibanaDependencies",
"text": "FieldInputKibanaDependencies"
}
],
"path": "src/platform/packages/shared/kbn-management/settings/application/services.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-application",
"id": "def-public.SettingsApplicationServices",
"type": "Type",
"tags": [],
"label": "SettingsApplicationServices",
"description": [],
"signature": [
"Services",
" & ",
{
"pluginId": "@kbn/management-settings-components-field-input",
"scope": "public",
"docId": "kibKbnManagementSettingsComponentsFieldInputPluginApi",
"section": "def-public.FieldInputServices",
"text": "FieldInputServices"
},
" & ",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "public",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-public.Services",
"text": "Services"
},
" & ",
"Services"
],
"path": "src/platform/packages/shared/kbn-management/settings/application/services.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}