From b5b831f47280d3cf423bf26a5ab6eead1a67de1c Mon Sep 17 00:00:00 2001
From: Demetriad Sinzeanu <demetriad.sinzeanu@thinslices.com>
Date: Tue, 27 Nov 2018 13:18:16 +0200
Subject: [PATCH] docs(ManuscriptFiles): Wrote documentation for
ManuscriptFiles component
---
.../src/contextualBoxes/AuthorReviews.js | 2 +-
.../manuscriptDetails/ManuscriptDetailsTop.js | 4 +-
.../src/submissionRevision/ManuscriptFiles.js | 37 +++++++++++++++++++
3 files changed, 40 insertions(+), 3 deletions(-)
diff --git a/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js b/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js
index 8512204ea..f3ffc9825 100644
--- a/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js
+++ b/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js
@@ -44,7 +44,7 @@ AuthorReviews.propTypes = {
getSignedUrl: PropTypes.func,
/** Object containing the list of recommendations. */
journal: PropTypes.object, //eslint-disable-line
- /** Contains the token of the currently logged user */
+ /** Contains the token of the currently logged user. */
token: PropTypes.string,
}
diff --git a/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptDetailsTop.js b/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptDetailsTop.js
index 005af4452..162a6ade7 100644
--- a/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptDetailsTop.js
+++ b/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptDetailsTop.js
@@ -114,9 +114,9 @@ export default compose(
)(ManuscriptDetailsTop)
ManuscriptDetailsTop.propTypes = {
- /** Object with details about fragment. */
+ /** Object containing the selected fragment. */
fragment: PropTypes.object, //eslint-disable-line
- /** Object with details about collection. */
+ /** Object containing the selected collection. */
collection: PropTypes.object, //eslint-disable-line
/** Object with versions of manuscript. */
versions: PropTypes.array, //eslint-disable-line
diff --git a/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.js b/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.js
index 81a19cecb..d0e4eb12e 100644
--- a/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.js
+++ b/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.js
@@ -1,6 +1,7 @@
import React from 'react'
import { get, has } from 'lodash'
import { Field } from 'redux-form'
+import PropTypes from 'prop-types'
import { Icon } from '@pubsweet/ui'
import styled from 'styled-components'
import { th } from '@pubsweet/ui-toolkit'
@@ -59,6 +60,42 @@ const ManuscriptFiles = ({
</ContextualBox>
)
+ManuscriptFiles.propTypes = {
+ /** Contains the token of the currently logged user. */
+ token: PropTypes.string,
+ /** Object containing the selected fragment. */
+ fragment: PropTypes.object, //eslint-disable-line
+ /** Object containing the selected collection. */
+ collection: PropTypes.object, //eslint-disable-line
+ /** Name of added form. */
+ formName: PropTypes.func,
+ /** Change added form. */
+ changeForm: PropTypes.func,
+ /** Removes the file from the server. */
+ deleteFile: PropTypes.func,
+ /** Uploads the file to the server. */
+ uploadFile: PropTypes.func,
+ /** View content of the uploaded file. */
+ previewFile: PropTypes.func,
+ /** An async call that returns the securized S3 file url. */
+ getSignedUrl: PropTypes.func,
+ /** Value representing if the form has any errors. */
+ formErrors: PropTypes.object, //eslint-disable-line
+}
+
+ManuscriptFiles.defaultProps = {
+ token: '',
+ fragment: {},
+ collection: {},
+ formName: undefined,
+ changeForm: undefined,
+ deleteFile: undefined,
+ uploadFile: undefined,
+ previewFile: undefined,
+ getSignedUrl: undefined,
+ formErrors: {},
+}
+
export default ManuscriptFiles
// #region styled-components
--
GitLab