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/kbn_management_settings_components_field_row.devdocs.json

601 lines
No EOL
22 KiB
JSON
Raw Blame History

{
"id": "@kbn/management-settings-components-field-row",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRow",
"type": "Function",
"tags": [],
"label": "FieldRow",
"description": [
"\nComponent for displaying a {@link FieldDefinition} in a form row, using a {@link FieldInput}."
],
"signature": [
"(props: ",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowProps",
"text": "FieldRowProps"
},
") => JSX.Element"
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRow.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [
"The {@link FieldRowProps } for the {@link FieldRow } component."
],
"signature": [
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowProps",
"text": "FieldRowProps"
}
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowKibanaProvider",
"type": "Function",
"tags": [],
"label": "FieldRowKibanaProvider",
"description": [
"\nKibana-specific Provider that maps Kibana plugins and services to a {@link FieldRowProvider}."
],
"signature": [
"({ children, docLinks, toasts, }: React.PropsWithChildren<",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowKibanaDependencies",
"text": "FieldRowKibanaDependencies"
},
">) => JSX.Element"
],
"path": "packages/kbn-management/settings/components/field_row/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowKibanaProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n docLinks,\n toasts,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowKibanaDependencies",
"text": "FieldRowKibanaDependencies"
},
">"
],
"path": "packages/kbn-management/settings/components/field_row/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProvider",
"type": "Function",
"tags": [],
"label": "FieldRowProvider",
"description": [
"\nReact Provider that provides services to a {@link FieldRow} component and its dependents.\\"
],
"signature": [
"({ children, ...services }: ",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowProviderProps",
"text": "FieldRowProviderProps"
},
") => JSX.Element"
],
"path": "packages/kbn-management/settings/components/field_row/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProvider.$1",
"type": "Object",
"tags": [],
"label": "{ children, ...services }",
"description": [],
"signature": [
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowProviderProps",
"text": "FieldRowProviderProps"
}
],
"path": "packages/kbn-management/settings/components/field_row/services.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps",
"type": "Interface",
"tags": [],
"label": "FieldRowProps",
"description": [
"\nProps for a {@link FieldRow} component."
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [
"The {@link FieldDefinition} corresponding the setting."
],
"signature": [
"{ type: ",
{
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.UiSettingsType",
"text": "UiSettingsType"
},
"; id: string; defaultValue?: string | number | boolean | (string | number)[] | null | undefined; name: string; groupId: string; displayName: string; isCustom: boolean; isOverridden: boolean; ariaAttributes: { ariaLabel: string; ariaDescribedBy?: string | undefined; }; savedValue?: string | number | boolean | (string | number)[] | null | undefined; defaultValueDisplay: string; isDefaultValue: boolean; unsavedFieldId: string; }"
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.isSavingEnabled",
"type": "boolean",
"tags": [],
"label": "isSavingEnabled",
"description": [
"True if saving settings is enabled, false otherwise."
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.onChange",
"type": "Function",
"tags": [],
"label": "onChange",
"description": [
"The {@link OnChangeFn} handler."
],
"signature": [
"(id: string, change?: ",
{
"pluginId": "@kbn/management-settings-types",
"scope": "common",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-common.UnsavedFieldChange",
"text": "UnsavedFieldChange"
},
"<",
{
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.UiSettingsType",
"text": "UiSettingsType"
},
"> | undefined) => void"
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.onChange.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.onChange.$2",
"type": "Object",
"tags": [],
"label": "change",
"description": [],
"signature": [
{
"pluginId": "@kbn/management-settings-types",
"scope": "common",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-common.UnsavedFieldChange",
"text": "UnsavedFieldChange"
},
"<T> | undefined"
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.onClear",
"type": "Function",
"tags": [],
"label": "onClear",
"description": [
"\nThe onClear handler, if a value is cleared to an empty or default state."
],
"signature": [
"((id: string) => void) | undefined"
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.onClear.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"The id relating to the field to clear."
],
"signature": [
"string"
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProps.unsavedChange",
"type": "Object",
"tags": [],
"label": "unsavedChange",
"description": [
"The {@link UnsavedFieldChange} corresponding to any unsaved change to the field."
],
"signature": [
{
"pluginId": "@kbn/management-settings-types",
"scope": "common",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-common.UnsavedFieldChange",
"text": "UnsavedFieldChange"
},
"<",
{
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.UiSettingsType",
"text": "UiSettingsType"
},
"> | undefined"
],
"path": "packages/kbn-management/settings/components/field_row/field_row.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProviderProps",
"type": "Interface",
"tags": [],
"label": "FieldRowProviderProps",
"description": [
"\nProps for {@link FieldRowProvider}."
],
"signature": [
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowProviderProps",
"text": "FieldRowProviderProps"
},
" extends ",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.FieldRowServices",
"text": "FieldRowServices"
}
],
"path": "packages/kbn-management/settings/components/field_row/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowProviderProps.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "packages/kbn-management/settings/components/field_row/services.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.KibanaDependencies",
"type": "Interface",
"tags": [],
"label": "KibanaDependencies",
"description": [
"\nAn interface containing a collection of Kibana plugins and services required to\nrender a {@link FieldRow} component."
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.KibanaDependencies.docLinks",
"type": "Object",
"tags": [],
"label": "docLinks",
"description": [],
"signature": [
"{ links: { management: Record<string, string>; }; }"
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.Services",
"type": "Interface",
"tags": [],
"label": "Services",
"description": [
"\nContextual services used by a {@link FieldRow} component."
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.Services.links",
"type": "Object",
"tags": [],
"label": "links",
"description": [],
"signature": [
"{ [key: string]: string; }"
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowKibanaDependencies",
"type": "Type",
"tags": [],
"label": "FieldRowKibanaDependencies",
"description": [
"\nAn interface containing a collection of Kibana plugins and services required to\nrender a {@link FieldRow} component and its dependents."
],
"signature": [
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.KibanaDependencies",
"text": "KibanaDependencies"
},
" & ",
{
"pluginId": "@kbn/management-settings-components-field-input",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldInputPluginApi",
"section": "def-common.FieldInputKibanaDependencies",
"text": "FieldInputKibanaDependencies"
}
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.FieldRowServices",
"type": "Type",
"tags": [],
"label": "FieldRowServices",
"description": [
"\nContextual services used by a {@link FieldRow} component and its dependents."
],
"signature": [
{
"pluginId": "@kbn/management-settings-components-field-input",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldInputPluginApi",
"section": "def-common.FieldInputServices",
"text": "FieldInputServices"
},
" & ",
{
"pluginId": "@kbn/management-settings-components-field-row",
"scope": "common",
"docId": "kibKbnManagementSettingsComponentsFieldRowPluginApi",
"section": "def-common.Services",
"text": "Services"
}
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.RowOnChangeFn",
"type": "Type",
"tags": [],
"label": "RowOnChangeFn",
"description": [
"\nAn `onChange` handler for a {@link FieldRow} component."
],
"signature": [
"(id: string, change?: ",
{
"pluginId": "@kbn/management-settings-types",
"scope": "common",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-common.UnsavedFieldChange",
"text": "UnsavedFieldChange"
},
"<T> | undefined) => void"
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.RowOnChangeFn.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"A unique id corresponding to the particular setting being changed."
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/management-settings-components-field-row",
"id": "def-common.RowOnChangeFn.$2",
"type": "Object",
"tags": [],
"label": "change",
"description": [
"The {@link UnsavedFieldChange } corresponding to any unsaved change to the field."
],
"signature": [
{
"pluginId": "@kbn/management-settings-types",
"scope": "common",
"docId": "kibKbnManagementSettingsTypesPluginApi",
"section": "def-common.UnsavedFieldChange",
"text": "UnsavedFieldChange"
},
"<T> | undefined"
],
"path": "packages/kbn-management/settings/components/field_row/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink