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

Make ShowBase, CreateBase and EditBase components support resource override via props #7652

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
22 changes: 17 additions & 5 deletions packages/ra-core/src/controller/create/CreateBase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
} from './useCreateController';
import { CreateContextProvider } from './CreateContextProvider';
import { RaRecord } from '../../types';
import { ResourceContextProvider } from '../../core';

/**
* Call useCreateController and put the value in a CreateContext
Expand Down Expand Up @@ -39,8 +40,19 @@ import { RaRecord } from '../../types';
export const CreateBase = <RecordType extends RaRecord = any>({
children,
...props
}: CreateControllerProps<RecordType> & { children: ReactNode }) => (
<CreateContextProvider value={useCreateController(props)}>
{children}
</CreateContextProvider>
);
}: CreateControllerProps<RecordType> & { children: ReactNode }) => {
const controllerProps = useCreateController<RecordType>(props);
const body = (
<CreateContextProvider value={controllerProps}>
{children}
</CreateContextProvider>
);
return props.resource ? (
// support resource override via props
<ResourceContextProvider value={props.resource}>
{body}
</ResourceContextProvider>
) : (
body
);
};
2 changes: 2 additions & 0 deletions packages/ra-core/src/controller/create/useCreateController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ export const useCreateController = <RecordType extends RaRecord = RaRecord>(

export interface CreateControllerProps<RecordType extends RaRecord = RaRecord> {
disableAuthentication?: boolean;
hasEdit?: boolean;
hasShow?: boolean;
record?: Partial<RecordType>;
redirect?: RedirectionSideEffect;
resource?: string;
Expand Down
22 changes: 17 additions & 5 deletions packages/ra-core/src/controller/edit/EditBase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { ReactNode } from 'react';
import { RaRecord } from '../../types';
import { useEditController, EditControllerProps } from './useEditController';
import { EditContextProvider } from './EditContextProvider';
import { ResourceContextProvider } from '../../core';

/**
* Call useEditController and put the value in a EditContext
Expand Down Expand Up @@ -37,8 +38,19 @@ import { EditContextProvider } from './EditContextProvider';
export const EditBase = <RecordType extends RaRecord = any>({
children,
...props
}: { children: ReactNode } & EditControllerProps<RecordType>) => (
<EditContextProvider value={useEditController<RecordType>(props)}>
{children}
</EditContextProvider>
);
}: { children: ReactNode } & EditControllerProps<RecordType>) => {
const controllerProps = useEditController<RecordType>(props);
const body = (
<EditContextProvider value={controllerProps}>
{children}
</EditContextProvider>
);
return props.resource ? (
// support resource override via props
<ResourceContextProvider value={props.resource}>
{body}
</ResourceContextProvider>
) : (
body
);
};
22 changes: 17 additions & 5 deletions packages/ra-core/src/controller/show/ShowBase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { ReactElement } from 'react';
import { RaRecord } from '../../types';
import { useShowController, ShowControllerProps } from './useShowController';
import { ShowContextProvider } from './ShowContextProvider';
import { ResourceContextProvider } from '../../core';

/**
* Call useShowController and put the value in a ShowContext
Expand Down Expand Up @@ -37,8 +38,19 @@ import { ShowContextProvider } from './ShowContextProvider';
export const ShowBase = <RecordType extends RaRecord = any>({
children,
...props
}: { children: ReactElement } & ShowControllerProps<RecordType>) => (
<ShowContextProvider value={useShowController<RecordType>(props)}>
{children}
</ShowContextProvider>
);
}: { children: ReactElement } & ShowControllerProps<RecordType>) => {
const controllerProps = useShowController<RecordType>(props);
const body = (
<ShowContextProvider value={controllerProps}>
{children}
</ShowContextProvider>
);
return props.resource ? (
// support resource override via props
<ResourceContextProvider value={props.resource}>
{body}
</ResourceContextProvider>
) : (
body
);
};
48 changes: 26 additions & 22 deletions packages/ra-ui-materialui/src/detail/Create.tsx
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
import * as React from 'react';
import { ReactElement } from 'react';
import PropTypes from 'prop-types';
import {
CreateContextProvider,
RaRecord,
ResourceContextProvider,
useCheckMinimumRequiredProps,
useCreateController,
} from 'ra-core';
import { RaRecord, useCheckMinimumRequiredProps } from 'ra-core';

import { CreateProps } from '../types';
import { CreateView } from './CreateView';
import { CreateBase } from 'ra-core';

/**
* Page component for the Create view
Expand Down Expand Up @@ -59,19 +54,30 @@ export const Create = <RecordType extends RaRecord = any>(
props: CreateProps<RecordType> & { children: ReactElement }
): ReactElement => {
useCheckMinimumRequiredProps('Create', ['children'], props);
const controllerProps = useCreateController<RecordType>(props);
const body = (
<CreateContextProvider value={controllerProps}>
<CreateView {...props} {...controllerProps} />
</CreateContextProvider>
);
return props.resource ? (
// support resource override via props
<ResourceContextProvider value={props.resource}>
{body}
</ResourceContextProvider>
) : (
body
const {
resource,
record,
redirect,
transform,
mutationOptions,
disableAuthentication,
hasEdit,
hasShow,
...rest
} = props;
return (
<CreateBase
resource={resource}
record={record}
redirect={redirect}
transform={transform}
mutationOptions={mutationOptions}
disableAuthentication={disableAuthentication}
hasEdit={hasEdit}
hasShow={hasShow}
>
<CreateView {...rest} />
</CreateBase>
);
};

Expand All @@ -81,7 +87,6 @@ Create.propTypes = {
children: PropTypes.element,
className: PropTypes.string,
disableAuthentication: PropTypes.bool,
hasCreate: PropTypes.bool,
hasEdit: PropTypes.bool,
hasShow: PropTypes.bool,
redirect: PropTypes.oneOfType([
Expand All @@ -92,7 +97,6 @@ Create.propTypes = {
resource: PropTypes.string,
title: PropTypes.node,
record: PropTypes.object,
hasList: PropTypes.bool,
mutationOptions: PropTypes.object,
transform: PropTypes.func,
sx: PropTypes.any,
Expand Down
46 changes: 26 additions & 20 deletions packages/ra-ui-materialui/src/detail/Edit.tsx
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
import * as React from 'react';
import { ReactNode } from 'react';
import PropTypes from 'prop-types';
import {
EditContextProvider,
ResourceContextProvider,
useCheckMinimumRequiredProps,
useEditController,
RaRecord,
} from 'ra-core';
import { useCheckMinimumRequiredProps, RaRecord } from 'ra-core';
import { EditProps } from '../types';
import { EditView } from './EditView';
import { EditBase } from 'ra-core';

/**
* Page component for the Edit view
Expand Down Expand Up @@ -60,19 +55,30 @@ export const Edit = <RecordType extends RaRecord = any>(
props: EditProps<RecordType> & { children: ReactNode }
) => {
useCheckMinimumRequiredProps('Edit', ['children'], props);
const controllerProps = useEditController<RecordType>(props);
const body = (
<EditContextProvider value={controllerProps}>
<EditView {...props} {...controllerProps} />
</EditContextProvider>
);
return props.resource ? (
// support resource override via props
<ResourceContextProvider value={props.resource}>
{body}
</ResourceContextProvider>
) : (
body
const {
resource,
id,
mutationMode,
mutationOptions,
queryOptions,
redirect,
transform,
disableAuthentication,
...rest
} = props;
return (
<EditBase
resource={resource}
id={id}
mutationMode={mutationMode}
mutationOptions={mutationOptions}
queryOptions={queryOptions}
redirect={redirect}
transform={transform}
disableAuthentication={disableAuthentication}
>
<EditView {...rest} />
</EditBase>
);
};

Expand Down
14 changes: 8 additions & 6 deletions packages/ra-ui-materialui/src/detail/Show.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as React from 'react';
import { ReactElement } from 'react';
import PropTypes from 'prop-types';
import { ShowBase, ResourceContextProvider, RaRecord } from 'ra-core';
import { ShowBase, RaRecord } from 'ra-core';

import { ShowProps } from '../types';
import { ShowView } from './ShowView';
Expand Down Expand Up @@ -64,11 +64,13 @@ export const Show = <RecordType extends RaRecord = any>({
queryOptions,
...rest
}: ShowProps<RecordType>): ReactElement => (
<ResourceContextProvider value={resource}>
<ShowBase<RecordType> id={id} queryOptions={queryOptions}>
<ShowView {...rest} />
</ShowBase>
</ResourceContextProvider>
<ShowBase<RecordType>
id={id}
queryOptions={queryOptions}
resource={resource}
>
<ShowView {...rest} />
</ShowBase>
);

Show.propTypes = {
Expand Down
4 changes: 4 additions & 0 deletions packages/ra-ui-materialui/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface EditProps<RecordType extends RaRecord = any> {
aside?: ReactElement;
className?: string;
component?: ElementType;
disableAuthentication?: boolean;
id?: Identifier;
mutationMode?: MutationMode;
queryOptions?: UseQueryOptions<RecordType>;
Expand All @@ -36,6 +37,9 @@ export interface CreateProps<RecordType extends RaRecord = any> {
aside?: ReactElement;
className?: string;
component?: ElementType;
disableAuthentication?: boolean;
hasEdit?: boolean;
hasShow?: boolean;
record?: Partial<RecordType>;
redirect?: RedirectionSideEffect;
resource?: string;
Expand Down