ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
35 lines • 1.35 kB
TypeScript
import { RaRecord } from '../../types';
/**
* Hook to read the record from a RecordContext.
*
* Must be used within a <RecordContext> such as provided by the <EditContextProvider>
* (e.g. as a descendent of <Edit> or <EditBase>) or within a <ShowContextProvider>
* (e.g. as a descendent of <Show> or <ShowBase>)
*
* @example // basic usage
*
* import { useRecordContext } from 'ra-core';
*
* const TitleField = () => {
* const record = useRecordContext();
* return <span>{record && record.title}</span>;
* };
*
* @example // allow record override via props
*
* import { useRecordContext } from 'ra-core';
*
* const TitleField = (props) => {
* const record = useRecordContext(props);
* return <span>{record && record.title}</span>;
* };
* render(<TextField record={record} />);
*
* @returns {RaRecord} A record object
*/
export declare const useRecordContext: <RecordType extends RaRecord<import("../../types").Identifier> | Omit<RaRecord<import("../../types").Identifier>, "id"> = RaRecord<import("../../types").Identifier>>(props?: UseRecordContextParams<RecordType> | undefined) => RecordType | undefined;
export interface UseRecordContextParams<RecordType extends RaRecord | Omit<RaRecord, 'id'> = RaRecord> {
record?: RecordType;
[key: string]: any;
}
//# sourceMappingURL=useRecordContext.d.ts.map