Skip to content

Commit ba7fccc

Browse files
committed
docs: add JSDoc comments to IterableEmbeddedView component for better clarity on props and usage
1 parent a8d3008 commit ba7fccc

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/embedded/components/IterableEmbeddedView.tsx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ interface IterableEmbeddedViewProps extends IterableEmbeddedComponentProps {
1515
viewType: IterableEmbeddedViewType;
1616
}
1717

18+
/**
19+
*
20+
* @param viewType - The type of view to render.
21+
* @param message - The message to render.
22+
* @param config - The config for the IterableEmbeddedView component, most likely used to style the view.
23+
* @param onButtonClick - The function to call when a button is clicked.
24+
* @returns The IterableEmbeddedView component.
25+
*
26+
* This component is used to render pre-created, customizable message displays
27+
* included with Iterables RN SDK: cards, banners, and notifications.
28+
*/
1829
export const IterableEmbeddedView = ({
1930
viewType,
2031
...props

0 commit comments

Comments
 (0)