UICollectionViewDiffableDataSource() constructor
The UICollectionViewDiffableDataSource() constructor creates a data source, attaches it to a list, and supplies the cellProvider the system calls when it needs to show an item.
Syntax
new UICollectionViewDiffableDataSource(collectionView, { cellProvider })Parameters
collectionView
The list to attach to, a UICollectionView.
options.cellProvider
A function, required. The system calls it when it needs to show an item: cellProvider(collectionView, indexPath, itemIdentifier). The three arguments are this list, the item's position (an NSIndexPath), and the item's identifier. It must return a cell, obtained with dequeueReusableCellWithReuseIdentifier().
- It runs on the spot: the system waits for it to return, and the interface does not move while it runs. Only get a cell and set its content in it.
- It is called only for the rows that fit on screen, not for every item (verified by testing).
- If it throws, the app does not crash: the exception is reported through the
errorevent ofapplication, and the item shows as blank. - If it returns something that is not a cell, the
errorevent reportsTypeError: cellProvider must return a UICollectionViewCell, got undefined, and the item shows as blank.
Return value
The new data source, already attached to collectionView: collectionView.dataSource reads as it. The list holds the data source, so you do not need to keep a separate reference.
Exceptions
TypeError
- The first argument is not a list:
UICollectionViewDiffableDataSource needs a UICollectionView cellProvideris not a function, or no options were given:UICollectionViewDiffableDataSource: cellProvider must be a function
Examples
const list = new UICollectionView(
UICollectionViewCompositionalLayout.layoutWithListConfiguration(
new UICollectionLayoutListConfiguration('insetGrouped')));
list.registerClass(UICollectionViewListCell, { forCellWithReuseIdentifier: 'row' });
const source = new UICollectionViewDiffableDataSource(list, {
cellProvider(collectionView, indexPath, id) {
const cell = collectionView.dequeueReusableCellWithReuseIdentifier('row', { forIndexPath: indexPath });
const content = cell.defaultContentConfiguration();
content.text = String(id);
cell.contentConfiguration = content;
return cell;
},
});
console.log(list.dataSource === source);Result: Prints true.
Corresponding iOS API
-[UICollectionViewDiffableDataSource initWithCollectionView:cellProvider:]. The ObjC block is written as a function in the options object.