Skip to content

[Docs] Fix custom field uses defaultProps for labels #11367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fzaninotto merged 2 commits into from
Sep 10, 2026
+2 −4
Merged

[Docs] Fix custom field uses defaultProps for labels #11367

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d571100
docs: pass custom field labels explicitly
jabrailkhalil Sep 8, 2026
5b4099b
docs: drop defaultProps rationale per review
jabrailkhalil Sep 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/Fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,13 +495,11 @@ export const FullNameField = (props) => {
const record = useRecordContext(props);
return record ? <span>{record.firstName} {record.lastName}</span> : null;
}

FullNameField.defaultProps = { label: 'Name' };
```

**Tip**: Always check the `record` is defined before inspecting its properties, as react-admin may display the Show view *before* fetching the record from the data provider. So the first time it renders the show view for a resource, the `record` is `undefined`.

You can now use this field like any other react-admin field:
You can now use this field like any other react-admin field. Pass the `label` explicitly so the parent layout can read it from the field's props:

```jsx
import { List, Datagrid } from 'react-admin';
Expand All @@ -510,7 +508,7 @@ import { FullNameField } from './FullNameField';
export const UserList = () => (
<List>
<Datagrid>
<FullNameField source="lastName" />
<FullNameField source="lastName" label="Name" />
</Datagrid>
</List>
);
Expand Down