ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
97 lines • 5.4 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.useListContextWithProps = void 0;
var react_1 = require("react");
var defaults_1 = __importDefault(require("lodash/defaults"));
var ListContext_1 = require("./ListContext");
/**
* Hook to read the list controller props from the ListContext.
*
* Mostly used within a <ListContext.Provider> (e.g. as a descendent of <List>
* or <ListBase>).
*
* But you can also use it without a <ListContext.Provider>. In this case, it is up to you
* to pass all the necessary props (see the list below).
*
* The given props will take precedence over context values.
*
* @typedef {Object} ListControllerProps
* @prop {Object} data an array of the list records, e.g. [{ id: 123, title: 'hello world' }, { ... }]
* @prop {integer} total the total number of results for the current filters, excluding pagination. Useful to build the pagination controls. e.g. 23
* @prop {boolean} isFetching boolean that is true on mount, and false once the data was fetched
* @prop {boolean} isLoading boolean that is false until the data is available
* @prop {integer} page the current page. Starts at 1
* @prop {Function} setPage a callback to change the page, e.g. setPage(3)
* @prop {integer} perPage the number of results per page. Defaults to 25
* @prop {Function} setPerPage a callback to change the number of results per page, e.g. setPerPage(25)
* @prop {Object} sort a sort object { field, order }, e.g. { field: 'date', order: 'DESC' }
* @prop {Function} setSort a callback to change the sort, e.g. setSort({ field : 'name', order: 'ASC' })
* @prop {Object} filterValues a dictionary of filter values, e.g. { title: 'lorem', nationality: 'fr' }
* @prop {Function} setFilters a callback to update the filters, e.g. setFilters(filters, displayedFilters)
* @prop {Object} displayedFilters a dictionary of the displayed filters, e.g. { title: true, nationality: true }
* @prop {Function} showFilter a callback to show one of the filters, e.g. showFilter('title', defaultValue)
* @prop {Function} hideFilter a callback to hide one of the filters, e.g. hideFilter('title')
* @prop {Array} selectedIds an array listing the ids of the selected rows, e.g. [123, 456]
* @prop {Function} onSelect callback to change the list of selected rows, e.g. onSelect([456, 789])
* @prop {Function} onSelectAll callback to select all the records, e.g. onSelectAll({ limit: 50, queryOptions: { meta: { foo: 'bar' } } })
* @prop {Function} onToggleItem callback to toggle the selection of a given record based on its id, e.g. onToggleItem(456)
* @prop {Function} onUnselectItems callback to clear the selection, e.g. onUnselectItems();
* @prop {string} defaultTitle the translated title based on the resource, e.g. 'Posts'
* @prop {string} resource the resource name, deduced from the location. e.g. 'posts'
*
* @param {ListControllerProps} props Props passed to the useListContext hook
*
* @returns {ListControllerResult} list controller props
*
* @see useListController for how it is filled
*/
var useListContextWithProps = function (props) {
var context = (0, react_1.useContext)(ListContext_1.ListContext);
// Props take precedence over the context
return (0, react_1.useMemo)(function () {
return (0, defaults_1.default)({}, props != null ? extractListContextProps(props) : {}, context);
}, [context, props]);
};
exports.useListContextWithProps = useListContextWithProps;
/**
* Extract only the list controller props
*
* @param {Object} props Props passed to the useListContext hook
*
* @returns {ListControllerResult} List controller props
*/
var extractListContextProps = function (_a) {
var sort = _a.sort, data = _a.data, defaultTitle = _a.defaultTitle, displayedFilters = _a.displayedFilters, exporter = _a.exporter, filterValues = _a.filterValues, hasCreate = _a.hasCreate, hideFilter = _a.hideFilter, isFetching = _a.isFetching, isLoading = _a.isLoading, isPending = _a.isPending, onSelect = _a.onSelect, onSelectAll = _a.onSelectAll, onToggleItem = _a.onToggleItem, onUnselectItems = _a.onUnselectItems, page = _a.page, perPage = _a.perPage, refetch = _a.refetch, resource = _a.resource, selectedIds = _a.selectedIds, setFilters = _a.setFilters, setPage = _a.setPage, setPerPage = _a.setPerPage, setSort = _a.setSort, showFilter = _a.showFilter, total = _a.total;
return ({
sort: sort,
data: data,
defaultTitle: defaultTitle,
displayedFilters: displayedFilters,
exporter: exporter,
filterValues: filterValues,
hasCreate: hasCreate,
hideFilter: hideFilter,
isFetching: isFetching,
isLoading: isLoading,
isPending: isPending,
onSelect: onSelect,
onSelectAll: onSelectAll,
onToggleItem: onToggleItem,
onUnselectItems: onUnselectItems,
page: page,
perPage: perPage,
refetch: refetch,
resource: resource,
selectedIds: selectedIds,
setFilters: setFilters,
setPage: setPage,
setPerPage: setPerPage,
setSort: setSort,
showFilter: showFilter,
total: total,
});
};
//# sourceMappingURL=useListContextWithProps.js.map