ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
43 lines • 1.31 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.useResourceContext = void 0;
var react_1 = require("react");
var ResourceContext_1 = require("./ResourceContext");
/**
* Hook to read the resource from the ResourceContext.
*
* Must be used within a <ResourceContextProvider> (e.g. as a descendent of <Resource>
* or any reference related components), or called with a resource prop.
*
* @example
*
* const ResourceName = (props) => {
* const resource = useResourceContext(props);
* const getResourceLabel = useGetResourceLabel();
* return <>{getResourceLabel(resource, 1)}</>;
* }
*
* // use it in a resource context
* const MyComponent = () => (
* <ResourceContextProvider value="posts">
* <ResourceName />
* ...
* </ResourceContextProvider>
* );
*
* // override resource via props
* const MyComponent = () => (
* <>
* <ResourceName resource="posts"/>
* ...
* </>
* );
*
* @returns {ResourceContextValue} The resource name, e.g. 'posts'
*/
var useResourceContext = function (props) {
var context = (0, react_1.useContext)(ResourceContext_1.ResourceContext);
return (props && props.resource) || context;
};
exports.useResourceContext = useResourceContext;
//# sourceMappingURL=useResourceContext.js.map