{"repo":"atlassian/extract-react-types","free":true,"listed":false,"github":"https://github.com/atlassian/extract-react-types","clone":"git clone https://github.com/atlassian/extract-react-types.git","description":"One stop shop for documenting your react components.","language":"JavaScript","stars":188,"topics":["babel-plugin","prop-types","react-components","typescript","docs-as-code","docs","docgen","docgenerator"],"license":"MIT","category":"ui-components","readme_excerpt":"Extract React Types One stop shop to document your react components. Getting started 🏁 Step 1: Install npm install --save-dev babel-plugin-extract-react-types pretty-proptypes Step 2: Annotate your prop types Step 3: Output prop types pretty-proptypes can display props from two sources. Option 1. Using babel-plugin-extract-react-types and passing the component to Props .babelrc Option 2. Directly passing a component's props to Props with extract-react-types-loader or getting types from extract-react-types and writing it to a file This analyses prop type definitions, and default props. It creates descriptions from comments before the type definitions, and will render markdown syntax using react-markings. Packages 1. extract-react-types Extract Flow & TypeScript types from React Components 2. extract-react-types-loader Webpack loader for extract-react-types 3. babel-plugin-extract-react-types A Babel plugin to store the types of React components as a property on the component for documentation 4. kind2string kind2string is designed to take the data structures output by extract-react-types and convert it down to a (useful) string. 5. pretty-proptypes PrettyPropTypes is designed to display the output of extract-react-types and display rich prop information for consumers. Contribute Pull requests, issues and comments welcome - please read our contributing guidelines and our code of conduct.","default_branch":null,"files":null,"tree":[],"storefront":"/r/atlassian","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/atlassian/extract-react-types/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}