ra-core/dist/core/useResourceDefinition.js

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

import { useMemo } from 'react';
import defaults from 'lodash/defaults.js';
import { useResourceDefinitions } from "./useResourceDefinitions.js";
import { useResourceContext } from "./useResourceContext.js";
/**
 * Hook to get the definition of a given resource
 *
 * @example // Get the current resource definition (based on ResourceContext)
 *
 * const definition = useResourceDefinition();
 * console.log(definition);
 * // {
 * //   name: 'posts',
 * //   hasList: true,
 * //   hasEdit: true,
 * //   hasShow: true,
 * //   hasCreate: true,
 * //   options: {},
 * //   icon: PostIcon,
 * // }
 *
 * @example // Pass a resource prop to check a different resource definition
 *
 * const definition = useResourceDefinition({ resource: 'posts' });
 */
export const useResourceDefinition = (props) => {
    const resource = useResourceContext(props);
    const resourceDefinitions = useResourceDefinitions();
    const { hasCreate, hasEdit, hasList, hasShow, recordRepresentation } = props || {};
    const definition = useMemo(() => {
        return defaults({}, {
            hasCreate,
            hasEdit,
            hasList,
            hasShow,
            recordRepresentation,
        }, resource ? resourceDefinitions[resource] : {});
    }, [
        resource,
        resourceDefinitions,
        hasCreate,
        hasEdit,
        hasList,
        hasShow,
        recordRepresentation,
    ]);
    return definition;
};
//# sourceMappingURL=useResourceDefinition.js.map