kibana/api_docs/kbn_language_documentation.devdocs.json

{
  "id": "@kbn/language-documentation",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/language-documentation",
        "id": "def-common.LanguageDocumentationFlyout",
        "type": "Function",
        "tags": [],
        "label": "LanguageDocumentationFlyout",
        "description": [],
        "signature": [
          "React.NamedExoticComponent<DocumentationFlyoutProps> & { readonly type: ({ searchInDescription, linkToDocumentation, isHelpMenuOpen, onHelpMenuVisibilityChange, }: DocumentationFlyoutProps) => React.JSX.Element; }"
        ],
        "path": "src/platform/packages/private/kbn-language-documentation/src/components/as_flyout/index.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/language-documentation",
            "id": "def-common.LanguageDocumentationFlyout.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/ts5.0/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/language-documentation",
        "id": "def-common.LanguageDocumentationInline",
        "type": "Function",
        "tags": [],
        "label": "LanguageDocumentationInline",
        "description": [],
        "signature": [
          "React.NamedExoticComponent<DocumentationInlineProps> & { readonly type: ({ searchInDescription, height }: DocumentationInlineProps) => React.JSX.Element; }"
        ],
        "path": "src/platform/packages/private/kbn-language-documentation/src/components/as_inline/index.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/language-documentation",
            "id": "def-common.LanguageDocumentationInline.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/ts5.0/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/language-documentation",
        "id": "def-common.LanguageDocumentationPopover",
        "type": "Function",
        "tags": [],
        "label": "LanguageDocumentationPopover",
        "description": [],
        "signature": [
          "React.NamedExoticComponent<DocumentationPopoverProps> & { readonly type: ({ language, sections, buttonProps, searchInDescription, linkToDocumentation, isHelpMenuOpen, onHelpMenuVisibilityChange, }: DocumentationPopoverProps) => React.JSX.Element; }"
        ],
        "path": "src/platform/packages/private/kbn-language-documentation/src/components/as_popover/index.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/language-documentation",
            "id": "def-common.LanguageDocumentationPopover.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/ts5.0/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/language-documentation",
        "id": "def-common.LanguageDocumentationPopoverContent",
        "type": "Function",
        "tags": [],
        "label": "LanguageDocumentationPopoverContent",
        "description": [],
        "signature": [
          "React.NamedExoticComponent<DocumentationProps> & { readonly type: ({ language, sections, searchInDescription, linkToDocumentation, }: DocumentationProps) => React.JSX.Element; }"
        ],
        "path": "src/platform/packages/private/kbn-language-documentation/src/components/as_popover/popover_content.tsx",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/language-documentation",
            "id": "def-common.LanguageDocumentationPopoverContent.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "props",
            "description": [],
            "signature": [
              "P"
            ],
            "path": "node_modules/@types/react/ts5.0/index.d.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/language-documentation",
        "id": "def-common.LanguageDocumentationSections",
        "type": "Interface",
        "tags": [],
        "label": "LanguageDocumentationSections",
        "description": [],
        "path": "src/platform/packages/private/kbn-language-documentation/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/language-documentation",
            "id": "def-common.LanguageDocumentationSections.groups",
            "type": "Array",
            "tags": [],
            "label": "groups",
            "description": [],
            "signature": [
              "{ label: string; description?: string | undefined; items: { label: string; description?: JSX.Element | undefined; }[]; }[]"
            ],
            "path": "src/platform/packages/private/kbn-language-documentation/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/language-documentation",
            "id": "def-common.LanguageDocumentationSections.initialSection",
            "type": "Object",
            "tags": [],
            "label": "initialSection",
            "description": [],
            "signature": [
              "JSX.Element"
            ],
            "path": "src/platform/packages/private/kbn-language-documentation/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}