src/platform/packages/private/kbn-language-documentation/README.md
This is a stateless shareable component that can be used to render documentation for a language as a popover, flyour or a React component that you can add in your applications as you wish.
It can be used in every application that would like to add an in-app documentation. The component consists of:
<LanguageDocumentationPopover language={language} sections={documentationSections} onHelpMenuVisibilityChange={onHelpMenuVisibilityChange} isHelpMenuOpen={isHelpMenuOpen} />
<LanguageDocumentationFlyout linkToDocumentation={docLinks?.links?.query?.queryESQL ?? ''} isHelpMenuOpen={isLanguageComponentOpen} onHelpMenuVisibilityChange={setIsLanguageComponentOpen} />
<LanguageDocumentationInline />
The properties are typed as:
export interface LanguageDocumentationSections {
groups: Array<{
label: string;
description?: string;
items: Array<{ label: string; description?: JSX.Element }>;
}>;
initialSection: JSX.Element;
}