kibana/api_docs/kbn_shared_ux_card_no_data.devdocs.json

{
  "id": "@kbn/shared-ux-card-no-data",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCard",
        "type": "Function",
        "tags": [],
        "label": "NoDataCard",
        "description": [],
        "signature": [
          "({ href: srcHref, category, description, ...props }: ",
          "NoDataCardComponentProps",
          ") => JSX.Element"
        ],
        "path": "packages/shared-ux/card/no_data/impl/src/no_data_card.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-card-no-data",
            "id": "def-common.NoDataCard.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{ href: srcHref, category, description, ...props }",
            "description": [],
            "signature": [
              "NoDataCardComponentProps"
            ],
            "path": "packages/shared-ux/card/no_data/impl/src/no_data_card.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCardKibanaProvider",
        "type": "Function",
        "tags": [],
        "label": "NoDataCardKibanaProvider",
        "description": [
          "\nKibana-specific Provider that maps dependencies to services."
        ],
        "signature": [
          "({ children, ...dependencies }: React.PropsWithChildren<",
          "NoDataCardKibanaDependencies",
          ">) => JSX.Element"
        ],
        "path": "packages/shared-ux/card/no_data/impl/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-card-no-data",
            "id": "def-common.NoDataCardKibanaProvider.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  children,\n  ...dependencies\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "NoDataCardKibanaDependencies",
              ">"
            ],
            "path": "packages/shared-ux/card/no_data/impl/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCardProvider",
        "type": "Function",
        "tags": [],
        "label": "NoDataCardProvider",
        "description": [
          "\nA Context Provider that provides services to the component and its dependencies."
        ],
        "signature": [
          "({ children, ...services }: React.PropsWithChildren<",
          "NoDataCardServices",
          ">) => JSX.Element"
        ],
        "path": "packages/shared-ux/card/no_data/impl/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-card-no-data",
            "id": "def-common.NoDataCardProvider.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{ children, ...services }",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "NoDataCardServices",
              ">"
            ],
            "path": "packages/shared-ux/card/no_data/impl/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCardComponentProps",
        "type": "Type",
        "tags": [],
        "label": "NoDataCardComponentProps",
        "description": [
          "\nProps for the `NoDataCard` pure component."
        ],
        "signature": [
          "Partial<Omit<",
          "EuiCardProps",
          ", \"description\" | \"onClick\" | \"isDisabled\" | \"layout\" | \"button\">> & { button?: React.ReactNode; onClick?: React.MouseEventHandler<HTMLElement> | undefined; description?: React.ReactNode; category?: string | undefined; canAccessFleet?: boolean | undefined; }"
        ],
        "path": "packages/shared-ux/card/no_data/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCardKibanaDependencies",
        "type": "Type",
        "tags": [],
        "label": "NoDataCardKibanaDependencies",
        "description": [
          "\nAn interface containing a collection of Kibana plugins and services required to\nrender this component as well as any dependencies."
        ],
        "signature": [
          "KibanaDependencies",
          " & ",
          "RedirectAppLinksKibanaDependencies"
        ],
        "path": "packages/shared-ux/card/no_data/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCardProps",
        "type": "Type",
        "tags": [],
        "label": "NoDataCardProps",
        "description": [
          "\nProps for the `NoDataCard` sevice-connected component."
        ],
        "signature": [
          "Partial<Omit<",
          "EuiCardProps",
          ", \"description\" | \"onClick\" | \"isDisabled\" | \"layout\" | \"button\">> & { button?: React.ReactNode; onClick?: React.MouseEventHandler<HTMLElement> | undefined; description?: React.ReactNode; category?: string | undefined; canAccessFleet?: boolean | undefined; }"
        ],
        "path": "packages/shared-ux/card/no_data/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-card-no-data",
        "id": "def-common.NoDataCardServices",
        "type": "Type",
        "tags": [],
        "label": "NoDataCardServices",
        "description": [
          "\nServices that are consumed by this component and any dependencies."
        ],
        "signature": [
          "Services",
          " & ",
          "RedirectAppLinksServices"
        ],
        "path": "packages/shared-ux/card/no_data/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}