Skip to content
A drop-in replacement for iOS Settings Bundle "Settings.bundle".
Objective-C Ruby
Branch: master
Clone or download
Latest commit 1fd463a Aug 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Design Remove unused resources Mar 26, 2018
Example no more light fonts Aug 12, 2019
XUI fix data description Aug 18, 2019
.gitignore Remove Example Pod Caches Mar 26, 2018
.travis.yml use xcode 10 Aug 12, 2019
LICENSE Initial commit Oct 10, 2017
README.md Update README.md Apr 30, 2018
XUI.podspec Bump version Mar 26, 2018
_Pods.xcodeproj Initial commit Oct 10, 2017

README.md

XUI

CI Status Cocoapods

// XUI in a single line
[XUIListViewController presentFromTopViewControllerWithDictionary:@{  @"items": { @"default": @YES, @"label": @"Feature", @"cell": @"Switch", @"key": @"switch1" } }];

Make a configuration UITableView in 5 minutes? Let's do it!

XUI is a drop-in replacement for "Settings Application Schema" on iOS. It allows application to show preferences view controller by creating a simple configuration bundle (much like "Settings.bundle").

Features

  • Data Persistence (NSUserDefaults / Custom Adapters)
  • Localized Strings / Image Resources
  • Custom Cells (Runtime)
  • Notifications

Components

XUI provides more components than private framework "Preferences.framework":

  • Group
  • Link (Child Pane)
  • Switch
  • Button (Action)
  • TextField
  • Radio / Checkbox Group
  • Segment Group
  • Single Selection Option List
  • Multiple Selection Option List
  • Ordered Multiple Selection Option List
  • Slider
  • Stepper
  • DateTime Picker
  • TitleValue
  • StaticText
  • Textarea
  • Image
  • Editable List (Strings)

Usage

// to specify the path for Settings.bundle
NSString *bundlePath = [[NSBundle mainBundle] pathForResource:@"Settings" ofType:@"bundle"];

// to specify the root entry for that bundle
NSString *xuiPath = [[NSBundle bundleWithPath:bundlePath] pathForResource:@"Root" ofType:@"plist"];

// present or push it!
XUIListViewController *xuiController = [[XUIListViewController alloc] initWithPath:xuiPath withBundlePath:bundlePath];
XUINavigationController *navController = [[XUINavigationController alloc] initWithRootViewController:xuiController];
[self presentViewController:navController animated:YES completion:nil];
NSString *xuiPath = [[NSBundle bundleWithPath:bundlePath] pathForResource:@"Root" ofType:@"plist"];

// directly present XUI from the top most view controller
[XUIListViewController presentFromTopViewControllerWithPath:xuiPath];

Configurations

If the key defaults is not set, configuration will be saved to Standard User Defaults.

NSNumber *enabled = [[NSUserDefaults standardUserDefaults] objectForKey:@"enabled"];
[enabled boolValue];

Notification

XUINotificationEventValueChanged: Any

Theme

XUI Theme can be configured in theme dictionary.

Adapter

Create custom adapter to read the interface schema from any format you like: plist, json, or lua. Adapter also handles data persistence and notifications.

Logger

To know if there is any invalid in our interface schema...

Custom Cells

Inherit from XUIBaseCell then have fun with your own cells whether it is xib based layout or not. XUI will automatically load custom cells.

More Documentation

https://github.com/Lessica/XUI/wiki/

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Demo

Requirements

  • Xcode 7 or above
  • iOS 7 or above
  • Objective-C (ARC)
  • iPhone / iPad compatible.

Installation

XUI is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'XUI', :git => "https://github.com/Lessica/XUI.git"

Author

Lessica, i.82@me.com

License

XUI is available under the MIT license. See the LICENSE file for more info.

Related Projects

You can’t perform that action at this time.