Skip to content
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.

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

Fix <WithRecord> render prop type #8993

Merged
merged 3 commits into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions examples/demo/src/orders/NbItemsField.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import * as React from 'react';
import { FunctionField, RenderRecordFunction } from 'react-admin';
import { FunctionField } from 'react-admin';
import { Order } from '../types';

const render: RenderRecordFunction<Order> = record => record.basket.length;
const render = (record: Order) => record.basket.length;

const NbItemsField = () => <FunctionField<Order> render={render} />;

Expand Down
7 changes: 4 additions & 3 deletions packages/ra-core/src/controller/record/WithRecord.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { RenderRecordFunction } from '../../types';
import * as React from 'react';
import { ReactNode } from 'react';
import { useRecordContext } from './useRecordContext';

/**
Expand All @@ -17,12 +18,12 @@ export const WithRecord = <RecordType extends Record<string, unknown> = any>({
render,
}: WithRecordProps<RecordType>) => {
const record = useRecordContext<RecordType>();
return record ? render(record) : null;
return record ? <>{render(record)}</> : null;
};

export interface WithRecordProps<
RecordType extends Record<string, unknown> = any
> {
render: RenderRecordFunction<RecordType>;
render: (record: RecordType) => ReactNode;
label?: string;
}
4 changes: 0 additions & 4 deletions packages/ra-core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -361,10 +361,6 @@ export interface ResourceProps {
children?: ReactNode;
}

export type RenderRecordFunction<
RecordType extends Record<string, unknown> = any
> = (record: RecordType, source?: string) => ReactNode;

export type Exporter = (
data: any,
fetchRelatedRecords: (
Expand Down
6 changes: 3 additions & 3 deletions packages/ra-ui-materialui/src/field/FunctionField.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';
import { useMemo } from 'react';
import { RenderRecordFunction, useRecordContext } from 'ra-core';
import { useMemo, ReactNode } from 'react';
import { useRecordContext } from 'ra-core';
import PropTypes from 'prop-types';
import Typography, { TypographyProps } from '@mui/material/Typography';

Expand Down Expand Up @@ -50,5 +50,5 @@ export interface FunctionFieldProps<
RecordType extends Record<string, unknown> = any
> extends FieldProps<RecordType>,
Omit<TypographyProps, 'textAlign'> {
render: RenderRecordFunction<RecordType>;
render: (record: RecordType, source?: string) => ReactNode;
}