🎤 Builder Talk: The Story Behind Lady Gaga’s Digital Experience – Register now

How to Add a Link to an Image in PortableText Editor

13 replies
Last updated: Aug 11, 2022
Question about links. I've setup links similar to this post: https://www.sanity.io/guides/portable-text-internal-and-external-links and that is fine with one drawback, how to add a link to an image? I'm currently importing a wordpress blog and ran into this limitation. Is there a recommended way to link an image that works in the portableText editor with annotations?
Aug 11, 2022, 9:21 PM
Would this be an image in your dataset or an image hosted outside of sanity?
Aug 11, 2022, 9:22 PM
I'm importing the images into sanity as I go, using block-tools. So it would be an image I import. Creating ldjson as I go through the html.
Aug 11, 2022, 9:23 PM
I guess I could add a link option on my media types, just wondering if there is a better way.
Aug 11, 2022, 9:25 PM
not really hard to check if the link child is an image in the processing, block-tools is super cool
Aug 11, 2022, 9:26 PM
Ah, got it. I understand. If you're adding the image to your dataset, could you just add it to your array of blocks like in this example? You could then use conditionals in your query to expand the asset on your frontend.
Aug 11, 2022, 9:29 PM
But how would you attach a link, e.g <a href="some external url"><img src="sanity image asset" /></a>?
Aug 11, 2022, 9:37 PM
only thing I can think of is a custom image object with a link option but the portableText UI wouldn't be used to manage the linking. It would have to be set when the image is inserted from the popup
Aug 11, 2022, 9:38 PM
Ok, I think I misunderstood. Is the idea to a) set a link and b) set an image that will represent that link on the frontend?
Aug 11, 2022, 9:39 PM
If so, you can add a field to your image object for that url:
{
  name: 'image',
  type: 'image',
  fields: [
    {
      name: 'link',
      type: 'url',
      options: {
        isHighlighted: true
      }
    }
  ]
}
Aug 11, 2022, 9:41 PM
yeah, the wordpress site I'm imported uses images linked to youtube videos. So I want to maintain that on import.
Aug 11, 2022, 9:41 PM
fair enough, I'll go that route. It was my initial plan but wasn't sure if there was a better way.
Aug 11, 2022, 9:42 PM
thank you
Aug 11, 2022, 9:43 PM
Happy to help!
Aug 11, 2022, 9:43 PM

Sanity– build remarkable experiences at scale

Sanity is a modern headless CMS that treats content as data to power your digital business. Free to get started, and pay-as-you-go on all plans.

Was this answer helpful?

Related answers

Get more help in the community Slack

TopicCategoriesFeaturedRepliesLast Updated
Hey all - what’s the quickest way to batch delete all documents of a certain type? It looks like the `sanity` cli tool allows...Jan 29, 2021
Rendering nested block contentJan 18, 2021
In the tutorial, there is samples of what the API returns as JSON. Is there a way to view these ?Jan 11, 2021
Warning: Data for Page Exceeds the Threshold of 128 kBAug 17, 2022
Custom Document Views - Is it Even Possible to Use the Structure Builder?Apr 21, 2022
How to get the number of nested/children components in a GROQ query.Jan 19, 2024
Issue with fetching data from an array of references and non-references in a groq query.Dec 14, 2023
GraphQL query resolving references on a _raw field in GatsbyMay 17, 2022
GROQ query for getting references from arrays in another array in Sanity.ioApr 9, 2020
How to populate a list of values in a Sanity schema using a separate fileSep 6, 2021

Related contributions

Turbo Start Sanity
- Template

The battle-tested Sanity template that powers Roboto Studio's websites

Go to Turbo Start Sanity

Schema UI - Next.js Sanity Starter
- Template

A Next.js starter template with Next.js 15, Tailwind CSS, shadcn/ui, and Sanity CMS with Live Editing. Get production-ready React components with matching Sanity schemas and queries. Build dynamic pages faster while keeping full control over customization.

Serge Ovcharenko
Go to Schema UI - Next.js Sanity Starter

The Swaddle
- Made with Sanity

A new brand identity to represent a more mature company, to signify The Swaddle’s evolution from publisher to production house, combined with an easier to navigate platform that can surface multiple content types - drawing readers through The Swaddle’s content offering.

Nightjar
Go to The Swaddle