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

Commit a150636

Browse files
committed
Fix props
1 parent 9e7bd5c commit a150636

File tree

12 files changed

+68
-60
lines changed

12 files changed

+68
-60
lines changed

components/atoms/Code/Code.js

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
import PropTypes from 'prop-types'
22
import React from 'react'
3-
import styles from './Code.module.css'
43
import {Prism as SyntaxHighlighter} from 'react-syntax-highlighter'
54
import {tomorrow} from 'react-syntax-highlighter/dist/cjs/styles/prism'
5+
import styles from './Code.module.css'
66

77
/**
88
* Render the Code component.
99
*
1010
* @author WebDevStudios
11-
* @param {object} props The component attributes as props.
12-
* @param {string} props.className Optional classname.
13-
* @param props.id
14-
* @param props.content
15-
* @param {boolean} props.fullWidth Is this a fullwidth block.
16-
* @return {Element} The Code component.
11+
* @param {object} props The component attributes as props.
12+
* @param {string} props.className Optional classname.
13+
* @param {string} props.id The optional ID.
14+
* @param {string} props.content The content for inside the code block.
15+
* @return {Element} The Code component.
1716
*/
1817
export default function Code({id, className, content}) {
1918
// Use the className to pass the langauge.

components/atoms/Image/Image.js

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1+
import RichText from '@/components/atoms/RichText'
2+
import cn from 'classnames'
13
import Link from 'next/link'
24
import PropTypes from 'prop-types'
35
import React from 'react'
4-
import RichText from '@/components/atoms/RichText'
56
import styles from './Image.module.css'
6-
import cn from 'classnames'
77

88
/**
99
* Render the Image component.
1010
*
1111
* @author WebDevStudios
12-
* @param {string} anchor The anchor/id of the block.
13-
* @param {string} alt The image alt text.
14-
* @param {string} caption The image caption.
15-
* @param {string} className The image class.
16-
* @param {string} id The image ID.
17-
* @param {string} href The URL of the link.
18-
* @param {string} linkTarget Target for the link.
19-
* @param {string} linkClass Class for the link.
20-
* @param {string} rel The rel attribute for the link.
21-
* @param {string} sizeSlug The WP image size.
22-
* @param {string} url The full URL path of the image.
23-
* @return {Element} The Image component.
12+
* @param {object} props The component properties.
13+
* @param {string} props.anchor The anchor/id of the block.
14+
* @param {string} props.alt The image alt text.
15+
* @param {string} props.caption The image caption.
16+
* @param {string} props.className The image class.
17+
* @param {string} props.id The image ID.
18+
* @param {string} props.href The URL of the link.
19+
* @param {string} props.linkTarget Target for the link.
20+
* @param {string} props.linkClass Class for the link.
21+
* @param {string} props.rel The rel attribute for the link.
22+
* @param {string} props.sizeSlug The WP image size.
23+
* @param {string} props.url The full URL path of the image.
24+
* @return {Element} The Image component.
2425
*/
2526
export default function Image({
2627
alt,

components/atoms/PullQuote/PullQuote.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ import styles from './PullQuote.module.css'
77
* PullQuote Block
88
*
99
* @author WebDevStudios
10-
* @param {string} value The pull quote content of the block.
11-
* @param {string} citation The optional author citation.
12-
* @param {string} id Optional anchor/id.
13-
* @param {string} className Optional classnames.
14-
* @return {Element} The PullQuote component.
10+
* @param {object} props The component properties.
11+
* @param {string} props.value The pull quote content of the block.
12+
* @param {string} props.citation The optional author citation.
13+
* @param {string} props.id Optional anchor/id.
14+
* @param {string} props.className Optional classnames.
15+
* @return {Element} The PullQuote component.
1516
*/
1617
export default function PullQuote({value, citation, id, className}) {
1718
return (

components/atoms/Quote/Quote.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ import styles from './Quote.module.css'
99
* The core Quote block from Gutenberg.
1010
*
1111
* @author WebDevStudios
12-
* @param {string} value The quote content of the block.
13-
* @param {string} citation The optional author citation.
14-
* @param {string} id Optional anchor/id.
15-
* @param {string} className Optional classnames.
16-
* @return {Element} The Quote component.
12+
* @param {object} props The component properties.
13+
* @param {string} props.value The quote content of the block.
14+
* @param {string} props.citation The optional author citation.
15+
* @param {string} props.id Optional anchor/id.
16+
* @param {string} props.className Optional classnames.
17+
* @return {Element} The Quote component.
1718
*/
1819
export default function Quote({value, citation, id, className}) {
1920
return (

components/atoms/Separator/Separator.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ import styles from './Separator.module.css'
88
* Render the Separator component.
99
*
1010
* @author WebDevStudios
11-
* @param {string} className Optional classname.
12-
* @param {boolean} fullWidth Is this a fullwidth block.
13-
* @return {Element} The Separator component.
11+
* @param {object} props The component properties.
12+
* @param {string} props.className Optional classname.
13+
* @param {boolean} props.fullWidth Is this a fullwidth block.
14+
* @return {Element} The Separator component.
1415
*/
1516
export default function Separator({className, fullWidth}) {
1617
return (

components/atoms/Spacer/Spacer.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ import React from 'react'
55
* Render the Spacer component.
66
*
77
* @author WebDevStudios
8-
* @param {string} anchor Optional anchor/id.
9-
* @param {number} height The height of the spacer.
10-
* @return {Element} The Spacer component.
8+
* @param {object} props The component properties.
9+
* @param {string} props.anchor Optional anchor/id.
10+
* @param {number} props.height The height of the spacer.
11+
* @return {Element} The Spacer component.
1112
*/
1213
export default function Spacer({height, anchor}) {
1314
const rootEmVal = 16

components/atoms/Table/Table.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ import styles from './Table.module.css'
77
* Table Block
88
*
99
* @author WebDevStudios
10-
* @param {string} id Optional anchor/id.
11-
* @param {string} head The optional table head array.
12-
* @param {string} body The table body array.
13-
* @param {string} body The table body array.
14-
* @param {string} foot The optional table foorter array.
15-
* @param {string} caption Optional table caption.
16-
* @param {string} className Optional classnames.
17-
* @return {Element} The Table component.
10+
* @param {object} props The component properties.
11+
* @param {string} props.id Optional anchor/id.
12+
* @param {string} props.head The optional table head array.
13+
* @param {string} props.body The table body array.
14+
* @param {string} props.body The table body array.
15+
* @param {string} props.foot The optional table foorter array.
16+
* @param {string} props.caption Optional table caption.
17+
* @param {string} props.className Optional classnames.
18+
* @return {Element} The Table component.
1819
*/
1920
export default function Table({id, head, body, foot, caption, className}) {
2021
return (

components/molecules/ButtonGroup/ButtonGroup.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ import styles from './ButtonGroup.module.css'
99
* Render the ButtonGroup component.
1010
*
1111
* @author WebDevStudios
12-
* @param {string} id The id of the block.
13-
* @param {string} orientation The orientation of buttons.
14-
* @param {string} contentJustification The justification of the buttons.
15-
* @param {element} children The children props to render.
16-
* @return {Element} The ButtonGroup component.
12+
* @param {object} props The component properties.
13+
* @param {string} props.id The id of the block.
14+
* @param {string} props.orientation The orientation of buttons.
15+
* @param {string} props.contentJustification The justification of the buttons.
16+
* @param {element} props.children The children props to render.
17+
* @return {Element} The ButtonGroup component.
1718
*/
1819
export default function ButtonGroup({
1920
id,

components/molecules/ImageGallery/ImageGallery.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ import styles from './ImageGallery.module.css'
99
* Render the ImageGallery component.
1010
*
1111
* @author WebDevStudios
12-
* @param {string} anchor The anchor/id of the block.
13-
* @param {string} caption The image caption.
14-
* @param {string} className The image class.
15-
* @param {number} columns The amount of columns.
16-
* @param {Array} images The array of images.
17-
* @return {Element} The ImageGallery component.
12+
* @param {object} props The component properties.
13+
* @param {string} props.anchor The anchor/id of the block.
14+
* @param {string} props.caption The image caption.
15+
* @param {string} props.className The image class.
16+
* @param {number} props.columns The amount of columns.
17+
* @param {Array} props.images The array of images.
18+
* @return {Element} The ImageGallery component.
1819
*/
1920
export default function ImageGallery({
2021
anchor,

components/organisms/Header/Header.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ import styles from './Header.module.css'
99
// TODO: Create mobile menu.
1010

1111
/**
12-
* Render Header component.
12+
* Render the ImageGallery component.
13+
*
14+
* @author WebDevStudios
15+
* @return {Element} The Header component.
1316
*/
1417
export default function Header() {
1518
const {menus} = useContext(MenuContext)

0 commit comments

Comments
 (0)