diff --git a/docs/Classes.html b/docs/Classes.html index 023aef021..4c39206ce 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -10,6 +10,7 @@ +
@@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • @@ -263,9 +281,9 @@

    Classes

  • - - - IGListAdapter + + + IGListBatchUpdateData
    @@ -273,26 +291,23 @@

    Classes

    -

    IGListAdapter objects provide an abstraction for feeds of objects in a UICollectionView by breaking each object -into individual sections, called section controllers. These controllers (objects subclassing to -IGListSectionController) act as a data source and delegate for each section.

    - -

    Feed implementations must act as the data source for an IGListAdapter in order to drive the objects and section -controllers in a collection view.

    +

    An instance of IGListBatchUpdateData takes section indexes and item index paths +and performs cleanup on init in order to perform a crash-free +update via -[UICollectionView performBatchUpdates:completion:].

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListAdapter : NSObject
    +@interface IGListBatchUpdateData : NSObject

    Swift

    - 
    class ListAdapter : NSObject
    + 
    class ListBatchUpdateData : NSObject
    @@ -306,9 +321,9 @@

    Declaration

  • @@ -316,29 +331,21 @@

    Declaration

    -

    An IGListAdapterUpdater is a concrete type that conforms to IGListUpdatingDelegate. -It is an out-of-box updater for IGListAdapter objects to use.

    -
    -

    Note

    - This updater performs re-entrant, coalesced updating for a list. It also uses a least-minimal diff -for calculating UI updates when IGListAdapter calls --performUpdateWithCollectionView:fromObjects:toObjects:completion:. - -
    +

    A result object returned when diffing with sections.

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListAdapterUpdater : NSObject <IGListUpdatingDelegate>
    +@interface IGListIndexPathResult : NSObject

    Swift

    - 
    class ListAdapterUpdater : NSObject, ListUpdatingDelegate
    + 
    class ListIndexPathResult : NSObject
    @@ -352,9 +359,9 @@

    Declaration

  • @@ -362,23 +369,21 @@

    Declaration

    -

    An instance of IGListBatchUpdateData takes section indexes and item index paths -and performs cleanup on init in order to perform a crash-free -update via -[UICollectionView performBatchUpdates:completion:].

    +

    A result object returned when diffing with indexes.

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListBatchUpdateData : NSObject
    +@interface IGListIndexSetResult : NSObject

    Swift

    - 
    class ListBatchUpdateData : NSObject
    + 
    class ListIndexSetResult : NSObject
    @@ -392,9 +397,9 @@

    Declaration

  • @@ -402,38 +407,21 @@

    Declaration

    -

    This section controller uses a data source to transform its top level object into an array of diffable view models. -It then automatically binds each view model to cells via the IGListBindable protocol.

    - -

    Models used with IGListBindingSectionController should take special care to always return YES for identical -objects. That is, any objects with matching -diffIdentifiers should always be equal, that way the section controller -can create new view models via the data source, create a diff, and update the specific cells that have changed.

    - -

    In Objective-C, your -isEqualToDiffableObject: can simply be:

    -
    - (BOOL)isEqualToDiffableObject:(id)object {
-  return YES;
-}
-
    - -

    In Swift:

    -
    func isEqual(toDiffableObject object: IGListDiffable?) -> Bool {
-  return true
-}
-
    - -

    Only when -diffIdentifiers match is object equality compared, so you can assume the class is the same, and the -instance has already been checked.

    +

    An object representing a move between indexes.

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListBindingSectionController < __covariant ObjectType
-    : id <IGListDiffable>
-> : IGListSectionController @end
    +@interface IGListMoveIndex : NSObject + +
    +
    +

    Swift

    + 
    class ListMoveIndex : NSObject
    @@ -447,9 +435,9 @@

    Declaration

  • @@ -457,29 +445,21 @@

    Declaration

    -

    This UICollectionView subclass allows for partial layout invalidation using IGListCollectionViewLayout.

    -
    -

    Note

    - When updating a collection view (ex: calling -insertSections), -invalidateLayoutWithContext gets called on -the layout object. However, the invalidation context doesn’t provide details on which index paths are being modified, -which typically forces a full layout re-calculation. IGListCollectionView gives IGListCollectionViewLayout the -missing information to re-calculate only the modified layout attributes. - -
    +

    An object representing a move between indexes.

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListCollectionView : UICollectionView
    +@interface IGListMoveIndexPath : NSObject

    Swift

    - 
    class ListCollectionView : UICollectionView
    + 
    class ListMoveIndexPath : NSObject
    @@ -493,9 +473,9 @@

    Declaration

  • @@ -503,72 +483,26 @@

    Declaration

    -

    This UICollectionViewLayout subclass is for vertically or horizontally scrolling lists of data with variable widths and -heights. It supports an infinite number of sections and items. All work is done on the main thread, and while extremely efficient, -care must be taken not to stall the main thread in sizing delegate methods.

    - -

    This layout piggybacks on the mechanics of UICollectionViewFlowLayout in that:

    - -
      -
    • Your UICollectionView data source must also conform to UICollectionViewDelegateFlowLayout
      • -
    • Header support given via UICollectionElementKindSectionHeader
      • -
    - -

    All UICollectionViewDelegateFlowLayout methods are required and used by this layout:

    -
    - (CGSize)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout sizeForItemAtIndexPath:(NSIndexPath *)indexPath;
-- (UIEdgeInsets)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout insetForSectionAtIndex:(NSInteger)section;
-- (CGFloat)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout minimumLineSpacingForSectionAtIndex:(NSInteger)section;
-- (CGFloat)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout minimumInteritemSpacingForSectionAtIndex:(NSInteger)section;
-- (CGSize)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout referenceSizeForHeaderInSection:(NSInteger)section;
-
    - -

    In a vertically scrolling layout, sections and items are put into the same horizontal row until the max-x position -of an item extends beyond the width of the collection view. When that happens, the item is newlined to the next row. -The y position of that row is determined by the maximum height (including section insets) of the section/item of the previous row.

    - -

    Ex. of a section (2,0) with a large width causing a newline.

    -
    |[ 0,0 ][ 1,0 ]         |
-|[         2,0         ]|
-
    - -

    A section with a non-zero height header will always cause that section to newline. Headers are always stretched to the -width of the collection view, pinched with the section insets.

    - -

    Ex. of a section (2,0) with a header inset on the left/right.

    -
    |[ 0,0 ][ 1,0 ]         |
-| >======header=======< |
-| [ 2,0 ]               |
-
    - -

    Section insets apply to items in the section no matter if they begin on a new row or are on the same row as a previous -section.

    - -

    Ex. of a section (2) with multiple items and a left inset.

    -
    |[ 0,0 ][ 1,0 ] >[ 2,0 ]|
-| >[ 2,1 ][ 2,2 ][ 2,3 ]|
-
    - -

    Interitem spacing applies to items and sections within the same row. Line spacing only applies to items within the same -section.

    - -

    In a horizontally scrolling layout, sections and items are flowed vertically until they need to be newlined to the -next column. Headers, if used, are stretched to the height of the collection view, minus the section insets.

    +

    IGListAdapter objects provide an abstraction for feeds of objects in a UICollectionView by breaking each object +into individual sections, called section controllers. These controllers (objects subclassing to +IGListSectionController) act as a data source and delegate for each section.

    -

    Please see the unit tests for more configuration examples and expected output.

    +

    Feed implementations must act as the data source for an IGListAdapter in order to drive the objects and section +controllers in a collection view.

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListCollectionViewLayout : UICollectionViewLayout
    +@interface IGListAdapter : NSObject

    Swift

    - 
    class ListCollectionViewLayout : UICollectionViewLayout
    + 
    class ListAdapter : NSObject
    @@ -582,9 +516,9 @@

    Declaration

  • @@ -592,22 +526,29 @@

    Declaration

    -

    This class adds a helper layer to IGListSectionController to automatically store a generic object in -didUpdateToObject:.

    +

    An IGListAdapterUpdater is a concrete type that conforms to IGListUpdatingDelegate. +It is an out-of-box updater for IGListAdapter objects to use.

    +
    +

    Note

    + This updater performs re-entrant, coalesced updating for a list. It also uses a least-minimal diff +for calculating UI updates when IGListAdapter calls +-performUpdateWithCollectionView:fromObjects:toObjects:completion:. - See more +
    + + See more

    Declaration

    Objective-C

    
-@interface IGListGenericSectionController <__covariant ObjectType> : IGListSectionController
    +@interface IGListAdapterUpdater : NSObject <IGListUpdatingDelegate>

    Swift

    - 
    class ListGenericSectionController<ObjectType> : ListSectionController where ObjectType : AnyObject
    + 
    class ListAdapterUpdater : NSObject, ListUpdatingDelegate
    @@ -621,9 +562,9 @@

    Declaration

  • @@ -631,21 +572,42 @@

    Declaration

    -

    A result object returned when diffing with sections.

    +

    This section controller uses a data source to transform its top level object into an array of diffable view models. +It then automatically binds each view model to cells via the IGListBindable protocol.

    - See more +

    Models used with IGListBindingSectionController should take special care to always return YES for identical +objects. That is, any objects with matching -diffIdentifiers should always be equal, that way the section controller +can create new view models via the data source, create a diff, and update the specific cells that have changed.

    + +

    In Objective-C, your -isEqualToDiffableObject: can simply be:

    +
    - (BOOL)isEqualToDiffableObject:(id)object {
+  return YES;
+}
+
    + +

    In Swift:

    +
    func isEqual(toDiffableObject object: IGListDiffable?) -> Bool {
+  return true
+}
+
    + +

    Only when -diffIdentifiers match is object equality compared, so you can assume the class is the same, and the +instance has already been checked.

    + + See more

    Declaration

    Objective-C

    
-@interface IGListIndexPathResult : NSObject
    +@interface IGListBindingSectionController< + __covariant ObjectType : id <IGListDiffable>> : IGListSectionController

    Swift

    - 
    class ListIndexPathResult : NSObject
    + 
    class ListBindingSectionController<ObjectType> : ListSectionController where ObjectType : ListDiffable
    @@ -659,9 +621,9 @@

    Declaration

  • @@ -669,21 +631,30 @@

    Declaration

    -

    A result object returned when diffing with indexes.

    +

    This UICollectionView subclass allows for partial layout invalidation using IGListCollectionViewLayout, +or custom layout classes that conform to IGListCollectionViewLayoutCompatible.

    +
    +

    Note

    + When updating a collection view (ex: calling -insertSections), -invalidateLayoutWithContext gets called on +the layout object. However, the invalidation context doesn’t provide details on which index paths are being modified, +which typically forces a full layout re-calculation. IGListCollectionView gives IGListCollectionViewLayout the +missing information to re-calculate only the modified layout attributes. - See more +
    + + See more

    Declaration

    Objective-C

    
-@interface IGListIndexSetResult : NSObject
    +@interface IGListCollectionView : UICollectionView

    Swift

    - 
    class ListIndexSetResult : NSObject
    + 
    class ListCollectionView : UICollectionView
    @@ -697,9 +668,9 @@

    Declaration

  • @@ -707,21 +678,73 @@

    Declaration

    -

    An object representing a move between indexes.

    +

    This UICollectionViewLayout subclass is for vertically or horizontally scrolling lists of data with variable widths and +heights. It supports an infinite number of sections and items. All work is done on the main thread, and while extremely efficient, +care must be taken not to stall the main thread in sizing delegate methods.

    - See more +

    This layout piggybacks on the mechanics of UICollectionViewFlowLayout in that:

    + +
      +
    • Your UICollectionView data source must also conform to UICollectionViewDelegateFlowLayout
      • +
    • Header support given via UICollectionElementKindSectionHeader
      • +
    + +

    All UICollectionViewDelegateFlowLayout methods are required and used by this layout:

    +
    - (CGSize)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout sizeForItemAtIndexPath:(NSIndexPath *)indexPath;
+- (UIEdgeInsets)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout insetForSectionAtIndex:(NSInteger)section;
+- (CGFloat)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout minimumLineSpacingForSectionAtIndex:(NSInteger)section;
+- (CGFloat)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout minimumInteritemSpacingForSectionAtIndex:(NSInteger)section;
+- (CGSize)collectionView:(UICollectionView *)collectionView layout:(UICollectionViewLayout *)collectionViewLayout referenceSizeForHeaderInSection:(NSInteger)section;
+
    + +

    In a vertically scrolling layout, sections and items are put into the same horizontal row until the max-x position +of an item extends beyond the width of the collection view. When that happens, the item is newlined to the next row. +The y position of that row is determined by the maximum height (including section insets) of the section/item of the previous row.

    + +

    Ex. of a section (2,0) with a large width causing a newline.

    +
    |[ 0,0 ][ 1,0 ]         |
+|[         2,0         ]|
+
    + +

    A section with a non-zero height header will always cause that section to newline. Headers are always stretched to the +width of the collection view, pinched with the section insets.

    + +

    Ex. of a section (2,0) with a header inset on the left/right.

    +
    |[ 0,0 ][ 1,0 ]         |
