Giter Club home page Giter Club logo

redactable-ios's Introduction

Redactable

Platforms Swift Package Manager CocoaPods Compatible Carthage Compatible

A convenient library to show a shimmer effect while loading data. Easily convert your current view with a slick skeleton loading animation just by wrapping your view and conforming to a protocol.

Redactable Example

Installation

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

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

dependencies: [
    .package(url: "https://github.com/JustinGuedes/redactable-ios.git", .upToNextMajor(from: "0.1.0"))
]

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Redactable into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'Redactable', '~> 0.1'

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate Redactable into your Xcode project using Carthage, specify it in your Cartfile:

github "JustinGuedes/redactable-ios" ~> 0.1

Usage

Firstly, ensure your data class/struct conforms to Redactable:

extension Object: Redactable {

  static var placeholder: Object {
    // Return a version of this object that has placeholder data
  }

}

Secondly, create a bindable loadable property which allows you to control the state of the loading view:

@Binding
var loadable: Loadable<[Object]> = .loading

NOTE: The possible values for loadable are: loading, loaded([Object]), error(Error).


Lastly, wrap your content in a LoadableView:

LoadableView($loadable) { (data: [Object]) in
  // Use data 
}

License

Redactable is released under the MIT license. See LICENSE for details.

redactable-ios's People

Contributors

justinguedes avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.