Swiftpack.co - Package - Juanpe/SkeletonView

codebeat badge Platforms CocoaPods Carthage SPM Twitter: @JuanpeCatalan
License

๐ŸŒŽ Translations:
๐Ÿ‡จ๐Ÿ‡ณ by @WhatsXie
๐Ÿ‡ง๐Ÿ‡ท by @brunomunizaf

Today almost all apps have async processes, such as Api requests, long running processes, etc. And while the processes are working, usually developers place a loading view to show users that something is going on.

SkeletonView has been conceived to address this need, an elegant way to show users that something is happening and also prepare them to which contents he is waiting.

Enjoy it! ๐Ÿ™‚

๐ŸŒŸ Features

  • [x] Easy to use
  • [x] All UIViews are skeletonables
  • [x] Fully customizable
  • [x] Universal (iPhone & iPad)
  • [x] Interface Builder friendly
  • [x] Simple Swift syntax
  • [x] Lightweight readable codebase

๐ŸŽฌ Guides

๐Ÿ“ฒ Installation

Using CocoaPods

Edit your Podfile and specify the dependency:

pod "SkeletonView"

Using Carthage

Edit your Cartfile and specify the dependency:

github "Juanpe/SkeletonView"

Using Swift Package Manager

Once you have your Swift package set up, adding SkeletonView as a dependency is as easy as adding it to the dependencies value of your Package.swift.

  dependencies: [
    .package(url: "https://github.com/Juanpe/SkeletonView.git", from: "1.6")
  ]

๐Ÿ’ How to use

Only 3 steps needed to use SkeletonView:

1. Import SkeletonView in proper place.

import SkeletonView

2. Now, set which views will be skeletonables. You achieve this in two ways:

Using code:

avatarImageView.isSkeletonable = true

Using IB/Storyboards:

3. Once you've set the views, you can show the skeleton. To do so, you have 4 choices:

(1) view.showSkeleton()                 // Solid
(2) view.showGradientSkeleton()         // Gradient
(3) view.showAnimatedSkeleton()         // Solid animated
(4) view.showAnimatedGradientSkeleton() // Gradient animated

Preview

Solid
Gradient
Solid Animated
Gradient Animated

IMPORTANT!

SkeletonView is recursive, so if you want show the skeleton in all skeletonable views, you only need to call the show method in the main container view. For example, with UIViewControllers

๐ŸŒฟ Collections

Now, SkeletonView is compatible with UITableView and UICollectionView.

UITableView

If you want to show the skeleton in a UITableView, you need to conform to SkeletonTableViewDataSource protocol.

public protocol SkeletonTableViewDataSource: UITableViewDataSource {
    func numSections(in collectionSkeletonView: UITableView) -> Int
    func collectionSkeletonView(_ skeletonView: UITableView, numberOfRowsInSection section: Int) -> Int
    func collectionSkeletonView(_ skeletonView: UITableView, cellIdentifierForRowAt indexPath: IndexPath) -> ReusableCellIdentifier
}

As you can see, this protocol inherits from UITableViewDataSource, so you can replace this protocol with the skeleton protocol.

This protocol has a default implementation:

func numSections(in collectionSkeletonView: UITableView) -> Int
// Default: 1
func collectionSkeletonView(_ skeletonView: UITableView, numberOfRowsInSection section: Int) -> Int
// Default:
// It calculates how many cells need to populate whole tableview

There is only one method you need to implement to let Skeleton know the cell identifier. This method doesn't have default implementation:

func collectionSkeletonView(_ skeletonView: UITableView, cellIdentifierForRowAt indexPath: IndexPath) -> ReusableCellIdentifier

Example

func collectionSkeletonView(_ skeletonView: UITableView, cellIdentifierForRowAt indexPath: IndexPath) -> ReusableCellIdentifier {
   return "CellIdentifier"
}

IMPORTANT! If you are using resizable cells (tableView.rowHeight = UITableViewAutomaticDimension ), it's mandatory define the estimatedRowHeight.

