ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
33 lines • 1.16 kB
TypeScript
/// <reference types="react" />
import { ResourceDefinition, ResourceOptions } from '../types';
/**
* 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 declare const useResourceDefinition: <OptionsType extends ResourceOptions = any>(props?: UseResourceDefinitionOptions) => ResourceDefinition<OptionsType>;
export interface UseResourceDefinitionOptions {
readonly resource?: string;
readonly hasList?: boolean;
readonly hasEdit?: boolean;
readonly hasShow?: boolean;
readonly hasCreate?: boolean;
readonly recordRepresentation?: string | React.ReactElement | ((record: any) => string);
}
//# sourceMappingURL=useResourceDefinition.d.ts.map