FlagKit.Net 0.2.0

FlagKit.Net

FlagKit.Net packages the assets from madebybowtie/FlagKit for .NET. It embeds the upstream SVG and PNG flag files and exposes a small API shaped after the original Swift API.

using FlagKit;

var countryCode = RegionInfo.CurrentRegion.TwoLetterISORegionName;
var flag = Flag.FromCountryCode(countryCode);
var typedFlag = Flag.FromCountry(FlagCountry.SE);

var originalImage = flag?.OriginalImage;
var styledImage = flag?.Image(FlagStyle.Circle);
var largeRounded = flag?.Image(FlagStyle.RoundedRect, new FlagSize(84, 60));

API

var flag = Flag.FromCountryCode("SE");
var typedFlag = Flag.FromCountry(FlagCountry.SE);

// Original unstyled PNG, equivalent to Swift's originalImage.
FlagImage original = flag!.OriginalImage;

// Strongly typed country codes use FlagCountry enum values.
FlagImage typedOriginal = typedFlag.OriginalImage;
FlagImage scotland = Flag.FromCountry(FlagCountry.GB_SCT).SvgImage();
FlagImage zetland = Flag.FromCountry(FlagCountry.GB_ZET).PngImage(FlagScale.ThreeX);

// Styled PNG variants matching FlagKit's none, roundedRect, square, circle styles.
FlagImage none = flag.Image(FlagStyle.None);
FlagImage rounded = flag.Image(FlagStyle.RoundedRect);
FlagImage square = flag.Image(FlagStyle.Square);
FlagImage circle = flag.Image(FlagStyle.Circle);

// Custom output size.
FlagImage largeCircle = flag.Image(FlagStyle.Circle, new FlagSize(64, 64));

// Access embedded assets directly.
using Stream svg = Assets.OpenStream("SE", FlagFormat.Svg)!;
using Stream png2x = Assets.OpenStream("SE", FlagFormat.Png, FlagScale.TwoX)!;
using Stream typedSvg = Assets.OpenStream(FlagCountry.GB_ZET, FlagFormat.Svg);

Flag.Image(FlagStyle.None) returns PNG output. Styled output is rendered with Magick.NET from the upstream PNG assets. The default logical dimensions match FlagKit: None and RoundedRect are 21 x 15, Square and Circle are 15 x 15. Use Image(style, size) to render another PNG size.

For Avalonia:

using Avalonia.Media.Imaging;
using FlagKit;

var flag = Flag.FromCountryCode("SE");
using var stream = flag!.Image(FlagStyle.Circle, new FlagSize(30, 30)).OpenStream();
var bitmap = new Bitmap(stream);

Assets

The package includes 255 SVG flags and PNG variants at 1x, 2x, and 3x scale from the upstream FlagKit repository.

License

FlagKit.Net is distributed under the MIT license. The embedded flag assets come from madebybowtie/FlagKit, also MIT licensed.