Skip to content
Snippets Groups Projects
Commit 649d7a74 authored by Mihail Hagiu's avatar Mihail Hagiu
Browse files

docs(SubmitRevision): Updated documentation for withSubmitRevision HOC

parent fab6673f
No related branches found
No related tags found
3 merge requests!222Sprint #26,!217Sprint #26,!191Hin 1116 documentation
...@@ -14,29 +14,27 @@ The `withSubmitRevision` HOC contains the logic for submitting a manuscript vers ...@@ -14,29 +14,27 @@ The `withSubmitRevision` HOC contains the logic for submitting a manuscript vers
`submitRevision` namespace contains the following fields: `submitRevision` namespace contains the following fields:
Name|Type|Description Name|Type|Description
---|---|--- ---|---|---
. initialValues|`{...fragment}`| Object containing the initial state of the fragment collection|`object`|Object containing the selected collection
. addFile|`({ file: object, type: string, fragment: object }) => any`|Uploads the file to the server fragment|`object`|Object containing the selected fragment
journal|`???`|??? journal|`object`|Deprecated object containing manuscript types
. collection|`object`|Object containing the selected collection currentUser|`object`|Object containing the currently logged user
. fragment|`object`|Object containing the selected fragment initialValues|`{...fragment}`| Object containing the initial state of the fragment
. canSubmit|`bool`|Value representing if the form doesn't have errors and can be submitted
. addAuthor|`({ author, collectionId: string, fragmentId: string }) => any`|An async call to add an author to the manuscript
changeForm|`function`|Des Cri Pti On!
. deleteFile|`({ fileId: string, type: string }) => any`|Removes the file from the server
. currentUser|`object`|Object containing the currently logged user
onAuthorEdit|`function`|Des Cri Pti On!
. deleteAuthor|`({ authorId, fragmentId, collectionId }) => any`|An async call to remove an existing author from the manuscript
. getSignedUrl|`(id: string) => Promise({signedURL: string})`|An async call that returns the securized S3 file url
hasFormError|`function`|Des Cri Pti On!
formErrors|`function`|Des Cri Pti On!
addResponseFile|`file => any`|Uploads the file and adds it on the form
deleteResponseFile|`file => any`|Deletes the file from the server and removes it from the form
isEditingAuthor|`bool`|Value representing if the current user is the editing author isEditingAuthor|`bool`|Value representing if the current user is the editing author
. onChange|`(reduxFormValues, dispatch, { collection, fragment }) => any`|Used to autosave new fragment when fields change canSubmit|`bool`|Value representing if the form doesn't have errors and can be submitted
. onSubmit|`(reduxFormValues, dispatch, { history, fragment, collection, showModal, setFetching, canSubmit })`|Handles the submission of a new manuscript version hasFormError|`bool`|Value representing if the form has any errors
. validate|`({ editAuthors: , files: array, responseToReviewers: object }) => errors: object`|Checks the form for required fields and returns the errors formErrors|`bool`|Value representing if the form has any errors
. responseFile|`file`|Value containing the revision's file for the reviewer's response responseFile|`file`|Value containing the revision's file for the reviewer's response
addAuthor|`({ author, collectionId: string, fragmentId: string }) => any`|An async call to add an author to the manuscript
deleteAuthor|`({ authorId, fragmentId, collectionId }) => any`|An async call to remove an existing author from the manuscript
onAuthorEdit|`index => authorEditIndex: number`|Chages the form to allow editing of the selected author and returns his index
addFile|`({ file: object, type: string, fragment: object }) => any`|Uploads the file to the server
deleteFile|`({ fileId: string, type: string }) => any`|Removes the file from the server
getSignedUrl|`(id: string) => Promise({signedURL: string})`|An async call that returns the securized S3 file url
addResponseFile|`file => any`|Uploads the file then updates the form
deleteResponseFile|`file => any`|Deletes the file from the server then updates the form
onChange|`(reduxFormValues, dispatch, { collection, fragment }) => any`|Used to autosave new fragment when fields change
validate|`({ editAuthors: , files: array, responseToReviewers: object }) => errors: object`|Checks the form for required fields and returns the errors
onSubmit|`(reduxFormValues, dispatch, { history, fragment, collection, showModal, setFetching, canSubmit })`|Handles the submission of a new manuscript version
```javascript ```javascript
``` ```
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment