ra-core/src/core/useGetRecordRepresentation.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import * as React from 'react';
import { useCallback, ReactNode } from 'react';
import get from 'lodash/get';

import { useResourceDefinition } from './useResourceDefinition';

/**
 * Get the default representation of a record (either a string or a React node)
 *
 * @example // No customization
 * const getRecordRepresentation = useGetRecordRepresentation('posts');
 * getRecordRepresentation({ id: 1, title: 'Hello' }); // => "#1"
 *
 * @example // With <Resource name="posts" recordRepresentation="title" />
 * const getRecordRepresentation = useGetRecordRepresentation('posts');
 * getRecordRepresentation({ id: 1, title: 'Hello' }); // => "Hello"
 */
export const useGetRecordRepresentation = (
    resource?: string
): ((record: any) => ReactNode) => {
    const { recordRepresentation } = useResourceDefinition({ resource });
    return useCallback(
        record => {
            if (!record) return '';
            if (typeof recordRepresentation === 'function') {
                return recordRepresentation(record);
            }
            if (typeof recordRepresentation === 'string') {
                return get(record, recordRepresentation);
            }
            if (React.isValidElement(recordRepresentation)) {
                return recordRepresentation;
            }
            if (record?.name != null && record?.name !== '') {
                return record.name;
            }
            if (record?.title != null && record?.title !== '') {
                return record.title;
            }
            if (record?.label != null && record?.label !== '') {
                return record.label;
            }
            if (record?.reference != null && record?.reference !== '') {
                return record.reference;
            }
            return `#${record.id}`;
        },
        [recordRepresentation]
    );
};