Skip to content

Latest commit

 

History

History
144 lines (97 loc) · 6.21 KB

README.md

File metadata and controls

144 lines (97 loc) · 6.21 KB
Raw

SWRevealTableViewCell

SWRevealTableViewCell is UITableViewCell subclass to easily display left and right buttons based on user pan gestures or developer programmatic actions. Similar to the iOS8 mail app and but with enhanced features.

Features

  • Support for any combination of left/right utility buttons.
  • Works both on iOS7 and iOS8, no issues
  • Full in and out animations of utility buttons with damper effect.
  • Buttons are specified by providing an array of SWCellButtonItems, similar to UIToolBarItems.
  • Items can have text, images or both.
  • Configurable item sizes on an individual basis.
  • Item action is provided by calling a handler block.
  • Convenience UIActionSheet category method 'showFromCellButtonItem:animated:' to display menus from items
  • Correct handling of rotations, and cell/table resizing.
  • No issues with transparency, background colors or images on cells or table views.
  • No issues with accessory views on cells.
  • API easier than a UIToolbar.
  • Seamless integration of a pan gesture recognizer, behaving as smooth as silk.
  • Comprehensive set of delegate methods for getting full state of the controller and implementing your own code hooks for customizing behavior.
  • Lightweight, clean, easy-to-read, self-documenting code that you will enjoy using in your projects.

Basic Functionality

Left and right 'cellButtonItems' with optional 'performsActionOnOverdraw' feature, imitating iOS8 mail app feedback animation for deleting cells

Image1

Items can be stacked 'first on top' (default) or 'last on top' (like iOS8 mail app). The following gif shows button items stacked as if they were behind the cell.

Image2

Works well with transparency and visual effects on cells and button items. No issues either with tableViewCell accessory views.

Image3

YouTube Videos

http://youtu.be/jlaWQsWinoU (new)

http://youtu.be/v6GAGdf_Kkg

Examples

The repo includes the following example projects that can be used as templates or for testing purposes

  • RevealTableViewCellExample.xcodeproj

Image      Image      Image      Image

Requirements

  • iOS 7.0 or later.
  • Objective-C, ARC.

Usage

The SWRevealTableViewCell repository attempts to provide an updated cocoaPods file and consistent tag versioning, but it is not actively updated on the cocoapods-specs repository.

The easiest way to install it is by copying the following to your project:

  • SWRevealTableViewCell.h
  • SWRevealTableViewCell.m

On your project:

  • Initialize instances of SWRevealTableViewCell on your cellForRowAtIndexPath or register the SWRevealTableViewCell for use with you table view
  • In cellForRowAtIndexPath set the dataSource and optionally the delegate for SWRevealTableViewCell instances.
  • Implement the following two datasource methods to return an array of SWCellButtonItems
    • (NSArray*)leftButtonItemsInRevealTableViewCell:(SWRevealTableViewCell *)revealTableViewCell
    • (NSArray*)rightButtonItemsInRevealTableViewCell:(SWRevealTableViewCell *)revealTableViewCell

Basic API Description

Registering a SWRevealTableViewCell for use on your tableView

[tableView registerClass:[SWRevealTableViewCell class] forCellReuseIdentifier:RevealCellReuseIdentifier];

Creating cell instances

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
    SWRevealTableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:RevealCellReuseIdentifier forIndexPath:indexPath];

    cell.dataSource = self;
    .
    .
}

Providing button items

- (NSArray*)rightButtonItemsInRevealTableViewCell:(SWRevealTableViewCell *)revealTableViewCell
{
    SWCellButtonItem *item1 = [SWCellButtonItem itemWithTitle:@"Delete" handler:^(SWCellButtonItem *item, SWRevealTableViewCell *cell)
    {
        NSLog( @"Delete");
    }];

    item1.backgroundColor = [UIColor redColor];
    item1.tintColor = [UIColor whiteColor];
    item1.width = 75;
    
    return @[item1];
}

Programmatic animation of left/right items. Position can be: SWCellRevealPositionLeft, SWCellRevealPositionCenter, SWCellRevealPositionRight

- (void)setRevealPosition:(SWCellRevealPosition)revealPosition animated:(BOOL)animated;

Other methods are documented in the SWRevealTableViewCell.h header file.

Release Notes

Release Notes are updated on the class main header file. Please see SWRevealTableViewCell.h

License

Copyright (c) 2013 Joan Lluch [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.