Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Vulcain support for reference fields/inputs

Open
#448 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
react, typescript
Domain
api, frontend

Research direction

Start with ReferenceField and ReferenceInput, then compare their calls with useGetList, useGetOne, useGetMany, and the dataProvider path. Done means establishing whether Vulcain’s Preload header can be supplied for these relationship loads, or documenting the supported usage.

Written by the indexing model from the issue text.

Description

enhancement

Description
Hey! I am currently using APIP with this admin package to build a UI on top of my API. Most of my resources have multiple many-to-one or many-to-many relationships, which end up on each screen (show, create, edit). I'm using the default <ReferenceField /> and <ReferenceInput /> to load these relationships, but these end up making quite a few additional API calls which slows down page render.

If I understood correctly, Vulcain could help combat this issue by hitting the API once, and passing an additional header specifying which additional resources to pass in the response. However, this doesn't seem possible with my set-up, as I'm not calling the dataProvider directly (it is done by the reference components) and cannot specify the header for Vulcain.

Or maybe I am missing something. Should I not be using the <ReferenceField />/<ReferenceInput /> in this case? Would it be possible to pass the Preload header if I use the dataProvider methods directly? (eg. useGetList, useGetOne, useGetMany etc)

Thanks.

Dominant language
TypeScript
Stars
516
Forks
134
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from api-platform/admin

All issues in api-platform/admin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.