Explorar el Código

uppy-react: Add some semi jsdoc to Dashboard components.

René Kooi hace 8 años
padre
commit
82960df150
Se han modificado 2 ficheros con 13 adiciones y 3 borrados
  1. 5 0
      src/uppy-react/Dashboard.js
  2. 8 3
      src/uppy-react/DashboardModal.js

+ 5 - 0
src/uppy-react/Dashboard.js

@@ -4,6 +4,11 @@ const DashboardPlugin = require('../plugins/Dashboard')
 
 
 const h = React.createElement
 const h = React.createElement
 
 
+/**
+ * React Component that renders a Dashboard for an Uppy instance. This component
+ * renders the Dashboard inline, so you can put it anywhere you want.
+ */
+
 class Dashboard extends React.Component {
 class Dashboard extends React.Component {
   componentDidMount () {
   componentDidMount () {
     const uppy = this.props.uppy
     const uppy = this.props.uppy

+ 8 - 3
src/uppy-react/DashboardModal.js

@@ -4,7 +4,12 @@ const ReactDashboardPlugin = require('./bridge/ReactDashboardPlugin')
 
 
 const h = React.createElement
 const h = React.createElement
 
 
-class Dashboard extends React.Component {
+/**
+ * React Component that renders a Dashboard for an Uppy instance in a Modal
+ * dialog. Visibility of the Modal is toggled using the `open` prop.
+ */
+
+class DashboardModal extends React.Component {
   componentDidMount () {
   componentDidMount () {
     const uppy = this.props.uppy
     const uppy = this.props.uppy
     uppy.use(ReactDashboardPlugin, {
     uppy.use(ReactDashboardPlugin, {
@@ -35,9 +40,9 @@ class Dashboard extends React.Component {
   }
   }
 }
 }
 
 
-Dashboard.propTypes = {
+DashboardModal.propTypes = {
   uppy: React.PropTypes.instanceOf(UppyCore).isRequired,
   uppy: React.PropTypes.instanceOf(UppyCore).isRequired,
   onRequestClose: React.PropTypes.func
   onRequestClose: React.PropTypes.func
 }
 }
 
 
-module.exports = Dashboard
+module.exports = DashboardModal