SwiftGridView

@MainActor
open class SwiftGridView : UIView, UICollectionViewDataSource, UICollectionViewDelegate, SwiftGridLayoutDelegate, SwiftGridReusableViewDelegate

SwiftGridView is the primary view class, utilizing a UICollectionView and a custom layout handler.

Show on GitHub

Init


                    
                    
                    init(coder:)

Undocumented

Declaration

Swift

@MainActor
public required init?(coder aDecoder: NSCoder)

Show on GitHub

init(frame:)
Undocumented
Declaration
Swift

@MainActor public override init(frame: CGRect)
Show on GitHub

Public Properties

collectionView
Internal Collectionview. Open to allow for custom interaction, modify at own risk.
Declaration
Swift

@objc @MainActor open internal(set) var collectionView: UICollectionView! { get }
Show on GitHub
dataSource

Allows IBOutlets to work properly. Required dataSource link of type SwiftGridViewDataSource
delegate

Allows IBOutlets to work properly. Required delegate link of type SwiftGridViewDelegate
dataSource
Required dataSource link of type SwiftGridViewDataSource
Declaration
Swift

@objc @MainActor open weak var dataSource: SwiftGridViewDataSource?
Show on GitHub
delegate
Required delegate link of type SwiftGridViewDelegate
Declaration
Swift

@objc @MainActor open weak var delegate: SwiftGridViewDelegate?
Show on GitHub
allowsSelection
Enable or disable selection for the entire gridview.
Declaration
Swift

@objc @MainActor open var allowsSelection: Bool { get set }
Show on GitHub
allowsMultipleSelection
When enabled, multiple cells can be selected. If row selection is enabled, then multiple rows can be selected.
Declaration
Swift

@objc @MainActor open var allowsMultipleSelection: Bool
Show on GitHub
rowSelectionEnabled
If row selection is enabled, then entire rows will be selected rather than individual cells. This applies to section headers/footers in addition to rows.
Declaration
Swift

@objc @MainActor open var rowSelectionEnabled: Bool
Show on GitHub
visibleCells
Array of SwiftGridCell for all visible cells.
Declaration
Swift

@objc @MainActor open var visibleCells: [SwiftGridCell] { get }
Show on GitHub
indexPathsForVisibleItems
Array of IndexPath for all visible cells.
Declaration
Swift

@objc @MainActor open var indexPathsForVisibleItems: [IndexPath] { get }
Show on GitHub
indexPathsForSelectedItems
Array of IndexPath for any selected cells
Declaration
Swift

@objc @MainActor open var indexPathsForSelectedItems: [IndexPath] { get }
Show on GitHub
isDirectionalLockEnabled
When directional lock is enabled, the grid is only scrollable in one direction at a time (vertically or horizontally)
Declaration
Swift

@objc @MainActor open var isDirectionalLockEnabled: Bool { get set }
Show on GitHub
bounces
Enables bouncing for the gridvies
Declaration
Swift

@objc @MainActor open var bounces: Bool { get set }
Show on GitHub
stickySectionHeaders
Determines whether section headers will stick while scrolling vertically or scroll off screen.
Declaration
Swift

@objc @MainActor open var stickySectionHeaders: Bool { get set }
Show on GitHub
alwaysBounceVertical
default NO. if YES and bounces is YES, even if content is smaller than bounds, allow drag vertically
Declaration
Swift

@objc @MainActor open var alwaysBounceVertical: Bool { get set }
Show on GitHub
alwaysBounceHorizontal
default NO. if YES and bounces is YES, even if content is smaller than bounds, allow drag horizontally
Declaration
Swift

@objc @MainActor open var alwaysBounceHorizontal: Bool { get set }
Show on GitHub
showsHorizontalScrollIndicator
A Boolean value that controls whether the horizontal scroll indicator is visible. The default value is true. The indicator is visible while tracking is underway and fades out after tracking.
Declaration
Swift

@objc @MainActor open var showsHorizontalScrollIndicator: Bool { get set }
Show on GitHub
showsVerticalScrollIndicator
A Boolean value that controls whether the vertical scroll indicator is visible. The default value is true. The indicator is visible while tracking is underway and fades out after tracking.
Declaration
Swift

@objc @MainActor open var showsVerticalScrollIndicator: Bool { get set }
Show on GitHub
pinchExpandEnabled
Pinch to expand increases the size of the columns. Experimental feature.
Declaration
Swift

