Add clickable link in field description property?

6 replies
Last updated: Jan 27, 2026
Small question: is it possible to add a clickable link in the
description
property for a field?
AI Update

Based on the documentation, yes, you can add clickable links in field descriptions! When using .jsx or .tsx file extensions for your schema files, the description property supports basic JSX formatting.

Here's an example from the defineField documentation:

defineField({
  name: 'myField',
  type: 'string',
  description: (
    <details>
      <summary>Why is this important?</summary>
      The Googlebot is an indexer of...
    </details>
  )
})

So for a clickable link, you can do something like:

defineField({
  name: 'myField',
  type: 'string',
  description: (
    <>
      This field is used for X. See <a href="https://example.com" target="_blank" rel="noopener noreferrer">our documentation</a> for more details.
    </>
  )
})

Important note: This JSX support only works when your schema file has a .jsx or .tsx extension. If you're using plain .js or .ts files, you'll need to rename them to use this feature.

The JSX support is described as "basic," so you can use standard HTML elements like <a>, <details>, <summary>, and other common formatting tags to make your descriptions more helpful for content editors.

Show original thread
6 replies

Sanity – Build the way you think, not the way your CMS thinks

Sanity is the developer-first content operating system that gives you complete control. Schema-as-code, GROQ queries, and real-time APIs mean no more workarounds or waiting for deployments. Free to start, scale as you grow.

Was this answer helpful?