NotionX / NotionX/react-notion-x
Support for hyperlinks attached to images
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.4k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
While using the library, I thought it would be great to have native support for hyperlinks applied directly to images.
After reviewing this issue, it seems that links can be supported via image captions.
However, using captions to display hyperlinks feels a bit awkward, as it exposes the link directly within the Notion page.
I believe we could add support for actual image hyperlinks by modifying the asset-wrapper file directly. Here’s a snippet showing how this might be implemented:
const caption = block.properties?.caption?.[0]?.[0]
const imageHyperlink = (block as ImageBlock).format?.image_hyperlink
const isURL = getIsURL(block, imageHyperlink, caption)
function getIsURL(block: BaseContentBlock, imageHyperlink?: string, caption?: string): boolean {
if (block.type !== 'image') {
return false
}
if (imageHyperlink) {
const id = parsePageId(imageHyperlink, { uuid: true })
return imageHyperlink.charAt(0) === '/' && !!id
}
if (caption) {
const id = parsePageId(caption, { uuid: true })
const isPage = caption.charAt(0) === '/' && id
return !!(isPage || isValidURL(caption))
}
return false
}
This is my first time submitting an issue, so please let me know if there's anything I should improve.
Thank you!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the asset-wrapper file mentioned in the issue and inspect how image blocks currently handle captions and links. Compare the proposed image_hyperlink and caption logic with issue 306; done means image hyperlinks render as actual links while the existing caption-based behavior remains understood and covered by the relevant project checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100