Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WizelineLabs/WLEmptyState
WLEmptyState is an iOS based component that lets you customize the view when the dataset of a UITableView or a UICollectionView is empty. We created a sample project with the WLEmptyState component to show how you can use it.
https://github.com/WizelineLabs/WLEmptyState
empty-state emptydataset ios placeholder uicollectionview uikit uitableview
Last synced: 25 days ago
JSON representation
WLEmptyState is an iOS based component that lets you customize the view when the dataset of a UITableView or a UICollectionView is empty. We created a sample project with the WLEmptyState component to show how you can use it.
- Host: GitHub
- URL: https://github.com/WizelineLabs/WLEmptyState
- Owner: WizelineLabs
- License: mit
- Created: 2018-12-10T18:46:16.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-22T03:07:15.000Z (about 2 years ago)
- Last Synced: 2024-04-13T23:14:51.478Z (5 months ago)
- Topics: empty-state, emptydataset, ios, placeholder, uicollectionview, uikit, uitableview
- Language: Swift
- Homepage: https://cocoapods.org/pods/WLEmptyState
- Size: 871 KB
- Stars: 316
- Watchers: 23
- Forks: 26
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ios - WLEmptyState - A component that lets you customize the view when the dataset of UITableView is empty. (UI / Table View / Collection View)
README
[](https://cocoapods.org/pods/WLEmptyState)
[](https://github.com/Carthage/Carthage)
[](http://twitter.com/thewizeline)
[](http://opensource.org/licenses/MIT)
## Table of Content
- [Overview](#overview)
- [Running an Example Project](#running-an-example-project)
- [Installing WLEmptyState](#installing-wlemptystate)
- [Configuring WLEmptyState](#configuring-wlemptystate)
- [Using WLEmptyState](#using-wlemptystate)
- [Customizing WLEmptyState](#customizing-wlemptystate)
- [Contributing to WLEmptyState](#contributing-to-wlemptystate)
- [Author](#author)
- [License](#license)
## Overview
WLEmptyState is an iOS based component that lets you customize the message when the dataset of `UITableView` or `UICollectionView` is empty. We created a sample project with the WLEmptyState component to show how you can use it.
## Running an Example Project
To run the `Example` project:
1. Clone the repo with the following command:
`git clone [email protected]:wizeline/WLEmptyState.git`
2. Move to the `Example` directory and run the following command:
`pod install`
### Installing WLEmptyState
#### CocoaPods
WLEmptyState is available through [CocoaPods](https://cocoapods.org). To install it, add the following command to your Podfile:
```ruby
pod 'WLEmptyState'
```
#### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate WLEmptyState into your Xcode project using Carthage, specify it in your Cartfile:
```ruby
github "wizeline/WLEmptyState"
```
### Configuring WLEmptyState
The WLEmptyState component uses [Method Swizzling](https://nshipster.com/method-swizzling/). Therefore, to configure `WLEmptyState`, follow these steps:
1. Import the module in the `AppDelegate` class by adding `import WLEmptyState`.
2. Call the static method `configure()` on `application(_ application:, didFinishLaunchingWithOptions:)` method.
Your `AppDelegate` class should look like this:
```Swift
import WLEmptyState
...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
WLEmptyState.configure()
return true
}
```
### Using WLEmptyState
Once you have configured `WLEmptyState`, you can use it for your `UITableViewController` or `UICollectionViewController`. You need to conform the `WLEmptyStateDataSource` protocol. For example,
```Swift
class YourTableViewController: UITableViewController, WLEmptyStateDataSource {
override func viewDidLoad() {
super.viewDidLoad()
tableView.emptyStateDataSource = self
}
}
```
After you run your project with an empty dataset for your entity, you'll be able to see a default `WLEmptyState` view.
**Default Image**
## Customizing Default WLEmptyState
If you want to customize the text, description, or image, of the default component you need to implement the `WLEmptyStateDataSource` function. You can find the code for customization in the following list:
- Customize Image
```Swift
func imageForEmptyDataSet() -> UIImage? {
return UIImage(named: "bubble_icon")
}
```
- Customize Title
```Swift
func titleForEmptyDataSet() -> NSAttributedString {
let title = NSAttributedString(string: "No messages", attributes: [NSAttributedString.Key.font: UIFont.preferredFont(forTextStyle: .headline)])
return title
}
```
- Customize Description
```Swift
func descriptionForEmptyDataSet() -> NSAttributedString {
let title = NSAttributedString(string: "There's no messages to show.", attributes: [NSAttributedString.Key.font: UIFont.preferredFont(forTextStyle: .caption1)])
return title
}
```
**Customized Image**
## Creating your own EmptyState
Using `customViewForEmptyState()` allows you to provide your own implementation for Empty State.
```Swift
func customViewForEmptyState() -> UIView? {
let activityIndicatorView = UIActivityIndicatorView()
activityIndicatorView.startAnimating()
activityIndicatorView.color = .purple
return activityIndicatorView
}
```
## Disable scroll
You can disable the scroll when the Empty State is showing. You only need to conform the `WLEmptyStateDelegate` protocol and return `false` in the `enableScrollForEmptyState()` function:
```Swift
// Conform the WLEmptyStateDelegate protocol
class YourTableViewController: UITableViewController, WLEmptyStateDataSource, WLEmptyStateDelegate {
override func viewDidLoad() {
super.viewDidLoad()
tableView.emptyStateDataSource = self
tableView.emptyStateDelegate = self // Set your delegate
}
func enableScrollForEmptyState() -> Bool {
// To enable/disable the scroll return true or false
return false
}
}
```
## Contributing to WLEmptyState
We actively welcome your pull requests. We are trying to make contributions to this project as transparent and accessible as possible, please read our [Contributing guidelines](contributing.md) and follow the [Code of conduct](CODE_OF_CONDUCT.md).
If you face any problem with the code, please open an issue on GitHub.
List of [Contributors](https://github.com/wizeline/WLEmptyState/graphs/contributors). ⭐️
## License
WLEmptyState is available under the MIT license. See the LICENSE file for more info.