Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit 15a91d2

Browse files
author
Mike England
committed
Update GravityForm doc blocks
1 parent 3817f38 commit 15a91d2

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

components/molecules/GravityForm/GravityForm.js

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ import * as Yup from 'yup'
55
import getGfFieldId from '@/functions/gravityForms/getGfFieldId'
66
import {useState} from 'react'
77

8+
/**
9+
* Render the GravityForm component.
10+
*
11+
* @param {object} props The GravityForm block attributes as props.
12+
* @param {object} props.formData GravityForm form data.
13+
* @param {string} props.formData.cssClass GravityForm form classname.
14+
* @param {object} props.formData.fields GravityForm form fields.
15+
* @param {number} props.formData.formId GravityForm form id.
16+
* @param {string} props.formData.title GravityForm form title.
17+
* @return {Element} The GravityForm component.
18+
*/
819
export default function GravityForm({
920
formData: {cssClass, fields, formId, title}
1021
}) {
@@ -15,8 +26,8 @@ export default function GravityForm({
1526
/**
1627
* Map field GravityForm ids and defaults to Object.
1728
*
18-
* @param {Array} fields Array of fields.
19-
* @return {Object} Default field values.
29+
* @param {Array} fields Array of fields.
30+
* @return {object} Default field values.
2031
*/
2132
function getFieldDefaults(fields) {
2233
const defaults = {}

0 commit comments

Comments
 (0)