GGLinnk/foris-js
1
0
Fork 0
mirror of https://gitlab.nic.cz/turris/reforis/foris-js.git synced 2024-12-24 00:01:36 +01:00
Code Issues Releases Activity

Merge branch 'foris-form-docs' into 'dev'

Browse Source 
Fixed ForisForm docstring.

See merge request turris/reforis/foris-js!87
This commit is contained in:
Maciej Lenartowicz 2020-02-14 13:55:23 +01:00
commit 83409b0118
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/form/components/ForisForm.js
View File

@ -27,7 +27,7 @@ ForisForm.propTypes = {
ws: PropTypes.object, ws: PropTypes.object,
/** Foris configuration object. See usage in main components. */ /** Foris configuration object. See usage in main components. */
forisConfig: PropTypes.shape({ forisConfig: PropTypes.shape({
/** reForis Flask aplication API endpoint from `src/common/API.js`. */ /** reForis Flask application API endpoint from `src/common/API.js`. */
endpoint: PropTypes.string.isRequired, endpoint: PropTypes.string.isRequired,
/** `foris-controller` module name to be used via WebSockets. /** `foris-controller` module name to be used via WebSockets.
* It can be use only with `ws` prop. * It can be use only with `ws` prop.
@ -38,7 +38,7 @@ ForisForm.propTypes = {
* */ * */
wsAction: PropTypes.string, wsAction: PropTypes.string,
}).isRequired, }).isRequired,
/** Function to prepare data recived from the API before using in forms. */ /** Function to prepare data received from the API before using in forms. */
prepData: PropTypes.func, prepData: PropTypes.func,
/** Function to prepare data from form before submitting. */ /** Function to prepare data from form before submitting. */
prepDataToSubmit: PropTypes.func, prepDataToSubmit: PropTypes.func,
@ -50,7 +50,9 @@ ForisForm.propTypes = {
disabled: PropTypes.bool, disabled: PropTypes.bool,
/** Optional override of form submit callback */ /** Optional override of form submit callback */
onSubmitOverridden: PropTypes.func, onSubmitOverridden: PropTypes.func,
/** Optional override of form submit callback */ /** Reference to actual form element (useful for programmatically submitting it).
* Pass the output of useRef hook to this prop.
*/
formReference: PropTypes.object, formReference: PropTypes.object,
/** reForis form components. */ /** reForis form components. */
children: PropTypes.node.isRequired, children: PropTypes.node.isRequired,