<ReferenceArrayFieldBase>

Use <ReferenceArrayFieldBase> to display a list of related records, via a one-to-many relationship materialized by an array of foreign keys.

<ReferenceArrayFieldBase> fetches a list of referenced records (using the dataProvider.getMany() method), and puts them in a ListContext. This component is headless, and its children need to use the data from this context to render the desired ui.

Tip: If the relationship is materialized by a foreign key on the referenced resource, use the <ReferenceManyFieldBase> component instead.

Usage

For instance, let’s consider a model where a post has many tags, materialized to a tags_ids field containing an array of ids:

┌──────────────┐       ┌────────┐
│ posts        │       │ tags   │
│--------------│       │--------│
│ id           │   ┌───│ id     │
│ title        │   │   │ name   │
│ body         │   │   └────────┘
│ is_published │   │
│ tag_ids      │╾──┘
└──────────────┘

A typical post record therefore looks like this:

{
  "id": 1,
  "title": "Hello world",
  "body": "...",
  "is_published": true,
  "tags_ids": [1, 2, 3]
}

In that case, use <ReferenceArrayFieldBase> to display the post tag names as a list of chips, as follows:

import { ListBase, ListIterator, ReferenceArrayFieldBase } from 'ra-core';

export const PostList = () => (
    <ListBase>
        <ListIterator>
            <ReferenceArrayFieldBase reference="tags" source="tag_ids">
                <TagList />
            </ReferenceArrayFieldBase>
        </ListIterator>
    </ListBase>
);

const TagList = (props: { children: React.ReactNode }) => {
    const context = useListContext();

    if (context.isPending) {
        return <p>Loading...</p>;
    }

    if (context.error) {
        return <p className="error">{context.error.toString()}</p>;
    }
    return (
        <p>
            {listContext.data?.map((tag, index) => (
                <li key={index}>{tag.name}</li>
            ))}
        </p>
    );
};

<ReferenceArrayFieldBase> expects a reference attribute, which specifies the resource to fetch for the related records. It also expects a source attribute, which defines the field containing the list of ids to look for in the referenced resource.

<ReferenceArrayFieldBase> fetches the tag resources related to each post resource by matching post.tag_ids to tag.id.

You can change how the list of related records is rendered by passing a custom child reading the ListContext (e.g. a <DataTable> component) or a render function prop. See the children and the render sections for details.

Props

Prop	Required	Type	Default	Description
source	Required	string	-	Name of the property to display
reference	Required	string	-	The name of the resource for the referenced records, e.g. ‘tags’
children	Optional*	Element		One or several elements that render a list of records based on a ListContext
render	Optional*	(ListContext) => Element		A function that takes a list context and renders a list of records
filter	Optional	Object	-	Filters to use when fetching the related records (the filtering is done client-side)
perPage	Optional	number	1000	Maximum number of results to display
queryOptions	Optional	UseQuery Options	{}	react-query options for the getMany query
sort	Optional	{ field, order }	{ field: 'id', order: 'DESC' }	Sort order to use when displaying the related records (the sort is done client-side)
sortBy	Optional	`string	Function`	source

* Either one of children or render is required.

children

You can pass any React component as child, to render the list of related records based on the ListContext.

<ReferenceArrayFieldBase label="Tags" reference="tags" source="tag_ids">
    <TagList />
</ReferenceArrayFieldBase>

const TagList = (props: { children: React.ReactNode }) => {
    const { isPending, error, data } = useListContext();

    if (isPending) {
        return <p>Loading...</p>;
    }

    if (error) {
        return <p className="error">{error.toString()}</p>;
    }
    return (
        <p>
            {data?.map((tag, index) => (
                <li key={index}>{tag.name}</li>
            ))}
        </p>
    );
};

render

Alternatively to children, you can pass a render function prop to <ReferenceArrayFieldBase>. The render prop will receive the ListContext as its argument, allowing to inline the rendering logic.

<ReferenceArrayFieldBase
    label="Tags"
    reference="tags"
    source="tag_ids"
    render={({ isPending, error, data }) => {
        if (isPending) {
            return <p>Loading...</p>;
        }
        if (error) {
            return <p className="error">{error.toString()}</p>;
        }
        return (
            <p>
                {data.map((tag, index) => (
                    <li key={index}>{tag.name}</li>
                ))}
            </p>
        );
    }}
/>

Tip: When receiving a render prop, the <ReferenceArrayFieldBase> component will ignore the children property.

filter

<ReferenceArrayFieldBase> fetches all the related records, and displays them all, too. You can use the filter prop to filter the list of related records to display (this works by filtering the records client-side, after the fetch).

For instance, to render only tags that are ‘published’, you can use the following code:

<ReferenceArrayFieldBase
    label="Tags"
    source="tag_ids"
    reference="tags"
    filter={{ is_published: true }}
/>

perPage

<ReferenceArrayFieldBase> fetches all the related fields, and puts them all in a ListContext. If a record has a large number of related records, it may be a good idea to limit the number of displayed records. The perPage prop allows to create a client-side pagination for the related records.

For instance, to limit the display of related records to 10, you can use the following code:

 <ReferenceArrayFieldBase label="Tags" source="tag_ids" reference="tags" perPage={10} />

queryOptions

Use the queryOptions prop to pass options to the dataProvider.getMany() query that fetches the referenced record.

For instance, to pass a custom meta:

<ReferenceArrayFieldBase queryOptions={{ meta: { foo: 'bar' } }} />

reference

The resource to fetch for the relateds record.

For instance, if the posts resource has a tag_ids field, set the reference to tags to fetch the tags related to each post.

<ReferenceArrayFieldBase label="Tags" source="tag_ids" reference="tags" />

sort

By default, the related records are displayed in the order in which they appear in the source. For instance, if the current record is { id: 1234, title: 'Lorem Ipsum', tag_ids: [1, 23, 4] }, a <ReferenceArrayFieldBase> on the tag_ids field will display tags in the order 1, 23, 4.

<ReferenceArrayFieldBase> can force a different order (via a client-side sort after fetch) if you specify a sort prop.

For instance, to sort tags by title in ascending order, you can use the following code:

<ReferenceArrayFieldBase
    label="Tags"
    source="tag_ids"
    reference="tags"
    sort={{ field: 'title', order: 'ASC' }}
/>