From a79b83d41246a678b80dea92208bb29daf401b24 Mon Sep 17 00:00:00 2001 From: Demetriad Sinzeanu <demetriad.sinzeanu@thinslices.com> Date: Wed, 28 Nov 2018 11:00:54 +0200 Subject: [PATCH] docs(ResponseToRevisionRequest/ReviewDetails): Wrote documentation for ResponseToRevisionRequest and --- .../ResponseToRevisionRequest.js | 18 +++++- .../src/contextualBoxes/ReviewerDetails.js | 62 +++++++++++++++++++ 2 files changed, 79 insertions(+), 1 deletion(-) diff --git a/packages/component-faraday-ui/src/contextualBoxes/ResponseToRevisionRequest.js b/packages/component-faraday-ui/src/contextualBoxes/ResponseToRevisionRequest.js index 4d3d4b181..8f2ea00ac 100644 --- a/packages/component-faraday-ui/src/contextualBoxes/ResponseToRevisionRequest.js +++ b/packages/component-faraday-ui/src/contextualBoxes/ResponseToRevisionRequest.js @@ -1,5 +1,5 @@ import React from 'react' - +import PropTypes from 'prop-types' import { ContextualBox, AuthorReply } from '../' const ResponseToRevisionRequest = ({ @@ -18,4 +18,20 @@ const ResponseToRevisionRequest = ({ </ContextualBox> ) +ResponseToRevisionRequest.propTypes = { + /** Object containing the selected fragment. */ + fragment: PropTypes.object, //eslint-disable-line + /** Callback function used to control the state of the component. + * To be used together with the `expanded` prop. + */ + toggle: PropTypes.func, + /** Prop used together with toggle. */ + expanded: PropTypes.bool, +} +ResponseToRevisionRequest.defaultProps = { + fragment: {}, + toggle: () => {}, + expanded: false, +} + export default ResponseToRevisionRequest diff --git a/packages/component-faraday-ui/src/contextualBoxes/ReviewerDetails.js b/packages/component-faraday-ui/src/contextualBoxes/ReviewerDetails.js index d8a41b821..b77e07729 100644 --- a/packages/component-faraday-ui/src/contextualBoxes/ReviewerDetails.js +++ b/packages/component-faraday-ui/src/contextualBoxes/ReviewerDetails.js @@ -1,5 +1,6 @@ import React, { Fragment } from 'react' import { get } from 'lodash' +import PropTypes from 'prop-types' import { H4 } from '@pubsweet/ui' import styled from 'styled-components' import { th } from '@pubsweet/ui-toolkit' @@ -138,6 +139,67 @@ const ReviewerDetails = ({ </ContextualBox> ) +ReviewerDetails.propTypes = { + /** Object containing the list of recommendations. */ + journal: PropTypes.object, //eslint-disable-line + /** Object containing the selected fragment. */ + fragment: PropTypes.object, //eslint-disable-line + /** Specifies how many reviewers have been invited. */ + invitations: PropTypes.array, //eslint-disable-line + /** Array that contains publon reviewers. */ + publonReviewers: PropTypes.array, //eslint-disable-line + /** View content of the uploaded file. */ + previewFile: PropTypes.func, + /** Downloads the file from the server. */ + downloadFile: PropTypes.func, + /** Sends an invitation to the reviewer. */ + onInviteReviewer: PropTypes.func, + /** Reviewers reports. */ + reports: PropTypes.array, //eslint-disable-line + /** Sends an invitation to a Publon reviewer. */ + onInvitePublonReviewer: PropTypes.func, + /** Resends an invitation to an already invited. */ + onResendReviewerInvite: PropTypes.func, + /** Cancels an invitation to an invited reviewer. */ + onRevokeReviewerInvite: PropTypes.func, + /** Callback function used to control the state of the component. + * To be used together with the `expanded` prop. + */ + toggle: PropTypes.func, + /** Prop used together with toggle. */ + expanded: PropTypes.bool, + /* Specifies if the contextual box should be highlighted */ + highlight: PropTypes.bool, + /** Specifies if manuscript is at the latest version. */ + isLatestVersion: PropTypes.bool, + /** Specifies if we can invite reviewers on the current version. */ + canInviteReviewers: PropTypes.bool, + /** Specifies if we can view reviewers details on the current version. */ + canViewReviewersDetails: PropTypes.bool, + /** Specifies if the author can view reports details on the current version. */ + authorCanViewReportsDetails: PropTypes.func, +} +ReviewerDetails.defaultProps = { + journal: {}, + reports: [], + fragment: {}, + invitations: [], + publonReviewers: [], + previewFile: () => {}, + downloadFile: () => {}, + onInviteReviewer: () => {}, + onInvitePublonReviewer: () => {}, + onResendReviewerInvite: () => {}, + onRevokeReviewerInvite: () => {}, + toggle: () => {}, + expanded: false, + highlight: false, + canInviteReviewers: false, + canViewReviewersDetails: false, + authorCanViewReportsDetails: () => {}, + isLatestVersion: false, +} + export default compose( withFilePreview, withFileDownload, -- GitLab