Close Menu

gvuserdefaults

Here is a guide to using GVUserDefaults in your iOS app. GVUserDefaults is a convenient library for managing user defaults in iOS applications. It provides an easy way to define and access user defaults through a clean and concise syntax.

Installation

To install GVUserDefaults, follow these steps:

  • Add the pod ‘GVUserDefaults’ to your Podfile
  • Run pod install in Terminal
  • Import GVUserDefaults.h in your AppDelegate file
  • And that’s it! You’re ready to use GVUserDefaults in your app.

Usage

To start using GVUserDefaults, follow these steps:

Define User Defaults Properties

The first step is to define your user defaults properties using a GVUserDefaults subclass. Create a new NSObject subclass, and name it something like “AppSettings”.

In AppSettings.h, define your properties using the GVDefineUserDefaults macro:

GV_DEFINE_USER_DEFAULTS(AppSettings)

After defining your properties, make sure to include the GVUserDefaultsDelegate protocol:

@interface AppSettings : NSObject <GVUserDefaultsDelegate>

// Define your properties here

@end

In the implementation file, import the GVUserDefaults.h file and implement the required protocol method:

#import "AppSettings.h"
#import "GVUserDefaults.h"

@implementation AppSettings

// Implement required protocol method
+ (NSDictionary *)setupDefaults {
    return @{
        // Set your default values here
    };
}

// Implement custom getter/setter methods if needed

@end

Accessing User Defaults

Once you have defined your user defaults properties, you can access them using the convenient dot notation.

// Get the value for a key
NSUInteger fontSize = [AppSettings sharedInstance].fontSize;

// Set the value for a key
[AppSettings sharedInstance].isAutoSaveEnabled = YES;

You can also use the square bracket syntax:

// Get the value for a key
NSUInteger fontSize = [[AppSettings sharedInstance] fontSize];

// Set the value for a key
[[AppSettings sharedInstance] setIsAutoSaveEnabled:YES];

Advanced Usage

GVUserDefaults provides several advanced features for managing user defaults:

Custom Getter/Setter Methods

If you need custom getter/setter methods for your properties, you can implement them in your GVUserDefaults subclass.

// Implement custom getter
- (NSUInteger)fontSize {
    // Custom logic here
    return [self integerForKey:@"fontSize"];
}

// Implement custom setter
- (void)setFontSize:(NSUInteger)fontSize {
    // Custom logic here
    [self setInteger:fontSize forKey:@"fontSize"];
}

Registering External Defaults

If you have external defaults that you want to register, you can define them in your GVUserDefaults subclass.

// Register external defaults
+ (NSDictionary *)setupDefaults {
    NSString *path = [[NSBundle mainBundle] pathForResource:@"ExternalDefaults" ofType:@"plist"];
    NSDictionary *externalDefaults = [NSDictionary dictionaryWithContentsOfFile:path];
    return externalDefaults;
}

Make sure to create a plist file with your external defaults. The plist file should be named “ExternalDefaults.plist” and should be added to your app’s bundle.

Master Key

If you have multiple GVUserDefaults subclasses and want to share the defaults across all of them, you can use a master key.

In your app delegate, call the following method:

[GVUserDefaults setupDefaultsWithSuiteName:@"com.yourcompany.appName"];

Conclusion

GVUserDefaults is a powerful library for managing user defaults in your iOS app. It provides an easy way to define and access user defaults with a clean syntax, and also offers advanced features for customizing defaults behavior. Now that you know how to use GVUserDefaults, you can start improving your app’s user preferences management.