@objc @MainActor open var pinchExpandEnabled: Bool { get set }
Show on GitHub
isTracking
Declaration
Swift

@objc @MainActor open var isTracking: Bool { get }
Return Value

YES if user has touched. may not yet have started draggin

Show on GitHub
isDragging
Declaration
Swift

@objc @MainActor open var isDragging: Bool { get }
Return Value

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

Show on GitHub
isDecelerating
Declaration
Swift

@objc @MainActor open var isDecelerating: Bool { get }
Return Value

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

Show on GitHub
scrollsToTop
Whether or not the gridView will automatically scroll to top when the status bar is tapped. Default is YES.
Declaration
Swift

@objc @MainActor open var scrollsToTop: Bool { get set }
Show on GitHub


                    
                    
                    refreshControl

Undocumented

Declaration

Swift

@objc
@MainActor
open var refreshControl: UIRefreshControl? { get set }

Show on GitHub

Layout Subviews

layoutSubviews()
Undocumented
Declaration
Swift

@MainActor open override func layoutSubviews()
Show on GitHub

Public Methods

reloadData(_:)
Reloads all data for the SwiftGridView
Declaration
Swift

@objc @MainActor open func reloadData(_ resetSize: Bool = true)
Show on GitHub


                    
                    
                    reloadCellsAtIndexPaths(_:animated:)

Reloads the specified items by their indexPath(s).

Declaration

Swift

@objc
@MainActor
open func reloadCellsAtIndexPaths(_ indexPaths: [IndexPath], animated: Bool)

Parameters

`indexPaths`	Array of `IndexPath` to reload
`animated`	Whether to animate the change or not

Show on GitHub


                    
                    
                    reloadCellsAtIndexPaths(_:animated:completion:)

Reloads the specified items by their indexPath(s).

Declaration

Swift

@objc
@MainActor
open func reloadCellsAtIndexPaths(_ indexPaths: [IndexPath], animated: Bool, completion: ((Bool) -> Void)?)

Parameters

`indexPaths`	Array of `IndexPath` to reload
`animated`	Whether to animate the change or not
`completion`	Completion handler executed upon reload

Show on GitHub


                    
                    
                    indexPathForItem(at:)

Get the item indexPath based on the provided point

Declaration

Swift

@objc
@MainActor
open func indexPathForItem(at point: CGPoint) -> IndexPath?

Parameters


                                point

CGPoint to search for

Return Value

The indexPath for the appropriate item if it exists

Show on GitHub


                    
                    
                    indexPath(for:)

Get the item indexPath for the provided cell

Declaration

Swift

@objc
@MainActor
open func indexPath(for cell: SwiftGridCell) -> IndexPath?

Parameters


                                cell

Instance of SwiftGridCell

Return Value

The indexPath for the appropriate item if it exists

Show on GitHub


                    
                    
                    selectedIndexPathsForSupplementaryView(ofElementKind:)

Get the selected indexPath(s) for the provided supplementary view kind

Declaration

Swift

@objc
@MainActor
open func selectedIndexPathsForSupplementaryView(ofElementKind kind: String) -> [IndexPath]

Parameters


                                kind

View type SwiftGridViewElementKind...

Return Value

Array of IndexPath for the selected view(s)

Show on GitHub


                    
                    
                    cellForItem(at:)

Get the cell for the provided indexPath

Declaration

Swift

@objc
@MainActor
open func cellForItem(at indexPath: IndexPath) -> SwiftGridCell?

Parameters


                                indexPath

IndexPath to search for.

Return Value

The SwiftGridCell instance for the provided indexPath

Show on GitHub


                    
                    
                    supplementaryView(ofElementKind:at:)

Get the supplementary view for the provided indexPath

Declaration

Swift

@objc
@MainActor
open func supplementaryView(ofElementKind kind: String, at indexPath: IndexPath) -> SwiftGridReusableView?

Parameters

`kind`	View type `SwiftGridViewElementKind...`
`indexPath`	IndexPath to search for.

Return Value

The SwiftGridReusableView instance for the provided indexPath

Show on GitHub


                    
                    
                    register(_:forCellWithReuseIdentifier:)

Declaration

Swift

