From f2979487f00471d0368a63848fde72e44f9288df Mon Sep 17 00:00:00 2001 From: Mihail Hagiu <mihail.hagiu@thinslices.com> Date: Tue, 6 Nov 2018 12:56:54 +0200 Subject: [PATCH] docs(HandleRecommendation): Wrote documentation for withHandleRecommendation HOC --- .../src/handleRecommendation/README.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 packages/component-manuscript/src/handleRecommendation/README.md diff --git a/packages/component-manuscript/src/handleRecommendation/README.md b/packages/component-manuscript/src/handleRecommendation/README.md new file mode 100644 index 000000000..783844056 --- /dev/null +++ b/packages/component-manuscript/src/handleRecommendation/README.md @@ -0,0 +1,45 @@ +## Hindawi Handling Recommendation HOC. + +Injects `createRecommendation` and `onEditorialRecommendation` handlers as props. + +### withHandleRecommendation props + +`recommendationHandler` namespace contains the following fields: +Name|Type|Description +---|---|--- +createRecommendation |`(reduxFormValues, modalProps) => any`|creates a recommendation for the manuscript +onEditorialRecommendation |`(reduxFormValues, modalProps) => any`|handles the recommendation for the manuscript + +_Note: The functions must be used withing a modal_ + +```javascript +const HERecommendationPanel = ({ createRecommendation }) => ( + <Modal> + <span>Recommend the manuscript for:</span> + <select> + <option>Approve</option> + <option>Reject</option> + <option>Minor revision</option> + <option>Major revision</option> + </select> + <button onClick={() => createRecommendation(reduxFormValues, { ...modalProps, setFetching })}> + Submit + </button> + </Modal> +) + +const EICDecisionPanel = ({ onEditorialRecommendation }) => ( + <Modal> + <span>Take decision to:</span> + <select> + <option>Approve</option> + <option>Reject</option> + <option>Minor revision</option> + <option>Major revision</option> + </select> + <button onClick={() => onEditorialRecommendation(reduxFormValues, { ...modalProps, setFetching })}> + Submit + </button> + </Modal> +) +``` -- GitLab