Skip to content
Beautiful flag icons for usage in apps and on the web.
Swift Objective-C Ruby
Branch: master
Clone or download
Latest commit fd87cc8 Mar 26, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Assets Adding flags for St Martin and St Helena Aug 22, 2017
Sources/Swift Version bump to 2.2 Mar 26, 2019
.gitignore Initial commit Aug 19, 2015
.travis.yml Migrate to Swift 5 (#68) Mar 26, 2019
FlagKit.podspec Version bump to 2.2 Mar 26, 2019
Header.png Updating README Aug 9, 2017
LICENSE Update LICENSE Apr 22, 2016
README.md Updating README Aug 9, 2017

README.md

Header

FlagKit

Beautiful flag icons for usage in apps and on the web. All flags are provided as stand-alone PNG and SVG files. FlagKit also provides an Asset Catalog and framework for easy use on Apple platforms.

Installation (iOS, macOS, tvOS)

FlagKit provides a framework for easy installation as a dependency. You can also manually copy the Asset Catalog into your project.

Carthage

Add the following line to your Cartfile:

github "madebybowtie/FlagKit"

CocoaPods

Add the following line to your Podfile:

pod 'FlagKit'

Manual

Add Assets/FlagKit.xcassets to your target.

Usage (iOS, macOS, tvOS)

FlagKit provides both rectangular unstyled flags and styled flags in a variety of shapes. Our sample project demonstrates how to display flags and customize them into different shapes (rounded corners, square, circle).

Note: Styling is currently not supported by FlagKit on macOS

This brief example loads the flag for the users current locale, and retrieves the unstyled flag and a styled flag:

let countryCode = Locale.current.regionCode!
let flag = Flag(countryCode: countryCode)!

// Retrieve the unstyled image for customized use
let originalImage = flag.originalImage

// Or retrieve a styled flag
let styledImage = flag.image(style: .circle)

You can always access the underlying assets directly, through the bundled Asset Catalog:

let countryCode = Locale.current.regionCode!
let bundle = FlagKit.assetBundle
let originalImage = UIImage(named: countryCode, in: bundle, compatibleWith: nil)

Reference

FlagKit provides over 250 flags. A list of all flags can be found here.

More Info

Have a question? Please open an issue!

License

FlagKit is released under the MIT license. See LICENSE.

You can’t perform that action at this time.