@objc(registerClass:forCellReuseIdentifier:)
@MainActor
open func register(_ cellClass: Swift.AnyClass?, forCellWithReuseIdentifier identifier: String)

Show on GitHub

register(_:forCellWithReuseIdentifier:)
Register the provided nib for row cell reuse within the SwiftGridView
Declaration
Swift

@objc @MainActor open func register(_ nib: UINib?, forCellWithReuseIdentifier identifier: String)
Show on GitHub


                    
                    
                    register(_:forSupplementaryViewOfKind:withReuseIdentifier:)

Declaration

Swift

@objc(registerClass:forSupplementaryViewOfKind:withReuseIdentifier:)
@MainActor
open func register(_ viewClass: Swift.AnyClass?, forSupplementaryViewOfKind elementKind: String, withReuseIdentifier identifier: String)

Show on GitHub

register(_:forSupplementaryViewOfKind:withReuseIdentifier:)
Register the provided class for supplementary cell reuse within the SwiftGridView
Declaration
Swift

@objc @MainActor open func register(_ nib: UINib?, forSupplementaryViewOfKind kind: String, withReuseIdentifier identifier: String)
Show on GitHub


                    
                    
                    dequeueReusableCellWithReuseIdentifier(_:forIndexPath:)

Dequeue Row Cell

Declaration

Swift

@objc
@MainActor
open func dequeueReusableCellWithReuseIdentifier(_ identifier: String, forIndexPath indexPath: IndexPath!) -> SwiftGridCell

Show on GitHub


                    
                    
                    dequeueReusableSupplementaryViewOfKind(_:withReuseIdentifier:atColumn:)

Dequeue Supplementary Cell by column

Declaration

Swift

@objc
@MainActor
open func dequeueReusableSupplementaryViewOfKind(_ elementKind: String, withReuseIdentifier identifier: String, atColumn column: NSInteger) -> SwiftGridReusableView

Show on GitHub


                    
                    
                    dequeueReusableSupplementaryViewOfKind(_:withReuseIdentifier:forIndexPath:)

Dequeue Supplementary Cell by IndexPath

Declaration

Swift

@objc
@MainActor
open func dequeueReusableSupplementaryViewOfKind(_ elementKind: String, withReuseIdentifier identifier: String, forIndexPath indexPath: IndexPath) -> SwiftGridReusableView

Show on GitHub

selectCellAtIndexPath(_:animated:)
Selects the cell at the provided indexPath
Declaration
Swift

@objc @MainActor open func selectCellAtIndexPath(_ indexPath: IndexPath, animated: Bool)
Show on GitHub
deselectCellAtIndexPath(_:animated:)
Deselects the cell at the provided indexPath
Declaration
Swift

@objc @MainActor open func deselectCellAtIndexPath(_ indexPath: IndexPath, animated: Bool)
Show on GitHub
selectHeaderAtIndexPath(_:)
Selects the header at the provided indexPath
Declaration
Swift

@objc @MainActor open func selectHeaderAtIndexPath(_ indexPath: IndexPath)
Show on GitHub
deselectHeaderAtIndexPath(_:)
Deselects the header at the provided indexPath
Declaration
Swift

@objc @MainActor open func deselectHeaderAtIndexPath(_ indexPath: IndexPath)
Show on GitHub
selectSectionHeaderAtIndexPath(_:)
Select the section header at the provided indexPath
Declaration
Swift

@objc @MainActor open func selectSectionHeaderAtIndexPath(_ indexPath: IndexPath)
Show on GitHub
deselectSectionHeaderAtIndexPath(_:)
Deselect the section header at the provided indexPath
Declaration
Swift

@objc @MainActor open func deselectSectionHeaderAtIndexPath(_ indexPath: IndexPath)
Show on GitHub
selectSectionFooterAtIndexPath(_:)
Select the section footer at the provided indexPath
Declaration
Swift

@objc @MainActor open func selectSectionFooterAtIndexPath(_ indexPath: IndexPath)
Show on GitHub
deselectSectionFooterAtIndexPath(_:)
Deselect the section footer at the provided indexPath
Declaration
Swift

@objc @MainActor open func deselectSectionFooterAtIndexPath(_ indexPath: IndexPath)
Show on GitHub


                    
                    
                    scrollToCellAtIndexPath(_:atScrollPosition:animated:)

