From 7458a7a821d5553a019852da53a6eaf4d8dba2fe Mon Sep 17 00:00:00 2001 From: Demetriad Sinzeanu <demetriad.sinzeanu@thinslices.com> Date: Fri, 7 Dec 2018 16:31:26 +0200 Subject: [PATCH] docs(ContextualBoxes/ManuscriptDetails/submissionRevisionfolders): Wrote documentation for files ins --- .../component-faraday-ui/src/AuthorReply.js | 2 +- .../src/contextualBoxes/AuthorReviews.js | 1 + .../src/contextualBoxes/HERecommendation.js | 2 - .../src/contextualBoxes/HERecommendation.md | 29 ++- .../src/manuscriptDetails/ManuscriptHeader.md | 178 ++++++++++++++---- .../manuscriptDetails/ManuscriptVersion.md | 23 ++- .../manuscriptDetails/ResponseToInvitation.md | 6 +- .../src/pending/ControlledAccordion.js | 4 +- .../src/submissionRevision/ManuscriptFiles.md | 6 +- .../submissionRevision/ResponseToReviewer.md | 21 ++- .../src/submissionRevision/SubmitRevision.js | 4 +- 11 files changed, 209 insertions(+), 67 deletions(-) diff --git a/packages/component-faraday-ui/src/AuthorReply.js b/packages/component-faraday-ui/src/AuthorReply.js index 053d3003c..3d1ed3491 100644 --- a/packages/component-faraday-ui/src/AuthorReply.js +++ b/packages/component-faraday-ui/src/AuthorReply.js @@ -67,7 +67,7 @@ AuthorReply.propTypes = { /** Previews the file from the server then updates the form. */ onPreview: PropTypes.func, /** Reply File. */ - replyFile: PropTypes.object, //eslint-disable-line + replyFile: PropTypes.oneOfType([PropTypes.string, PropTypes.object]), } AuthorReply.defaultProps = { replyContent: undefined, diff --git a/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js b/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js index 580363ef7..613ab6e4f 100644 --- a/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js +++ b/packages/component-faraday-ui/src/contextualBoxes/AuthorReviews.js @@ -10,6 +10,7 @@ import { Text, indexReviewers, } from '../' +import { FragmentsOnCompositeTypes } from 'graphql' const SubmittedReportsNumberForAuthorReviews = ({ reports }) => ( <Row fitContent justify="flex-end"> diff --git a/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.js b/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.js index a1f02843e..9fd76615c 100644 --- a/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.js +++ b/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.js @@ -108,7 +108,6 @@ const HERecommendation = ({ /> </ItemOverrideAlert> </Row> - {get(formValues, 'recommendation') === 'minor' || get(formValues, 'recommendation') === 'major' ? ( <Row mt={2}> @@ -148,7 +147,6 @@ const HERecommendation = ({ </ResponsiveItem> </ResponsiveRow> )} - <Row justify="flex-end" mt={2}> <Button data-test-id="button-editorial-recommendation-submit" diff --git a/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.md b/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.md index 8d00e6a5f..45874db4a 100644 --- a/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.md +++ b/packages/component-faraday-ui/src/contextualBoxes/HERecommendation.md @@ -2,10 +2,37 @@ HE recommendation. ```js const formValues = { - recommendation: 'minor-revision', + recommendation: 'minor', } +const options = [ + { + value: 'publish', + label: 'Publish', + message: 'Recommend Manuscript for Publishing', + button: 'Submit Recommendation', + }, + { + value: 'reject', + label: 'Reject', + message: 'Recommend Manuscript for Rejection', + button: 'Submit Recommendation', + }, + { + value: 'minor', + label: 'Request Minor Revision', + message: 'Request Minor Revision', + button: 'Request Revision', + }, + { + value: 'major', + label: 'Request Major Revision', + message: 'Request Major Revision', + button: 'Request Revision', + }, +] ;<HERecommendation formValues={formValues} + options={options} modalKey="heRecommendation" onRecommendationSubmit={(values, props) => { props.setFetching(true) diff --git a/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptHeader.md b/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptHeader.md index 6c3c740eb..e8d4243ea 100644 --- a/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptHeader.md +++ b/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptHeader.md @@ -2,33 +2,65 @@ Manuscript header without a HE assigned. ```js const authors = [ - { + { + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ecbafc48fe', email: 'john.doe@gmail.com', firstName: 'John', lastName: 'Doe', isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'michael.felps@gmail.com', - firstName: 'Michael', - lastName: 'Felps', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ecsdfc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', isSubmitting: true, isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail.com', - firstName: 'Barrack', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ec56fc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail1.com', - firstName: 'Barrack 1', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-144cbafc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail2.com', - firstName: 'Barrack 2', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ec33fc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, ] @@ -93,33 +125,65 @@ Manuscript header with a pending HE invitation. ```js const authors = [ - { + { + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ecbafc48fe', email: 'john.doe@gmail.com', firstName: 'John', lastName: 'Doe', isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'michael.felps@gmail.com', - firstName: 'Michael', - lastName: 'Felps', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ecsdfc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', isSubmitting: true, isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail.com', - firstName: 'Barrack', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ec56fc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail1.com', - firstName: 'Barrack 1', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-144cbafc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail2.com', - firstName: 'Barrack 2', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ec33fc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, ] @@ -205,32 +269,64 @@ Manuscript header with a pending HE invitation. ```js const authors = [ { + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ecbafc48fe', email: 'john.doe@gmail.com', firstName: 'John', lastName: 'Doe', isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'michael.felps@gmail.com', - firstName: 'Michael', - lastName: 'Felps', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ecsdfc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', isSubmitting: true, isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail.com', - firstName: 'Barrack', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ec56fc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail1.com', - firstName: 'Barrack 1', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-144cbafc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, { - email: 'barrack.obama@gmail2.com', - firstName: 'Barrack 2', - lastName: 'Obama', + affiliation: 'TSD', + affiliationNumber: 1, + country: 'AX', + id: '5001955e-cc18-42d4-b0ca-15ec33fc48fe', + email: 'john.doe@gmail.com', + firstName: 'John', + lastName: 'Doe', + isSubmitting: true, + isCorresponding: true, + title: 'mr', }, ] @@ -267,7 +363,11 @@ const fragment = { }, } -const currentUser = {} +const currentUser = { + permissions: { + canAssignHE: false, + }, +} const journal = { manuscriptTypes: [ diff --git a/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptVersion.md b/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptVersion.md index 00e12ce33..cee73787f 100644 --- a/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptVersion.md +++ b/packages/component-faraday-ui/src/manuscriptDetails/ManuscriptVersion.md @@ -1,19 +1,22 @@ Manuscript version component ```js - const history = { - push: v => console.log('go to version -> ', v) -}; - -const fragment={}; -const collection={ - fragments: ['1','2'], -}; + push: v => console.log('go to version -> ', v), +} -<ManuscriptVersion +const fragment = {} +const collection = { + fragments: ['1', '2'], +} +const versions = [ + { label: 'Version 1', value: '10d28459-6f8e-4f6c-a57e-65979e5f8d2' }, + { label: 'Version 2', value: '10d28459-6f8e-4f6c-a57e-65979e5f854' }, +] +;<ManuscriptVersion collection={collection} history={history} fragment={fragment} - /> + versions={versions} +/> ``` diff --git a/packages/component-faraday-ui/src/manuscriptDetails/ResponseToInvitation.md b/packages/component-faraday-ui/src/manuscriptDetails/ResponseToInvitation.md index e7f3a21c9..588a77de8 100644 --- a/packages/component-faraday-ui/src/manuscriptDetails/ResponseToInvitation.md +++ b/packages/component-faraday-ui/src/manuscriptDetails/ResponseToInvitation.md @@ -5,10 +5,9 @@ const formValues = { decision: 'accept', } ;<RemoteOpener> - {({ toggle, expanded }) => ( + {({ toggle }) => ( <ResponseToInvitation commentsOn="decline" - expanded={expanded} label="Do you agree to be the handling editor for this manuscript?" formValues={formValues} onResponse={(values, { setFetching }) => { @@ -26,9 +25,8 @@ A Reviewer response to an invitation. ```js <RemoteOpener> - {({ toggle, expanded }) => ( + {({ toggle }) => ( <ResponseToInvitation - expanded={expanded} label="Do you agree to review this manuscript?" onResponse={(values, { setFetching }) => { console.log('on response: ', values) diff --git a/packages/component-faraday-ui/src/pending/ControlledAccordion.js b/packages/component-faraday-ui/src/pending/ControlledAccordion.js index 0c63d576e..8b13d4478 100644 --- a/packages/component-faraday-ui/src/pending/ControlledAccordion.js +++ b/packages/component-faraday-ui/src/pending/ControlledAccordion.js @@ -24,8 +24,8 @@ class ControlledAccordion extends React.Component { const shouldScroll = !prevProps.expanded && this.props.expanded if (this.props.scrollIntoView && shouldScroll) { - const appBarHeight = 70 // TODO -- take height from constants - const appBarMargin = 16 // TODO -- take margin from constants + const appBarHeight = 70 + const appBarMargin = 16 this.scroller.scrollTop = this._accordion.offsetTop - appBarHeight - appBarMargin } diff --git a/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.md b/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.md index 42a8e2120..5129d1d5a 100644 --- a/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.md +++ b/packages/component-faraday-ui/src/submissionRevision/ManuscriptFiles.md @@ -14,8 +14,6 @@ const Wrapper = compose( reduxForm({ form: 'styleguide', }), -)(( props ) => ( - <ManuscriptFiles {...props} /> -)) +)(props => <ManuscriptFiles {...props} />) ;<Wrapper /> -``` \ No newline at end of file +``` diff --git a/packages/component-faraday-ui/src/submissionRevision/ResponseToReviewer.md b/packages/component-faraday-ui/src/submissionRevision/ResponseToReviewer.md index e9264445b..903a52a70 100644 --- a/packages/component-faraday-ui/src/submissionRevision/ResponseToReviewer.md +++ b/packages/component-faraday-ui/src/submissionRevision/ResponseToReviewer.md @@ -1,7 +1,24 @@ ```js +const { reduxForm, getFormValues, change } = require('redux-form') +const { compose } = require('recompose') +const { connect } = require('react-redux') + const allowedFileExtensions = ['pdf', 'doc', 'docx'] -const onUpload = (f) => {console.log('Upload', f)} +const onUpload = file => console.log('Upload', file) -<ResponseToReviewer onUpload={onUpload} allowedFileExtensions={allowedFileExtensions}/> +const Wrapper = compose( + connect(state => ({ + formValues: getFormValues('Response to reviewer')(state), + })), + reduxForm({ + form: 'Response to reviewer', + }), +)(props => ( + <ResponseToReviewer + onUpload={onUpload} + allowedFileExtensions={allowedFileExtensions} + /> +)) +;<Wrapper /> ``` diff --git a/packages/component-faraday-ui/src/submissionRevision/SubmitRevision.js b/packages/component-faraday-ui/src/submissionRevision/SubmitRevision.js index 5c94d8718..aec7021b0 100644 --- a/packages/component-faraday-ui/src/submissionRevision/SubmitRevision.js +++ b/packages/component-faraday-ui/src/submissionRevision/SubmitRevision.js @@ -113,7 +113,7 @@ SubmitRevision.propTypes = { /** An async call that returns the securized S3 file url. */ getSignedUrl: PropTypes.func, /** Value containing the revision's file for the reviewer's response. */ - responseFile: PropTypes.func, + responseFile: PropTypes.object, //eslint-disable-line /** Downloads the file from the server. */ downloadFile: PropTypes.func, /** Uploads the file then updates the form. */ @@ -138,7 +138,7 @@ SubmitRevision.defaultProps = { hasFormError: false, deleteAuthor: () => {}, getSignedUrl: () => {}, - responseFile: () => {}, + responseFile: {}, downloadFile: () => {}, addResponseFile: () => {}, deleteResponseFile: () => {}, -- GitLab