kibana/packages/kbn-language-documentation-popover
Joe Reuter 15c12bdd39
Rename all vis-editors and datavis to visualizations (#144589)
* rename all the vis-editors

* rename datavis to visualizations
2022-11-05 19:16:20 -04:00
..
.storybook Language documentation popover package (#143429) 2022-10-19 08:53:50 +03:00
src [Lens] Use the language-documentation package for formula (#143649) 2022-10-21 09:00:27 +03:00
BUILD.bazel [auto] migrate existing plugin/package configs 2022-10-28 14:06:46 -05:00
index.ts [Lens] Use the language-documentation package for formula (#143649) 2022-10-21 09:00:27 +03:00
jest.config.js Language documentation popover package (#143429) 2022-10-19 08:53:50 +03:00
kibana.jsonc Rename all vis-editors and datavis to visualizations (#144589) 2022-11-05 19:16:20 -04:00
package.json [auto] migrate existing plugin/package configs 2022-10-28 14:06:46 -05:00
README.md Language documentation popover package (#143429) 2022-10-19 08:53:50 +03:00
tsconfig.json fix(NA): wrongly spread stripInternal and rootDir configs across packages (#144463) 2022-11-03 01:04:55 +00: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;
}