ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
34 lines • 1.15 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.useRemoveFromStore = void 0;
const react_1 = require("react");
const useStoreContext_1 = require("./useStoreContext.cjs");
/**
* Get a callback to remove an item from the store
*
* @example
* import { useRemoveFromStore } from 'react-admin';
*
* const ResetDatagridPrefs = () {
* const removeItem = useRemoveFromStore();
*
* const handleClick = () => {
* removeItem('datagrid.prefs');
* };
*
* return <Button onClick={hancleClick}>Reset datagrid preferences</Button>;
* }
*/
const useRemoveFromStore = (hookTimeKey) => {
const { removeItem } = (0, useStoreContext_1.useStoreContext)();
return (0, react_1.useCallback)((key) => {
if (typeof key === 'undefined' &&
typeof hookTimeKey === 'undefined') {
throw new Error('You must provide a key to remove an item from the store');
}
// @ts-ignore
return removeItem(key ?? hookTimeKey);
}, [removeItem, hookTimeKey]);
};
exports.useRemoveFromStore = useRemoveFromStore;
//# sourceMappingURL=useRemoveFromStore.js.map