Skip to content

Commit 27a4ee4

Browse files
committed
fix js docs
1 parent c9f54ba commit 27a4ee4

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

packages/js/src/ai-content-planner/components/content-suggestions-modal.js

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ const intentBadge = {
2828
/**
2929
* Suggestion button component.
3030
*
31-
* @param {string} intent The intent of the suggestion.
32-
* @param {string} title The title of the suggestion.
33-
* @param {string} description The description of the suggestion.
34-
* @param {Function} onClick The function to call when the suggestion button is clicked.
31+
* @param {object} props The component props.
32+
* @param {string} props.intent The intent of the suggestion.
33+
* @param {string} props.title The title of the suggestion.
34+
* @param {string} props.description The description of the suggestion.
35+
* @param {Function} props.onClick The function to call when the suggestion button is clicked.
3536
*
3637
* @returns {JSX.Element} The SuggestionButton component.
3738
*/
@@ -69,6 +70,11 @@ const SuggestionButtonSkeleton = () => (
6970
</div>
7071
);
7172

73+
/**
74+
* The loading content for the ContentSuggestionsModal.
75+
*
76+
* @returns {JSX.Element} The loading content for the ContentSuggestionsModal.
77+
*/
7278
const LoadingModalContent = () => (
7379
<>
7480
<div className="yst-flex yst-flex-col yst-items-center yst-pb-8">
@@ -96,11 +102,12 @@ const LoadingModalContent = () => (
96102
/**
97103
* ContentSuggestionsModal component.
98104
*
99-
* @param {boolean} isOpen Whether the modal is open or not.
100-
* @param {Function} onClose The function to call when the modal should be closed.
101-
* @param {boolean} isLoading Whether the content suggestions are being generated.
102-
* @param {boolean} isPremium Whether the user has a premium add-on is activated or not.
103-
* @param {Suggestion[]} suggestions The content suggestions to display in the modal.
105+
* @param {Object} props The component props.
106+
* @param {boolean} props.isOpen Whether the modal is open or not.
107+
* @param {Function} props.onClose The function to call when the modal should be closed.
108+
* @param {boolean} props.isLoading Whether the content suggestions are being generated.
109+
* @param {boolean} props.isPremium Whether the user has a premium add-on is activated or not.
110+
* @param {Suggestion[]} props.suggestions The content suggestions to display in the modal.
104111
*
105112
* @returns {JSX.Element} The ContentSuggestionsModal component.
106113
*/

0 commit comments

Comments
 (0)