HoloCollectionView

HoloCollectionView provides chained syntax calls that encapsulate delegate methods for UICollectionView. The delegate methods for UICollectionView is distributed to each cell, each cell having its own method for setting Class, model, size, and click event, etc.

Features

• Provide section and item maker to handle proxy events of HoloCollectionView.
• Provide protocols, implemented in cells, headers and footers to handle proxy events of HoloCollectionView.
• Diff reload data. HoloCollectionViewDiffPlugin to support DeepDiff
• Support to reload a collection view by setting datasource with HoloCollectionSection and HoloCollectionItem.
• Adapt new APIs from iOS 13 and iOS 14.
• Modern Objective-C and better Swift support.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Integration with 3rd party libraries

• HoloCollectionViewDiffPlugin - plugin to support DeepDiff, diff reload a section of UICollectionView. DeepDiff tells the difference between 2 collections and the changes as edit steps.

Usage

中文介绍、文章介绍

1. Make a simple cell list

UICollectionViewFlowLayout *flowLayout = [UICollectionViewFlowLayout new];
flowLayout...

UICollectionView *collectionView = [[UICollectionView alloc] initWithFrame:self.view.bounds collectionViewLayout:flowLayout];
[self.view addSubview:collectionView];

[collectionView holo_makeItems:^(HoloCollectionViewItemMaker * _Nonnull make) {
    // make a cell
    make.item(ExampleCollectionViewCell.class).model(NSDictionary.new).size(CGSizeMake(100, 200));
    
    // make a list
    for (NSObject *obj in NSArray.new) {
        make.item(ExampleCollectionViewCell.class).model(obj).didSelectHandler(^(id  _Nullable model) {
            NSLog(@"did select item : %@", model);
        });
    }
}];

[collectionView reloadData];

// etc.

The holo_makeItems: method is used to create a list of items with a default section. Each item is a cell. More properties provided for item see: HoloCollectionViewItemMaker.h and HoloCollectionItemMaker.h

Requirements for cell

Conforms to protocol HoloCollectionViewCellProtocol, HoloCollectionView will automatically identify cell whether implement these methods and calls, the commonly used two methods:

@required

// set the model to cell
// the model is the object passed in by make.model()
- (void)holo_configureCellWithModel:(id)model;


@optional

// return cell size（ Priority is higher than: 'sizeHandler' and 'size' of maker）
// the model is the object passed in by make.model()
+ (CGSize)holo_sizeForCellWithModel:(id)model;

See HoloCollectionViewCellProtocol more methods: HoloCollectionViewCellProtocol

You can also call your own methods by configuring properties such as configSEL, sizeSEL, etc. More properties can find in HoloCollectionItemMaker.h.

Note that attributes such as size, shouldHighlight, etc. that exist SEL have priority:

1. First judge whether cell implements sizeSEL method
2. Secondly, verify the implementation of the sizeHandler block
3. Finally, determine whether the property size is assigned

2. Make a section list (contain header, footer, item)

UICollectionViewFlowLayout *flowLayout = [UICollectionViewFlowLayout new];
flowLayout...

UICollectionView *collectionView = [[UICollectionView alloc] initWithFrame:self.view.bounds collectionViewLayout:flowLayout];
[self.view addSubview:collectionView];

[collectionView holo_makeSections:^(HoloCollectionViewSectionMaker * _Nonnull make) {
    make.section(TAG)
    .header(ExampleHeaderView.class).headerSize(CGSizeMake(HOLO_SCREEN_WIDTH, 100))
    .footer(ExampleFooterView.class).footerSize(CGSizeMake(HOLO_SCREEN_WIDTH, 100))
    .makeItems(^(HoloCollectionViewItemMaker * _Nonnull make) {
        // make a cell
        make.item(ExampleCollectionViewCell.class).model(NSDictionary.new).size(CGSizeMake(100, 200));
        
        // make a list
        for (NSObject *obj in NSArray.new) {
            make.item(ExampleCollectionViewCell.class).model(obj).didSelectHandler(^(id  _Nullable model) {
                NSLog(@"did select item : %@", model);
            });
        }
    });
}];

[collectionView reloadData];

The holo_makeSections: method is used to create a list of section. More properties provided for section see: HoloCollectionViewSectionMaker.h and HoloCollectionSectionMaker.h

Requirements for header and footer

1. header: conforms to protocol HoloCollectionViewHeaderProtocol , implement these methods, the commonly used two methods:

@required

// set the model to header
// the model is the object passed in by make.headerModel()
- (void)holo_configureHeaderWithModel:(id)model;

@optional
    
// return header size（ Priority is higher than: 'headerSizeHandler' and 'headerSize' of maker）
// the model is the object passed in by make.headerModel()
+ (CGSize)holo_sizeForHeaderWithModel:(id)model;

2. Footer: conforms to protocol HoloCollectionViewFooterProtocol , implement these methods, the commonly used two methods:

@required

// set the model to footer
// the model is the object passed in by make.footerModel()
- (void)holo_configureFooterWithModel:(id)model;

@optional

