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

docs(SubmitRevision): WIP withSubmitRevision HOC documentation

parent f2979487
No related branches found
No related tags found
3 merge requests!222Sprint #26,!217Sprint #26,!191Hin 1116 documentation
## Hindawi Submit Revision HOC.
The `withSubmitRevision` HOC contains the logic for submitting a manuscript version. It contains the following utility HOCs:
* `withFetching`
* `withFilePreview`
* `withFileDownload`
* `withModal`
..as well as other `recompose` HOCs.
### withSubmitRevision props
`submitRevision` namespace contains the following fields:
Name|Type|Description
---|---|---
initialValues|`{...fragment}`| Object containing the initial state of the fragment
addFile|`({ file: object, type: string, fragment: object }) => any`|Uploads the file to the server
journal|`function`|Des Cri Pti On!
history|`object`|Added by `react-router` to allow navigation
fragment|`function`|Des Cri Pti On!
canSubmit|`function`|Des Cri Pti On!
addAuthor|`function`|Des Cri Pti On!
showModal|`function`|Des Cri Pti On!
changeForm|`function`|Des Cri Pti On!
collection|`function`|Des Cri Pti On!
isFetching|`function`|Des Cri Pti On!
deleteFile|`function`|Des Cri Pti On!
currentUser|`function`|Des Cri Pti On!
setFetching|`function`|Des Cri Pti On!
previewFile|`function`|Des Cri Pti On!
downloadFile|`function`|Des Cri Pti On!
onAuthorEdit|`function`|Des Cri Pti On!
deleteAuthor|`function`|Des Cri Pti On!
getSignedUrl|`function`|Des Cri Pti On!
hasFormError|`function`|Des Cri Pti On!
formErrors|`function`|Des Cri Pti On!
fetchingError|`string`|Value representing a server request error
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
onChange|`(reduxFormValues, dispatch, { collection, fragment }) => any`|Used to autosave new fragment when fields change
onSubmit|`(reduxFormValues, dispatch, { history, fragment, collection, showModal, setFetching, canSubmit })`|Handles the submission of a new manuscript version
validate|`({ editAuthors, files, responseToReviewers }) => errors: object`|Checks the form for required fields and returns the errors
responseFile|`file`|Value containing the revision's file for the reviewer's response
```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