+| >======header=======< |
+| [ 2,0 ]               |
+
    + +

    Section insets apply to items in the section no matter if they begin on a new row or are on the same row as a previous +section.

    + +

    Ex. of a section (2) with multiple items and a left inset.

    +
    |[ 0,0 ][ 1,0 ] >[ 2,0 ]|
+| >[ 2,1 ][ 2,2 ][ 2,3 ]|
+
    + +

    Interitem spacing applies to items and sections within the same row. Line spacing only applies to items within the same +section.

    + +

    In a horizontally scrolling layout, sections and items are flowed vertically until they need to be newlined to the +next column. Headers, if used, are stretched to the height of the collection view, minus the section insets.

    + +

    Please see the unit tests for more configuration examples and expected output.

    + + See more

    Declaration

    Objective-C

    
-@interface IGListMoveIndex : NSObject
    +@interface IGListCollectionViewLayout + : UICollectionViewLayout <IGListCollectionViewLayoutCompatible>

    Swift

    - 
    class ListMoveIndex : NSObject
    + 
    class ListCollectionViewLayout : UICollectionViewLayout, ListCollectionViewLayoutCompatible
    @@ -735,9 +758,9 @@

    Declaration

  • @@ -745,21 +768,23 @@

    Declaration

    -

    An object representing a move between indexes.

    +

    This class adds a helper layer to IGListSectionController to automatically store a generic object in +didUpdateToObject:.

    - See more + See more

    Declaration

    Objective-C

    
-@interface IGListMoveIndexPath : NSObject
    +@interface IGListGenericSectionController<__covariant ObjectType> + : IGListSectionController

    Swift

    - 
    class ListMoveIndexPath : NSObject
    + 
    class ListGenericSectionController<ObjectType> : ListSectionController where ObjectType : AnyObject
    @@ -889,56 +914,11 @@

    Declaration

    • -
    -
      -
    • - -
      -
      -
      -
      -
      -

      An instance of IGListStackedSectionController is a clustered section controller, composed of many child section -controllers. It constructs and routes item-level indexes to the appropriate child section controller with a local -index. This lets you build section controllers made up of individual units that can be shared and reused with other -section controllers.

      - -

      For example, you can create a Comments section controller that displays lists of text that is used alongside photo, -video, or slideshow section controllers. You then have four small and manageable section controllers instead of one -huge class.

      - - See more -
      -
      -

      Declaration

      -
      -

      Objective-C

      - 
      
-@interface IGListStackedSectionController : IGListSectionController
      - -
      -
      -

      Swift

      - 
      class ListStackedSectionController : ListSectionController
      - -
      -
      -
      -
      -
      • -
    -
    • diff --git a/docs/Classes/IGListAdapter.html b/docs/Classes/IGListAdapter.html index 85904a90c..f4c0cc8b9 100644 --- a/docs/Classes/IGListAdapter.html +++ b/docs/Classes/IGListAdapter.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -262,8 +279,8 @@

    IGListAdapter

    -

    IGListAdapter objects provide an abstraction for feeds of objects in a UICollectionView by breaking each object -into individual sections, called section controllers. These controllers (objects subclassing to +

    IGListAdapter objects provide an abstraction for feeds of objects in a UICollectionView by breaking each object +into individual sections, called section controllers. These controllers (objects subclassing to IGListSectionController) act as a data source and delegate for each section.

    Feed implementations must act as the data source for an IGListAdapter in order to drive the objects and section @@ -400,7 +417,7 @@

    Declaration

    Swift

    - 
    weak var delegate: IGListAdapterDelegate? { get set }
    + 
    weak var delegate: ListAdapterDelegate? { get set }
    @@ -516,6 +533,39 @@

    Declaration

    +
  • +
    + + + + performanceDelegate + +
    +
    +
    +
    +
    +
    +

    The object that receives IGListAdapterPerformanceDelegate events to measure performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, nonatomic, nullable) id<IGListAdapterPerformanceDelegate>
+    performanceDelegate;
    + +
    +
    +

    Swift

    + 
    weak var performanceDelegate: ListAdapterPerformanceDelegate? { get set }
    + +
    +
    +
    +
    +
  • @@ -607,9 +657,9 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
- initWithUpdater:(nonnull id<IGListUpdatingDelegate>)updater
-  viewController:(nullable UIViewController *)viewController
-workingRangeSize:(NSInteger)workingRangeSize;
    + initWithUpdater:(nonnull id<IGListUpdatingDelegate>)updater + viewController:(nullable UIViewController *)viewController + workingRangeSize:(NSInteger)workingRangeSize;
    @@ -684,8 +734,8 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
-initWithUpdater:(nonnull id<IGListUpdatingDelegate>)updater
- viewController:(nullable UIViewController *)viewController;
    + initWithUpdater:(nonnull id<IGListUpdatingDelegate>)updater + viewController:(nullable UIViewController *)viewController;
    @@ -749,7 +799,7 @@

    Declaration

    Objective-C

    - (void)performUpdatesAnimated:(BOOL)animated
-                    completion:(nullable IGListUpdaterCompletion)completion;
    + completion:(nullable IGListUpdaterCompletion)completion;
    @@ -818,7 +868,7 @@

    Parameters

    Declaration

    Objective-C

    - 
    - (void)reloadDataWithCompletion:(nullable IGListUpdaterCompletion)completion;
    + 
    - (void)reloadDataWithCompletion:(nullable IGListUpdaterCompletion)completion;
    @@ -1432,7 +1482,7 @@

    Declaration

    Swift

    - 
    func scroll(to object: Any, supplementaryKinds: [String]?, scrollDirection: UICollectionViewScrollDirection, scrollPosition: UICollectionViewScrollPosition, animated: Bool)
    + 
    func scroll(to object: Any, supplementaryKinds: [String]?, scrollDirection: UICollectionView.ScrollDirection, scrollPosition: UICollectionView.ScrollPosition, animated: Bool)
    @@ -1743,8 +1793,8 @@

    Parameters

    • diff --git a/docs/Classes/IGListAdapterUpdater.html b/docs/Classes/IGListAdapterUpdater.html index c0ec0464c..7c34e112c 100644 --- a/docs/Classes/IGListAdapterUpdater.html +++ b/docs/Classes/IGListAdapterUpdater.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -344,9 +361,9 @@

    Declaration

  • - - - allowsBackgroundReloading + + + preferItemReloadsForSectionReloads
    @@ -354,31 +371,28 @@

    Declaration

    -

    A flag indicating whether this updater should skip diffing and simply call -reloadData for updates when the collection view is not in a window. The default value is YES.

    +

    A flag indicating that section reloads should be treated as item reloads, instead of converting them to delete, then insert operations. +This only applies if the number of items for the section is unchanged.

    Note

    -

    This will result in better performance, but will not generate the same delegate -callbacks. If using a custom layout, it will not receive prepareForCollectionViewUpdates:.

    + If the number of items for the section is changed, we would fallback to the default behavior and convert it to delete + insert, +because the collectionView can crash otherwise.
    -
    -

    Warning

    -

    On iOS < 8.3, this behavior is unsupported and will always be treated as NO.

    -
    +

    Default is NO.

    Declaration

    Objective-C

    - 
    @property (assign, readwrite, nonatomic) BOOL allowsBackgroundReloading;
    + 
    @property (assign, readwrite, nonatomic) BOOL preferItemReloadsForSectionReloads;

    Swift

    - 
    var allowsBackgroundReloading: Bool { get set }
    + 
    var preferItemReloadsForSectionReloads: Bool { get set }
    @@ -388,9 +402,9 @@

    Declaration

  • @@ -398,19 +412,31 @@

    Declaration

    -

    Time, in seconds, to wait and coalesce batch updates. Default is 0.

    +

    A flag indicating whether this updater should skip diffing and simply call +reloadData for updates when the collection view is not in a window. The default value is YES.

    +
    +

    Note

    +

    This will result in better performance, but will not generate the same delegate +callbacks. If using a custom layout, it will not receive prepareForCollectionViewUpdates:.

    + +
    +
    +

    Warning

    +

    On iOS < 8.3, this behavior is unsupported and will always be treated as NO.

    + +

    Declaration

    Objective-C

    - 
    @property (assign, readwrite, nonatomic) NSTimeInterval coalescanceTime;
    + 
    @property (assign, readwrite, nonatomic) BOOL allowsBackgroundReloading;

    Swift

    - 
    var coalescanceTime: TimeInterval { get set }
    + 
    var allowsBackgroundReloading: Bool { get set }
    @@ -454,8 +480,8 @@

    Declaration

    • diff --git a/docs/Classes/IGListBatchUpdateData.html b/docs/Classes/IGListBatchUpdateData.html index abb8c8279..c1066ae4c 100644 --- a/docs/Classes/IGListBatchUpdateData.html +++ b/docs/Classes/IGListBatchUpdateData.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -433,6 +450,39 @@

    Declaration

    +
  • +
    + + + + updateIndexPaths + +
    +
    +
    +
    +
    +
    +

    Item update index paths.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, strong, nonatomic)
+    NSArray<NSIndexPath *> *_Nonnull updateIndexPaths;
    + +
    +
    +

    Swift

    + 
    var updateIndexPaths: [IndexPath] { get }
    + +
    +
    +
    +
    +
  • @@ -469,9 +519,9 @@

    Declaration

  • - - - -initWithInsertSections:deleteSections:moveSections:insertIndexPaths:deleteIndexPaths:moveIndexPaths: + + + -initWithInsertSections:deleteSections:moveSections:insertIndexPaths:deleteIndexPaths:updateIndexPaths:moveIndexPaths:fixIndexPathImbalance:
    @@ -487,17 +537,20 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
-initWithInsertSections:(nonnull NSIndexSet *)insertSections
-        deleteSections:(nonnull NSIndexSet *)deleteSections
-          moveSections:(nonnull NSSet<IGListMoveIndex *> *)moveSections
-      insertIndexPaths:(nonnull NSArray<NSIndexPath *> *)insertIndexPaths
-      deleteIndexPaths:(nonnull NSArray<NSIndexPath *> *)deleteIndexPaths
-        moveIndexPaths:(nonnull NSArray<IGListMoveIndexPath *> *)moveIndexPaths;
    + initWithInsertSections:(nonnull NSIndexSet *)insertSections + deleteSections:(nonnull NSIndexSet *)deleteSections + moveSections:(nonnull NSSet<IGListMoveIndex *> *)moveSections + insertIndexPaths:(nonnull NSArray<NSIndexPath *> *)insertIndexPaths + deleteIndexPaths:(nonnull NSArray<NSIndexPath *> *)deleteIndexPaths + updateIndexPaths:(nonnull NSArray<NSIndexPath *> *)updateIndexPaths + moveIndexPaths: + (nonnull NSArray<IGListMoveIndexPath *> *)moveIndexPaths + fixIndexPathImbalance:(BOOL)fixIndexPathImbalance;

    Swift

    - 
    init(insertSections: IndexSet, deleteSections: IndexSet, moveSections: Set<ListMoveIndex>, insert insertIndexPaths: [IndexPath], delete deleteIndexPaths: [IndexPath], moveIndexPaths: [ListMoveIndexPath])
    + 
    init(insertSections: IndexSet, deleteSections: IndexSet, moveSections: Set<ListMoveIndex>, insert insertIndexPaths: [IndexPath], delete deleteIndexPaths: [IndexPath], update updateIndexPaths: [IndexPath], moveIndexPaths: [ListMoveIndexPath], fixIndexPathImbalance: Bool)
    @@ -565,6 +618,18 @@

    Parameters

    + + + + updateIndexPaths + + + +
    +

    Item index paths to update.

    +
    + + @@ -577,6 +642,18 @@

    Parameters

    + + + + fixIndexPathImbalance + + + +
    +

    When enabled, we remove duplicate NSIndexPath inserts to avoid insert/delete imbalance and a crash.

    +
    + + @@ -587,13 +664,53 @@

    Return Value

    • +
  • +
    + + + + -initWithInsertSections:deleteSections:moveSections:insertIndexPaths:deleteIndexPaths:updateIndexPaths:moveIndexPaths: + +
    +
    +
    +
    +
    +
    +

    Convenience initializer with fixIndexPathImbalance disabled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithInsertSections:(nonnull NSIndexSet *)insertSections
+            deleteSections:(nonnull NSIndexSet *)deleteSections
+              moveSections:(nonnull NSSet<IGListMoveIndex *> *)moveSections
+          insertIndexPaths:(nonnull NSArray<NSIndexPath *> *)insertIndexPaths
+          deleteIndexPaths:(nonnull NSArray<NSIndexPath *> *)deleteIndexPaths
+          updateIndexPaths:(nonnull NSArray<NSIndexPath *> *)updateIndexPaths
+            moveIndexPaths:
+                (nonnull NSArray<IGListMoveIndexPath *> *)moveIndexPaths;
    + +
    +
    +

    Swift

    + 
    convenience init(insertSections: IndexSet, deleteSections: IndexSet, moveSections: Set<ListMoveIndex>, insert insertIndexPaths: [IndexPath], delete deleteIndexPaths: [IndexPath], update updateIndexPaths: [IndexPath], moveIndexPaths: [ListMoveIndexPath])
    + +
    +
    +
    +
    +
    • diff --git a/docs/Classes/IGListBindingSectionController.html b/docs/Classes/IGListBindingSectionController.html index 052084698..f9a611a91 100644 --- a/docs/Classes/IGListBindingSectionController.html +++ b/docs/Classes/IGListBindingSectionController.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -258,9 +275,8 @@

    IGListBindingSectionController

    
