Latest 1.0.2
Homepage https://github.com/tristanseifert/TSAppKit
License BSD
Platforms osx 10.9, requires ARC
Authors

TSAppKit serves as a supplement to Apple’s AppKit framework, providing several commonly-used functionalities, controls, and behaviours. This encourages code re-use, and saves time by having code only be implemented in one single place.

How do I use it?

CocoaPods

TSAppKit is available as a CocoaPod. Simply add the following to your podfile:

pod 'TSAppKit'

This will use the master branch, but I do my best to make this branch the most stable—I use it in several production apps myself.

Manually

Download the repository, or add it as a subrepository in your local project, and drag TSAppKit.xcodeproj into your existing project.

Then, under "Target Dependencies," select the TSAppKit framework. Add TSAppKit.framework to "Linked Frameworks," and add a "Copy Files" step, with the destination set to "Frameworks," to copy TSAppKit.framework.

Demo

Want to try out TSAppKit for yourself? Check out the demo app.

Included Goodies

Preferences Window

Provides a Mac OS X standard preferences window, implementing all the subtle behaviours users expect.

Screenshot of Prefs Window

Information about each individual panel is read from a plist within the main bundle’s Resources folder. This file should be named TSPreferencesPanels.plist and contain an array of dictionaries under the key panels.

Each of these dictionaries describes a preference panel—the first entry in the array describing the leftmost icon in the window.

Keys parsed by the preferences controller are:

  • title: String displayed in the bar at the top of the window, and the window title when the panel is selected. (Required)
  • icon: Name of an image to display above the text string in the window’s tab bar. This is passed straight to NSImage imageNamed: so a system image, such as NSImageNamePreferencesAdvanced can be used. If omitted, NSImageNamePreferencesGeneral is used.
  • class: Class name of an NSViewController instance that controls the logic and UI for a specific preference pane. This controller should implement init to either load the required NIB, or build the UI programmatically.
  • identifier: A unique identifier that is saved by the preferences controller to restore the panel that was selected last.
  • description: An optional description for the preference pane.

Additionally, the root dictionary has some configuration variables as well:

  • saveState: When set to YES, the selected panel is stored in NSUserDefaults and restored next time the controller is instantiated.

Panels’ views may be of differing sizes, both in the X and Y directions: the controller automatically adjusts the window’s size to account for this. However, it is standard practice to maintain a constant width, and change only the height.

TSMouseTrackingView

A custon NSView subclass that sets up a tracking rectangle for its bounds, and issues notifications when the mouse enters or leaves its bounds, as well for mouse down and mouse up events.

TSCoreData

Provides a basic CoreData stack. Exposes the managed object context, persistend store coordinator, and managed object model as properties.

To use, create an object model called "TSCoreData" and include it as part of the application’s bundle resources.

License

See LICENSE.md for licensing information. If you use this library, just add a little line somewhere that you found this helpful. A link would be nice, but it’s not required—just don’t go claiming it as your own work!

Latest podspec

{
    "name": "TSAppKit",
    "version": "1.0.2",
    "summary": "Useful classes for Mac application development.",
    "description": "                   Provides various classes and UI controls that are commonly used in apps on the Mac, including preferences windows.n",
    "homepage": "https://github.com/tristanseifert/TSAppKit",
    "license": "BSD",
    "authors": {
        "Tristan Seifert": "[email protected]"
    },
    "social_media_url": "http://twitter.com/tristanseifert",
    "platforms": {
        "osx": "10.9"
    },
    "source": {
        "git": "https://github.com/tristanseifert/TSAppKit.git",
        "tag": "1.0.2"
    },
    "source_files": [
        "Classes",
        "Classes/**/*.{h,m}"
    ],
    "exclude_files": "Classes/Exclude",
    "resources": "Resources/*",
    "requires_arc": true
}

Pin It on Pinterest

Share This