@cimpress/react-components/dist/esm/docs/components/documentation/index.js

React components to support the MCP styleguide

import React from 'react';
import { CodeExample } from '@cimpress/react-components';
import DemoDocsCode from '!raw-loader!./documentation.jsx';
import DemoDocs from './documentation.jsx';
import ComponentDoc from '../../shared/TabbedComponentDoc';
const DocumentationDocs = () => {
    const codePropInfos = [
        {
            name: 'code',
            type: 'string (required)',
            default: '',
            description: 'The code to display, as a string.',
        },
        {
            name: 'initialOpen',
            type: 'boolean',
            default: 'true',
            description: 'Whether the code example should start open or collapsed.',
        },
    ];
    const propInfos = [
        {
            name: 'name',
            type: 'string (required)',
            default: '',
            description: 'The name of the component being documented.',
        },
        {
            name: 'demoName',
            type: 'string',
            default: 'Demo',
            description: 'Header for the code demo, if desired.',
        },
        {
            name: 'propInfos',
            type: 'array of {name: string, type: string, default: string, description: string}',
            default: '',
            description: React.createElement("span", null, "Array of objects representing prop info to document the props."),
        },
        {
            name: 'remarks',
            type: 'element',
            default: '',
            description: 'Additional remarks or notes about the component',
        },
        {
            name: 'children',
            type: 'node',
            default: '',
            description: 'Children for the component doc -- usually a demo of the component and the code example',
        },
    ];
    return (React.createElement("div", null,
        React.createElement(ComponentDoc, { name: "Documentation" }),
        React.createElement(ComponentDoc, { name: "ComponentDoc", propInfos: propInfos, includeTabs: false }),
        React.createElement(ComponentDoc, { name: "CodeExample", propInfos: codePropInfos, includeTabs: false },
            React.createElement(DemoDocs, null),
            React.createElement(CodeExample, { code: DemoDocsCode }))));
};
export default DocumentationDocs;
//# sourceMappingURL=index.js.map