README.md

React Typescript Document Generator

Documentation generator for React Components written in Typescript.

This exists to generate docs for your react components.

It extracts documentation from your components and their props.

Usage

Use tsdoc-style comments for your components:

/**

*/

Your components must either be classes that inherit from React.Component<P,S> or, if you're using new-style function components, then they should be declared as variables of type React.FunctionComponent<P>.

Examples:

interface ILabelProps {
    /**
    *  the label text to be set
    */
    value: string;
}

/**
* A simple component to render a static label
*/
const Label:React.Component<ILabelProps> = (props) =>  <span>{props.value}</span>;


/**
* A simple component to render a static label
*/
class Label2 extends React.Component<ILabelProps,{}> {
    render() {
        return <span>{this.props.value}</span>;
    }
}

Commands

react-tsdoc types <output.d.ts> --module-name