kibana/api_docs/kbn_shared_ux_components.devdocs.json

{
  "id": "@kbn/shared-ux-components",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/shared-ux-components",
        "id": "def-common.KibanaPageTemplate",
        "type": "Function",
        "tags": [],
        "label": "KibanaPageTemplate",
        "description": [],
        "signature": [
          "({ template, className, children, solutionNav, noDataConfig, ...rest }: React.PropsWithChildren<",
          {
            "pluginId": "@kbn/shared-ux-components",
            "scope": "common",
            "docId": "kibKbnSharedUxComponentsPluginApi",
            "section": "def-common.KibanaPageTemplateProps",
            "text": "KibanaPageTemplateProps"
          },
          ">) => JSX.Element"
        ],
        "path": "packages/kbn-shared-ux-components/src/page_template/page_template.tsx",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.KibanaPageTemplate.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  template,\n  className,\n  children,\n  solutionNav,\n  noDataConfig,\n  ...rest\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              {
                "pluginId": "@kbn/shared-ux-components",
                "scope": "common",
                "docId": "kibKbnSharedUxComponentsPluginApi",
                "section": "def-common.KibanaPageTemplateProps",
                "text": "KibanaPageTemplateProps"
              },
              ">"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/page_template.tsx",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-components",
        "id": "def-common.KibanaPageTemplateSolutionNav",
        "type": "Function",
        "tags": [],
        "label": "KibanaPageTemplateSolutionNav",
        "description": [
          "\nA wrapper around EuiSideNav but also creates the appropriate title with optional solution logo"
        ],
        "signature": [
          "({ children, headingProps, icon, isOpenOnDesktop, items, mobileBreakpoints, closeFlyoutButtonPosition, name, onCollapse, canBeCollapsed, ...rest }: React.PropsWithChildren<",
          "KibanaPageTemplateSolutionNavProps",
          ">) => JSX.Element"
        ],
        "path": "packages/kbn-shared-ux-components/src/page_template/solution_nav/solution_nav.tsx",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.KibanaPageTemplateSolutionNav.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "{\n  children,\n  headingProps,\n  icon,\n  isOpenOnDesktop = false,\n  items,\n  mobileBreakpoints = ['xs', 's'],\n  closeFlyoutButtonPosition = 'outside',\n  name,\n  onCollapse,\n  canBeCollapsed = true,\n  ...rest\n}",
            "description": [],
            "signature": [
              "React.PropsWithChildren<",
              "KibanaPageTemplateSolutionNavProps",
              ">"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/solution_nav/solution_nav.tsx",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/shared-ux-components",
        "id": "def-common.NoDataConfigPage",
        "type": "Function",
        "tags": [],
        "label": "NoDataConfigPage",
        "description": [],
        "signature": [
          "(props: ",
          {
            "pluginId": "@kbn/shared-ux-components",
            "scope": "common",
            "docId": "kibKbnSharedUxComponentsPluginApi",
            "section": "def-common.KibanaPageTemplateProps",
            "text": "KibanaPageTemplateProps"
          },
          ") => JSX.Element | null"
        ],
        "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_config_page/no_data_config_page.tsx",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.NoDataConfigPage.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/shared-ux-components",
                "scope": "common",
                "docId": "kibKbnSharedUxComponentsPluginApi",
                "section": "def-common.KibanaPageTemplateProps",
                "text": "KibanaPageTemplateProps"
              }
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_config_page/no_data_config_page.tsx",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/shared-ux-components",
        "id": "def-common.NoDataPageProps",
        "type": "Interface",
        "tags": [],
        "label": "NoDataPageProps",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/shared-ux-components",
            "scope": "common",
            "docId": "kibKbnSharedUxComponentsPluginApi",
            "section": "def-common.NoDataPageProps",
            "text": "NoDataPageProps"
          },
          " extends ",
          "CommonProps"
        ],
        "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.NoDataPageProps.solution",
            "type": "string",
            "tags": [],
            "label": "solution",
            "description": [
              "\nSingle name for the current solution, used to auto-generate the title, logo, description, and button label"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.NoDataPageProps.logo",
            "type": "string",
            "tags": [],
            "label": "logo",
            "description": [
              "\nOptionally replace the auto-generated logo"
            ],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.NoDataPageProps.docsLink",
            "type": "string",
            "tags": [],
            "label": "docsLink",
            "description": [
              "\nRequired to set the docs link for the whole solution"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.NoDataPageProps.pageTitle",
            "type": "string",
            "tags": [],
            "label": "pageTitle",
            "description": [
              "\nOptionally replace the auto-generated page title (h1)"
            ],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "@kbn/shared-ux-components",
            "id": "def-common.NoDataPageProps.action",
            "type": "Object",
            "tags": [],
            "label": "action",
            "description": [
              "\nAn object of `NoDataPageActions`.\nUse `elasticAgent` as the primary key for pre-configured cards of this type.\nOtherwise use a custom key that contains `EuiCard` props."
            ],
            "signature": [
              "{ [x: string]: ",
              "NoDataCardProps",
              "; }"
            ],
            "path": "packages/kbn-shared-ux-components/src/page_template/no_data_page/types.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/shared-ux-components",
        "id": "def-common.KibanaPageTemplateProps",
        "type": "Type",
        "tags": [],
        "label": "KibanaPageTemplateProps",
        "description": [],
        "signature": [
          "Omit<",
          "EuiPageProps",
          ", \"paddingSize\"> & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ",
          "EuiPageSideBarProps",
          " | undefined; pageHeader?: ",
          "EuiPageHeaderProps",
          " | undefined; pageBodyProps?: ",
          "EuiPageBodyProps",
          "<\"main\"> | undefined; pageContentProps?: ",
          "EuiPageContentProps",
          " | undefined; pageContentBodyProps?: ",
          "EuiPageContentBodyProps",
          " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ",
          "EuiBottomBarProps",
          " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ",
          "Property",
          ".MinHeight<string | number> | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ",
          "KibanaPageTemplateSolutionNavProps",
          " | undefined; noDataConfig?: ",
          {
            "pluginId": "@kbn/shared-ux-components",
            "scope": "common",
            "docId": "kibKbnSharedUxComponentsPluginApi",
            "section": "def-common.NoDataPageProps",
            "text": "NoDataPageProps"
          },
          " | undefined; }"
        ],
        "path": "packages/kbn-shared-ux-components/src/page_template/types.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}