Browse Source

Add a one line description to components on the React component list

Renée Kooi 7 years ago
parent
commit
c5131ff8dc
1 changed files with 14 additions and 10 deletions
  1. 14 10
      website/src/docs/react.md

+ 14 - 10
website/src/docs/react.md

@@ -54,16 +54,20 @@ const AvatarPicker = ({ currentAvatar }) => {
 
 The plugins that are available as React component wrappers are:
 
- - [Dashboard][]
- - [DashboardModal][]
- - [DragDrop][]
- - [ProgressBar][]
- - [StatusBar][]
+ - [<Dashboard />][] - renders an inline [Dashboard][]
+ - [<DashboardModal />][] - renders a [Dashboard][] modal
+ - [<DragDrop />][] - renders a [DragDrop][] area
+ - [<ProgressBar />][] - renders a [ProgressBar][]
+ - [<StatusBar />][] - renders a [StatusBar][]
 
 [React]: https://facebook.github.io/react
 [Preact]: https://preactjs.com/
-[Dashboard]: /docs/react/dashboard
-[DragDrop]: /docs/react/dragdrop
-[ProgressBar]: /docs/react/progressbar
-[StatusBar]: /docs/react/statusbar
-[DashboardModal]: /docs/react/dashboard-modal
+[<Dashboard />]: /docs/react/dashboard
+[<DragDrop />]: /docs/react/dragdrop
+[<ProgressBar />]: /docs/react/progressbar
+[<StatusBar />]: /docs/react/statusbar
+[<DashboardModal />]: /docs/react/dashboard-modal
+[Dashboard]: /docs/dashboard
+[DragDrop]: /docs/dragdrop
+[ProgressBar]: /docs/progressbar
+[StatusBar]: /docs/statusbar