๐Ÿ‘ฉ๐Ÿผโ€๐Ÿซ How specify which elements are skeletonables?

Here is an illustration that shows how you should specify which elements are skeletonables when you are using an UITableView:

As you can see, we have to make skeletonable the tableview, the cell and the UI elements, but we don't need to set as skeletonable the contentView

UICollectionView

For UICollectionView, you need to conform to SkeletonCollectionViewDataSource protocol.

public protocol SkeletonCollectionViewDataSource: UICollectionViewDataSource {
    func numSections(in collectionSkeletonView: UICollectionView) -> Int
    func collectionSkeletonView(_ skeletonView: UICollectionView, numberOfItemsInSection section: Int) -> Int
    func collectionSkeletonView(_ skeletonView: UICollectionView, cellIdentifierForItemAt indexPath: IndexPath) -> ReusableCellIdentifier
}

The rest of the process is the same as UITableView

๐Ÿ“ฐ Multiline text

When using elements with text, SkeletonView draws lines to simulate text. Besides, you can decide how many lines you want. If numberOfLines is set to zero, it will calculate how many lines needed to populate the whole skeleton and it will be drawn. Instead, if you set it to one, two or any number greater than zero, it will only draw this number of lines.

๐ŸŽ› Customize

You can set some properties for multilines elements.

| Property | Values | Default | Preview | ------- | ------- |------- | ------- | Filling percent of the last line. | 0...100 | 70% | | Corner radius of lines. (NEW) | 0...10 | 0 |

To modify the percent or radius using code, set the properties:

descriptionTextView.lastLineFillPercent = 50
descriptionTextView.linesCornerRadius = 5

Or, if you prefer use IB/Storyboard:

๐ŸŽจ Custom colors

You can decide which color the skeleton is tinted with. You only need to pass as a parameter the color or gradient you want.

Using solid colors

view.showSkeleton(usingColor: UIColor.gray) // Solid
// or
view.showSkeleton(usingColor: UIColor(red: 25.0, green: 30.0, blue: 255.0, alpha: 1.0))

Using gradients

let gradient = SkeletonGradient(baseColor: UIColor.midnightBlue)
view.showGradientSkeleton(usingGradient: gradient) // Gradient

Besides, SkeletonView features 20 flat colors ๐Ÿค™๐Ÿผ

UIColor.turquoise, UIColor.greenSea, UIColor.sunFlower, UIColor.flatOrange ...

Image captured from website https://flatuicolors.com

๐Ÿฆ‹ Appearance

NEW The skeletons have a default appearance. So, when you don't specify the color, gradient or multilines properties, SkeletonView uses the default values.

Default values:

  • tintColor: UIColor
    • default: .clouds
  • gradient: SkeletonGradient
    • default: SkeletonGradient(baseColor: .clouds)
  • multilineHeight: CGFloat
    • default: 15
  • multilineSpacing: CGFloat
    • default: 10
  • multilineLastLineFillPercent: Int
    • default: 70
  • multilineCornerRadius: Int
    • default: 0

To get these default values you can use SkeletonAppearance.default. Using this property you can set the values as well:

SkeletonAppearance.default.multilineHeight = 20
SkeletonAppearance.default.tintColor = .green

๐Ÿค“ Custom animations

SkeletonView has two built-in animations, pulse for solid skeletons and sliding for gradients.

Besides, if you want to do your own skeleton animation, it's really easy.

Skeleton provides the showAnimatedSkeleton function which has a SkeletonLayerAnimation closure where you can define your custom animation.

public typealias SkeletonLayerAnimation = (CALayer) -> CAAnimation

You can call the function like this:

view.showAnimatedSkeleton { (layer) -> CAAnimation in
  let animation = CAAnimation()
  // Customize here your animation

  return animation
}

It's available SkeletonAnimationBuilder. It's a builder to make SkeletonLayerAnimation.

Today, you can create sliding animations for gradients, deciding the direction and setting the duration of the animation (default = 1.5s).