Scroll to the cell at the provided indexPath. If the cell scroll posiition would not fit without pushing the grid outside of its normal scroll bounds, the position wil be the closest compatible

Declaration

Swift

@objc
@MainActor
open func scrollToCellAtIndexPath(_ indexPath: IndexPath, atScrollPosition scrollPosition: UICollectionView.ScrollPosition, animated: Bool)

Parameters

`indexPath`	IndexPath of the cell to scroll to
`scrollPosition`	Position to use when scrolling.
`animated`	Whether to animate the scroll action

Show on GitHub

setContentOffset(_:animated:)
Manually set the content offset for the gridview
Declaration
Swift

@objc @MainActor open func setContentOffset(_ contentOffset: CGPoint, animated: Bool)
Show on GitHub
location(for:)
Declaration
Swift

@objc @MainActor open func location(for gestureRecognizer: UIGestureRecognizer) -> CGPoint
Return Value

The CGPoint location for the provided gesture in the gridview context

Show on GitHub

SwiftGridReusableViewDelegate Methods


                    
                    
                    swiftGridReusableView(_:didSelectViewAtIndexPath:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func swiftGridReusableView(_ reusableView: SwiftGridReusableView, didSelectViewAtIndexPath indexPath: IndexPath)

Show on GitHub


                    
                    
                    swiftGridReusableView(_:didDeselectViewAtIndexPath:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func swiftGridReusableView(_ reusableView: SwiftGridReusableView, didDeselectViewAtIndexPath indexPath: IndexPath)

Show on GitHub


                    
                    
                    swiftGridReusableView(_:didHighlightViewAtIndexPath:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func swiftGridReusableView(_ reusableView: SwiftGridReusableView, didHighlightViewAtIndexPath indexPath: IndexPath)

Show on GitHub


                    
                    
                    swiftGridReusableView(_:didUnhighlightViewAtIndexPath:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func swiftGridReusableView(_ reusableView: SwiftGridReusableView, didUnhighlightViewAtIndexPath indexPath: IndexPath)

Show on GitHub

UICollectionView DataSource


                    
                    
                    numberOfSections(in:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func numberOfSections(in collectionView: UICollectionView) -> Int

Show on GitHub


                    
                    
                    collectionView(_:numberOfItemsInSection:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int

Show on GitHub


                    
                    
                    collectionView(_:cellForItemAt:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell

Show on GitHub


                    
                    
                    collectionView(_:viewForSupplementaryElementOfKind:at:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, viewForSupplementaryElementOfKind kind: String, at indexPath: IndexPath) -> UICollectionReusableView

Show on GitHub

UICollectionView Delegate


                    
                    
                    selectColumnAtIndexPath(_:animated:includeHeader:)

Undocumented

Declaration

Swift

@MainActor
open func selectColumnAtIndexPath(_ indexPath: IndexPath, animated: Bool, includeHeader: Bool = true)

Show on GitHub


                    
                    
                    deselectColumnAtIndexPath(_:animated:includeHeader:)

Undocumented

Declaration

Swift

@MainActor
open func deselectColumnAtIndexPath(_ indexPath: IndexPath, animated: Bool, includeHeader: Bool = true)

Show on GitHub


                    
                    
                    selectRowAtIndexPath(_:animated:)

Undocumented

Declaration

Swift

@MainActor
open func selectRowAtIndexPath(_ indexPath: IndexPath, animated: Bool)

Show on GitHub


                    
                    
                    deselectRowAtIndexPath(_:animated:)

Undocumented

Declaration

Swift

@MainActor
open func deselectRowAtIndexPath(_ indexPath: IndexPath, animated: Bool)

Show on GitHub


                    
                    
                    collectionView(_:didHighlightItemAt:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, didHighlightItemAt indexPath: IndexPath)

Show on GitHub


                    
                    
                    collectionView(_:didUnhighlightItemAt:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, didUnhighlightItemAt indexPath: IndexPath)

Show on GitHub


                    
                    
                    collectionView(_:didSelectItemAt:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath)

Show on GitHub


                    
                    
                    collectionView(_:didDeselectItemAt:)

Internal to SwiftGridView, do not use

Declaration

Swift

@MainActor
open func collectionView(_ collectionView: UICollectionView, didDeselectItemAt indexPath: IndexPath)

Show on GitHub