lessica / xui Goto Github PK

A drop-in replacement for iOS Settings Bundle "Settings.bundle".

License: MIT License

Ruby 0.21% Objective-C 99.79%

xui's Introduction

XUI

// 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

(iOS 14+) Dynamic Fonts Support
(iOS 13+) SF Symbols Support
(iOS 13+) Dark Mode Support
Data Persistence (NSUserDefaults / Custom Adapters)
Localized Strings / Image Resources
Custom Cells (Runtime)
Notifications

Components

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

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.

Example

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

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, [email protected]

License

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

Related Projects

xui's People

Contributors

Stargazers

Watchers

Recommend Projects