kibana/api_docs/kbn_shared_ux_page_kibana_template.devdocs.json

{
  "id": "@kbn/shared-ux-page-kibana-template",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.KibanaPageTemplate",
        "type": "Function",
        "tags": [],
        "label": "KibanaPageTemplate",
        "description": [
          "\nKibana-specific wrapper of EuiPageTemplate and it's namespaced components"
        ],
        "signature": [
          "React.FC<",
          "KibanaPageTemplateProps",
          "> & { Sidebar: React.FunctionComponent<",
          "EuiPageSidebarProps",
          ">; Header: React.FunctionComponent<",
          "EuiPageHeaderProps",
          ">; Section: React.FunctionComponent<",
          "EuiPageSectionProps",
          ">; BottomBar: React.FunctionComponent<",
          "_EuiPageBottomBarProps",
          ">; EmptyPrompt: React.FunctionComponent<",
          "_EuiPageEmptyPromptProps",
          ">; }"
        ],
        "path": "packages/shared-ux/page/kibana_template/impl/src/page_template.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-page-kibana-template",
            "id": "def-common.KibanaPageTemplate.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P & { children?: React.ReactNode; }"
            ],
            "path": "node_modules/@types/react/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/shared-ux-page-kibana-template",
            "id": "def-common.KibanaPageTemplate.$2",
            "type": "Any",
            "tags": [],
            "label": "context",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "node_modules/@types/react/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.KibanaPageTemplateKibanaProvider",
        "type": "Function",
        "tags": [],
        "label": "KibanaPageTemplateKibanaProvider",
        "description": [
          "\nKibana-specific Provider that maps dependencies to services."
        ],
        "signature": [
          "({ children, ...dependencies }: React.PropsWithChildren<",
          "NoDataCardKibanaDependencies",
          ">) => JSX.Element"
        ],
        "path": "packages/shared-ux/page/kibana_template/impl/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-page-kibana-template",
            "id": "def-common.KibanaPageTemplateKibanaProvider.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  children,\n  ...dependencies\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "NoDataCardKibanaDependencies",
              ">"
            ],
            "path": "packages/shared-ux/page/kibana_template/impl/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.KibanaPageTemplateProvider",
        "type": "Function",
        "tags": [],
        "label": "KibanaPageTemplateProvider",
        "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/page/kibana_template/impl/src/services.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-page-kibana-template",
            "id": "def-common.KibanaPageTemplateProvider.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  children,\n  ...services\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "NoDataCardServices",
              ">"
            ],
            "path": "packages/shared-ux/page/kibana_template/impl/src/services.tsx",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.KibanaPageTemplateKibanaDependencies",
        "type": "Type",
        "tags": [],
        "label": "KibanaPageTemplateKibanaDependencies",
        "description": [],
        "signature": [
          "KibanaDependencies",
          " & ",
          "RedirectAppLinksKibanaDependencies"
        ],
        "path": "packages/shared-ux/page/kibana_template/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.KibanaPageTemplateProps",
        "type": "Type",
        "tags": [],
        "label": "KibanaPageTemplateProps",
        "description": [],
        "signature": [
          "_EuiPageOuterProps",
          " & Omit<any, \"border\" | \"component\"> & ",
          "_EuiPageRestrictWidth",
          " & ",
          "_EuiPageBottomBorder",
          " & { contentBorder?: any; minHeight?: ",
          "Property",
          ".MinHeight<string | number> | undefined; offset?: number | undefined; mainProps?: (",
          "CommonProps",
          " & React.HTMLAttributes<HTMLElement>) | undefined; component?: ",
          "ComponentTypes",
          " | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ",
          {
            "pluginId": "@kbn/shared-ux-page-solution-nav",
            "scope": "common",
            "docId": "kibKbnSharedUxPageSolutionNavPluginApi",
            "section": "def-common.SolutionNavProps",
            "text": "SolutionNavProps"
          },
          " | undefined; noDataConfig?: ",
          "NoDataPageProps",
          " | undefined; pageHeader?: ",
          "EuiPageHeaderProps",
          " | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ",
          "EuiPageSidebarProps",
          " | undefined; }"
        ],
        "path": "packages/shared-ux/page/kibana_template/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.KibanaPageTemplateServices",
        "type": "Type",
        "tags": [],
        "label": "KibanaPageTemplateServices",
        "description": [],
        "signature": [
          "Services",
          " & ",
          "RedirectAppLinksServices"
        ],
        "path": "packages/shared-ux/page/kibana_template/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-page-kibana-template",
        "id": "def-common.NoDataConfig",
        "type": "Type",
        "tags": [],
        "label": "NoDataConfig",
        "description": [],
        "signature": [
          "NoDataPageProps"
        ],
        "path": "packages/shared-ux/page/no_data_config/types/index.d.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}