PrismicLink output if not enough attributes are passed in

Is your feature request related to a problem? Please describe.

I created a Link-Field in Prismic CMS and wanted to use PrismicLink in order to display it. In my case it could be a document, external or media link. I used this code to render the PrismicLink:

<PrismicLink
  field={item.link}
  linkResolver={linkResolver}
>
  {item.text}
</PrismicLink>

I expect this to work but there was no error and no link was rendered. (It just returned null I think) After that, I added more fields to my GraphQL query and then it worked. So, the component needed some more attributes in order to work correctly.

Describe the solution you’d like

I would like the PrismicLink component to output a message like “uid, id, lang, …” are needed on the link field in order to work. Or at least some feedback from the component and not just nothing.

Additional context

The link fields I selected when it didn’t work: link_type. The link fields I selected when it finally worked:

link_type, url, uid, id, lang, type, target

[lihbr]

https://github.com/prismicio/prismic-helpers/pull/51 was merged and released 🎉 This one should land soon too!

[angeloashmore]

Hi @alexanderbluhm, thanks for reporting this bug.

v2.4.1 includes a development-only check for missing Link field properties. It will throw an error letting you know the field is missing properties and links to a document with an explanation. See the document here: https://github.com/prismicio/prismic-react/blob/1eb04d88a72f436ac7586625716ff6c9fe337949/messages/missing-link-properties.md

You can see more details on the changes in the PR here: #153.

Update to the latest version of @prismicio/react to benefit from the development check:

npm i @prismicio/react@latest

If you have any questions, feel free to post them here and I will help. Thanks! 🙂