kibana/packages/kbn-language-documentation-popover/README.md
Stratoula Kalafateli 9656163820
Language documentation popover package (#143429)
* Language documentation popover package

* Add readme

* [CI] Auto-commit changed files from 'node scripts/generate packages_build_manifest'

* [CI] Auto-commit changed files from 'node scripts/generate codeowners'

* Move the entire popover into the package, add stories

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2022-10-19 08:53:50 +03:00

671 B

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;
}