flipper/docs/ui-components.md at 20bd937d43fac10bb332c926de74525d7484d3e8

Files

Daniel Büchele 640dee6645 auto generated UI docs

Summary:
Using `react-docgen` to automatically generate docs for our UI components.
React-docgen parses the files in `components/ui` and using comments and flowtypes to generate structured information about the UI components.

For higher-order-components `react-docgen` is not able to get the information. As we are using HOC often as part of emotion's styled-components, I added a custom parser for HOCs. Using babel/parser I am parsing the components and using their doc-comments to generate the structured description.

Then, the description generated by react-docgen and my custom parser is used to generate markdown which is added to the `ui-components.md` file of our docs.

Plus: Added some styling around the documentation of props, mostly table styles.

Reviewed By: jknoxville

Differential Revision: D12896110

fbshipit-source-id: 1337c924c06e10a5d3aa752579428fd2cc7b4743

2018-11-05 03:12:23 -08:00

212 B

Raw Blame History

id, title, sidebar_label

id	title	sidebar_label
ui-components	UI Components	UI Components

Flipper has a lot of built in React components to build UIs. You can import them directly using e.g. import {Button} from 'flipper'.

212 B Raw Blame History

212 B

Raw Blame History