FAQ

Can I have custom identifiers/primary keys for my resources?

React-admin requires that each resource has an id field to identify it. If your API uses a different name for the primary key, you have to map that name to id in a custom dataProvider. For instance, to use a field named _id as identifier:

const convertHTTPResponse = (response, type, resource, params) => {
    const { headers, json } = response;
    switch (type) {
    case GET_LIST:
        return {
            data: json.map(resource => ({ ...resource, id: resource._id }) ),
            total: parseInt(headers.get('content-range').split('/').pop(), 10),
        };
    case UPDATE:
    case DELETE:
    case GET_ONE:
        return { ...json, id: json._id };
    case CREATE:
        return { ...params.data, id: json._id };
    default:
        return json;
    }
};

I get warning about unique key for child in array

When displaying a Datagrid component, you get the following warning:

Warning: Each child in an array or iterator should have a unique “key” prop. Check the render method of DatagridBody.

This is most probably because the resource does not have an id property as expected by react-admin. See the previous FAQ to see how to resolve this: Can I have custom identifiers/primary keys for my resources?

A form with validation freezes when rendering

You’re probably using validator factories directly in the render method of your component:

export const CommentEdit = ({ ...props }) => (
    <Edit {...props}>
        <SimpleForm>
            <DisabledInput source="id" />
            <DateInput source="created_at" />
            <LongTextInput source="body" validate={minLength(10)} />
        </SimpleForm>
    </Edit>
);

Avoid calling functions directly inside the render method:

const validateMinLength = minLength(10);

export const CommentEdit = ({ ...props }) => (
    <Edit {...props}>
        <SimpleForm>
            <DisabledInput source="id" />
            <DateInput source="created_at" />
            <LongTextInput source="body" validate={validateMinLength} />
        </SimpleForm>
    </Edit>
);

This is related to redux-form.

How can I customize the UI depending on the user permissions?

Some fairly common use cases which may be dependent on the user permissions:

  • Specific views
  • Having parts of a view (fields, inputs) differents for specific users
  • Hiding or displaying menu items

For all those cases, you can use the aor-permissions addon.

How can I customize forms depending on its inputs values?

Some use cases:

  • Show/hide some inputs if another input has a value
  • Show/hide some inputs if another input has a specific value
  • Show/hide some inputs if the current form values matches specific constraints

For all those cases, you can use the aor-dependent-input addon.

UI in production build is empty or broke

You have probably specified a version requirement for @material-ui/core that is incompatible with the one required by react-admin. As a consequence, npm bundled two copies of material-ui in your application, and material-ui doesn’t work in that case.

Please align your version requirement with the one of the ra-ui-materialui package.

See this issue for more information.

My Resource is defined but not displayed on the Menu

You can declare a resource without list prop, to manage reference for example:

<Admin>
    <Resource name="reference" create={PostReference} edit={EditReference} />
</Admin>

But with the default menu, resources without list prop aren’t shown.

In order to have a specific resource without list prop listed on the menu, you have to write your own custom menu.

 const MyMenu = ({ resources, onMenuClick, logout }) => (
    <div>
        {resources.map(resource => (
            <MenuItemLink to={`/${resource.name}`} primaryText={resource.name} onClick={onMenuClick} />
        ))}
        <MenuItemLink to="/reference/create" primaryText="New Reference" onClick={onMenuClick} />
    </div>
);

Why Doesn’t React Admin Support The Latest Version Of Material-UI?

React Admin users and third-party libraries maintainers might have noticed that the default UI template ra-ui-materialui has @material-ui/[email protected]^1.4.0 as dependency even though the latest version of Material UI is already 3.x.

We chose not to upgrade to Material UI v3 when it was released because the MUI team was already hard at work preparing the next major version (which includes major breaking changes). In fact, material-ui published a release schedule for one major version every 6 months. This means that developers using material-ui have to upgrade their codebase every six months to get the latest updates. On the other hand, react-admin plans to release a major version once every year, minimizing the upgrade work for developers. This gain in stability is a tradeoff - react-admin users can’t use the latest version of material-ui for about half a year.

Feel free to discuss this policy in issue #2399.

If you are a maintainer of a third-party library based on React Admin, your library has to add material-ui v1.x as a peer dependency.