Skip to content

WithRecord.md

Latest commit

 

History

History
95 lines (70 loc) · 2.96 KB

WithRecord.md

File metadata and controls

95 lines (70 loc) · 2.96 KB
layout default
title WithRecord

<WithRecord>

<WithRecord> grabs the current record from the RecordContext. It's the render prop version of the useRecordContext hook.

Usage

The most common use case for <WithRecord> is to build a custom field on-the-fly, without creating a new component. For instance, an author field for a book Show view.

import { Show, SimpleShowLayout, WithRecord } from 'react-admin';

const BookShow = () => (
    <Show>
        <SimpleShowLayout>
            <WithRecord label="author" render={record => <span>{record.author}</span>} />
        </SimpleShowLayout>
    </Show>
);

Note that if record is undefined, <WithRecord> doesn't call the render callback and renders nothing, so you don't have to worry about this case in your render callback.

Availability

As soon as there is a record available, react-admin puts it in a RecordContext. This means that <WithRecord> works out of the box:

  • in descendants of the <Show> and <ShowBase> component
  • in descendants of the <Edit> and <EditBase> component
  • in descendants of the <Create> and <CreateBase> component
  • in descendants of the <DataTable> component
  • in descendants of the <Datagrid> component
  • in descendants of the <SimpleList> component
  • in descendants of the <ReferenceField> component

Using in a Datagrid

When using <WithRecord> in a <Datagrid>, you must specify the label prop to let react-admin know which field to display in the column header.

import { Datagrid, TextField, WithRecord } from 'react-admin';

const PostList = () => (
    <List>
        <Datagrid>
            <TextField source="title" />
            <WithRecord label="author" render={record => <span>{record.author}</span>} />
        </Datagrid>
    </List>
);

Tip: You don't need to use <WithRecord> if you are using <DataTable>, as the <DataTable.Col> component directly provides a render prop that works similarly to <WithRecord>.

TypeScript

The <WithRecord> component accepts a generic parameter for the record type:

import { Show, SimpleShowLayout, WithRecord } from 'react-admin';

type Book = {
    id: number;
    author: string;
}

const BookShow = () => (
    <Show>
        <SimpleShowLayout>
            <WithRecord<Book>
                label="author"
                render={book => {
                    // TypeScript knows that book is of type Book
                    return <span>{book.author}</span>}
                }
            />
        </SimpleShowLayout>
    </Show>
);

See Also

API