S.S. Toolkit

What is S.S. Toolkit?

SSToolkit is a collection of well-documented iOS classes for making life easier by solving common problems all iOS developers face. Some really handy classes are SSCollectionView, SSGradientView, SSSwitch, and many more.

Download the source code. Read the documentations. See sample code.

Getting Started

SSToolkit aims to be as easy to use as possible. There are some limitations on distributing iOS libraries, so this is the simplest way to get started with SSToolkit. It's painless after this, promise.

Adding SSToolkit to Your Project

Get the Source Code

Run the following commands to download the source code:

$ mkdir -p Vendor/SSToolkit
$ curl -L http://github.com/samsoffes/sstoolkit/tarball/master | tar xz --strip 1 -C Vendor/SSToolkit

If you prefer, you can just download the code from Github and put in Vendor/SSToolkit (relative to your project root).

Get the Source Code

Run the following command to add the submodule. Be sure you have are you in the root of your git repository.

$ git submodule add git://github.com/samsoffes/sstoolkit.git Vendor/SSToolkit

Adding to Your Project

  1. In Finder, navigate to the Vendor/SSToolkit folder and drag the xcodeproj file into your Xcode project.

  2. In Finder, drag SSToolkit.bundle located in Vendor/SSToolkit/Resources into the Resources folder in your Xcode project.

  3. Select your main Xcode project from the sidebar in Xcode and then select the target you want to add SSToolkit to.

  4. Select the Build Phases tab.

  5. Under the Target Dependencies group, click the plus button, select SSToolkit from the menu, and choose Add.

  6. Under the Link Binary With Libraries group, click the plus button, select libSSToolkit.a from the menu, and choose Add. Be sure you have QuartzCore.framework and CoreGraphics.framework added to your project as well.

  7. Choose the Build Settings tab. Make sure All in the top left of the bar under the tabs.

  8. Add Vendor/SSToolkit to Header Search Path (do not click the Recursive checkbox).

  9. Add -all_load -ObjC to Other Linker Flags.

That's it. The annoying part is over. Now to the fun part.

Adding to Your Project

  1. In Finder, navigate to the Vendor/SSToolkit folder and drag the xcodeproj file into your Xcode project.

  2. In Finder, drag SSToolkit.bundle located in Vendor/SSToolkit/Resources into the Resources folder in your Xcode project.

  3. Select the SSToolkit Xcode project from the sidebar in Xcode. In the file browser on the right in Xcode, click the checkbox next to libSSToolkit.a. (If you don't see the file browser, hit Command-Shift-E to toggle it on.)

  4. Select your target from the sidebar and open Get Info (Command-I).

  5. Choose the General tab from the top.

  6. Under the Direct Dependencies area, click the plus button, select SSToolkit from the menu, and choose Add Target. Be sure you have QuartzCore.framework and CoreGraphics.framework added to your project as well.

  7. Choose the build tab from the top of the window. Make sure the configuration dropdown at the top is set to All Configurations.

  8. Add Vendor/SSToolkit to Header Search Path (do not click the Recursive checkbox).

  9. Add -all_load -ObjC to Other Linker Flags.

That's it. The annoying part is over. Now to the fun part.

Usage

To use SSToolkit, simply add the following line to your source file. I recommend adding this to your prefix to make things easy.

#import <SSToolkit/SSToolkit.h>

You can also import individual files instead of the whole framework (for faster compile times) by doing something like:

#import <SSToolkit/SSCollectionView.h>

If you are going to use SSToolkit's categories, you will need to import then separately (since some people might not want to use them). You import them like this:

#import <SSToolkit/SSCategories.h>
SSCatalog

Sample Code

SSCatalog is available on GitHub. It is a universal iPhone/iPad application to demonstrate the various features of SSToolkit.

Simply open the Xcode projectand build. There are demos for most of SSToolkit.

Thanks

Huge thanks to our contributors, Jake Marsh, and Mike Rundle. Thanks to Kyle Steed for the flying boat illustration.

If you're using this in your project, I'd love to hear about it! Send me an email and let me know which pieces you're using and such.

Other Libraries

Here are some of my other libraries. Some of these used to be part of SSToolkit.