Skip to content
Snippets Groups Projects
Commit 31cc866c authored by Anca Ursachi's avatar Anca Ursachi
Browse files

docs(pullFromBranch):

parents e7ed4206 01a5be0a
No related branches found
No related tags found
3 merge requests!222Sprint #26,!217Sprint #26,!191Hin 1116 documentation
import { get } from 'lodash' import { get } from 'lodash'
import { H2 } from '@pubsweet/ui' import { H2 } from '@pubsweet/ui'
import PropTypes from 'prop-types'
import styled, { css } from 'styled-components' import styled, { css } from 'styled-components'
import { th } from '@pubsweet/ui-toolkit' import { th } from '@pubsweet/ui-toolkit'
...@@ -9,7 +10,7 @@ const width = props => css` ...@@ -9,7 +10,7 @@ const width = props => css`
width: calc(${th('gridUnit')} * ${get(props, 'width', 50)}); width: calc(${th('gridUnit')} * ${get(props, 'width', 50)});
` `
export default styled.div` const ShadowedBox = styled.div`
background-color: ${th('colorBackgroundHue')}; background-color: ${th('colorBackgroundHue')};
border-radius: ${th('borderRadius')}; border-radius: ${th('borderRadius')};
box-shadow: ${th('boxShadow')}; box-shadow: ${th('boxShadow')};
...@@ -26,3 +27,15 @@ export default styled.div` ...@@ -26,3 +27,15 @@ export default styled.div`
text-align: center; text-align: center;
} }
` `
ShadowedBox.propTypes = {
/** Width of shadowed box */
width: PropTypes.number,
/** Position of shadowed box */
position: PropTypes.string,
}
ShadowedBox.defaultProps = {
width: 50,
position: 'initial',
}
export default ShadowedBox
...@@ -55,10 +55,10 @@ const Tag = styled.div` ...@@ -55,10 +55,10 @@ const Tag = styled.div`
` `
Tag.propTypes = { Tag.propTypes = {
/** if true then object gets properties. */ /** Old status of the corresponding user. */
oldStatus: PropTypes.bool, oldStatus: PropTypes.bool,
/** if true then object gets properties. */ /** New status of the corresponding user. */
status: PropTypes.boo, status: PropTypes.bool,
} }
Tag.defaultProps = { Tag.defaultProps = {
......
...@@ -100,17 +100,17 @@ const Text = ({ bullet, children, ...rest }) => ...@@ -100,17 +100,17 @@ const Text = ({ bullet, children, ...rest }) =>
) )
Text.propTypes = { Text.propTypes = {
/** if true then object gets properties. */ /** Defines what style the secondary text will have. */
secondary: PropTypes.bool, secondary: PropTypes.bool,
/** if true then object gets properties. */ /** Defines what style the error text will have. */
error: PropTypes.bool, error: PropTypes.bool,
/** if true then object gets properties. */ /** Defines what style the customId text will have. */
customId: PropTypes.bool, customId: PropTypes.bool,
/** if true then object gets properties. */ /** Defines what style the labelLine text will have. */
labelLine: PropTypes.bool, labelLine: PropTypes.bool,
/** if true then object gets properties. */ /** Defines what style the journal text will have. */
journal: PropTypes.bool, journal: PropTypes.bool,
/** if true thenobject gets properties. */ /** Defines what style the small text will have. */
small: PropTypes.bool, small: PropTypes.bool,
/** defines how items will be displayed. */ /** defines how items will be displayed. */
display: PropTypes.string, display: PropTypes.string,
......
...@@ -19,12 +19,24 @@ A secondary text. (Body 2) ...@@ -19,12 +19,24 @@ A secondary text. (Body 2)
<Text secondary>my boy is amazing</Text> <Text secondary>my boy is amazing</Text>
``` ```
Error text.
```js
<Text error>why error?</Text>
```
A text used for manuscript custom IDs. A text used for manuscript custom IDs.
```js ```js
<Text customId>ID 444222</Text> <Text customId>ID 444222</Text>
``` ```
A text used for journal.
```js
<Text journal>text for journal</Text>
```
A small text. A small text.
```js ```js
......
import { get } from 'lodash' import { get } from 'lodash'
import PropTypes from 'prop-types'
import { th } from '@pubsweet/ui-toolkit' import { th } from '@pubsweet/ui-toolkit'
import styled, { css } from 'styled-components' import styled, { css } from 'styled-components'
...@@ -33,6 +34,14 @@ const Textarea = styled.textarea` ...@@ -33,6 +34,14 @@ const Textarea = styled.textarea`
background-color: ${th('colorBackgroundHue')}; background-color: ${th('colorBackgroundHue')};
} }
` `
Textarea.propTypes = {
/** The minimum height that the text box should have */
minHeight: PropTypes.number,
}
Textarea.defaultProps = {
minHeight: 10,
}
/** @component */ /** @component */
export default Textarea export default Textarea
...@@ -14,29 +14,68 @@ The `withSubmitRevision` HOC contains the logic for submitting a manuscript vers ...@@ -14,29 +14,68 @@ 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
const ManuscriptLayout = ({submitRevision}) =>(
<SubmitRevision {...submitRevision} />
)
const SubmitRevision = ({...}) => (
<Root>
<DetailsAndAuthors
addAuthor={addAuthor}
changeForm={changeForm}
collection={collection}
deleteAuthor={deleteAuthor}
formErrors={formErrors}
fragment={fragment}
isAuthorEdit={isEditingAuthor}
manuscriptTypes={journal.manuscriptTypes}
onAuthorEdit={onAuthorEdit}
/>
<ManuscriptFiles
changeForm={changeForm}
collection={collection}
deleteFile={deleteFile}
downloadFile={downloadFile}
formErrors={formErrors}
formName="revision"
fragment={fragment}
getSignedUrl={getSignedUrl}
previewFile={previewFile}
token={currentUser.token}
uploadFile={addFile}
/>
<ResponseToReviewer
file={responseFile}
getSignedUrl={getSignedUrl}
isFetching={isFetching}
onDelete={deleteResponseFile}
onUpload={addResponseFile}
token={currentUser.token}
/>
</Root>
``` ```
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