kibana/api_docs/kbn_shared_ux_utility.devdocs.json

{
  "id": "@kbn/shared-ux-utility",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.dynamic",
        "type": "Function",
        "tags": [],
        "label": "dynamic",
        "description": [
          "\nLazy load and wrap with Suspense any component.\n"
        ],
        "signature": [
          "(loader: Loader<TElement>, options: ",
          {
            "pluginId": "@kbn/shared-ux-utility",
            "scope": "common",
            "docId": "kibKbnSharedUxUtilityPluginApi",
            "section": "def-common.DynamicOptions",
            "text": "DynamicOptions"
          },
          ") => React.ForwardRefExoticComponent<React.PropsWithoutRef<React.ComponentPropsWithRef<TElement>> & React.RefAttributes<TRef>>"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/dynamic/dynamic.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.dynamic.$1",
            "type": "Function",
            "tags": [],
            "label": "loader",
            "description": [],
            "signature": [
              "Loader<TElement>"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/dynamic/dynamic.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.dynamic.$2",
            "type": "Object",
            "tags": [],
            "label": "options",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/shared-ux-utility",
                "scope": "common",
                "docId": "kibKbnSharedUxUtilityPluginApi",
                "section": "def-common.DynamicOptions",
                "text": "DynamicOptions"
              }
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/dynamic/dynamic.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.Fallback",
        "type": "Function",
        "tags": [],
        "label": "Fallback",
        "description": [
          "\nA simple implementation of `React.Suspense.fallback` that renders a loading spinner."
        ],
        "signature": [
          "() => React.JSX.Element"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/fallback.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.getClosestLink",
        "type": "Function",
        "tags": [],
        "label": "getClosestLink",
        "description": [
          "\nReturns the closest anchor (`<a>`) element in the element parents (self included) up\nto the given container (excluded), or undefined if none is found."
        ],
        "signature": [
          "(element: HTMLElement | null | undefined, container?: HTMLElement | undefined) => HTMLAnchorElement | undefined"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.getClosestLink.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "element",
            "description": [],
            "signature": [
              "HTMLElement | null | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          },
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.getClosestLink.$2",
            "type": "Object",
            "tags": [],
            "label": "container",
            "description": [],
            "signature": [
              "HTMLElement | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.hasActiveModifierKey",
        "type": "Function",
        "tags": [],
        "label": "hasActiveModifierKey",
        "description": [
          "\nReturns true if any modifier key is active on the event, false otherwise."
        ],
        "signature": [
          "(event: React.MouseEvent<Element, MouseEvent>) => boolean"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/utils.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.hasActiveModifierKey.$1",
            "type": "Object",
            "tags": [],
            "label": "event",
            "description": [],
            "signature": [
              "React.MouseEvent<Element, MouseEvent>"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/utils.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.withSuspense",
        "type": "Function",
        "tags": [],
        "label": "withSuspense",
        "description": [
          "\nA HOC which supplies React.Suspense with a fallback component, and a `KibanaErrorBoundary` to contain errors."
        ],
        "signature": [
          "<P extends {}, R = {}>(Component: React.ComponentType<P>, fallback?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | null) => React.ForwardRefExoticComponent<React.PropsWithoutRef<P & ",
          {
            "pluginId": "@kbn/shared-ux-utility",
            "scope": "common",
            "docId": "kibKbnSharedUxUtilityPluginApi",
            "section": "def-common.WithSuspenseExtendedDeps",
            "text": "WithSuspenseExtendedDeps"
          },
          "> & React.RefAttributes<R>>"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/with_suspense.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.withSuspense.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "Component",
            "description": [
              "A component deferred by `React.lazy`"
            ],
            "signature": [
              "React.ComponentType<P>"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/with_suspense.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.withSuspense.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "fallback",
            "description": [
              "A fallback component to render while things load; default is `Fallback` from SharedUX."
            ],
            "signature": [
              "React.ReactElement<any, string | React.JSXElementConstructor<any>> | null"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/with_suspense.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.DynamicOptions",
        "type": "Interface",
        "tags": [],
        "label": "DynamicOptions",
        "description": [
          "\nOptions for the lazy loaded component"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/dynamic/dynamic.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.DynamicOptions.fallback",
            "type": "CompoundType",
            "tags": [],
            "label": "fallback",
            "description": [],
            "signature": [
              "string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/dynamic/dynamic.tsx",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-utility",
        "id": "def-common.WithSuspenseExtendedDeps",
        "type": "Interface",
        "tags": [],
        "label": "WithSuspenseExtendedDeps",
        "description": [
          "\nOptional services that the Suspense wrapper can use"
        ],
        "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/with_suspense.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-utility",
            "id": "def-common.WithSuspenseExtendedDeps.analytics",
            "type": "Object",
            "tags": [],
            "label": "analytics",
            "description": [
              "\nThe `AnalyticsServiceStart` object from `CoreStart`"
            ],
            "signature": [
              "AnalyticsServiceStart",
              " | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-shared-ux-utility/src/with_suspense.tsx",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}