Skip to content

Commit 7789e92

Browse files
committed
Align JSDoc param formatting in reactions components
Standardized the alignment of JSDoc @param and @Property tags across edit.js, reactions.js, and view.js for improved readability and consistency.
1 parent 1c76ea6 commit 7789e92

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

src/reactions/edit.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ const DUMMY_REACTIONS = {
5252
/**
5353
* Edit component for the Reactions block.
5454
*
55-
* @param {Object} props Block props.
56-
* @param {Object} props.attributes Block attributes.
57-
* @param {string} props.__unstableLayoutClassNames Layout class names.
55+
* @param {Object} props Block props.
56+
* @param {Object} props.attributes Block attributes.
57+
* @param {string} props.__unstableLayoutClassNames Layout class names.
5858
* @return {JSX.Element} Component to render.
5959
*/
6060
export default function Edit( { attributes, setAttributes, __unstableLayoutClassNames } ) {

src/reactions/reactions.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ import { useOptions } from '../shared/use-options';
1111
/**
1212
* A component that renders a row of user avatars for a given set of reactions.
1313
*
14-
* @param {Object} props Component props.
15-
* @param {Array} props.reactions Array of reaction objects.
14+
* @param {Object} props Component props.
15+
* @param {Array} props.reactions Array of reaction objects.
1616
* @param {string} props.displayStyle The display style ('facepile' or 'compact').
1717
* @return {JSX.Element} The rendered component.
1818
*/
@@ -127,11 +127,11 @@ const ReactionGroup = ( { items, label, displayStyle } ) => {
127127
/**
128128
* The Reactions component.
129129
*
130-
* @param {Object} props Component props.
131-
* @param {?number} props.postId The Post ID.
132-
* @param {?Object} props.reactions Optional reactions data.
130+
* @param {Object} props Component props.
131+
* @param {?number} props.postId The Post ID.
132+
* @param {?Object} props.reactions Optional reactions data.
133133
* @param {?Object} props.fallbackReactions Optional fallback reactions data to use if no real reactions are found.
134-
* @param {string} props.displayStyle The display style ('facepile' or 'summary').
134+
* @param {string} props.displayStyle The display style ('facepile' or 'summary').
135135
* @return {?JSX.Element} The rendered component.
136136
*/
137137
export function Reactions( {

src/reactions/view.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ createModalStore( 'activitypub/reactions' );
1313

1414
/**
1515
* @typedef {Object} context
16-
* @property {String} blockId The block ID.
17-
* @property {Object} modal The modal state.
16+
* @property {String} blockId The block ID.
17+
* @property {Object} modal The modal state.
1818
* @property {boolean} modal.isCompact Whether the modal is compact.
19-
* @property {boolean} modal.isOpen Whether the modal is open.
20-
* @property {Object} modal.items The items to display in the modal.
21-
* @property {String} postId The post ID.
22-
* @property {Object} reactions Reactions data, keyed by reaction type.
19+
* @property {boolean} modal.isOpen Whether the modal is open.
20+
* @property {Object} modal.items The items to display in the modal.
21+
* @property {String} postId The post ID.
22+
* @property {Object} reactions Reactions data, keyed by reaction type.
2323
*/
2424

2525
const { callbacks, state } = store( 'activitypub/reactions', {

0 commit comments

Comments
 (0)