UNPKG

778 BTypeScriptView Raw
1import { FunctionComponent } from 'react';
2import { DescriptionProps as PureDescriptionProps } from '@storybook/components';
3import { DocsContextProps } from './DocsContext';
4import { Component } from './types';
5export declare enum DescriptionType {
6 INFO = "info",
7 NOTES = "notes",
8 DOCGEN = "docgen",
9 LEGACY_5_2 = "legacy-5.2",
10 AUTO = "auto"
11}
12interface DescriptionProps {
13 of?: '.' | Component;
14 type?: DescriptionType;
15 markdown?: string;
16 children?: string;
17}
18export declare const getDescriptionProps: ({ of, type, markdown, children }: DescriptionProps, { id, storyById }: DocsContextProps<any>) => PureDescriptionProps;
19declare const DescriptionContainer: FunctionComponent<DescriptionProps>;
20export { DescriptionContainer as Description };