@cimpress/react-components/dist/src/documentation/ComponentDoc.d.ts

React components to support the MCP styleguide

import React, { ReactElement, ReactNode } from 'react';
import { PropInfo } from './PropInfo';
export interface ComponentDocProps<T> {
    /**
     * Children for the component doc, usually a demo of the component and the code example.
     */
    children?: ReactNode;
    /**
     * Header for the code demo, if desired.
     */
    demoName?: string;
    /**
     * The name of the component being documented.
     */
    name: string;
    /**
     * Array of `PropInfo` components to document the props.
     */
    propInfos: PropInfo<T>[];
    /**
     * Additional remarks or notes about the component.
     */
    remarks?: ReactElement<any>;
}
export declare function ComponentDoc<T>({ name, demoName, propInfos, remarks, children }: ComponentDocProps<T>): React.JSX.Element;
//# sourceMappingURL=ComponentDoc.d.ts.map