// return footer size（ Priority is higher than: 'footerSizeHandler' and 'footerSize' of maker）
// the model is the object passed in by make.footerModel()
+ (CGSize)holo_sizeForFooterWithModel:(id)model;

See HoloCollectionViewHeaderProtocol and HoloCollectionViewFooterProtocol more methods: HoloCollectionViewHeaderProtocol and HoloCollectionViewFooterProtocol

You can also call your own methods by configuring properties such as headerConfigSEL, footerConfigSEL, etc. More properties can find in HoloCollectionSectionMaker.h.

Like cell, properties that contain SEL also have a priority.

3. Methods for section

// adding
[self.collectionView holo_makeSections:^(HoloCollectionViewSectionMaker * _Nonnull make) {
    make.section(TAG);
}];

// inserting at index
[self.collectionView holo_insertSectionsAtIndex:0 block:^(HoloCollectionViewSectionMaker * _Nonnull make) {
    make.section(TAG);
}];

// updating with tag value by maker
[self.collectionView holo_updateSections:^(HoloCollectionViewSectionMaker * _Nonnull make) {
    make.section(TAG);
}];

// resetting with tag value by maker
[self.collectionView holo_remakeSections:^(HoloCollectionViewSectionMaker * _Nonnull make) {
    make.section(TAG);
}];

// deleting
[self.collectionView holo_removeAllSections];

// deleting with tag value
[self.collectionView holo_removeSections:@[TAG]];


// reloadData
[self.collectionView reloadData];

UICollectionView+HoloCollectionView.h provides a series of methods for manipulating sections, including adding, inserting, updating, resetting, deleting, etc. More methods provided for section see: UICollectionView+HoloCollectionView.h (about section)

4. Methods for item

// adding
[self.collectionView holo_makeItems:^(HoloCollectionViewItemMaker * _Nonnull make) {
    make.item(ExampleCollectionViewCell.class);
}];

// adding to section with tag value
[self.collectionView holo_makeItemsInSection:TAG block:^(HoloCollectionViewItemMaker * _Nonnull make) {
    make.item(ExampleCollectionViewCell.class);
}];

// inserting at index
[self.collectionView holo_insertItemsAtIndex:0 block:^(HoloCollectionViewItemMaker * _Nonnull make) {
    make.item(ExampleCollectionViewCell.class);
}];

// inserting at index to section with tag value
[self.collectionView holo_insertItemsAtIndex:0 inSection:TAG block:^(HoloCollectionViewItemMaker * _Nonnull make) {
    make.item(ExampleCollectionViewCell.class);
}];

// updating
[self.collectionView holo_updateItems:^(HoloCollectionViewUpdateItemMaker * _Nonnull make) {
    make.tag(TAG).size(CGSizeMake(100, 200));
}];

// resetting
[self.collectionView holo_remakeItems:^(HoloCollectionViewUpdateItemMaker * _Nonnull make) {
    make.tag(TAG).model(NSDictionary.new).size(CGSizeMake(100, 200));
}];

// deleting
[self.collectionView holo_removeAllItemsInSections:@[TAG]];

// deleting
[self.collectionView holo_removeItems:@[TAG]];


// reloadData
[self.collectionView reloadData];

UICollectionView+HoloCollectionView.h provides a series of methods for manipulating items, including adding, inserting, updating, resetting, deleting, etc. More methods provided for item see: UICollectionView+HoloCollectionView.h (about item)

5. Retrieve Delegate

You can retrieve the delegate of UICollectionView at any time, such as:

// first way
self.collectionView.holo_proxy.dataSource = self;
self.collectionView.holo_proxy.delegate = self;
self.collectionView.holo_proxy.scrollDelegate = self;

// second way
[self.collectionView holo_makeCollectionView:^(HoloCollectionViewViewMaker * _Nonnull make) {
    make.dataSource(self).delegate(self).scrollDelegate(self);
}];

Once you set up dataSource, delegate, scrollDelegate and implement some of their methods, HoloCollectionView will use your methods and return values first. For specific logic, please refer to: HoloCollectionViewProxy.m

6. Reload a collection view by setting datasource with HoloCollectionSection and HoloCollectionItem

Make a section list with HoloTableSection and HoloTableRow:

HoloCollectionSection *section = [HoloCollectionSection new];
section.tag = TAG;

section.header = ExampleHeaderView.class;
section.headerModel = @{@"title":@"header"};
section.headerSize = CGSizeMake(HOLO_SCREEN_WIDTH, 100);

section.footer = ExampleFooterView.class;
section.footerModel = @{@"title":@"footer"};
section.footerSize = CGSizeMake(HOLO_SCREEN_WIDTH, 100);

NSMutableArray *items = [NSMutableArray new];
for (NSDictionary *dict in self.modelArray) {
    HoloCollectionItem *item = [HoloCollectionItem new];
    item.cell = ExampleCollectionViewCell.class;
    item.model = dict;
    [items addObject:item];
}
section.items = items;

self.collectionView.holo_sections = @[section];
[self.collectionView reloadData];

Installation

HoloCollectionView is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'HoloCollectionView'

Author

gonghonglou, gonghonglou@icloud.com

License

HoloCollectionView is available under the MIT license. See the LICENSE file for more info.