Swiftpack.co - Package - yannickl/Petal

Petal ❀

Supported Platforms Version Carthage compatible Build Status codecov.io codebeat badge

Petal

Petal is a beautiful activity indicator to show that a task is in progress.

RequirementsUsageInstallationContributionContactLicense

Requirements

  • iOS 8.0+ / Mac OS X 10.9+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 9.0+
  • Swift 4.0+

Usage

At first, import Petal library:

import Petal

Then just create your Petal:

let petal   = Petal()
petal.frame = CGRect(x: 0, y: 0, width: 200, height: 200)

view.addSubview(petal)

To update the petal number, the color of each one and the rotation duration use these properties:

petal.petalCount       = 9
petal.colors           = [.red, .blue, .green]
petal.rotationDuration = 12

Like with an activity indicator you can update its behavior when it's stopped:

petal.hidesWhenStopped = true

Have fun! :)

For more information...

To go further, take a look at the documentation and the example project.

Installation

CocoaPods

Install CocoaPods if not already available:

$ [sudo] gem install cocoapods
$ pod setup

Go to the directory of your Xcode project, and Create and Edit your Podfile and add Petal:

$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

use_frameworks!
pod 'Petal', '~> 3'

Install into your project:

$ pod install

Open your project in Xcode from the .xcworkspace file (not the usual project file):

$ open MyProject.xcworkspace

You can now import Petal framework into your files.

Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Petal into your Xcode project using Carthage, specify it in your Cartfile file:

github "yannickl/Petal" >= 3.0.0

Swift Package Manager

You can use The Swift Package Manager to install Petal by adding the proper description to your Package.swift file:

import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    dependencies: [
        .Package(url: "https://github.com/yannickl/Petal.git", versions: 3 ..< Version.max)
    ]
)

Note that the Swift Package Manager is still in early design and development, for more information checkout its GitHub Page.

Manually

Download the project and copy the Source folder into your project to use it in.

Contribution

Contributions are welcomed and encouraged .

Contact

Yannick Loriot

License (MIT)

Petal is available under the MIT license.

Copyright (c) 2016-present Yannick Loriot

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: 63
Help us keep the lights on

Dependencies

Used By

Total: 0