HGPlaceholders
  • October 15, 2023

Example


To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements


  • iOS 8.0+
  • Xcode 9.2

Installation


HGPlaceholders is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod ‘HGPlaceholders’

HGPlaceholders is also available through Carthage. To install it, simply add the following line to your Cartfile:

github “HamzaGhazouani/HGPlaceholders”

Usage


  1. Inherit your UITableView class from TableView Or inherit UICollectionView from CollectionView
  2. Call the placeholder to show
  • tableView.showLoadingPlaceholder() or collectionView.showLoadingPlaceholder()
  • tableView.showNoResultsPlaceholder() or collectionView.showNoResultsPlaceholder()
  • tableView.showErrorPlaceholder() or collectionView.showErrorPlaceholder()
  • tableView.showNoConnectionPlaceholder() or collectionView.showNoConnectionPlaceholder()

Customization


If you want to change only images, just set them in your asset with this names (the framework check firstly in the main bundle):

  • loading : “hg_default-loading”
  • no_connection : “hg_default-no_connection”
  • no_results : “hg_default-no_results”
  • error : “hg_default-error”

The framework contains different defaults placeholders:

  • Basic :

tableView.placeholdersProvider = .basic or collectionView.placeholdersProvider = .basic

  • Default :

tableView.placeholdersProvider = .default or collectionView.placeholdersProvider = .default

  • Default2 :

tableView.placeholdersProvider = .default2 or collectionView.placeholdersProvider = .default2

  • Hallowen :

tableView.placeholdersProvider = .halloween or collectionView.placeholdersProvider = .halloween // for fun :)`

If you want to change the default palceholders for all table views in your project:

class ProjectNameTableView: TableView {

override func customSetup() {
placeholdersProvider = .basic
}
}

class ProjectNameCollectionView: CollectionView {

override func customSetup() {
placeholdersProvider = .basic
}
}

You can also add new placeholders fully customizable, you should keep in mind that the view will take table view frame, and placeholder can have only one action, please check the example project

Creating a new theme from scratch

static var summer: PlaceholdersProvider {

var commonStyle = PlaceholderStyle()
commonStyle.backgroundColor = UIColor(red: 1.0, green: 236.0/255, blue: 209.0/255.0, alpha: 1.0)
commonStyle.actionBackgroundColor = .black
commonStyle.actionTitleColor = .white
commonStyle.titleColor = .black
commonStyle.isAnimated = false

commonStyle.titleFont = UIFont(name: “AvenirNextCondensed-HeavyItalic”, size: 19)!
commonStyle.subtitleFont = UIFont(name: “AvenirNextCondensed-Italic”, size: 19)!
commonStyle.actionTitleFont = UIFont(name: “AvenirNextCondensed-Heavy”, size: 19)!

var loadingStyle = commonStyle
loadingStyle.actionBackgroundColor = .clear
loadingStyle.actionTitleColor = .gray

var loadingData: PlaceholderData = .loading
loadingData.image = #imageLiteral(resourceName: “summer-hat”)
let loading = Placeholder(data: loadingData, style: loadingStyle, key: .loadingKey)

var errorData: PlaceholderData = .error
errorData.image = #imageLiteral(resourceName: “summer-ball”)
let error = Placeholder(data: errorData, style: commonStyle, key: .errorKey)

var noResultsData: PlaceholderData = .noResults
noResultsData.image = #imageLiteral(resourceName: “summer-cocktail”)
let noResults = Placeholder(data: noResultsData, style: commonStyle, key: .noResultsKey)

var noConnectionData: PlaceholderData = .noConnection
noConnectionData.image = #imageLiteral(resourceName: “summer-beach-slippers”)
let noConnection = Placeholder(data: noConnectionData, style: commonStyle, key: .noConnectionKey)

let placeholdersProvider = PlaceholdersProvider(loading: loading, error: error, noResults: noResults, noConnection: noConnection)

let xibPlaceholder = Placeholder(cellIdentifier: “CustomPlaceholderCell”, key: PlaceholderKey.custom(key: “XIB”))

placeholdersProvider.add(placeholders: xibPlaceholder)

return placeholdersProvider
}

Adding a custom placeholder to an existing theme

private static var starWarsPlaceholder: Placeholder {
var starwarsStyle = PlaceholderStyle()
starwarsStyle.backgroundColor = .black
starwarsStyle.actionBackgroundColor = .clear
starwarsStyle.actionTitleColor = .white
starwarsStyle.titleColor = .white
starwarsStyle.isAnimated = false

var starwarsData = PlaceholderData()
starwarsData.title = NSLocalizedString(“\”This is a new day, a\nnew beginning\””, comment: “”)
starwarsData.subtitle = NSLocalizedString(“Star Wars”, comment: “”)
starwarsData.image = #imageLiteral(resourceName: “star_wars”)
starwarsData.action = NSLocalizedString(“OK!”, comment: “”)

let placeholder = Placeholder(data: starwarsData, style: starwarsStyle, key: PlaceholderKey.custom(key: “starWars”))

return placeholder
}

let provider = PlaceholdersProvider.summer
provider.addPlaceholders(MyUtilityClass.starWarsPlaceholder)

Documentation


Full documentation is available on CocoaDocs.
You can also install documentation locally using jazzy.

GitHub


View Github

#autolayout #cocoa #cocoapod #cocoapods #cocoatouch #collection #collectionkit #collectionview #collectionviewcell #collectionviewlayout #customlayout #dynamic #empty #emptystate #expandabletableview #flowlayout #hashtag #hashtags #ibinspectable #instagram #instagramanimation #ios #iosanimation #iosdevelopment #iossdk #iosswift #iosthirdparty #lightboxalgorithm #loading #objectivec #placeholder #statemanagement #swift #swiftanimation #swiftcollection #swiftimage #swiftlibrary #swiftpackagemanager #swiftui #swiftuicomponents #table #tableview #tableviewcell #taglistview #tags #tagsview #uicollectionview #uicollectionviewanimation #uicollectionviewcell #uicollectionviewflowlayout #uicollectionviewlayout #uitableview #uitableviewcell #uitableviewcocoapods #uitableviewcontroller #xcode
YOU MIGHT ALSO LIKE...
CameraBackground

Features Both front and back camera supported. Flash modes: auto, on, off. Countdown timer. Tap to focus. Pinch to zoom. Usage  

DKCamera

Description A light weight & simple & easy camera for iOS by Swift. It uses CoreMotion framework to detect device orientation, so ...

HorizonSDK-iOS

Horizon SDK is a state of the art real-time video recording / photo shooting iOS library. Some of the features ...

LLSimpleCamera

LLSimpleCamera: A simple customizable camera - video recorder control LLSimpleCamera is a library for creating a customized camera - video ...

RSBarcodes_Swift

RSBarcodes allows you to read 1D and 2D barcodes using the metadata scanning capabilities introduced with iOS 7 and generate ...