Skip to content

Commit

Permalink
Expose new generic methods to constrain different types of attributes…
Browse files Browse the repository at this point in the history 
… across 2 views

- Adjust the enums of ALEdge, ALDimension, and ALAxis to be unique (and additionally to match up with their NSLayoutAttribute counterparts)
- Add new APIs that allow any combination of ALAttributes on 2 views to be constrained
- Organize the source a bit more
- Add a new example to the demo project that uses the new generic ALAttribute methods
- Bump version number to v1.1
  • Loading branch information
@smileyborg
smileyborg committed Dec 30, 2013
1 parent 7a3a658 commit 881bcb7
Show file tree
Hide file tree
Showing 4 changed files with 374 additions and 149 deletions.
63 changes: 39 additions & 24 deletions Example/Example/ALViewController.m
View file
Expand Up @@ -16,6 +16,7 @@ typedef NS_ENUM(NSInteger, ExampleConstraintDemo) {
ExampleConstraintDemo4,
ExampleConstraintDemo5,
ExampleConstraintDemo6,
ExampleConstraintDemo7,
ExampleConstraintDemoCount
};

Expand Down Expand Up @@ -225,15 +226,40 @@ - (void)setupDemo4
[self.orangeView autoPinEdgeToSuperviewEdge:ALEdgeBottom withInset:20.0f];
}

/**
Demonstrates:
- Everything from Demo 4, and...
- Using leading/trailing edge attributes instead of left/right
*/
- (void)setupDemo5
{
[self.redView autoSetDimension:ALDimensionHeight toSize:44.0f];
[self.blueView autoMatchDimension:ALDimensionHeight toDimension:ALDimensionHeight ofView:self.redView];

[self.redView autoPinEdgeToSuperviewEdge:ALEdgeLeading withInset:20.0f];
[self.redView autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:20.0f];

[self.blueView autoPinEdgeToSuperviewEdge:ALEdgeTrailing withInset:20.0f];
[self.blueView autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:20.0f];

[self.blueView autoPinEdge:ALEdgeLeading toEdge:ALEdgeTrailing ofView:self.redView withOffset:10.0f];
[self.blueView autoMatchDimension:ALDimensionWidth toDimension:ALDimensionWidth ofView:self.redView withMultiplier:3.0f];

[self.orangeView autoPinEdge:ALEdgeTop toEdge:ALEdgeBottom ofView:self.blueView withOffset:20.0f];
[self.orangeView autoPinEdge:ALEdgeLeading toEdge:ALEdgeLeading ofView:self.redView withOffset:20.0];
[self.orangeView autoPinEdge:ALEdgeTrailing toEdge:ALEdgeTrailing ofView:self.blueView withOffset:-10.0];
[self.orangeView autoPinEdgeToSuperviewEdge:ALEdgeBottom withInset:20.0f];
}