-@interface IGListBindingSectionController < __covariant ObjectType
-    : id <IGListDiffable>
-> : IGListSectionController @end
    +@interface IGListBindingSectionController< + __covariant ObjectType : id <IGListDiffable>> : IGListSectionController
    @@ -315,6 +331,11 @@

    Declaration

    dataSource; +
    +

    Swift

    + 
    weak var dataSource: ListBindingSectionControllerDataSource? { get set }
    + +
    @@ -344,6 +365,11 @@

    Declaration

    selectionDelegate; +
    +

    Swift

    + 
    weak var selectionDelegate: ListBindingSectionControllerSelectionDelegate? { get set }
    + +
    @@ -371,6 +397,11 @@

    Declaration

    @property (readonly, strong, nonatomic, nullable) ObjectType object;
    +
    +

    Swift

    + 
    var object: ObjectType? { get }
    + +
    @@ -400,6 +431,11 @@

    Declaration

    NSArray<id<IGListDiffable>> *_Nonnull viewModels; +
    +

    Swift

    + 
    var viewModels: [ListDiffable] { get }
    + +
    @@ -428,6 +464,11 @@

    Declaration

    completion:(nullable void (^)(BOOL))completion; +
    +

    Swift

    + 
    func update(animated: Bool, completion: ((Bool) -> Void)? = nil)
    + +

    Parameters

    @@ -463,13 +504,82 @@

    Parameters

    +
  • +
    + + + + -moveObjectFromIndex:toIndex: + +
    +
    +
    +
    +
    +
    +

    Notifies the section that a list object should move within a section as the result of interactive reordering.

    +
    +

    Note

    +

    this method must be implemented if interactive reordering is enabled. To ensure updating the internal viewModels array, calling super is required, preferably before your own implementation.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)moveObjectFromIndex:(NSInteger)sourceIndex
