Skip to content

neobeppe/Squircle

Repository files navigation

Squircle

Build Status Version License Platform Coverage Status

Example

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

Installation

Swift Package Manager

Squircle is available through SPM. To install it, simply add the URL in Xcode: https://github.com/neobeppe/Squircle

Cocoapods

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

pod 'Squircle'

Usage

Squircle

Squircle is an UIView extension, and can be used in different ways:

let view = UIView()
view.squircle()

Just apply conventional squircle radius to the view. If the view is a square, i'll obtain the same effect as iOS springboard icons, if it's a rectangle i'll obtain rounded corners based on a square built on smallest side.

Squircle is also an CALayer extension, permitting you to add a squircle mask directly on a layer. Rules are the same as the UIView methods, invocation is:

let layer = CALayer()
layer.applySquircle()

Squircle with border

If you want to apply squircle with a border use the dedicated methods:

let view = UIView()
view.squircleWithBorder(width: CGFloat, color: UIColor)
let layer = CALayer()
layer.applySquircleWithBorder(width: CGFloat, color: UIColor)

Remove squircle

To remove the squircle from a UIView:

view.removeSquircle()

or directly on CALayer:

layer.removeSquircle()

If a border has been added to the squircle, both functions above will remove it too.

Remove border

To remove only the border from a squircle:

view.removeSquircleBorder()

or directly on CALayer:

layer.removeSquircleBorder()

License

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