kibana/api_docs/kbn_content_management_content_editor.devdocs.json

{
  "id": "@kbn/content-management-content-editor",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/content-management-content-editor",
        "id": "def-public.ContentEditorKibanaProvider",
        "type": "Function",
        "tags": [],
        "label": "ContentEditorKibanaProvider",
        "description": [
          "\nKibana-specific Provider that maps to known dependency types."
        ],
        "signature": [
          "({ children, ...services }: React.PropsWithChildren<",
          "ContentEditorKibanaDependencies",
          ">) => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/content-management-content-editor",
            "id": "def-public.ContentEditorKibanaProvider.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{ children, ...services }",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "ContentEditorKibanaDependencies",
              ">"
            ],
            "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/content-management-content-editor",
        "id": "def-public.ContentEditorProvider",
        "type": "Function",
        "tags": [],
        "label": "ContentEditorProvider",
        "description": [
          "\nAbstract external service Provider."
        ],
        "signature": [
          "({ children, ...services }: React.PropsWithChildren<",
          "Services",
          ">) => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/content-management-content-editor",
            "id": "def-public.ContentEditorProvider.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  children,\n  ...services\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "Services",
              ">"
            ],
            "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/content-management-content-editor",
        "id": "def-public.useOpenContentEditor",
        "type": "Function",
        "tags": [],
        "label": "useOpenContentEditor",
        "description": [],
        "signature": [
          "() => (args: ",
          {
            "pluginId": "@kbn/content-management-content-editor",
            "scope": "public",
            "docId": "kibKbnContentManagementContentEditorPluginApi",
            "section": "def-public.OpenContentEditorParams",
            "text": "OpenContentEditorParams"
          },
          ") => () => void"
        ],
        "path": "src/platform/packages/shared/content-management/content_editor/src/open_content_editor.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/content-management-content-editor",
        "id": "def-public.SavedObjectsReference",
        "type": "Interface",
        "tags": [],
        "label": "SavedObjectsReference",
        "description": [],
        "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/content-management-content-editor",
            "id": "def-public.SavedObjectsReference.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/content-management-content-editor",
            "id": "def-public.SavedObjectsReference.name",
            "type": "string",
            "tags": [],
            "label": "name",
            "description": [],
            "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/content-management-content-editor",
            "id": "def-public.SavedObjectsReference.type",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "path": "src/platform/packages/shared/content-management/content_editor/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/content-management-content-editor",
        "id": "def-public.OpenContentEditorParams",
        "type": "Type",
        "tags": [],
        "label": "OpenContentEditorParams",
        "description": [],
        "signature": [
          "{ onSave?: ((args: { id: string; title: string; description?: string | undefined; tags: string[]; }) => Promise<void>) | undefined; item: ",
          "Item",
          "; isReadonly?: boolean | undefined; readonlyReason?: string | undefined; entityName: string; customValidators?: ",
          "CustomValidators",
          " | undefined; appendRows?: React.ReactNode; }"
        ],
        "path": "src/platform/packages/shared/content-management/content_editor/src/open_content_editor.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}