+                    toIndex:(NSInteger)destinationIndex;
    + +
    +
    +

    Swift

    + 
    func moveObject(from sourceIndex: Int, to destinationIndex: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + sourceIndex + + +
    +

    The starting index of the object.

    +
    +
    + + destinationIndex + + +
    +

    The ending index of the object.

    +
    +
    +
    +
    +
    +
    • diff --git a/docs/Classes/IGListCollectionView.html b/docs/Classes/IGListCollectionView.html index e9c0c0bbb..6688ae1c9 100644 --- a/docs/Classes/IGListCollectionView.html +++ b/docs/Classes/IGListCollectionView.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -262,7 +279,8 @@

    IGListCollectionView

    -

    This UICollectionView subclass allows for partial layout invalidation using IGListCollectionViewLayout.

    +

    This UICollectionView subclass allows for partial layout invalidation using IGListCollectionViewLayout, +or custom layout classes that conform to IGListCollectionViewLayoutCompatible.

    Note

    When updating a collection view (ex: calling -insertSections), -invalidateLayoutWithContext gets called on @@ -301,14 +319,11 @@

    IGListCollectionView

    Declaration

    Objective-C

    - 
    - (nonnull instancetype)initWithFrame:(CGRect)frame
-             listCollectionViewLayout:
-                 (nonnull IGListCollectionViewLayout *)collectionViewLayout;
    - -
    -
    -

    Swift

    - 
    init(frame: CGRect, listCollectionViewLayout collectionViewLayout: IGListCollectionViewLayout)
    + 
    - (nonnull instancetype)
+               initWithFrame:(CGRect)frame
+    listCollectionViewLayout:
+        (nonnull UICollectionViewLayout<IGListCollectionViewLayoutCompatible> *)
+            collectionViewLayout;
    @@ -336,7 +351,8 @@

    Parameters

    -

    The layout to use with the collection view.

    +

    The layout to use with the collection view. You can use IGListCollectionViewLayout +here, or a custom layout class that conforms to IGListCollectionViewLayoutCompatible.

    @@ -351,8 +367,8 @@

    Parameters

    diff --git a/docs/Classes/IGListCollectionViewLayout.html b/docs/Classes/IGListCollectionViewLayout.html index 429e788da..6a792d7da 100644 --- a/docs/Classes/IGListCollectionViewLayout.html +++ b/docs/Classes/IGListCollectionViewLayout.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -258,7 +275,8 @@

    IGListCollectionViewLayout

    
-@interface IGListCollectionViewLayout : UICollectionViewLayout
    +@interface IGListCollectionViewLayout + : UICollectionViewLayout <IGListCollectionViewLayoutCompatible>
    @@ -345,7 +363,7 @@

    Declaration

    Swift

    - 
    var scrollDirection: UICollectionViewScrollDirection { get }
    + 
    var scrollDirection: UICollectionView.ScrollDirection { get }
    @@ -426,9 +444,9 @@

    Declaration

  • - - - -didModifySection: + + + experiments
    @@ -436,49 +454,22 @@

    Declaration

    -

    Notify the layout that a specific section was modified before invalidation. Used to optimize layout re-calculation.

    -
    -

    Note

    -

    When updating a collection view (ex: calling -insertSections), -invalidateLayoutWithContext gets called on -the layout object. However, the invalidation context doesn’t provide details on which index paths are being modified, -which typically forces a full layout re-calculation. We can use this method to keep track of which section actually -needs to be updated on the following -invalidateLayoutWithContext. See IGListCollectionView.

    - -
    +

    A bitmask of experiments to conduct on the adapter.

    Declaration

    Objective-C

    - 
    - (void)didModifySection:(NSInteger)modifiedSection;
    + 
    @property (assign, readwrite, nonatomic) IGListExperiment experiments;

    Swift

    - 
    func didModifySection(_ modifiedSection: Int)
    + 
    var experiments: IGListExperiment { get set }
    -
    -

    Parameters

    - - - - - - - -
    - - modifiedSection - - -
    -

    The section that was modified.

    -
    -
    -
    • @@ -503,15 +494,15 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
-initWithStickyHeaders:(BOOL)stickyHeaders
-      scrollDirection:(UICollectionViewScrollDirection)scrollDirection
-      topContentInset:(CGFloat)topContentInset
-        stretchToEdge:(BOOL)stretchToEdge;
    + initWithStickyHeaders:(BOOL)stickyHeaders + scrollDirection:(UICollectionViewScrollDirection)scrollDirection + topContentInset:(CGFloat)topContentInset + stretchToEdge:(BOOL)stretchToEdge;

    Swift

    - 
    init(stickyHeaders: Bool, scrollDirection: UICollectionViewScrollDirection, topContentInset: CGFloat, stretchToEdge: Bool)
    + 
    init(stickyHeaders: Bool, scrollDirection: UICollectionView.ScrollDirection, topContentInset: CGFloat, stretchToEdge: Bool)
    @@ -663,8 +654,8 @@

    Return Value

    diff --git a/docs/Classes/IGListGenericSectionController.html b/docs/Classes/IGListGenericSectionController.html index c719bf042..3637ddfdb 100644 --- a/docs/Classes/IGListGenericSectionController.html +++ b/docs/Classes/IGListGenericSectionController.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -258,7 +275,8 @@

    IGListGenericSectionController

    
-@interface IGListGenericSectionController <__covariant ObjectType> : IGListSectionController
    +@interface IGListGenericSectionController<__covariant ObjectType> + : IGListSectionController
    @@ -370,8 +388,8 @@

    Parameters

    diff --git a/docs/Classes/IGListIndexPathResult.html b/docs/Classes/IGListIndexPathResult.html index 874e6dafb..53d09d737 100644 --- a/docs/Classes/IGListIndexPathResult.html +++ b/docs/Classes/IGListIndexPathResult.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -589,8 +606,8 @@

    Declaration

    diff --git a/docs/Classes/IGListIndexSetResult.html b/docs/Classes/IGListIndexSetResult.html index 34bdd480a..5c8721061 100644 --- a/docs/Classes/IGListIndexSetResult.html +++ b/docs/Classes/IGListIndexSetResult.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -586,8 +603,8 @@

    Declaration

    diff --git a/docs/Classes/IGListMoveIndex.html b/docs/Classes/IGListMoveIndex.html index 2477ea911..aa6905b8a 100644 --- a/docs/Classes/IGListMoveIndex.html +++ b/docs/Classes/IGListMoveIndex.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -337,8 +354,8 @@

    Declaration

    diff --git a/docs/Classes/IGListMoveIndexPath.html b/docs/Classes/IGListMoveIndexPath.html index 36a61e078..99eb709a4 100644 --- a/docs/Classes/IGListMoveIndexPath.html +++ b/docs/Classes/IGListMoveIndexPath.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -337,8 +354,8 @@

    Declaration

    diff --git a/docs/Classes/IGListSectionController.html b/docs/Classes/IGListSectionController.html index 89ffae597..cab547294 100644 --- a/docs/Classes/IGListSectionController.html +++ b/docs/Classes/IGListSectionController.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -394,6 +411,13 @@

    Return Value

    one of the dequeue methods on the IGListCollectionContext. The default implementation will assert. You must override this method without calling super.

    + +
    +

    Warning

    +

    Don’t call this method to obtain a reference to currently dequeued cells: a new cell will be dequeued +and returned, rather than the existing cell that you may have intended to retrieve. Instead, you can call +-cellForItemAtIndex:sectionController: on IGListCollectionContext to obtain active cell references.

    +
    @@ -765,13 +789,17 @@

    Parameters

    -

    The index of the unhighlighted cell.

    +

    The index of the object in the list.

    +
    +

    Return Value

    +

    YES if the object is allowed to move, otherwise NO.

    +
    @@ -1350,8 +1378,8 @@

    Return Value

    diff --git a/docs/Classes/IGListSingleSectionController.html b/docs/Classes/IGListSingleSectionController.html index 51d8991ad..de2fa3486 100644 --- a/docs/Classes/IGListSingleSectionController.html +++ b/docs/Classes/IGListSingleSectionController.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -297,9 +314,10 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
-initWithCellClass:(nonnull Class)cellClass
-   configureBlock:(nonnull IGListSingleSectionCellConfigureBlock)configureBlock
-        sizeBlock:(nonnull IGListSingleSectionCellSizeBlock)sizeBlock;
    + initWithCellClass:(nonnull Class)cellClass + configureBlock: + (nonnull IGListSingleSectionCellConfigureBlock)configureBlock + sizeBlock:(nonnull IGListSingleSectionCellSizeBlock)sizeBlock;
    @@ -385,10 +403,11 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
-initWithNibName:(nonnull NSString *)nibName
-         bundle:(nullable NSBundle *)bundle
- configureBlock:(nonnull IGListSingleSectionCellConfigureBlock)configureBlock
-      sizeBlock:(nonnull IGListSingleSectionCellSizeBlock)sizeBlock;
    + initWithNibName:(nonnull NSString *)nibName + bundle:(nullable NSBundle *)bundle + configureBlock: + (nonnull IGListSingleSectionCellConfigureBlock)configureBlock + sizeBlock:(nonnull IGListSingleSectionCellSizeBlock)sizeBlock;
    @@ -486,11 +505,12 @@

    Declaration

    Objective-C

    - (nonnull instancetype)
-initWithStoryboardCellIdentifier:(nonnull NSString *)identifier
-                  configureBlock:(nonnull IGListSingleSectionCellConfigureBlock)
-                                     configureBlock
-                       sizeBlock:
-                           (nonnull IGListSingleSectionCellSizeBlock)sizeBlock;
    + initWithStoryboardCellIdentifier:(nonnull NSString *)identifier + configureBlock: + (nonnull IGListSingleSectionCellConfigureBlock) + configureBlock + sizeBlock:(nonnull IGListSingleSectionCellSizeBlock) + sizeBlock;
    @@ -588,8 +608,8 @@

    Declaration

    diff --git a/docs/Constants.html b/docs/Constants.html index 60c8f8733..bca8145f6 100644 --- a/docs/Constants.html +++ b/docs/Constants.html @@ -10,6 +10,7 @@ +
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Enums.html b/docs/Enums.html index 9aefe4764..6fc6e940f 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -10,6 +10,7 @@ +
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • @@ -263,9 +281,9 @@

    Enumerations

  • @@ -273,20 +291,20 @@

    Enumerations

    -

    The type of update that was performed by an IGListAdapter.

    +

    An option for how to do comparisons between similar objects.

    - See more + See more

    Declaration

    Objective-C

    - 
    enum IGListAdapterUpdateType {}
    + 
    enum IGListDiffOption {}

    Swift

    - 
    enum IGListAdapterUpdateType : Int
    + 
    enum IGListDiffOption : Int
    @@ -300,9 +318,9 @@

    Declaration

  • @@ -310,20 +328,20 @@

    Declaration

    -

    An option for how to do comparisons between similar objects.

    +

    Bitmask-able options used for pre-release feature testing.

    - See more + See more

    Declaration

    Objective-C

    - 
    enum IGListDiffOption {}
    + 
    enum IGListExperiment {}

    Swift

    - 
    enum IGListDiffOption : Int
    + 
    struct IGListExperiment : OptionSet
    @@ -337,9 +355,9 @@

    Declaration

  • @@ -347,20 +365,20 @@

    Declaration

    -

    Bitmask-able options used for pre-release feature testing.

    +

    The type of update that was performed by an IGListAdapter.

    - See more + See more

    Declaration

    Objective-C

    - 
    enum IGListExperiment {}
    + 
    enum IGListAdapterUpdateType {}

    Swift

    - 
    struct IGListExperiment : OptionSet
    + 
    enum IGListAdapterUpdateType : Int
    @@ -372,8 +390,8 @@

    Declaration

    • diff --git a/docs/Enums/IGListAdapterUpdateType.html b/docs/Enums/IGListAdapterUpdateType.html index 95d0b443f..d6903239c 100644 --- a/docs/Enums/IGListAdapterUpdateType.html +++ b/docs/Enums/IGListAdapterUpdateType.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Enums/IGListDiffOption.html b/docs/Enums/IGListDiffOption.html index 8fab459e9..f67ff4c48 100644 --- a/docs/Enums/IGListDiffOption.html +++ b/docs/Enums/IGListDiffOption.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Enums/IGListExperiment.html b/docs/Enums/IGListExperiment.html index 03db1cca3..74c0179f8 100644 --- a/docs/Enums/IGListExperiment.html +++ b/docs/Enums/IGListExperiment.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -366,9 +383,9 @@

    Declaration

  • @@ -376,19 +393,19 @@

    Declaration

    -

    Test a faster way to return visible section controllers.

    +

    Test removing the layout pass when calling scrollToObject to avoid creating off-screen cells.

    Declaration

    Objective-C

    - 
    IGListExperimentFasterVisibleSectionController = 1 << 4
    + 
    IGListExperimentAvoidLayoutOnScrollToObject = 1 << 4

    Swift

    - 
    static var fasterVisibleSectionController: IGListExperiment { get }
    + 
    static var avoidLayoutOnScrollToObject: IGListExperiment { get }
    @@ -398,9 +415,9 @@

    Declaration

  • @@ -408,19 +425,19 @@

    Declaration

    -

    Test deduping item-level updates.

    +

    Test fixing a crash when inserting and deleting the same NSIndexPath multiple times.

    Declaration

    Objective-C

    - 
    IGListExperimentDedupeItemUpdates = 1 << 5
    + 
    IGListExperimentFixIndexPathImbalance = 1 << 5

    Swift

    - 
    static var dedupeItemUpdates: IGListExperiment { get }
    + 
    static var fixIndexPathImbalance: IGListExperiment { get }
    @@ -459,13 +476,109 @@

    Declaration

    • +
  • + +
    +
    +
    +
    +
    +

    Test getting collection view at update time.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    IGListExperimentGetCollectionViewAtUpdate = 1 << 7
    + +
    +
    +

    Swift

    + 
    static var getCollectionViewAtUpdate: IGListExperiment { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Test invalidating layout when cell reloads/updates in IGListBindingSectionController.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    IGListExperimentInvalidateLayoutForUpdates = 1 << 8
    + +
    +
    +

    Swift

    + 
    static var invalidateLayoutForUpdates: IGListExperiment { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Test using the collection view when asking for layout instead of accessing the data source. Only apply to IGListCollectionViewLayout.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    IGListExperimentUseCollectionViewInsteadOfDataSourceInLayout = 1 << 9
    + +
    +
    +

    Swift

    + 
    static var useCollectionViewInsteadOfDataSourceInLayout: IGListExperiment { get }
    + +
    +
    +
    +
    +
    • diff --git a/docs/Functions.html b/docs/Functions.html index 62164af23..79105d9c7 100644 --- a/docs/Functions.html +++ b/docs/Functions.html @@ -10,6 +10,7 @@ +
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Guides.html b/docs/Guides.html index ec462aaeb..4e022785f 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -10,6 +10,7 @@ +
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • @@ -258,11 +276,141 @@

    Guides

    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    diff --git a/docs/Protocols.html b/docs/Protocols.html index 361a0a168..f789b2034 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -10,6 +10,7 @@ +
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • @@ -258,6 +276,43 @@

    Protocols

    +
    +
      +
    • +
      + + + + IGListDiffable + +
      +
      +
      +
      +
      +
      +

      The IGListDiffable protocol provides methods needed to compare the identity and equality of two objects.

      + + See more +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      @protocol IGListDiffable
      + +
      +
      +

      Swift

      + 
      protocol ListDiffable
      + +
      +
      +
      +
      +
      • +
    +
    • @@ -323,7 +378,7 @@

      Declaration

    Swift

    - 
    protocol IGListAdapterDelegate : NSObjectProtocol
    + 
    protocol ListAdapterDelegate : NSObjectProtocol
    @@ -369,6 +424,43 @@

    Declaration

    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      IGListAdapterPerformanceDelegate can be used to measure cell dequeue, display, size, and scroll callbacks.

      + + See more +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      @protocol IGListAdapterPerformanceDelegate <NSObject>
      + +
      +
      +

      Swift

      + 
      protocol ListAdapterPerformanceDelegate : NSObjectProtocol
      + +
      +
      +
      +
      +
      • +
    +
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListAdapterDelegate.html b/docs/Protocols/IGListAdapterDelegate.html index eb3ebcea7..30149598e 100644 --- a/docs/Protocols/IGListAdapterDelegate.html +++ b/docs/Protocols/IGListAdapterDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListAdapterMoveDelegate.html b/docs/Protocols/IGListAdapterMoveDelegate.html index 588271ae2..23cf24ac3 100644 --- a/docs/Protocols/IGListAdapterMoveDelegate.html +++ b/docs/Protocols/IGListAdapterMoveDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListAdapterPerformanceDelegate.html b/docs/Protocols/IGListAdapterPerformanceDelegate.html new file mode 100644 index 000000000..d56b167af --- /dev/null +++ b/docs/Protocols/IGListAdapterPerformanceDelegate.html @@ -0,0 +1,981 @@ + + + + IGListAdapterPerformanceDelegate Protocol Reference + + + + + + + + + + +
    +
    +

    IGListKit Docs (98% documented)

    +

    View on GitHub

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    IGListAdapterPerformanceDelegate

    +
    +
    + 
    @protocol IGListAdapterPerformanceDelegate <NSObject>
    + +
    +
    +

    IGListAdapterPerformanceDelegate can be used to measure cell dequeue, display, size, and scroll callbacks.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Will call -[IGListAdapter collectionView:cellForItemAtIndexPath:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapterWillCallDequeueCell:(nonnull IGListAdapter *)listAdapter;
      + +
      +
      +

      Swift

      + 
      func listAdapterWillCallDequeueCell(_ listAdapter: IGListAdapter)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Did finish calling -[IGListAdapter collectionView:cellForItemAtIndexPath:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapter:(nonnull IGListAdapter *)listAdapter
+     didCallDequeueCell:(nonnull UICollectionViewCell *)cell
+    onSectionController:(nonnull IGListSectionController *)sectionController
+                atIndex:(NSInteger)index;
      + +
      +
      +

      Swift

      + 
      func listAdapter(_ listAdapter: IGListAdapter, didCallDequeueCell cell: Any!, on sectionController: IGListSectionController, at index: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      + + cell + + +
      +

      A cell that was dequeued.

      +
      +
      + + sectionController + + +
      +

      The section controller providing the cell.

      +
      +
      + + index + + +
      +

      Item index of the cell.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Will call -[IGListAdapter collectionView:willDisplayCell:forItemAtIndexPath:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapterWillCallDisplayCell:(nonnull IGListAdapter *)listAdapter;
      + +
      +
      +

      Swift

      + 
      func listAdapterWillCallDisplayCell(_ listAdapter: IGListAdapter)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Did finish calling -[IGListAdapter collectionView:willDisplayCell:forItemAtIndexPath:].

      +
      +

      Note

      +

      Keep in mind this also includes calling the IGListAdapter‘s collectionViewDelegate and workingRangeHandler.

      + +
      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapter:(nonnull IGListAdapter *)listAdapter
+     didCallDisplayCell:(nonnull UICollectionViewCell *)cell
+    onSectionController:(nonnull IGListSectionController *)sectionController
+                atIndex:(NSInteger)index;
      + +
      +
      +

      Swift

      + 
      func listAdapter(_ listAdapter: IGListAdapter, didCallDisplayCell cell: Any!, on sectionController: IGListSectionController, at index: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      + + cell + + +
      +

      A cell that will be displayed.

      +
      +
      + + sectionController + + +
      +

      The section controller for that cell.

      +
      +
      + + index + + +
      +

      Item index of the cell.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Will call -[IGListAdapter collectionView:didEndDisplayingCell:forItemAtIndexPath:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapterWillCallEndDisplayCell:(nonnull IGListAdapter *)listAdapter;
      + +
      +
      +

      Swift

      + 
      func listAdapterWillCallEndDisplayCell(_ listAdapter: IGListAdapter)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Did finish calling -[IGListAdapter collectionView:didEndDisplayingCell:forItemAtIndexPath:].

      +
      +

      Note

      +

      Keep in mind this also includes calling the IGListAdapter‘s collectionViewDelegate and workingRangeHandler.

      + +
      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapter:(nonnull IGListAdapter *)listAdapter
+    didCallEndDisplayCell:(nonnull UICollectionViewCell *)cell
+      onSectionController:(nonnull IGListSectionController *)sectionController
+                  atIndex:(NSInteger)index;
      + +
      +
      +

      Swift

      + 
      func listAdapter(_ listAdapter: IGListAdapter, didCallEndDisplayCell cell: Any!, on sectionController: IGListSectionController, at index: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      + + cell + + +
      +

      A cell that was displayed.

      +
      +
      + + sectionController + + +
      +

      The section controller for that cell.

      +
      +
      + + index + + +
      +

      Item index of the cell.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Will call -[IGListAdapter collectionView:collectionViewLayout:sizeForItemAtIndexPath:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapterWillCallSize:(nonnull IGListAdapter *)listAdapter;
      + +
      +
      +

      Swift

      + 
      func listAdapterWillCallSize(_ listAdapter: IGListAdapter)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Did finish calling -[IGListAdapter collectionView:collectionViewLayout:sizeForItemAtIndexPath:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapter:(nonnull IGListAdapter *)listAdapter
+    didCallSizeOnSectionController:
+        (nonnull IGListSectionController *)sectionController
+                           atIndex:(NSInteger)index;
      + +
      +
      +

      Swift

      + 
      func listAdapter(_ listAdapter: IGListAdapter, didCallSizeOn sectionController: IGListSectionController, at index: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      + + sectionController + + +
      +

      The section controller providing the size.

      +
      +
      + + index + + +
      +

      Item index used to calculate the size.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Will call -[IGListAdapter scrollViewDidScroll:].

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapterWillCallScroll:(nonnull IGListAdapter *)listAdapter;
      + +
      +
      +

      Swift

      + 
      func listAdapterWillCallScroll(_ listAdapter: IGListAdapter)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Did finish calling -[IGListAdapter scrollViewDidScroll:].

      +
      +

      Note

      +

      Keep in mind this also includes calling the IGListAdapter‘s scrollViewDelegate and all visible IGListSectioControllers.

      + +
      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      - (void)listAdapter:(nonnull IGListAdapter *)listAdapter
+      didCallScroll:(nonnull UIScrollView *)scrollView;
      + +
      +
      +

      Swift

      + 
      func listAdapter(_ listAdapter: IGListAdapter, didCallScroll scrollView: Any!)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + listAdapter + + +
      +

      The list adapter sending this information.

      +
      +
      + + scrollView + + +
      +

      The scroll view backing the UICollectionView.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Protocols/IGListAdapterUpdateListener.html b/docs/Protocols/IGListAdapterUpdateListener.html index 124802ad5..f771a6df4 100644 --- a/docs/Protocols/IGListAdapterUpdateListener.html +++ b/docs/Protocols/IGListAdapterUpdateListener.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListAdapterUpdaterDelegate.html b/docs/Protocols/IGListAdapterUpdaterDelegate.html index faf009b9c..c56113a1a 100644 --- a/docs/Protocols/IGListAdapterUpdaterDelegate.html +++ b/docs/Protocols/IGListAdapterUpdaterDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -270,9 +287,9 @@

    IGListAdapterUpdaterDelegate

  • @@ -289,12 +306,15 @@

    Declaration

    Objective-C

    - (void)listAdapterUpdater:(nonnull IGListAdapterUpdater *)listAdapterUpdater
     willPerformBatchUpdatesWithCollectionView:
-        (nonnull UICollectionView *)collectionView;
    - -
    -
    -

    Swift

    - 
    func listAdapterUpdater(_ listAdapterUpdater: IGListAdapterUpdater, willPerformBatchUpdatesWith collectionView: UICollectionView)
    + (nonnull UICollectionView *)collectionView + fromObjects: + (nullable NSArray<id<IGListDiffable>> *) + fromObjects + toObjects: + (nullable NSArray<id<IGListDiffable>> *) + toObjects + listIndexSetResult:(nullable IGListIndexSetResult *) + listIndexSetResults;
    @@ -326,6 +346,42 @@

    Parameters

    + + + + fromObjects + + + +
    +

    The items transitioned from in the batch updates, if any.

    +
    + + + + + + toObjects + + + +
    +

    The items transitioned to in the batch updates, if any.

    +
    + + + + + + listIndexSetResults + + + +
    +

    The diffing result of indices to be inserted/removed/updated/moved/etc.

    +
    + + @@ -968,9 +1024,9 @@

    Parameters

  • @@ -990,12 +1046,13 @@

    Declaration

    willCrashWithException:(nonnull NSException *)exception fromObjects:(nullable NSArray *)fromObjects toObjects:(nullable NSArray *)toObjects + diffResult:(nonnull IGListIndexSetResult *)diffResult updates:(nonnull IGListBatchUpdateData *)updates;

    Swift

    - 
    func listAdapterUpdater(_ listAdapterUpdater: IGListAdapterUpdater, collectionView: UICollectionView, willCrashWith exception: NSException, from fromObjects: [Any]?, to toObjects: [Any]?, updates: ListBatchUpdateData)
    + 
    func listAdapterUpdater(_ listAdapterUpdater: IGListAdapterUpdater, collectionView: UICollectionView, willCrashWith exception: NSException, from fromObjects: [Any]?, to toObjects: [Any]?, diffResult: IGListIndexSetResult, updates: ListBatchUpdateData)
    @@ -1063,6 +1120,18 @@

    Parameters

    + + + + diffResult + + + +
    +

    The diff result that were computed from fromObjects and toObjects.

    +
    + + @@ -1086,8 +1155,8 @@

    Parameters

    • diff --git a/docs/Protocols/IGListBatchContext.html b/docs/Protocols/IGListBatchContext.html index fa8004a97..db0323383 100644 --- a/docs/Protocols/IGListBatchContext.html +++ b/docs/Protocols/IGListBatchContext.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -463,6 +480,71 @@

    Parameters

    +
  • + +
    +
    +
    +
    +
    +

    Invalidates layouts of cells at specific in the section controller.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)invalidateLayoutInSectionController:
+            (nonnull IGListSectionController *)sectionController
+                                  atIndexes:(nonnull NSIndexSet *)indexes;
    + +
    +
    +

    Swift

    + 
    func invalidateLayout(in sectionController: IGListSectionController, at indexes: IndexSet)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + sectionController + + +
    +

    The section controller who’s cells need invalidating.

    +
    +
    + + indexes + + +
    +

    The indexes of items that need invalidating.

    +
    +
    +
    +
    +
    +
  • @@ -769,10 +851,10 @@

    Parameters

    Declaration

    Objective-C

    - 
    - (void)
-revertInvalidInteractiveMoveFromIndexPath:(nonnull NSIndexPath *)sourceIndexPath
-                              toIndexPath:
-                                  (nonnull NSIndexPath *)destinationIndexPath;
    + 
    - (void)revertInvalidInteractiveMoveFromIndexPath:
+            (nonnull NSIndexPath *)sourceIndexPath
+                                      toIndexPath:(nonnull NSIndexPath *)
+                                                      destinationIndexPath;
    @@ -820,8 +902,8 @@

    Parameters

    • diff --git a/docs/Protocols/IGListBindable.html b/docs/Protocols/IGListBindable.html index bab20c98c..ee67cabd4 100644 --- a/docs/Protocols/IGListBindable.html +++ b/docs/Protocols/IGListBindable.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListBindingSectionControllerDataSource.html b/docs/Protocols/IGListBindingSectionControllerDataSource.html index 61141fa39..d3f37215e 100644 --- a/docs/Protocols/IGListBindingSectionControllerDataSource.html +++ b/docs/Protocols/IGListBindingSectionControllerDataSource.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -288,8 +305,9 @@

    Declaration

    Objective-C

    - (nonnull NSArray<id<IGListDiffable>> *)
-  sectionController:(nonnull IGListBindingSectionController *)sectionController
-viewModelsForObject:(nonnull id)object;
    + sectionController: + (nonnull IGListBindingSectionController *)sectionController + viewModelsForObject:(nonnull id)object;
    @@ -358,14 +376,10 @@

    Declaration

    Objective-C

    - (nonnull UICollectionViewCell<IGListBindable> *)
-sectionController:(nonnull IGListBindingSectionController *)sectionController
- cellForViewModel:(nonnull id)viewModel
-          atIndex:(NSInteger)index;
    - -
    -
    -

    Swift

    - 
    func sectionController(_ sectionController: IGListBindingSectionController, cellForViewModel viewModel: Any, at index: Int) -> Any!
    + sectionController: + (nonnull IGListBindingSectionController *)sectionController + cellForViewModel:(nonnull id)viewModel + atIndex:(NSInteger)index;
    @@ -447,7 +461,7 @@

    Declaration

    Swift

    - 
    func sectionController(_ sectionController: IGListBindingSectionController, sizeForViewModel viewModel: Any, at index: Int) -> Any!
    + 
    func sectionController(_ sectionController: IGListBindingSectionController, sizeForViewModel viewModel: Any, at index: Int) -> CGSize
    @@ -506,8 +520,8 @@

    Return Value

    diff --git a/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html b/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html index b74995430..fca312db9 100644 --- a/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html +++ b/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -359,11 +376,6 @@

    Parameters

    Tells the delegate that a cell at a given index was deselected.

    -
    -

    Note

    -

    Method is @optional until the 4.0.0 release where it will become required.

    - -
    @@ -378,7 +390,7 @@

    Declaration

    Swift

    - 
    optional func sectionController(_ sectionController: IGListBindingSectionController, didDeselectItemAt index: Int, viewModel: Any)
    + 
    func sectionController(_ sectionController: IGListBindingSectionController, didDeselectItemAt index: Int, viewModel: Any)
    @@ -456,7 +468,7 @@

    Declaration

    Swift

    - 
    optional func sectionController(_ sectionController: IGListBindingSectionController, didHighlightItemAt index: Int, viewModel: Any)
    + 
    func sectionController(_ sectionController: IGListBindingSectionController, didHighlightItemAt index: Int, viewModel: Any)
    @@ -534,7 +546,7 @@

    Declaration

    Swift

    - 
    optional func sectionController(_ sectionController: IGListBindingSectionController, didUnhighlightItemAt index: Int, viewModel: Any)
    + 
    func sectionController(_ sectionController: IGListBindingSectionController, didUnhighlightItemAt index: Int, viewModel: Any)
    @@ -589,8 +601,8 @@

    Parameters

    diff --git a/docs/Protocols/IGListCollectionContext.html b/docs/Protocols/IGListCollectionContext.html index 84a9acc56..4f3268d88 100644 --- a/docs/Protocols/IGListCollectionContext.html +++ b/docs/Protocols/IGListCollectionContext.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -396,6 +413,70 @@

    Declaration

    +
  • +
    + + + + scrollingTraits + +
    +
    +
    +
    +
    +
    +

    The current scrolling traits of the underlying collection view.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) IGListCollectionScrollingTraits scrollingTraits;
    + +
    +
    +

    Swift

    + 
    var scrollingTraits: IGListCollectionScrollingTraits { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + experiments + +
    +
    +
    +
    +
    +
    +

    A bitmask of experiments to conduct on the section controller.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) IGListExperiment experiments;
    + +
    +
    +

    Swift

    + 
    var experiments: IGListExperiment { get set }
    + +
    +
    +
    +
    +
  • @@ -546,8 +627,8 @@

    Declaration

    Objective-C

    - (nullable __kindof UICollectionViewCell *)
-cellForItemAtIndex:(NSInteger)index
- sectionController:(nonnull IGListSectionController *)sectionController;
    + cellForItemAtIndex:(NSInteger)index + sectionController:(nonnull IGListSectionController *)sectionController;
    @@ -811,7 +892,7 @@

    Declaration

    Swift

    - 
    func selectItem(at index: Int, sectionController: IGListSectionController, animated: Bool, scrollPosition: UICollectionViewScrollPosition)
    + 
    func selectItem(at index: Int, sectionController: IGListSectionController, animated: Bool, scrollPosition: UICollectionView.ScrollPosition)
    @@ -899,10 +980,11 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionViewCell *)
-dequeueReusableCellOfClass:(nonnull Class)cellClass
-       withReuseIdentifier:(nullable NSString *)reuseIdentifier
-      forSectionController:(nonnull IGListSectionController *)sectionController
-                   atIndex:(NSInteger)index;
    + dequeueReusableCellOfClass:(nonnull Class)cellClass + withReuseIdentifier:(nullable NSString *)reuseIdentifier + forSectionController: + (nonnull IGListSectionController *)sectionController + atIndex:(NSInteger)index;
    @@ -999,9 +1081,10 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionViewCell *)
-dequeueReusableCellOfClass:(nonnull Class)cellClass
-      forSectionController:(nonnull IGListSectionController *)sectionController
-                   atIndex:(NSInteger)index;
    + dequeueReusableCellOfClass:(nonnull Class)cellClass + forSectionController: + (nonnull IGListSectionController *)sectionController + atIndex:(NSInteger)index;
    @@ -1086,11 +1169,11 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionViewCell *)
-dequeueReusableCellWithNibName:(nonnull NSString *)nibName
-                        bundle:(nullable NSBundle *)bundle
-          forSectionController:
-              (nonnull IGListSectionController *)sectionController
-                       atIndex:(NSInteger)index;
    + dequeueReusableCellWithNibName:(nonnull NSString *)nibName + bundle:(nullable NSBundle *)bundle + forSectionController: + (nonnull IGListSectionController *)sectionController + atIndex:(NSInteger)index;
    @@ -1182,11 +1265,12 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionViewCell *)
-dequeueReusableCellFromStoryboardWithIdentifier:(nonnull NSString *)identifier
-                           forSectionController:
-                               (nonnull IGListSectionController *)
-                                   sectionController
-                                        atIndex:(NSInteger)index;
    + dequeueReusableCellFromStoryboardWithIdentifier: + (nonnull NSString *)identifier + forSectionController: + (nonnull IGListSectionController *) + sectionController + atIndex:(NSInteger)index;
    @@ -1271,11 +1355,11 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionReusableView *)
-dequeueReusableSupplementaryViewOfKind:(nonnull NSString *)elementKind
-                  forSectionController:
-                      (nonnull IGListSectionController *)sectionController
-                                 class:(nonnull Class)viewClass
-                               atIndex:(NSInteger)index;
    + dequeueReusableSupplementaryViewOfKind:(nonnull NSString *)elementKind + forSectionController: + (nonnull IGListSectionController *)sectionController + class:(nonnull Class)viewClass + atIndex:(NSInteger)index;
    @@ -1367,14 +1451,14 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionReusableView *)
-dequeueReusableSupplementaryViewFromStoryboardOfKind:
-    (nonnull NSString *)elementKind
-                                      withIdentifier:
-                                          (nonnull NSString *)identifier
-                                forSectionController:
-                                    (nonnull IGListSectionController *)
-                                        sectionController
-                                             atIndex:(NSInteger)index;
    + dequeueReusableSupplementaryViewFromStoryboardOfKind: + (nonnull NSString *)elementKind + withIdentifier: + (nonnull NSString *)identifier + forSectionController: + (nonnull IGListSectionController *) + sectionController + atIndex:(NSInteger)index;
    @@ -1471,12 +1555,12 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionReusableView *)
-dequeueReusableSupplementaryViewOfKind:(nonnull NSString *)elementKind
-                  forSectionController:
-                      (nonnull IGListSectionController *)sectionController
-                               nibName:(nonnull NSString *)nibName
-                                bundle:(nullable NSBundle *)bundle
-                               atIndex:(NSInteger)index;
    + dequeueReusableSupplementaryViewOfKind:(nonnull NSString *)elementKind + forSectionController: + (nonnull IGListSectionController *)sectionController + nibName:(nonnull NSString *)nibName + bundle:(nullable NSBundle *)bundle + atIndex:(NSInteger)index;
    @@ -1656,8 +1740,8 @@

    Parameters

    For example, inside your section controllers, you may want to delete and insert into the data source that backs your section controller. For example:

    [self.collectionContext performBatchItemUpdates:^ (id<IGListBatchContext> batchContext>){
-  // perform data source changes inside the update block
-  [self.items addObject:newItem];
+  // perform data source changes inside the update block
+  [self.items addObject:newItem];
   [self.items removeObjectAtIndex:0];
 
   NSIndexSet *inserts = [NSIndexSet indexSetWithIndex:[self.items count] - 1];
@@ -1679,10 +1763,10 @@ 
    Parameters
    
                         
    Declaration
    
                         
    
                           
    Objective-C
    
-                          
    - (void)
-performBatchAnimated:(BOOL)animated
-             updates:(nonnull void (^)(id<IGListBatchContext> _Nonnull))updates
-          completion:(nullable void (^)(BOOL))completion;
    
+                          
    - (void)performBatchAnimated:(BOOL)animated
+                     updates:(nonnull void (^)(id<IGListBatchContext> _Nonnull))
+                                 updates
+                  completion:(nullable void (^)(BOOL))completion;
    
 
                         
    
                         
    
@@ -1766,7 +1850,7 @@ 
    Declaration
    
                         
    
                         
    
                           
    Swift
    
-                          
    func scroll(to sectionController: IGListSectionController, at index: Int, scrollPosition: UICollectionViewScrollPosition, animated: Bool)
    
+                          
    func scroll(to sectionController: IGListSectionController, at index: Int, scrollPosition: UICollectionView.ScrollPosition, animated: Bool)
    @@ -1833,8 +1917,8 @@

    Parameters

    • diff --git a/docs/Protocols/IGListCollectionViewDelegateLayout.html b/docs/Protocols/IGListCollectionViewDelegateLayout.html index c5113e674..f083db075 100644 --- a/docs/Protocols/IGListCollectionViewDelegateLayout.html +++ b/docs/Protocols/IGListCollectionViewDelegateLayout.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -288,11 +305,13 @@

    IGListCollectionViewDelegateLayout

    Declaration

    Objective-C

    - 
    - (UICollectionViewLayoutAttributes *)
-                   collectionView:(UICollectionView *)collectionView
-                           layout:(UICollectionViewLayout *)collectionViewLayout
-customizedInitialLayoutAttributes:(UICollectionViewLayoutAttributes *)attributes
-                      atIndexPath:(NSIndexPath *)indexPath;
    + 
    - (UICollectionViewLayoutAttributes *)collectionView:
+                                          (UICollectionView *)collectionView
+                                              layout:(UICollectionViewLayout *)
+                                                         collectionViewLayout
+                   customizedInitialLayoutAttributes:
+                       (UICollectionViewLayoutAttributes *)attributes
+                                         atIndexPath:(NSIndexPath *)indexPath;
    @@ -380,10 +399,12 @@

    Declaration

    Objective-C

    - (UICollectionViewLayoutAttributes *)
-                 collectionView:(UICollectionView *)collectionView
-                         layout:(UICollectionViewLayout *)collectionViewLayout
-customizedFinalLayoutAttributes:(UICollectionViewLayoutAttributes *)attributes
-                    atIndexPath:(NSIndexPath *)indexPath;
    + collectionView:(UICollectionView *)collectionView + layout: + (UICollectionViewLayout *)collectionViewLayout + customizedFinalLayoutAttributes: + (UICollectionViewLayoutAttributes *)attributes + atIndexPath:(NSIndexPath *)indexPath;
    @@ -455,8 +476,8 @@

    Parameters

    diff --git a/docs/Classes/IGListStackedSectionController.html b/docs/Protocols/IGListCollectionViewLayoutCompatible.html similarity index 72% rename from docs/Classes/IGListStackedSectionController.html rename to docs/Protocols/IGListCollectionViewLayoutCompatible.html index 1c8b998c7..8c1c9ac97 100644 --- a/docs/Classes/IGListStackedSectionController.html +++ b/docs/Protocols/IGListCollectionViewLayoutCompatible.html @@ -1,7 +1,7 @@ - IGListStackedSectionController Class Reference + IGListCollectionViewLayoutCompatible Protocol Reference @@ -10,8 +10,8 @@ - - + +

    IGListKit Docs (98% documented)

    @@ -22,7 +22,7 @@
    @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,27 +258,27 @@ +
  • + Structures + +
    • -

    IGListStackedSectionController

    +

    IGListCollectionViewLayoutCompatible

    - 
    
-@interface IGListStackedSectionController : IGListSectionController
    + 
    @protocol IGListCollectionViewLayoutCompatible <NSObject>
    -

    An instance of IGListStackedSectionController is a clustered section controller, composed of many child section -controllers. It constructs and routes item-level indexes to the appropriate child section controller with a local -index. This lets you build section controllers made up of individual units that can be shared and reused with other -section controllers.

    - -

    For example, you can create a Comments section controller that displays lists of text that is used alongside photo, -video, or slideshow section controllers. You then have four small and manageable section controllers instead of one -huge class.

    +

    A protocol for layouts that defines interaction with an IGListCollectionView, for recieving updated section indexes.

    @@ -278,9 +287,9 @@

    IGListStackedSectionController

  • @@ -288,15 +297,14 @@

    IGListStackedSectionController

    -

    Creates a new stacked section controller.

    +

    Called to notify the layout that a specific section was modified before invalidation. This can be used to optimize +layout re-calculation.

    Note

    -

    The order of the section controllers dictates the order in which they appear.

    - -
    -
    -

    Warning

    -

    The first section controller that is the supplementary source decides which supplementary views get displayed.

    +

    When updating a collection view (ex: calling -insertSections), -invalidateLayoutWithContext gets called on +the layout object. However, the invalidation context doesn’t provide details on which index paths are being modified, +which typically forces a full layout re-calculation. Layouts can use this method to keep track of which section +actually needs to be updated on the following -invalidateLayoutWithContext. See IGListCollectionView.

    @@ -305,13 +313,12 @@

    IGListStackedSectionController

    Declaration

    Objective-C

    - 
    - (nonnull instancetype)initWithSectionControllers:
-    (nonnull NSArray<IGListSectionController *> *)sectionControllers;
    + 
    - (void)didModifySection:(NSInteger)modifiedSection;

    Swift

    - 
    init(sectionControllers: [ListSectionController])
    + 
    func didModifySection(_ modifiedSection: Int)
    @@ -322,12 +329,12 @@

    Parameters

    - sectionControllers + modifiedSection
    -

    An array of section controllers that make up the stack.

    +

    The section that was modified.

    @@ -342,8 +349,8 @@

    Parameters

    • diff --git a/docs/Protocols/IGListDiffable.html b/docs/Protocols/IGListDiffable.html index 90d6faa32..c35ea446f 100644 --- a/docs/Protocols/IGListDiffable.html +++ b/docs/Protocols/IGListDiffable.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListDisplayDelegate.html b/docs/Protocols/IGListDisplayDelegate.html index 7eb25246f..d9bd4559b 100644 --- a/docs/Protocols/IGListDisplayDelegate.html +++ b/docs/Protocols/IGListDisplayDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListScrollDelegate.html b/docs/Protocols/IGListScrollDelegate.html index decb52e0a..47818a830 100644 --- a/docs/Protocols/IGListScrollDelegate.html +++ b/docs/Protocols/IGListScrollDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -457,6 +474,19 @@

    Parameters

    + + + + decelerate + + + +
    +

    ‘Yes’ if the scrolling movement will continue, but decelerate, after a touch-up gesture during a +dragging operation. If the value is ‘No’, scrolling stops immediately upon touch-up.

    +
    + + @@ -538,8 +568,8 @@

    Parameters

    diff --git a/docs/Protocols/IGListSingleSectionControllerDelegate.html b/docs/Protocols/IGListSingleSectionControllerDelegate.html index dc830ff02..ccb21c1c3 100644 --- a/docs/Protocols/IGListSingleSectionControllerDelegate.html +++ b/docs/Protocols/IGListSingleSectionControllerDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/Protocols/IGListSupplementaryViewSource.html b/docs/Protocols/IGListSupplementaryViewSource.html index ce72b0ff1..c204a8159 100644 --- a/docs/Protocols/IGListSupplementaryViewSource.html +++ b/docs/Protocols/IGListSupplementaryViewSource.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -336,8 +353,8 @@

    Declaration

    Objective-C

    - (nonnull __kindof UICollectionReusableView *)
-viewForSupplementaryElementOfKind:(nonnull NSString *)elementKind
-                          atIndex:(NSInteger)index;
    + viewForSupplementaryElementOfKind:(nonnull NSString *)elementKind + atIndex:(NSInteger)index;
    @@ -453,8 +470,8 @@

    Return Value

    diff --git a/docs/Protocols/IGListTransitionDelegate.html b/docs/Protocols/IGListTransitionDelegate.html index eed4c4c7d..744a39418 100644 --- a/docs/Protocols/IGListTransitionDelegate.html +++ b/docs/Protocols/IGListTransitionDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -287,11 +304,12 @@

    IGListTransitionDelegate

    Declaration

    Objective-C

    - 
    - (UICollectionViewLayoutAttributes *)
-                      listAdapter:(IGListAdapter *)listAdapter
-customizedInitialLayoutAttributes:(UICollectionViewLayoutAttributes *)attributes
-                sectionController:(IGListSectionController *)sectionController
-                          atIndex:(NSInteger)index;
    + 
    - (UICollectionViewLayoutAttributes *)listAdapter:(IGListAdapter *)listAdapter
+                customizedInitialLayoutAttributes:
+                    (UICollectionViewLayoutAttributes *)attributes
+                                sectionController:
+                                    (IGListSectionController *)sectionController
+                                          atIndex:(NSInteger)index;
    @@ -378,11 +396,12 @@

    Parameters

    Declaration

    Objective-C

    - 
    - (UICollectionViewLayoutAttributes *)
-                    listAdapter:(IGListAdapter *)listAdapter
-customizedFinalLayoutAttributes:(UICollectionViewLayoutAttributes *)attributes
-              sectionController:(IGListSectionController *)sectionController
-                        atIndex:(NSInteger)index;
    + 
    - (UICollectionViewLayoutAttributes *)listAdapter:(IGListAdapter *)listAdapter
+                  customizedFinalLayoutAttributes:
+                      (UICollectionViewLayoutAttributes *)attributes
+                                sectionController:
+                                    (IGListSectionController *)sectionController
+                                          atIndex:(NSInteger)index;
    @@ -454,8 +473,8 @@

    Parameters

    diff --git a/docs/Protocols/IGListUpdatingDelegate.html b/docs/Protocols/IGListUpdatingDelegate.html index 6a2105005..40d750e36 100644 --- a/docs/Protocols/IGListUpdatingDelegate.html +++ b/docs/Protocols/IGListUpdatingDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • @@ -317,9 +334,9 @@

    Return Value

  • @@ -344,15 +361,19 @@

    Return Value

    Declaration

    Objective-C

    - 
    - (void)
-performUpdateWithCollectionView:(nonnull UICollectionView *)collectionView
-                    fromObjects:
-                        (nullable NSArray<id<IGListDiffable>> *)fromObjects
-                 toObjectsBlock:(nullable IGListToObjectBlock)toObjectsBlock
-                       animated:(BOOL)animated
-          objectTransitionBlock:
-              (nonnull IGListObjectTransitionBlock)objectTransitionBlock
-                     completion:(nullable IGListUpdatingCompletion)completion;
    + 
    - (void)performUpdateWithCollectionViewBlock:
+            (nonnull IGListCollectionViewBlock)collectionViewBlock
+                                 fromObjects:
+                                     (nullable NSArray<id<IGListDiffable>> *)
+                                         fromObjects
+                              toObjectsBlock:
+                                  (nullable IGListToObjectBlock)toObjectsBlock
+                                    animated:(BOOL)animated
+                       objectTransitionBlock:
+                           (nonnull IGListObjectTransitionBlock)
+                               objectTransitionBlock
+                                  completion:(nullable IGListUpdatingCompletion)
+                                                 completion;
    @@ -363,12 +384,12 @@

    Parameters

    - collectionView + collectionViewBlock
    -

    The collection view to perform the transition on.

    +

    A block returning the collecion view to perform updates on.

    @@ -809,9 +830,9 @@

    Parameters

  • @@ -826,15 +847,17 @@

    Parameters

    Declaration

    Objective-C

    - 
    - (void)
-reloadDataWithCollectionView:(nonnull UICollectionView *)collectionView
-           reloadUpdateBlock:(nonnull IGListReloadUpdateBlock)reloadUpdateBlock
-                  completion:(nullable IGListUpdatingCompletion)completion;
    + 
    - (void)reloadDataWithCollectionViewBlock:
+            (nonnull IGListCollectionViewBlock)collectionViewBlock
+                        reloadUpdateBlock:
+                            (nonnull IGListReloadUpdateBlock)reloadUpdateBlock
+                               completion:(nullable IGListUpdatingCompletion)
+                                              completion;

    Swift

    - 
    func reloadData(with collectionView: UICollectionView, reloadUpdate reloadUpdateBlock: @escaping ListReloadUpdateBlock, completion: ListUpdatingCompletion? = nil)
    + 
    func reloadData(collectionViewBlock: @escaping ListCollectionViewBlock, reloadUpdate reloadUpdateBlock: @escaping ListReloadUpdateBlock, completion: ListUpdatingCompletion? = nil)
    @@ -845,12 +868,12 @@

    Parameters

    - collectionView + collectionViewBlock
    -

    The collection view to reload.

    +

    A block returning the collecion view to reload.

    @@ -951,9 +974,9 @@

    Parameters

  • @@ -968,16 +991,18 @@

    Parameters

    Declaration

    Objective-C

    - 
    - (void)
-performUpdateWithCollectionView:(nonnull UICollectionView *)collectionView
-                       animated:(BOOL)animated
-                    itemUpdates:(nonnull IGListItemUpdateBlock)itemUpdates
-                     completion:(nullable IGListUpdatingCompletion)completion;
    + 
    - (void)performUpdateWithCollectionViewBlock:
+            (nonnull IGListCollectionViewBlock)collectionViewBlock
+                                    animated:(BOOL)animated
+                                 itemUpdates:
+                                     (nonnull IGListItemUpdateBlock)itemUpdates
+                                  completion:(nullable IGListUpdatingCompletion)
+                                                 completion;

    Swift

    - 
    func performUpdate(with collectionView: UICollectionView, animated: Bool, itemUpdates: @escaping ListItemUpdateBlock, completion: ListUpdatingCompletion? = nil)
    + 
    func performUpdate(collectionViewBlock: @escaping ListCollectionViewBlock, animated: Bool, itemUpdates: @escaping ListItemUpdateBlock, completion: ListUpdatingCompletion? = nil)
    @@ -988,12 +1013,12 @@

    Parameters

    - collectionView + collectionViewBlock
    -

    The collection view to update.

    +

    A block returning the collecion view to perform updates on.

    @@ -1044,8 +1069,8 @@

    Parameters

    • diff --git a/docs/Protocols/IGListWorkingRangeDelegate.html b/docs/Protocols/IGListWorkingRangeDelegate.html index aed33595d..23b62e3e9 100644 --- a/docs/Protocols/IGListWorkingRangeDelegate.html +++ b/docs/Protocols/IGListWorkingRangeDelegate.html @@ -35,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -108,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -150,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -174,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -201,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -249,6 +258,14 @@ +
  • + Structures + +
    • diff --git a/docs/generating-your-models.html b/docs/Structs.html similarity index 57% rename from docs/generating-your-models.html rename to docs/Structs.html index 9cb917e0c..1c25d7711 100644 --- a/docs/generating-your-models.html +++ b/docs/Structs.html @@ -1,7 +1,7 @@ - Generating your models Reference + Structures Reference @@ -10,7 +10,8 @@ - + +

    IGListKit Docs (98% documented)

    @@ -21,7 +22,7 @@
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,178 +258,67 @@ +
  • + Structures + +
    • - -

    Generating your IGListDiffable models

    - -

    With the IGListDiffable plugin for remodel by facebook, you can automatically generate models conforming to the IGListDiffable.

    - -

    This will automatically implement hash, isEqual: and description, as well as diffIdentifier and isEqualToDiffableObject: for you. Remodel is also capable to generate additional code, like conforming to NSCoding or additional Builder classes for your model object. It will make creating and updating models much easier, faster and safer.

    - -

    In /remodel-plugin, you can find the source files to build the IGListDiffable plugin locally.

    -

    Installation

    -

    1. Remodel installation

    - -

    Please follow the installation instructions in the main remodel repository.

    - -

    tl;dr: Either clone the original repository, or use an npm installation. In the latter case you can run which remodel-gen to find out the path of your installation.

    -

    2. Plugin installation

    - -

    Copy the following files & folders within /remodel-plugin into your local remodel checkout:

    - -
      -
    • /src/plugins/iglistdiffable.ts - the actual plugin
      • -
    • /src/__tests__/plugins/iglistdiffable-test.ts - unit tests
      • -
    • /features/iglistdiffable.feature - integration tests
      • -
    - -

    And then register the new plugin with the system:

    - -
      -
    • Edit /remodel/src/value-object-default-config.ts and add iglistdiffable to the list of basePlugins:
      • -
    -
    // value-object-default-config.ts
-basePlugins: List.of(
-    'assert-nullability',
-    'assume-nonnull',
-    'builder',
-    'coding',
-    'copying',
-    'description',
-    'equality',
-    'fetch-status',
-    'immutable-properties',
-    'init-new-unavailable',
-    'use-cpp',
-    'iglistdiffable'
-  )
-
    -

    3. Build plugin:

    - -

    Once you copied them over and registered the plugin, you have to compile the typescript files into javascript. Do do so run this command from the remodel directory:

    - -
      -
    • ./bin/build
      • -
    -

    4. Run tests (optional)

    - -

    To run the unit/integration tests, you can run the following commands:

    - -
      -
    • ./bin/runUnitTests
      • -
    • ./bin/runAcceptanceTests
      • -
    - -

    This is especially useful if you plan to change/extend the plugin in any way.

    -

    5. Use the plugin

    - -

    Now you are ready to generate your IGListDiffable conforming models! To generate a model, create a new .value file. Here’s an example:

    -
    // PersonModel.value
-PersonModel includes(IGListDiffable) {
-  NSString *firstName
-  NSString *lastName
-  %diffIdentifier
-  NSString *uniqueId
-}
-
    - -

    To generate your Objective-C models, run the generation tool like this:

    - -

    ./bin/generate path/to/your/PersonModel.value

    - -

    This will generate the following Objective-C files in the same directory:

    -
    // PersonModel.h
-@interface PersonModel : NSObject <IGListDiffable, NSCopying>
-
-@property (nonatomic, readonly, copy) NSString *firstName;
-@property (nonatomic, readonly, copy) NSString *lastName;
-@property (nonatomic, readonly, copy) NSString *uniqueId;
-
-- (instancetype)initWithFirstName:(NSString *)firstName lastName:(NSString *)lastName uniqueId:(NSString *)uniqueId;
-
-@end
-
    - -

    and

    -
    // PersonModel.m
-@implementation PersonModel
-
-- (instancetype)initWithFirstName:(NSString *)firstName lastName:(NSString *)lastName uniqueId:(NSString *)uniqueId
-{
-  if ((self = [super init])) {
-    _firstName = [firstName copy];
-    _lastName = [lastName copy];
-    _uniqueId = [uniqueId copy];
-  }
-
-  return self;
-}
-
-- (id<NSObject>)diffIdentifier
-{
-  return _uniqueId;
-}
-
-- (BOOL)isEqualToDiffableObject:(nullable id)object
-{
-  return [self isEqual:object];
-}
-
-- (BOOL)isEqual:(PersonModel *)object
-{
-  if (self == object) {
-    return YES;
-  } else if (self == nil || object == nil || ![object isKindOfClass:[self class]]) {
-    return NO;
-  }
-  return
-    (_firstName == object->_firstName ? YES : [_firstName isEqual:object->_firstName]) &&
-    (_lastName == object->_lastName ? YES : [_lastName isEqual:object->_lastName]) &&
-    (_uniqueId == object->_uniqueId ? YES : [_uniqueId isEqual:object->_uniqueId]);
-}
-
-- (id)copyWithZone:(nullable NSZone *)zone
-{
-  return self;
-}
-
-- (NSString *)description
-{
-  return [NSString stringWithFormat:@"%@ - \n\t firstName: %@; \n\t lastName: %@; \n\t uniqueId: %@; \n", [super description], _firstName, _lastName, _uniqueId];
-}
-
-- (NSUInteger)hash
-{
-  NSUInteger subhashes[] = {[_firstName hash], [_lastName hash], [_uniqueId hash]};
-  NSUInteger result = subhashes[0];
-  for (int ii = 1; ii < 3; ++ii) {
-    unsigned long long base = (((unsigned long long)result) << 32 | subhashes[ii]);
-    base = (~base) + (base << 18);
-    base ^= (base >> 31);
-    base *=  21;
-    base ^= (base >> 11);
-    base += (base << 6);
-    base ^= (base >> 22);
-    result = base;
-  }
-  return result;
-}
-
-@end
-
    -

    Documentation

    - -

    Please see the main remodel repository for additional documentation

    +

    Structures

    +

    The following structures are available globally.

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      The current scrolling traits of the underlying collection view. +The attributes are always equal to their corresponding properties on the underlying collection view.

      + + See more +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      struct IGListCollectionScrollingTraits {}
      + +
      +
      +

      Swift

      + 
      struct IGListCollectionScrollingTraits
      + +
      +
      +
      +
      +
      • +
    +
    +
    diff --git a/docs/Structs/IGListCollectionScrollingTraits.html b/docs/Structs/IGListCollectionScrollingTraits.html new file mode 100644 index 000000000..4edab6bbf --- /dev/null +++ b/docs/Structs/IGListCollectionScrollingTraits.html @@ -0,0 +1,396 @@ + + + + IGListCollectionScrollingTraits Structure Reference + + + + + + + + + + +
    +
    +

    IGListKit Docs (98% documented)

    +

    View on GitHub

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    IGListCollectionScrollingTraits

    +
    +
    + 
    struct IGListCollectionScrollingTraits {}
    + +
    +
    +

    The current scrolling traits of the underlying collection view. +The attributes are always equal to their corresponding properties on the underlying collection view.

    + +
    +
    +
    +
      +
    • +
      + + + + isTracking + +
      +
      +
      +
      +
      +
      +

      returns YES if user has touched. may not yet have started dragging.

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      _Bool isTracking
      + +
      +
      +

      Swift

      + 
      var isTracking: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isDragging + +
      +
      +
      +
      +
      +
      +

      returns YES if user has started scrolling. this may require some time and or distance to move to initiate dragging

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      _Bool isDragging
      + +
      +
      +

      Swift

      + 
      var isDragging: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isDecelerating + +
      +
      +
      +
      +
      +
      +

      returns YES if user isn’t dragging (touch up) but scroll view is still moving.

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      _Bool isDecelerating
      + +
      +
      +

      Swift

      + 
      var isDecelerating: Bool
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Type Definitions.html b/docs/Type Definitions.html index addd41394..164cfad99 100644 --- a/docs/Type Definitions.html +++ b/docs/Type Definitions.html @@ -10,6 +10,7 @@ +
    @@ -34,7 +35,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +108,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +147,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +174,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +204,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +258,14 @@ +
  • + Structures + +
    • @@ -313,6 +331,38 @@

    Parameters

    +
    + +
    • @@ -649,13 +699,45 @@

      Declaration

    +
  • + +
    +
    +
    +
    +
    +

    A block that returns a collection view to perform updates on.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef UICollectionView *_Nullable (^IGListCollectionViewBlock)(void)
    + +
    +
    +

    Swift

    + 
    typealias ListCollectionViewBlock = () -> UICollectionView?
    + +
    +
    +
    +
    +
    • diff --git a/docs/Type Definitions/IGListCollectionScrollingTraits.html b/docs/Type Definitions/IGListCollectionScrollingTraits.html new file mode 100644 index 000000000..b5d43a396 --- /dev/null +++ b/docs/Type Definitions/IGListCollectionScrollingTraits.html @@ -0,0 +1,333 @@ + + + + IGListCollectionScrollingTraits Type Definition Reference + + + + + + + + + + +
    +
    +

    IGListKit Docs (98% documented)

    +

    View on GitHub

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    IGListCollectionScrollingTraits

    +
    +
    + 
    typedef struct IGListCollectionScrollingTraits IGListCollectionScrollingTraits
    + +
    +
    +

    Undocumented

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      The current scrolling traits of the underlying collection view. +The attributes are always equal to their corresponding properties on the underlying collection view.

      + + See more +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      struct IGListCollectionScrollingTraits {}
      + +
      +
      +

      Swift

      + 
      struct IGListCollectionScrollingTraits
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Type Definitions/IGListCollectionScrollingTraits/IGListCollectionScrollingTraits.html b/docs/Type Definitions/IGListCollectionScrollingTraits/IGListCollectionScrollingTraits.html new file mode 100644 index 000000000..73eac391d --- /dev/null +++ b/docs/Type Definitions/IGListCollectionScrollingTraits/IGListCollectionScrollingTraits.html @@ -0,0 +1,396 @@ + + + + IGListCollectionScrollingTraits Structure Reference + + + + + + + + + + +
    +
    +

    IGListKit Docs (98% documented)

    +

    View on GitHub

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    IGListCollectionScrollingTraits

    +
    +
    + 
    struct IGListCollectionScrollingTraits {}
    + +
    +
    +

    The current scrolling traits of the underlying collection view. +The attributes are always equal to their corresponding properties on the underlying collection view.

    + +
    +
    +
    +
      +
    • +
      + + + + isTracking + +
      +
      +
      +
      +
      +
      +

      returns YES if user has touched. may not yet have started dragging.

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      _Bool isTracking
      + +
      +
      +

      Swift

      + 
      var isTracking: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isDragging + +
      +
      +
      +
      +
      +
      +

      returns YES if user has started scrolling. this may require some time and or distance to move to initiate dragging

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      _Bool isDragging
      + +
      +
      +

      Swift

      + 
      var isDragging: Bool
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + isDecelerating + +
      +
      +
      +
      +
      +
      +

      returns YES if user isn’t dragging (touch up) but scroll view is still moving.

      + +
      +
      +

      Declaration

      +
      +

      Objective-C

      + 
      _Bool isDecelerating
      + +
      +
      +

      Swift

      + 
      var isDecelerating: Bool
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/best-practices-and-faq.html b/docs/best-practices-and-faq.html index 7b46727d6..c5414c503 100644 --- a/docs/best-practices-and-faq.html +++ b/docs/best-practices-and-faq.html @@ -34,7 +34,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +107,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +146,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +173,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +203,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +257,14 @@ +
  • + Structures + +
    • @@ -301,7 +318,7 @@

    Does IGListKit
  • Core Data (Working with Core Data Guide)
  • AsyncDisplayKit (AsyncDisplayKit/#2942)
  • ComponentKit (ocrickard/IGListKit-ComponentKit)
    • -
  • RxSwift (yuzushioh/RxIGListKit)
    • +
  • RxSwift (RxSwiftCommunity/RxIGListKit)
  • React Native
  • Reactive Cocoa
    • @@ -318,7 +335,7 @@

    How can

    See discussion at #184.

    I have a huge data set and -performUpdatesAnimated: completion: is super slow. What do I do?

    -

    If you have multiple thousands of items and you cannot batch them in, you’ll see performance issues with -performUpdatesAnimated: completion:. The real bottle neck behind the scenes here is UICollectionView attempting to insert so many cells at once. Instead, call -reloadDataWithCompletion: when you first load data. Behind the scenes, this method does not do any diffing and simply calls -reloadData on UICollectionView. For subsequent updates, you can then use -performUpdatesAnimated: completion:.

    +

    If you have multiple thousands of items and you cannot batch them in, you’ll see performance issues with -performUpdatesAnimated: completion:. The real bottleneck behind the scenes here is UICollectionView attempting to insert so many cells at once. Instead, call -reloadDataWithCompletion: when you first load data. Behind the scenes, this method does not do any diffing and simply calls -reloadData on UICollectionView. For subsequent updates, you can then use -performUpdatesAnimated: completion:.

    How do I use IGListKit and estimated cell sizes with Auto Layout?

    This should work in theory, and we have an example section controller, but the estimated-size API in UICollectionViewFlowLayout has changed dramatically over different iOS versions, making first-class support in IGListKit difficult. We don’t use estimated cell sizes or Auto Layout in Instagram and cannot commit to fully supporting it.

    @@ -389,8 +406,8 @@

    + + + + + + +
    +
    +

    IGListKit Docs (98% documented)

    +

    View on GitHub

    +
    +
    +
    + +
    +
    + +
    +
    +
    + +

    Generating your IGListDiffable models using remodel

    + +

    With the IGListDiffable plugin for remodel by facebook, you can automatically generate models conforming to the IGListDiffable.

    + +

    This will automatically implement hash, isEqual: and description, as well as diffIdentifier and isEqualToDiffableObject: for you. Remodel is also capable to generate additional code, like conforming to NSCoding or additional Builder classes for your model object. It will make creating and updating models much easier, faster and safer.

    + +

    In /remodel-plugin, you can find the source files to build the IGListDiffable plugin locally.

    +

    Installation

    +

    1. Remodel installation

    + +

    Please follow the installation instructions in the main remodel repository.

    + +

    tl;dr: Either clone the original repository, or use an npm installation. In the latter case you can run which remodel-gen to find out the path of your installation.

    +

    2. Plugin installation

    + +

    Copy the following files & folders within /remodel-plugin into your local remodel checkout:

    + +
      +
    • /src/plugins/iglistdiffable.ts - the actual plugin
      • +
    • /src/__tests__/plugins/iglistdiffable-test.ts - unit tests
      • +
    • /features/iglistdiffable.feature - integration tests
      • +
    + +

    And then register the new plugin with the system:

    + +
      +
    • Edit /remodel/src/value-object-default-config.ts and add iglistdiffable to the list of basePlugins:
      • +
    +
    // value-object-default-config.ts
+basePlugins: List.of(
+    'assert-nullability',
+    'assume-nonnull',
+    'builder',
+    'coding',
+    'copying',
+    'description',
+    'equality',
+    'fetch-status',
+    'immutable-properties',
+    'init-new-unavailable',
+    'use-cpp',
+    'iglistdiffable'
+  )
+
    +

    3. Build plugin:

    + +

    Once you copied them over and registered the plugin, you have to compile the typescript files into javascript. Do do so run this command from the remodel directory:

    + +
      +
    • ./bin/build
      • +
    +

    4. Run tests (optional)

    + +

    To run the unit/integration tests, you can run the following commands:

    + +
      +
    • ./bin/runUnitTests
      • +
    • ./bin/runAcceptanceTests
      • +
    + +

    This is especially useful if you plan to change/extend the plugin in any way.

    +

    5. Use the plugin

    + +

    Now you are ready to generate your IGListDiffable conforming models! To generate a model, create a new .value file. Here’s an example:

    +
    # PersonModel.value
+PersonModel includes(IGListDiffable) {
+  NSString *firstName
+  NSString *lastName
+  %diffIdentifier
+  NSString *uniqueId
+}
+
    + +

    To generate your Objective-C models, run the generation tool like this:

    + +

    ./bin/generate path/to/your/PersonModel.value

    + +

    This will generate the following Objective-C files in the same directory:

    +
    // PersonModel.h
+@interface PersonModel : NSObject <IGListDiffable, NSCopying>
+
+@property (nonatomic, readonly, copy) NSString *firstName;
+@property (nonatomic, readonly, copy) NSString *lastName;
+@property (nonatomic, readonly, copy) NSString *uniqueId;
+
+- (instancetype)initWithFirstName:(NSString *)firstName lastName:(NSString *)lastName uniqueId:(NSString *)uniqueId;
+
+@end
+
    + +

    and

    +
    // PersonModel.m
+@implementation PersonModel
+
+- (instancetype)initWithFirstName:(NSString *)firstName lastName:(NSString *)lastName uniqueId:(NSString *)uniqueId
+{
+  if ((self = [super init])) {
+    _firstName = [firstName copy];
+    _lastName = [lastName copy];
+    _uniqueId = [uniqueId copy];
+  }
+
+  return self;
+}
+
+- (id<NSObject>)diffIdentifier
+{
+  return _uniqueId;
+}
+
+- (BOOL)isEqualToDiffableObject:(nullable id)object
+{
+  return [self isEqual:object];
+}
+
+- (BOOL)isEqual:(PersonModel *)object
+{
+  if (self == object) {
+    return YES;
+  } else if (self == nil || object == nil || ![object isKindOfClass:[self class]]) {
+    return NO;
+  }
+  return
+    (_firstName == object->_firstName ? YES : [_firstName isEqual:object->_firstName]) &&
+    (_lastName == object->_lastName ? YES : [_lastName isEqual:object->_lastName]) &&
+    (_uniqueId == object->_uniqueId ? YES : [_uniqueId isEqual:object->_uniqueId]);
+}
+
+- (id)copyWithZone:(nullable NSZone *)zone
+{
+  return self;
+}
+
+- (NSString *)description
+{
+  return [NSString stringWithFormat:@"%@ - \n\t firstName: %@; \n\t lastName: %@; \n\t uniqueId: %@; \n", [super description], _firstName, _lastName, _uniqueId];
+}
+
+- (NSUInteger)hash
+{
+  NSUInteger subhashes[] = {[_firstName hash], [_lastName hash], [_uniqueId hash]};
+  NSUInteger result = subhashes[0];
+  for (int ii = 1; ii < 3; ++ii) {
+    unsigned long long base = (((unsigned long long)result) << 32 | subhashes[ii]);
+    base = (~base) + (base << 18);
+    base ^= (base >> 31);
+    base *=  21;
+    base ^= (base >> 11);
+    base += (base << 6);
+    base ^= (base >> 22);
+    result = base;
+  }
+  return result;
+}
+
+@end
+
    +

    Documentation

    + +

    Please see the main remodel repository for additional documentation

    + +
    +
    + +
    +
    + + + diff --git a/docs/getting-started.html b/docs/getting-started.html index fa8d8cdcb..bcb6746a8 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -34,7 +34,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +107,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +146,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +173,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +203,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +257,14 @@ +
  • + Structures + +
    • diff --git a/docs/iglistdiffable-and-equality.html b/docs/iglistdiffable-and-equality.html index 5d4b06749..86368043d 100644 --- a/docs/iglistdiffable-and-equality.html +++ b/docs/iglistdiffable-and-equality.html @@ -34,7 +34,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +107,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +146,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +173,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +203,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +257,14 @@ +
  • + Structures + +
    • @@ -327,8 +344,8 @@

    Requirements

    • Xcode 9.0+
      • -
    • iOS 8.0+
      • +
    • iOS 9.0+
    • tvOS 9.0+
    • macOS 10.11+ (diffing algorithm components only)
    • Interoperability with Swift 3.0+
      • @@ -344,21 +361,21 @@

      Installation

      CocoaPods

      The preferred installation method is with CocoaPods. Add the following to your Podfile:

      -
      pod 'IGListKit', '~> 3.0'
+
      pod 'IGListKit', '~> 4.0.0'
 
      
 
      Carthage
      
 
 
      For Carthage, add the following to your Cartfile:
      
-
      github "Instagram/IGListKit" ~> 3.0
+
      github "Instagram/IGListKit" ~> 4.0.0
 
      
 
 
      
 
      For advanced usage, see our Installation Guide.
      
 
      
 
      Getting Started
      
-
      $ git clone https://github.com/Instagram/IGListKit.git
-$ cd IGListKit/
-$ ./scripts/setup.sh
+
      $ git clone https://github.com/Instagram/IGListKit.git
+$ cd IGListKit/
+$ ./scripts/setup.sh
    diff --git a/docs/installation.html b/docs/installation.html index 68c37c2d7..331f3c919 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -34,7 +34,7 @@ Best Practices and FAQ
  • - Generating your models + Generating your models using remodel
  • Getting Started @@ -107,9 +107,6 @@
  • IGListSingleSectionController
    • -
  • - IGListStackedSectionController -
  • @@ -149,6 +146,9 @@
  • IGListAdapterMoveDelegate
    • +
  • + IGListAdapterPerformanceDelegate +
  • IGListAdapterUpdateListener
    • @@ -173,6 +173,9 @@
  • IGListCollectionViewDelegateLayout
    • +
  • + IGListCollectionViewLayoutCompatible +
  • IGListDiffable
    • @@ -200,31 +203,37 @@
  • - Type Definitions + Type Definitions
    • @@ -248,6 +257,14 @@ +
  • + Structures + +
    • @@ -262,7 +279,7 @@

    CocoaPods

    The preferred method of installation for IGListKit is using CocoaPods.

    In order to use the latest release of the framework, add the following to your Podfile:

    -
    pod 'IGListKit', '~> 3.0'
+
    pod 'IGListKit', '~> 4.0'
 
    
 
    Using master
    
 
@@ -278,7 +295,7 @@ 
    Subspecs
    
 
    With the exception of macOS (which currently only supports the diffing algorithm components), using pod 'IGListKit' will get you the full library, including the flexible UICollectionView system. Learn more about how to get started in our Getting Started guide.
    
 
 
    However, if you only want to use the diffing components of this library, then you can use the diffing subspec in your Podfile:
    
-
    pod 'IGListKit/Diffing', '~> 3.0'
+
    pod 'IGListKit/Diffing', '~> 4.0'
 
    
 
 
    Regardless of whether you only use the diffing components, or the entire library, the imports are the same:
    
@@ -287,14 +304,14 @@ 
    Subspecs
    
 
    Carthage
    
 
 
    If using Carthage, add the following to your Cartfile:
    
-
    github "Instagram/IGListKit" ~> 3.0
+
    github "Instagram/IGListKit" ~> 4.0
    diff --git a/docs/js/jazzy.js b/docs/js/jazzy.js index 3965b5fb6..c31dc05e4 100755 --- a/docs/js/jazzy.js +++ b/docs/js/jazzy.js @@ -8,29 +8,41 @@ if (navigator.userAgent.match(/xcode/i)) { window.jazzy.docset = true } -// On doc load, toggle the URL hash discussion if present -$(document).ready(function() { - if (!window.jazzy.docset) { - var linkToHash = $('a[href="' + window.location.hash +'"]'); - linkToHash.trigger("click"); +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; } -}); + var $link = $(`.token[href="${location.hash}"]`); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); -// On token click, toggle its discussion and animate token.marginLeft -$(".token").click(function(event) { +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { if (window.jazzy.docset) { return; } - var link = $(this); - var animationDuration = 300; - var tokenOffset = "15px"; - var original = link.css('marginLeft') == tokenOffset; - link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration); - $content = link.parent().parent().next(); - $content.slideToggle(animationDuration); + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); // Keeps the document from jumping to the hash. - var href = $(this).attr('href'); + var href = $link.attr('href'); if (history.pushState) { history.pushState({}, '', href); } else { @@ -39,8 +51,9 @@ $(".token").click(function(event) { event.preventDefault(); }); -// Dumb down quotes within code blocks that delimit strings instead of quotations -// https://github.com/realm/jazzy/issues/714 -$("code q").replaceWith(function () { - return ["\"", $(this).contents(), "\""]; +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } }); diff --git a/docs/js/jquery.min.js b/docs/js/jquery.min.js old mode 100755 new mode 100644 index ab28a2472..a1c07fd80 --- a/docs/js/jquery.min.js +++ b/docs/js/jquery.min.js @@ -1,4 +1,2 @@ -/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ -!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="
    ",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h; -if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
    a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/\s*$/g,rb={option:[1,""],legend:[1,"
    ","
    "],area:[1,"",""],param:[1,"",""],thead:[1,"","
    "],tr:[2,"","
    "],col:[2,"","
    "],td:[3,"","
    "],_default:k.htmlSerialize?[0,"",""]:[1,"X
    ","
    "]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?""!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("