kibana/api_docs/kbn_react_kibana_mount.devdocs.json

{
  "id": "@kbn/react-kibana-mount",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/react-kibana-mount",
        "id": "def-public.MountPointPortal",
        "type": "Function",
        "tags": [],
        "label": "MountPointPortal",
        "description": [
          "\nUtility component to portal a part of a react application into the provided `MountPoint`."
        ],
        "signature": [
          "({ children, setMountPoint, }: React.PropsWithChildren<",
          {
            "pluginId": "@kbn/react-kibana-mount",
            "scope": "public",
            "docId": "kibKbnReactKibanaMountPluginApi",
            "section": "def-public.MountPointPortalProps",
            "text": "MountPointPortalProps"
          },
          ">) => React.ReactPortal | null"
        ],
        "path": "src/platform/packages/shared/react/kibana_mount/mount_point_portal.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-mount",
            "id": "def-public.MountPointPortal.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  children,\n  setMountPoint,\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              {
                "pluginId": "@kbn/react-kibana-mount",
                "scope": "public",
                "docId": "kibKbnReactKibanaMountPluginApi",
                "section": "def-public.MountPointPortalProps",
                "text": "MountPointPortalProps"
              },
              ">"
            ],
            "path": "src/platform/packages/shared/react/kibana_mount/mount_point_portal.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/react-kibana-mount",
        "id": "def-public.toMountPoint",
        "type": "Function",
        "tags": [],
        "label": "toMountPoint",
        "description": [
          "\nMountPoint converter for react nodes.\n"
        ],
        "signature": [
          "(node: React.ReactNode, params: ",
          {
            "pluginId": "@kbn/react-kibana-mount",
            "scope": "public",
            "docId": "kibKbnReactKibanaMountPluginApi",
            "section": "def-public.ToMountPointParams",
            "text": "ToMountPointParams"
          },
          ") => ",
          "MountPoint",
          "<HTMLElement>"
        ],
        "path": "src/platform/packages/shared/react/kibana_mount/to_mount_point.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-mount",
            "id": "def-public.toMountPoint.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "node",
            "description": [
              "React node to get a mount point for"
            ],
            "signature": [
              "React.ReactNode"
            ],
            "path": "src/platform/packages/shared/react/kibana_mount/to_mount_point.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          },
          {
            "parentPluginId": "@kbn/react-kibana-mount",
            "id": "def-public.toMountPoint.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "params",
            "description": [
              "services needed for rendering fully-featured React nodes in Kibana"
            ],
            "signature": [
              {
                "pluginId": "@kbn/react-kibana-mount",
                "scope": "public",
                "docId": "kibKbnReactKibanaMountPluginApi",
                "section": "def-public.ToMountPointParams",
                "text": "ToMountPointParams"
              }
            ],
            "path": "src/platform/packages/shared/react/kibana_mount/to_mount_point.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/react-kibana-mount",
        "id": "def-public.useIfMounted",
        "type": "Function",
        "tags": [],
        "label": "useIfMounted",
        "description": [],
        "signature": [
          "() => (func?: (() => void) | undefined) => void"
        ],
        "path": "src/platform/packages/shared/react/kibana_mount/utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/react-kibana-mount",
        "id": "def-public.MountPointPortalProps",
        "type": "Interface",
        "tags": [],
        "label": "MountPointPortalProps",
        "description": [],
        "path": "src/platform/packages/shared/react/kibana_mount/mount_point_portal.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/react-kibana-mount",
            "id": "def-public.MountPointPortalProps.setMountPoint",
            "type": "Function",
            "tags": [],
            "label": "setMountPoint",
            "description": [],
            "signature": [
              "(mountPoint: ",
              "MountPoint",
              "<HTMLElement> | undefined) => void | UnsetMountPointFn"
            ],
            "path": "src/platform/packages/shared/react/kibana_mount/mount_point_portal.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "returnComment": [],
            "children": [
              {
                "parentPluginId": "@kbn/react-kibana-mount",
                "id": "def-public.MountPointPortalProps.setMountPoint.$1",
                "type": "Function",
                "tags": [],
                "label": "mountPoint",
                "description": [],
                "signature": [
                  "MountPoint",
                  "<HTMLElement> | undefined"
                ],
                "path": "src/platform/packages/shared/react/kibana_mount/mount_point_portal.tsx",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          },
          {
            "parentPluginId": "@kbn/react-kibana-mount",
            "id": "def-public.MountPointPortalProps.children",
            "type": "CompoundType",
            "tags": [],
            "label": "children",
            "description": [],
            "signature": [
              "string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
            ],
            "path": "src/platform/packages/shared/react/kibana_mount/mount_point_portal.tsx",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/react-kibana-mount",
        "id": "def-public.ToMountPointParams",
        "type": "Type",
        "tags": [],
        "label": "ToMountPointParams",
        "description": [],
        "signature": [
          "RenderingService",
          " | ToMountPointParamsDeprecated"
        ],
        "path": "src/platform/packages/shared/react/kibana_mount/to_mount_point.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}