Add TSDocs to item components

This commit is contained in:
Violet Caulfield
2025-06-07 03:09:38 -05:00
parent 0fa9808d20
commit 611d295b21
2 changed files with 18 additions and 0 deletions

View File

@@ -16,6 +16,13 @@ interface CardProps extends TamaguiCardProps {
squared?: boolean
}
/**
* Displays an item as a card.
*
* This is used on the Home Screen and in the Search and Library Tabs.
*
* @param props
*/
export function ItemCard(props: CardProps) {
const { api, user } = useJellifyContext()

View File

@@ -13,6 +13,17 @@ import FavoriteIcon from './favorite-icon'
import { Gesture, GestureDetector } from 'react-native-gesture-handler'
import { runOnJS } from 'react-native-reanimated'
/**
* Displays an item as a row in a list.
*
* This is used in the Search and Library Tabs, as well as the Home and Discover Tabs
* when viewing a full list of items from a section
*
* @param item - The item to display.
* @param queueName - The name of the queue. Referenced in the {@link useLoadNewQueue} hook.
* @param navigation - The navigation object.
* @returns
*/
export default function Item({
item,
queueName,