kibana/packages/kbn-language-documentation-popover
2024-04-14 09:45:32 +02:00
..
.storybook
src [ES|QL] Query history design feedback (#180579) 2024-04-14 09:45:32 +02:00
index.ts [Lens] Use the language-documentation package for formula (#143649) 2022-10-21 09:00:27 +03:00
jest.config.js
kibana.jsonc Move esql code to the new kibana-esql team (#179454) 2024-03-27 07:47:08 +01:00
package.json [Lens] [ES|QL] Fixes inline documentation in cloud (#177774) 2024-02-25 14:32:45 +02:00
README.md
tsconfig.json [ES|QL] Use the shared ux Markdown component (#174320) 2024-02-12 10:47:36 +02:00

Shareable language documentation popover

This is a stateless shareable component that can be used to render documentation for a language as a popover.

It can be used in every application that would like to add an in-app documentation. The component consists of:

  • A sidebar navigation with a search
  • A details page
<LanguageDocumentationPopover language={language} sections={documentationSections} />

The properties are typed as:

 export interface LanguageDocumentationSections {
  groups: Array<{
    label: string;
    description?: string;
    items: Array<{ label: string; description?: JSX.Element }>;
  }>;
  initialSection: JSX.Element;
}