src/hooks/shared/useCardLink.ts - gerbeur documentation

Gives a dump's or a playlist's card, which is a clickable <li> and not a link, a link's behaviour: a middle or modified click opens its page in a new tab.

Functions

useCardLink(

url: string,

onOpen: () => void

): UseCardLinkResult

Returns the handlers that make a card open the page at url: in this tab on a click, in a new tab on a middle click or a ctrl, cmd or shift click. Every way it opens the page calls onOpen first, which marks the item visited. Anchors inside the card, such as the title or a category, keep their own target.

Interfaces

UseCardLinkResult

Returned by useCardLink to PlaylistCard, and through useDumpCardLink to DumpCard and JournalCard.

cardProps: { onClick: (e: MouseEvent) => void; onMouseDown: (e: MouseEvent) => void; onAuxClick: (e: MouseEvent) => void; }
Spread onto the card element.
go: () => void
Opens the page in this tab, for a handler that would rather not play.
handledAsNewTab: (e: MouseEvent) => boolean
Opens the page in a new tab and returns true when e is a ctrl, cmd or shift click away from any anchor. A click handler that plays media calls it first, so that such a click opens the page instead.

Functions

Interfaces

Usage