Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anodamobi/alister
No more boilerplate code with tables and collections!
https://github.com/anodamobi/alister
alister collectioncontroller objective-c tableview
Last synced: 4 months ago
JSON representation
No more boilerplate code with tables and collections!
- Host: GitHub
- URL: https://github.com/anodamobi/alister
- Owner: anodamobi
- License: mit
- Created: 2016-07-11T15:59:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-30T14:10:12.000Z (over 7 years ago)
- Last Synced: 2024-10-14T16:44:08.433Z (4 months ago)
- Topics: alister, collectioncontroller, objective-c, tableview
- Language: Objective-C
- Homepage: http://anoda.mobi/open-source/
- Size: 2.64 MB
- Stars: 15
- Watchers: 12
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# Alister
[](https://www.bitrise.io/app/b900e8f15eea0533)
[](http://cocoapods.org/pods/Alister)
[](http://cocoapods.org/pods/Alister)
[](http://cocoapods.org/pods/Alister)
[](https://codecov.io/gh/anodamobi/Alister)
[](https://codebeat.co/projects/github-com-anodamobi-alister)
# Overview
`Alister` allows to manage the content of any `UITableView` or `UICollectionView`.
The general idea is provide a layer that synchronizes data with the cell appearance for such operations like adding, moving, deleting and reordering.
Alister automatically handle `UITableView` and `UICollectionView` data source and delegates protocols and you can override them by subclassing from base controllers.
# Features
- Works with `UITableView` and `UICollectionView`
- Supports all operations for sections and rows such as `Insert`, `Delete`, `Move`, `Reload`
- Supports `UISearchBar` and provide search predicate
- Supports custom header and footer views
- Provides keyboard handling
- Provides bottom sticked footer as part of `ANTableView`
# Usage
#### Initialize storage and list controller
Use `ANTableController` and `ANCollectionController` for `UITableView` and `UICollectionView` respectively.
```objc
self.storage = [ANStorage new];
self.tableController = [ANTableController controllerWithTableView:self.tableView];
[self.tableController attachStorage:self.storage];
self.collectionController = [ANCollectionController controllerWithCollectionView:self.collectionView];
[self.collectionController attachStorage:self.storage];
```
#### Register cell, header and footer views for models
You can register any views for any model classes.
```objc
[self.controller configureCellsWithBlock:^(id configurator) {
[configurator registerCellClass:[ANBaseTableViewCell class]
forModelClass:[ANBaseTableViewCellViewModel class]];
[configurator registerFooterClass:[ANBaseTableFooterView class]
forModelClass:[NSString class]];
[configurator registerHeaderClass:[ANBaseTableHeaderView class]
forModelClass:[NSString class]];
}];
```
#### Add models to `ANStorage`
```objc
NSArray* models = [self generateModels];
[self.storage updateWithoutAnimationChangeBlock:^(id storageController) {
[storageController addItems:models]; // items will be added to a first section by default
[storageController addItems:models toSection:10];
[storageController addItem:@"Title" atIndexPath:indexPath];
// Supplementary models
[storageController updateSectionHeaderModel:headerTitle forSectionIndex:0];
[storageController updateSectionFooterModel:footerTitle forSectionIndex:0];
}];
```
#### And that`s all!
Here is an inline .
{:height="50px" width="90px"}
#### Changing cells order
`Alister` will change order of cells and models in storage automatically.
Or you can change it manually:
```objc
[self.storage updateWithAnimationChangeBlock:^(id storageController) {
[storageController moveItemFromIndexPath:fromIndexPath toIndexPath:toIndexPath];
}];
```
#### Models search with `UISearchBar`
`Alister` provides an ablility to search in storage.
To use it, search bar and search predicate block must be set:
```objc
[self.controller attachSearchBar:self.searchBar];
[self.controller updateSearchingPredicateBlock:[self predicateBlock]];
```
Where search predicate block is:
```objc
- (ANListControllerSearchPredicateBlock)predicateBlock
{
return ^NSPredicate* (NSString* searchString, NSInteger scope) {
NSPredicate* predicate = nil;
if (searchString)
{
predicate = [NSPredicate predicateWithFormat:@"self BEGINSWITH[cd] %@", searchString];
}
return predicate;
};
}
```
#### Item selection
Provide `configureItemSelectionBlock:` block for handling default cells selection.
```objc
[self.controller configureItemSelectionBlock:^(id model, NSIndexPath *indexPath) {
//Handle selection
}];
```
#### Custom header and footer views
Provide custom header and footer for list views.
```objc
[self.storage updateWithAnimationChangeBlock:^(id storageController) {
[storageController updateSectionHeaderModel:headerModel forSectionIndex:0];
[storageController updateSectionFooterModel:footerModel forSectionIndex:0];
}];
```
#### Table sticked footer
`ANTableView` provides an ability to set custom sticked footer.
```objc
[self.tableView addStickyFooter:self.footerView withFixedHeight:100];
[self.tableView updateStickerHeight:200];
```
#### Demo
See projects example or use it by web (Appetize.io link)
To run the example project, clone the repo or download, and run `pod install` from the Example directory first.
## Requirements
Xcode 7.2 or higher
iOS 9 or higher
## Installation
Alister is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "Alister"
```
## Changelog
### 0.2
renamed methods in ANStorage:
- setHeaderModel: sectionIndex:
- setFooterModel: sectionIndex:
to update ... model
## Author
Oksana Kovalchuk, [email protected]
## License
Alister is available under the MIT license. See the LICENSE file for more info.