res

RESwitch

Open source alternative to UISwitch, customizable via UIAppearance protocol.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

78

Maintenance

Last Commit

8yrs ago

Contributors

2

Package

Dependencies

0

License

MIT

Categories

Readme

RESwitch

Open source alternative to UISwitch, customizable via UIAppearance protocol.

Screenshot of RESwitch

Requirements

  • Xcode 4.5 or higher
  • Apple LLVM compiler
  • iOS 5.0 or higher
  • ARC

Demo

Build and run the RESwitchExample project in Xcode to see RESwitch in action.

Installation

CocoaPods

The recommended approach for installating RESwitch is via the CocoaPods package manager, as it provides flexible dependency management and dead simple installation. For best results, it is recommended that you install via CocoaPods >= 0.15.2 using Git >= 1.8.0 installed via Homebrew.

Install CocoaPods if not already available:

$ [sudo] gem install cocoapods
$ pod setup

Change to the directory of your Xcode project:

$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile

Edit your Podfile and add RESwitch:

platform :ios, '5.0'
pod 'RESwitch', '~> 1.0.1'

Install into your Xcode project:

$ pod install

Open your project in Xcode from the .xcworkspace file (not the usual project file)

$ open MyProject.xcworkspace

Please note that if your installation fails, it may be because you are installing with a version of Git lower than CocoaPods is expecting. Please ensure that you are running Git >= 1.8.0 by executing git --version. You can get a full picture of the installation details by executing pod install --verbose.

Manual Install

All you need to do is drop RESwitch files into your project, and add #include "RESwitch.h" to the top of classes that will use it.

Example Usage

RESwitch *switchView = [[RESwitch alloc] initWithFrame:CGRectMake(30, 100, 76, 28)];
[switchView addTarget:self action:@selector(switchViewChanged:) forControlEvents:UIControlEventValueChanged];
[self.view addSubview:switchView];

// Now let's customize it
//
[switchView setBackgroundImage:[UIImage imageNamed:@"Switch_Background"]];
[switchView setKnobImage:[UIImage imageNamed:@"Switch_Knob"]];
[switchView setOverlayImage:nil];
[switchView setHighlightedKnobImage:nil];
[switchView setCornerRadius:0];
[switchView setKnobOffset:CGSizeMake(0, 0)];
[switchView setTextShadowOffset:CGSizeMake(0, 0)];
[switchView setFont:[UIFont boldSystemFontOfSize:14]];
[switchView setTextOffset:CGSizeMake(3, 2) forLabel:RESwitchLabelOff];
[switchView setTextColor:[UIColor blackColor] forLabel:RESwitchLabelOn];
[switchView setTextColor:[UIColor colorWithRed:143/255.0 green:19/255.0 blue:24/255.0 alpha:1] forLabel:RESwitchLabelOff];
switchView.layer.cornerRadius = 4;
switchView.layer.borderColor = [UIColor colorWithRed:224/255.0 green:36/255.0 blue:24/255.0 alpha:1].CGColor;
switchView.layer.borderWidth = 2;
switchView.layer.masksToBounds = YES;

Customization

You can customize the appearance of all switches using the appearance proxy ([RESwitch appearance]), or just of a single switch. Use the following properties and tasks to customize RESwitch:

@property (strong, nonatomic) UIImage *backgroundImage;
@property (strong, nonatomic) UIImage *overlayImage;
@property (strong, nonatomic) UIImage *knobImage;
@property (strong, nonatomic) UIImage *highlightedKnobImage;
@property (assign, readwrite, nonatomic) CGSize knobOffset;
@property (assign, readwrite, nonatomic) CGSize textShadowOffset;
@property (strong, nonatomic) UIFont *font;

- (CGFloat)cornerRadius;
- (void)setCornerRadius:(CGFloat)radius;
- (void)setTextOffset:(CGSize)offset forLabel:(RESwitchLabel)label;
- (void)setTextColor:(UIColor *)color forLabel:(RESwitchLabel)label;
- (void)setTextShadowColor:(UIColor *)color forLabel:(RESwitchLabel)label;
- (void)setTitle:(NSString *)title forLabel:(RESwitchLabel)label;

For example, this is how the default appearance of RESwitch is set:

[[RESwitch appearance] setBackgroundImage:[UIImage imageNamed:@"RESwitch.bundle/Background"]];
[[RESwitch appearance] setOverlayImage:[UIImage imageNamed:@"RESwitch.bundle/Overlay"]];
[[RESwitch appearance] setKnobImage:[UIImage imageNamed:@"RESwitch.bundle/Knob"]];
[[RESwitch appearance] setHighlightedKnobImage:[UIImage imageNamed:@"RESwitch.bundle/Knob_Highlighted"]];
[[RESwitch appearance] setKnobOffset:CGSizeMake(4, -3)];
[[RESwitch appearance] setCornerRadius:14];
[[RESwitch appearance] setFont:[UIFont boldSystemFontOfSize:17]];
[[RESwitch appearance] setTextOffset:CGSizeMake(0, 0) forLabel:RESwitchLabelOn];
[[RESwitch appearance] setTextOffset:CGSizeMake(0, 0) forLabel:RESwitchLabelOff];
[[RESwitch appearance] setTextShadowOffset:CGSizeMake(0, -1)];

Contact

Roman Efimov

License

RESwitch is available under the MIT license.

Copyright © 2013 Roman Efimov.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100