// func makeSlidingAnimation(withDirection direction: GradientDirection, duration: CFTimeInterval = 1.5) -> SkeletonLayerAnimation

let animation = SkeletonAnimationBuilder().makeSlidingAnimation(withDirection: .leftToRight)
view.showAnimatedGradientSkeleton(usingGradient: gradient, animation: animation)

GradientDirection is an enum, with this cases:

| Direction | Preview |------- | ------- | .leftRight | | .rightLeft | | .topBottom | | .bottomTop | | .topLeftBottomRight | | .bottomRightTopLeft |

๐Ÿ˜‰ TRICK! Exist another way to create sliding animations, just using this shortcut:

let animation = GradientDirection.leftToRight.slidingAnimation()

๐Ÿ‘จโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Hierarchy

Since SkeletonView is recursive, and we want skeleton to be very efficient, we want to stop recursion as soon as possible. For this reason, you must set the container view as Skeletonable, because Skeleton will stop looking for skeletonable subviews as soon as a view is not Skeletonable, breaking then the recursion.

Because an image is worth a thousand words:

รฌsSkeletonable= โ˜ ๏ธ

| Configuration | Result |------- | ------- | | | | | | | |

๐Ÿ”ฌ Debug

NEW In order to facilitate the debug tasks when something is not working fine. SkeletonView has some new tools.

First, UIView has available a new property with his skeleton info:

var skeletonDescription: String

The skeleton representation looks like this:

Besides, you can activate the new debug mode. You just add the environment variable SKELETON_DEBUG and activate it.

Then, when the skeleton appears, you can see the view hierarchy in the Xcode console.

Open to see an output example

๐Ÿ“š Documentation

Coming soon...๐Ÿ˜…

๐Ÿ“‹ Supported OS & SDK Versions

  • iOS 9.0+
  • tvOS 9.0+
  • Swift 4.2

๐Ÿ“ฌ Next steps

  • [x] Set the filling percent of the last line in multiline elements
  • [x] Add more gradient animations
  • [x] Supported resizable cells
  • [x] CollectionView compatible
  • [x] tvOS compatible
  • [x] Add recovery state
  • [x] Custom default appearance
  • [x] Debug mode
  • [ ] Custom collections compatible
  • [ ] Add animations when it shows/hides the skeletons
  • [ ] MacOS and WatchOS compatible

โค๏ธ Contributing

This is an open source project, so feel free to contribute. How?

  • Open an issue.
  • Send feedback via email.
  • Propose your own fixes, suggestions and open a pull request with the changes.

See all contributors

Project generated with SwiftPlate

๐Ÿ“ข Mentions

๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป Author

  • Juanpe Catalรกn alt text

Buy me a coffee

๐Ÿ‘ฎ๐Ÿป License

MIT License

Copyright (c) 2017 Juanpe Catalรกn

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Github

link
Stars: 7474
Help us keep the lights on

Dependencies

Used By

Total: 1

Releases

1.6 - Jun 4, 2019

New

  • Now, SkeletonView is Swift Package Manager compatible.

1.4.2 - Feb 26, 2019

Improvements

  • Code quality
  • User Bitrise
  • Some minor fixes

1.4.1 - Dec 11, 2018

1.4 - Aug 10, 2018

New

  • Create skeletonDescription print a skeleton representation of the view.
  • Create SKELETON_DEBUG environment variable, in order to print the view hierarchy when the skeleton appears.

Improvements

  • Add two new methods to SkeletonFlowDelegate protocol. Now you can know when the skeleton did show and when it did hide.
  • Recursive protocol

Bug fixes

  • Solved issue #86 (thanks @reececomo)

1.3 - Aug 2, 2018

New

  • Default values customizables. Now you can set the default values of Skeleton appearance.(thanks @reececomo)

Bug fixes

  • Solved issue #41. Now, Skeleton works if UICollectionView cell's Nib is registered in code. (thanks @kjoneandrei)