liTao-leven / BFKit-Swift

BFKit-Swift is a collection of useful classes, structs and extensions to develop Apps faster.

---

Objective-C Version • What does it do • Compatibility • Requirements • Communication • Contributing • Installing and Usage • Documentation • Changelog • Example • Todo • Author • License

---

Objective-C Version

If you are looking for Objective-C version check it out here: BFKit.

What does it do

BFKit-Swift is a collection of useful classes, structs and extensions to develop Apps faster.
For example you can use every iOS fonts with just an enum!
It also adds some useful functions with BF classes and extends some Foundation and UIKit classes.

Compatibility

BFKit

	iOS	Linux
BFApp	✔️	✔️
BFButton	✔️
BFDataStructures (List - Queue - Stack)	✔️	✔️
BFLog	✔️	✔️
BFPassword	✔️	✔️
BFSystemSound	✔️
BFTextField	✔️
BFTouchID	✔️

Foundation

	iOS	Linux
Array	✔️	✔️
Collection	✔️	✔️
Data	✔️	✔️
Date	✔️	✔️
FileManager	✔️
Number	✔️	✔️
NSObject	✔️	✔️
ProcessInfo	✔️	✔️
String	✔️	✔️
Thread	✔️	✔️

UIKit

	iOS	Linux
UIBarButtonItem	✔️
UIButton	✔️
UIColor	✔️
UIDevice	✔️
UIFont	✔️
UIImage	✔️
UIImageView	✔️
UILabel	✔️
UINavigationBar	✔️
UIPasteboard	✔️
UIScreen	✔️
UIScrollView	✔️
UITableView	✔️
UITextField	✔️
UITextView	✔️
UIToolbar	✔️
UIView	✔️
UIViewController	✔️
UIWebView	✔️
UIWindow	✔️

Requirements

Swift	Xcode	BFKit	iOS	Linux
1.2	6.3	1.0.0...1.4.1	7.0+
2.0...2.1	7.0	1.5.0...1.6.2	7.0+
2.2	7.3	1.6.3...1.7.0	7.0+
2.3	8.0	1.8.0	7.0+
3.0	8.0...8.1	2.0.0...2.0.2	8.0+	✔️

Communication

• If you need help, use Stack Overflow.
• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, see Contributing section.

Contributing

See CONTRIBUTING.md file.

Installing and Usage

See Requirements section to check Swift, Xcode, BFKit Swift and OS versions.

Manual

• Open the BFKit folder and build the Framework from the project
• Import BFKit.framework into your project
• Import the framework with import BFKit
• Enjoy!

CocoaPods

• Create a Podfile in your project directory

• Write:

      platform :ios, '8.0'
      xcodeproj 'Project.xcodeproj'
      use_frameworks!
  
      pod 'BFKit-Swift'

• Change "Project" with your real project name

• Open Terminal, go to project directory and type: pod install

• Import the framework with import BFKit

• Enjoy!

Carthage

• Create a Cartfile in your project directory

• Write:

      github "FabrizioBrancati/BFKit-Swift"

• Open Terminal, go to project directory and type: carthage update

• Include the created Framework in your project

• Add Build Phase with the following contents:

      /usr/local/bin/carthage copy-frameworks

  and add the paths to the BFKit Swift framework under Input Files

      $(SRCROOT)/Carthage/Build/iOS/BFKit.framework

  This script works around an App Store submission bug triggered by universal binaries and ensures that necessary bitcode-related files are copied when archiving

• Import the framework with import BFKit

• Enjoy!

Swift Package Manager (Linux)

• Create a Package.swift file in your project directory

• Write:

  import PackageDescription
  
  let package = Package(
      name: "Project",
      dependencies: [
          .Package(url: "https://github.com/FabrizioBrancati/BFKit-Swift.git", majorVersion: 2)
      ]
  )

• Change "Project" with your real project name

• Open Terminal, go to project directory and type: swift build

• Import the framework with import BFKit

• Enjoy!

Documentation

CocoaDocs

100% Documented

Changelog

To see what has changed in recent version of BFKit Swift, see the CHANGELOG.md file.

Example

Open and run the BFKitExample project in Example folder in this repo, with Xcode and see BFKit Swift in action!

Todo

• Add macOS, watchOS and tvOS support
• Create a new Example App that shows all the functionalities of BFKit Swift
• 100% of code coverage with Unit Tests
• Create Unit Tests and add Codecov badge
• Add Linux support (Foundation extensions only)
• Add Carthage support
• Add to CocoaPods
• Create a great documentation

Author

Fabrizio Brancati

Website: https://www.fabriziobrancati.com
Email: [e-mail]

License

BFKit-Swift is available under the MIT license. See the LICENSE file for more info.