/**
Demonstrates:
- Looping over subviews to apply constraints between them
- Setting a priority less than required for specific constraints
- Specifying an inequality constraint that competes with the lower priority constraints
--> the orange view will maintain at least 10 points of spacing to the bottom of its superview (required constraint),
and this may require reducing its height (breaking the lower priority constraint)
--> the orange view will maintain at least 10 points of spacing to the bottom of its superview (required constraint),
and this may require reducing its height (breaking the lower priority constraint)
*/
- (void)setupDemo5
- (void)setupDemo6
{
[self.blueView autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:10.0f];
[self.blueView autoSetDimensionsToSize:CGSizeMake(25.0f, 10.0f)];
Expand Down Expand Up @@ -262,29 +288,15 @@ - (void)setupDemo5

/**
Demonstrates:
- Achieving a common layout scenario for content (e.g. an image view, title label, and body text)
- Matching the widths of two views using a multiplier
- Pinning views to each other and to the superview to maintain padding and insets
- Using leading/trailing constraints instead of left/right
- Applying a constraint across different types of attributes
*/
- (void)setupDemo6
- (void)setupDemo7
{
[self.redView autoSetDimension:ALDimensionHeight toSize:44.0f];
[self.blueView autoMatchDimension:ALDimensionHeight toDimension:ALDimensionHeight ofView:self.redView];

[self.redView autoPinEdgeToSuperviewEdge:ALEdgeLeading withInset:20.0f];
[self.redView autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:20.0f];

[self.blueView autoPinEdgeToSuperviewEdge:ALEdgeTrailing withInset:20.0f];
[self.blueView autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:20.0f];

[self.blueView autoPinEdge:ALEdgeLeading toEdge:ALEdgeTrailing ofView:self.redView withOffset:10.0f];
[self.blueView autoMatchDimension:ALDimensionWidth toDimension:ALDimensionWidth ofView:self.redView withMultiplier:3.0f];

[self.orangeView autoPinEdge:ALEdgeTop toEdge:ALEdgeBottom ofView:self.blueView withOffset:20.0f];
[self.orangeView autoPinEdge:ALEdgeLeading toEdge:ALEdgeLeading ofView:self.redView withOffset:20.0];
[self.orangeView autoPinEdge:ALEdgeTrailing toEdge:ALEdgeTrailing ofView:self.blueView withOffset:-10.0];
[self.orangeView autoPinEdgeToSuperviewEdge:ALEdgeBottom withInset:20.0f];
[self.redView autoCenterInSuperview];
[self.redView autoSetDimensionsToSize:CGSizeMake(100.0f, 250.0f)];

[self.orangeView autoSetDimensionsToSize:CGSizeMake(50.0f, 50.0f)];
[self.orangeView autoConstrainAttribute:ALAxisHorizontal toAttribute:ALEdgeTop ofView:self.redView];
}


Expand Down Expand Up @@ -328,6 +340,9 @@ - (void)setupConstraintsForCurrentDemo
case ExampleConstraintDemo6:
[self setupDemo6];
break;
case ExampleConstraintDemo7:
[self setupDemo7];
break;
default:
self.constraintDemo = ExampleConstraintDemoReset;
break;
Expand Down
9 changes: 4 additions & 5 deletions README.md
View file
Expand Up @@ -8,12 +8,11 @@ UIView+AutoLayout provides a developer-friendly interface for the vast majority
API Cheat Sheet
---------------

This is just a handy overview of the primary methods. Check out the [header file](https://github.com/smileyborg/UIView-AutoLayout/blob/master/Source/UIView%2BAutoLayout.h) for the full API and documentation.

*A couple notes:*
This is just a handy overview of the core API methods. Check out the [header file](https://github.com/smileyborg/UIView-AutoLayout/blob/master/Source/UIView%2BAutoLayout.h) for the full API and documentation. A couple notes:

* *All of the API methods begin with `auto...` for easy autocompletion!*
* *All methods that generate constraints also automatically add the constraint(s) to the correct view, then return the newly created constraint(s) for you to optionally store for later adjustment or removal.*
* *Many methods below also have a variant which includes a `relation:` parameter to make the constraint an inequality.

**UIView**

Expand All @@ -26,9 +25,9 @@ This is just a handy overview of the primary methods. Check out the [header file
* \- autoPinEdge(s)ToSuperviewEdge(s):withInset(s):
* \- autoPinEdge:toEdge:ofView:(withOffset:)
* \- autoAlignAxis:toSameAxisOfView:(withOffset:)
* \- autoMatchDimension:toDimension:ofView:(withOffset:)
* \- autoMatchDimension:toDimension:ofView:(withMultiplier:)
* \- autoMatchDimension:toDimension:ofView:(withOffset:)(withMultiplier:)
* \- autoSetDimension(s)ToSize:
* \- autoConstrainAttribute:toAttribute:ofView:(withOffset:)(withMultiplier:)
* \- autoPinToTopLayoutGuideOfViewController:withInset:
* \- autoPinToBottomLayoutGuideOfViewController:withInset:

Expand Down
103 changes: 73 additions & 30 deletions Source/UIView+AutoLayout.h
View file
@@ -1,6 +1,6 @@
//
// UIView+AutoLayout.h
// v1.0.0
// v1.1.0
// https://github.com/smileyborg/UIView-AutoLayout
//
// Copyright (c) 2012 Richard Turton
Expand Down Expand Up @@ -29,24 +29,26 @@

#import <UIKit/UIKit.h>

#pragma mark ALAttributes

typedef NS_ENUM(NSInteger, ALEdge) {
ALEdgeTop = 0, // the top edge of the view
ALEdgeLeft, // the left edge of the view
ALEdgeBottom, // the bottom edge of the view
ALEdgeRight, // the right edge of the view
ALEdgeLeading, // the leading edge of the view (left edge for left-to-right languages like English, right edge for right-to-left languages like Arabic)
ALEdgeTrailing // the trailing edge of the view (right edge for left-to-right languages like English, left edge for right-to-left languages like Arabic)
ALEdgeLeft = NSLayoutAttributeLeft, // the left edge of the view
ALEdgeRight = NSLayoutAttributeRight, // the right edge of the view
ALEdgeTop = NSLayoutAttributeTop, // the top edge of the view
ALEdgeBottom = NSLayoutAttributeBottom, // the bottom edge of the view
ALEdgeLeading = NSLayoutAttributeLeading, // the leading edge of the view (left edge for left-to-right languages like English, right edge for right-to-left languages like Arabic)
ALEdgeTrailing = NSLayoutAttributeTrailing // the trailing edge of the view (right edge for left-to-right languages like English, left edge for right-to-left languages like Arabic)
};

typedef NS_ENUM(NSInteger, ALAxis) {
ALAxisHorizontal = 0, // a horizontal line through the center of the view
ALAxisVertical, // a vertical line through the center of the view
ALAxisBaseline // a horizontal line at the text baseline (not applicable to all views)
typedef NS_ENUM(NSInteger, ALDimension) {
ALDimensionWidth = NSLayoutAttributeWidth, // the width of the view
ALDimensionHeight = NSLayoutAttributeHeight // the height of the view
};

typedef NS_ENUM(NSInteger, ALDimension) {
ALDimensionWidth = 0, // the width of the view
ALDimensionHeight // the height of the view
typedef NS_ENUM(NSInteger, ALAxis) {
ALAxisVertical = NSLayoutAttributeCenterX, // a vertical line through the center of the view
ALAxisHorizontal = NSLayoutAttributeCenterY, // a horizontal line through the center of the view
ALAxisBaseline = NSLayoutAttributeBaseline // a horizontal line at the text baseline (not applicable to all views)
};

typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UIView+AutoLayout category API
Expand All @@ -69,13 +71,15 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (instancetype)initForAutoLayout;


#pragma mark Auto Layout Convenience Methods
#pragma mark Set Constraint Priority

/** Sets the constraint priority to the given value for all constraints created using the UIView+AutoLayout category API within the given constraints block.
NOTE: This method will have no effect (and will NOT set the priority) on constraints created or added using the SDK directly within the block! */
+ (void)autoSetPriority:(UILayoutPriority)priority forConstraints:(ALConstraintsBlock)block;


#pragma mark Remove Constraints

/** Removes the given constraint from the view it has been added to. */
+ (void)autoRemoveConstraint:(NSLayoutConstraint *)constraint;

Expand Down Expand Up @@ -103,26 +107,16 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (void)autoRemoveConstraintsAffectingViewAndSubviewsIncludingImplicitConstraints:(BOOL)shouldRemoveImplicitConstraints;


#pragma mark Center in Superview

/** Centers the view in its superview. */
- (NSArray *)autoCenterInSuperview;

/** DEPRECATED, will be removed at some point in the future. Use -[autoAlignAxisToSuperviewAxis:] instead.
(This method has simply been renamed due to confusion. The replacement method works identically.)
Centers the view along the given axis (horizontal or vertical) within its superview. */
- (NSLayoutConstraint *)autoCenterInSuperviewAlongAxis:(ALAxis)axis __attribute__((deprecated));

/** Aligns the view to the same axis of its superview. */
- (NSLayoutConstraint *)autoAlignAxisToSuperviewAxis:(ALAxis)axis;


/** DEPRECATED, will be removed at some point in the future.
Pins the given center axis of the view to a fixed position (X or Y value, depending on axis) in the superview. */
- (NSLayoutConstraint *)autoPinCenterAxis:(ALAxis)axis toPositionInSuperview:(CGFloat)value __attribute__((deprecated));

/** DEPRECATED, will be removed at some point in the future. Use -[autoPinEdgeToSuperviewEdge:withInset:] instead.
Pins the given edge of the view to a fixed position (X or Y value, depending on edge) in the superview. */
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toPositionInSuperview:(CGFloat)value __attribute__((deprecated));

#pragma mark Pin Edges to Superview

/** Pins the given edge of the view to the same edge of the superview with an inset. */
- (NSLayoutConstraint *)autoPinEdgeToSuperviewEdge:(ALEdge)edge withInset:(CGFloat)inset;
Expand All @@ -134,6 +128,8 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (NSArray *)autoPinEdgesToSuperviewEdgesWithInsets:(UIEdgeInsets)insets;


#pragma mark Pin Edges

/** Pins an edge of the view to a given edge of another view. */
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toEdge:(ALEdge)toEdge ofView:(UIView *)peerView;

Expand All @@ -144,13 +140,17 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toEdge:(ALEdge)toEdge ofView:(UIView *)peerView withOffset:(CGFloat)offset relation:(NSLayoutRelation)relation;


#pragma mark Align Axes

/** Aligns an axis of the view to the same axis of another view. */
- (NSLayoutConstraint *)autoAlignAxis:(ALAxis)axis toSameAxisOfView:(UIView *)peerView;

/** Aligns an axis of the view to the same axis of another view with an offset. */
- (NSLayoutConstraint *)autoAlignAxis:(ALAxis)axis toSameAxisOfView:(UIView *)peerView withOffset:(CGFloat)offset;


#pragma mark Match Dimensions

/** Matches a dimension of the view to a given dimension of another view. */
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView;

Expand All @@ -167,6 +167,8 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier relation:(NSLayoutRelation)relation;


#pragma mark Set Dimensions

/** Sets the view to a specific size. */
- (NSArray *)autoSetDimensionsToSize:(CGSize)size;

Expand All @@ -177,12 +179,48 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (NSLayoutConstraint *)autoSetDimension:(ALDimension)dimension toSize:(CGFloat)size relation:(NSLayoutRelation)relation;


#pragma mark Constrain Any Attributes

/** Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view. */
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)attribute toAttribute:(NSInteger)toAttribute ofView:(UIView *)peerView;

/** Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with an offset. */
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)attribute toAttribute:(NSInteger)toAttribute ofView:(UIView *)peerView withOffset:(CGFloat)offset;

/** Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with an offset as a maximum or minimum. */
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)attribute toAttribute:(NSInteger)toAttribute ofView:(UIView *)peerView withOffset:(CGFloat)offset relation:(NSLayoutRelation)relation;

/** Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with a multiplier. */
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)attribute toAttribute:(NSInteger)toAttribute ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier;

/** Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with a multiplier as a maximum or minimum. */
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)attribute toAttribute:(NSInteger)toAttribute ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier relation:(NSLayoutRelation)relation;


#pragma mark Pin to Layout Guides

/** Pins the top edge of the view to the top layout guide of the given view controller with an inset. */
- (NSLayoutConstraint *)autoPinToTopLayoutGuideOfViewController:(UIViewController *)viewController withInset:(CGFloat)inset;

/** Pins the bottom edge of the view to the bottom layout guide of the given view controller with an inset. */
- (NSLayoutConstraint *)autoPinToBottomLayoutGuideOfViewController:(UIViewController *)viewController withInset:(CGFloat)inset;


#pragma mark Deprecated API Methods

/** DEPRECATED as of v1.1, will be removed at some point in the future. Use -[autoAlignAxisToSuperviewAxis:] instead.
(This method has simply been renamed due to confusion. The replacement method works identically.)
Centers the view along the given axis (horizontal or vertical) within its superview. */
- (NSLayoutConstraint *)autoCenterInSuperviewAlongAxis:(ALAxis)axis __attribute__((deprecated));

/** DEPRECATED as of v1.1, will be removed at some point in the future. Use -[autoConstrainAttribute:toAttribute:ofView:withOffset:] instead.
Pins the given center axis of the view to a fixed position (X or Y value, depending on axis) in the superview. */
- (NSLayoutConstraint *)autoPinCenterAxis:(ALAxis)axis toPositionInSuperview:(CGFloat)value __attribute__((deprecated));

/** DEPRECATED as of v1.1, will be removed at some point in the future. Use -[autoPinEdgeToSuperviewEdge:withInset:] instead.
Pins the given edge of the view to a fixed position (X or Y value, depending on edge) in the superview. */
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toPositionInSuperview:(CGFloat)value __attribute__((deprecated));

@end


Expand All @@ -193,6 +231,9 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
*/
@interface NSArray (AutoLayout)


#pragma mark Constrain Multiple Views

/** Aligns views in this array to one another along a given edge. */
- (NSArray *)autoAlignViewsToEdge:(ALEdge)edge;

Expand All @@ -206,10 +247,12 @@ typedef void(^ALConstraintsBlock)(void); // a block of method calls to the UI
- (NSArray *)autoSetViewsDimension:(ALDimension)dimension toSize:(CGFloat)size;


/** Distributes the views in this array equally along the selected axis. Views will be the same size (variable) in the dimension along the axis and will have spacing (fixed) between them. */
#pragma mark Distribute Multiple Views

/** Distributes the views in this array equally along the selected axis in their superview. Views will be the same size (variable) in the dimension along the axis and will have spacing (fixed) between them. */
- (NSArray *)autoDistributeViewsAlongAxis:(ALAxis)axis withFixedSpacing:(CGFloat)spacing alignment:(NSLayoutFormatOptions)alignment;

/** Distributes the views in this array equally along the selected axis. Views will be the same size (fixed) in the dimension along the axis and will have spacing (variable) between them. */
/** Distributes the views in this array equally along the selected axis in their superview. Views will be the same size (fixed) in the dimension along the axis and will have spacing (variable) between them. */
- (NSArray *)autoDistributeViewsAlongAxis:(ALAxis)axis withFixedSize:(CGFloat)size alignment:(NSLayoutFormatOptions)alignment;

@end
Expand Down

0 comments on commit 881bcb7

Please sign in to comment.