Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyoheig3/gridview
Reusable GridView with excellent performance and customization that can be time table, spreadsheet, paging and more.
https://github.com/kyoheig3/gridview
grid-layout gridview ios spreadsheet swift timetable
Last synced: 4 days ago
JSON representation
Reusable GridView with excellent performance and customization that can be time table, spreadsheet, paging and more.
- Host: GitHub
- URL: https://github.com/kyoheig3/gridview
- Owner: KyoheiG3
- License: mit
- Created: 2016-11-26T06:45:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-06T13:32:06.000Z (about 1 year ago)
- Last Synced: 2024-10-29T20:35:23.339Z (15 days ago)
- Topics: grid-layout, gridview, ios, spreadsheet, swift, timetable
- Language: Swift
- Homepage:
- Size: 180 KB
- Stars: 855
- Watchers: 21
- Forks: 59
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GridView
[](https://travis-ci.org/KyoheiG3/GridView)
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/G3GridView)
[](http://cocoadocs.org/docsets/G3GridView)
[](http://cocoadocs.org/docsets/G3GridView)
GridView can tile the view while reusing it. It has an API like UIKit that works fast. Even when device rotates it smoothly relayout.
#### [Appetize's Demo](https://appetize.io/app/d5qk2927a8y07armrbbdck64c4)
### You Can
- Scroll like paging
- Scroll infinitely
- Scale the view
- Call API like the `UITableView`
## Requirements
- Swift 5.0
- iOS 9.0 or later
## How to Install
#### CocoaPods
Add the following to your `Podfile`:
```Ruby
pod "G3GridView"
```
> :warning: **WARNING :** If you want to install from `CocoaPods`, must add `G3GridView` to Podfile because there is a `GridView` different from this `GridView`.
#### Carthage
Add the following to your `Cartfile`:
```Ruby
github "KyoheiG3/GridView"
```
## Over View
GridView can scroll in any direction while reusing Cell like `UITableView`. Also it is based `UIScrollView` and paging and scaling are possible. If necessary, it is possible to repeat the left and right scroll infinitely.
GridView is one `UIScrollView`, but the range which Cell is viewed depends on Superview. Cell reuse is also done within the range which Superview is viewed, so its size is very important.
On the other hand, scaling and paging depend to position and size of GridView. 'bounds' is important for paging, 'frame' is important in scaling. The same is true for offset of content.
The following image is a visual explanation of the view hierarchy.
You can use it like the `UITableView` APIs. However, there is concept of `Column`. The following functions are delegate APIs of 'GridView'.
```swift
func gridView(_ gridView: GridView, numberOfRowsInColumn column: Int) -> Int
func gridView(_ gridView: GridView, cellForRowAt indexPath: IndexPath) -> GridViewCell
@objc optional func numberOfColumns(in gridView: GridView) -> Int
```
You can see that must return the count.
## Examples
This project is including two examples that is timetable and paging. Those can change on Interface Builder for following:
Try the two examples.
| timetable | paging |
|-|-|
|
|
|
## Usage
### Variables
#### Infinite Loop
A horizontal loop is possible.
```swift
open var isInfinitable: Bool
```
- Default is `true`.
- Set `false` if you don't need to loop of view.
```swift
gridView.isInfinitable = true
```
#### Scaling
Content is done relayout rather than scaling like 'UIScrollView'.
```swift
open var minimumScale: Scale
open var maximumScale: Scale
```
- Default for x and y are 1.
- Set the vertical and horizontal scales.
```swift
public var currentScale: Scale { get }
```
- Get current vertical and horizontal scales.
```swift
gridView.minimumScale = Scale(x: 0.5, y: 0.5)
gridView.maximumScale = Scale(x: 1.5, y: 1.5)
```
#### Fill for Cell
It is possible to decide the placement of Cell at relayout.
```swift
open var layoutWithoutFillForCell: Bool
```
- Default is `false`.
- Set `true` if need to improved view layout performance.
| false | true |
|-|-|
|
|
|
```swift
gridView.layoutWithoutFillForCell = true
```
#### Content Offset
If `isInfinitable` is true, `contentOffset` depends on the content size including size to loop. It is possible to take content offset that actually visible.
```swift
open var actualContentOffset: CGPoint { get }
```
#### Delegate
Set the delegate destination. This delegate property is `UIScrollViewDelegate` but, actually set the `GridViewDelegate`.
```
weak open var dataSource: GridViewDataSource?
open var delegate: UIScrollViewDelegate?
```
### Functions
#### State
Get the view state.
```swift
public func visibleCells() -> [T]
public func cellForRow(at indexPath: IndexPath) -> GridViewCell?
public func rectForRow(at indexPath: IndexPath) -> CGRect
public func indexPathsForSelectedRows() -> [IndexPath]
public func indexPathForRow(at position: CGPoint) -> IndexPath
```
#### Operation
Operate the view.
```swift
public func contentScale(_ scale: CGFloat)
public func reloadData()
public func invalidateContentSize()
public func invalidateLayout(horizontally: Bool = default)
public func deselectRow(at indexPath: IndexPath)
override open func setContentOffset(_ contentOffset: CGPoint, animated: Bool)
public func scrollToRow(at indexPath: IndexPath, at scrollPosition: GridViewScrollPosition = default, animated: Bool = default)
```
## LICENSE
Under the MIT license. See [LICENSE](./LICENSE) file for details.