MrSquirrely.Flags
1.0.0
dotnet add package MrSquirrely.Flags --version 1.0.0
NuGet\Install-Package MrSquirrely.Flags -Version 1.0.0
<PackageReference Include="MrSquirrely.Flags" Version="1.0.0" />
<PackageVersion Include="MrSquirrely.Flags" Version="1.0.0" />
<PackageReference Include="MrSquirrely.Flags" />
paket add MrSquirrely.Flags --version 1.0.0
#r "nuget: MrSquirrely.Flags, 1.0.0"
#:package MrSquirrely.Flags@1.0.0
#addin nuget:?package=MrSquirrely.Flags&version=1.0.0
#tool nuget:?package=MrSquirrely.Flags&version=1.0.0
Waving Flags
A Blazor component library providing fluid, CSS-animated waving flags: LGBTQ+ pride flags, the ten most populous countries' flags, kink pride flags, community flags, or your own stripes and logo. The wave effect uses a synchronized columnar delay to achieve a heavy, realistic fabric feel.
This project is inspired by the animation work of Josh W. Comeau.
Installation & Setup
Install the package from NuGet:
dotnet add package MrSquirrely.Flags
Your project needs to target .NET 11.0 or higher. The library contains:
Components/Flag.razor- TheFlagcomponent.Components/Flag.razor.css- Scoped CSS for the wave animation and the designed flags.wwwroot/flags/*.svg- The designs for flags that are more than plain stripes (Progress Pride, countries, kink flags, ...).FlagCatalog.cs,FlagDefinition.cs,FlagColor.cs,FlagCategory.cs- The built-in flags.
Add the namespaces to your _Imports.razor file:
@using Flags
@using Flags.Components
Blazor apps pick up the component's stylesheet through their {App}.styles.css bundle. Razor Pages and MVC apps link it directly:
<link href="~/_content/MrSquirrely.Flags/MrSquirrely.Flags.bundle.scp.css" rel="stylesheet" asp-append-version="true" />
Usage
You can embed the flag component directly into your Razor views, MVC .cshtml pages, or other Blazor components.
Basic Example
<Flag Variant="FlagColor.Transgender" Width="300"/>
Custom Colors Example
<Flag CustomColors="@(new string[] { "hsl(0deg 90% 55%)", "hsl(120deg 90% 55%)", "hsl(240deg 90% 55%)" })" NumOfColumns="15"/>
Logo Example
<Flag LogoUrl="/images/my-custom-logo.svg" Variant="FlagColor.RainbowOriginal"/>
Listing Every Flag
@foreach (FlagDefinition flag in FlagCatalog.InCategory(FlagCategory.Pride)) {
<Flag Variant="flag.Variant" Width="90" Label="@flag.Name"/>
}
Razor Pages / MVC
<component type="typeof(Flag)" render-mode="Static" param-Variant="@FlagColor.ProgressPride" param-Width="(double)64" />
Component Parameters
Variant(FlagColor): A built-in flag. Defaults toFlagColor.RainbowOriginal.CustomColors(string[]?): An optional array of CSS color strings (e.g., HEX, HSL, RGB) to build a custom top-to-bottom striped flag. If provided, this overrides the selectedVariant.Width(double): The rendering target width of the flag in pixels, rounded to a whole number of pixels per column. The height follows at 3:2. Defaults to200.NumOfColumns(int): The number of individual vertical elements making up the flag. More columns create a higher-fidelity wave. Defaults to10; values below1are treated as1.StaggeredDelay(int): The animation delay offset (in milliseconds) added sequentially per column to establish the fluid ripple effect. Defaults to150.Billow(double): The intensity / peak vertical distance (in pixels) of the ripple animation oscillation. Defaults to3. Animation is disabled for visitors who setprefers-reduced-motion.LogoUrl(string): An optional URL to an image or SVG to display centered across the waving flag.Label(string?): An optional accessible name (e.g."Transgender pride flag"). When set, the flag is exposed as an image with that name; when omitted, the flag is treated as decorative and hidden from screen readers.
Built-in Flags
FlagCatalog.All lists every flag as a FlagDefinition (variant, display name, category, stripe colors), and FlagCatalog.Get(variant) returns one. Flags marked design are drawn from an SVG in wwwroot/flags; their stripe colors show while the SVG loads.
Pride (FlagCategory.Pride)
FlagColor |
Name | Notes |
|---|---|---|
RainbowOriginal |
Rainbow Pride | Classic 6 stripes |
Rainbow |
Philadelphia Pride | 6 stripes plus black and brown |
GilbertBaker |
Gilbert Baker Pride (1978) | Original 8 stripes |
ProgressPride |
Progress Pride | Design |
IntersexInclusiveProgress |
Intersex-Inclusive Progress Pride | Design |
Lesbian |
Lesbian | 5 stripes |
Gay |
Gay Men | 7 stripes |
Bisexual |
Bisexual | 2:1:2 stripes |
Pansexual |
Pansexual | |
Polysexual |
Polysexual | |
Omnisexual |
Omnisexual | |
Asexual |
Asexual | |
Demisexual |
Demisexual | Design |
Graysexual |
Graysexual | |
Aromantic |
Aromantic | |
Demiromantic |
Demiromantic | Design |
AroAce |
Aroace | |
Polyamory |
Polyamory | Design, the 2022 tricolor |
Transgender |
Transgender | |
NonBinary |
Non-Binary | |
Genderfluid |
Genderfluid | |
Genderqueer |
Genderqueer | |
Agender |
Agender | |
Bigender |
Bigender | |
Demigirl |
Demigirl | |
Demiboy |
Demiboy | |
Intersex |
Intersex | Design |
Transfeminine |
Transfeminine | |
Transmasculine |
Transmasculine | |
Pangender |
Pangender | |
Genderflux |
Genderflux | |
Neutrois |
Neutrois | |
Androgyne |
Androgyne | |
Maverique |
Maverique | |
Xenogender |
Xenogender | |
TwoSpirit |
Two-Spirit | Design, rainbow with two feathers in a circle |
Queer |
Queer | The 2015 flag, 8 stripes |
Abrosexual |
Abrosexual | |
Sapphic |
Sapphic | Design, stripes with a violet |
LabrysLesbian |
Labrys Lesbian | Design, violet with a black triangle and a labrys |
StraightAlly |
Straight Ally | Design, black and white stripes with a rainbow chevron |
Twink |
Twink | Design, interlocked Mars symbols |
Countries (FlagCategory.Country)
The ten most populous countries. All flags are drawn at 3:2, so flags with other official proportions (e.g. the United States at 19:10) are slightly stretched. Brazil and Mexico use simplified emblems, without the motto or the full coat of arms.
India, China, UnitedStates, Indonesia, Pakistan, Nigeria, Brazil, Bangladesh, Russia, Mexico
Kink (FlagCategory.Kink)
FlagColor |
Name | Notes |
|---|---|---|
Leather |
Leather Pride | 9 black and blue stripes, white center, red heart |
BdsmRights |
BDSM Rights | Leather stripes with a simplified red BDSM emblem |
PuppyPride |
Puppy Pride | Diagonal stripes with a red bone |
RubberPride |
Rubber Pride | Black with a kinked gold band outlined in red |
LeatherTransgender |
Trans Leather | Leather layout in trans colors |
LeatherAsexual |
Ace Leather | Leather layout in ace colors |
LeatherBisexual |
Bi Leather | Leather layout in bi colors |
LeatherPansexual |
Pan Leather | Leather layout in pan colors |
LeatherNonBinary |
Non-Binary Leather | Leather layout in non-binary colors |
The leather crossovers are community recolors with many variants; these keep the leather stripe pattern and red heart.
Community (FlagCategory.Community)
FlagColor |
Name | Notes |
|---|---|---|
BearBrotherhood |
Bear Brotherhood | Seven stripes with a black paw |
DisabilityPride |
Disability Pride | The 2021 low-flicker redesign |
Neurodiversity |
Neurodiversity | Rainbow infinity on white |
Upgrading from the first release
FlagColors.Colorsis replaced by the read-onlyFlagCatalog.- The
GetDisplayName()extension on everyEnumis removed (it clashed with apps that define their own); useFlagCatalog.Get(variant).Name. Rainbowis now named "Philadelphia Pride" andRainbowOriginal"Rainbow Pride".- The bisexual flag now uses its official 2:1:2 stripe proportions.
⚖️ License (LGPLv3)
This library is licensed under the GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later). The LGPL is a set of extra permissions on top of the GPLv3, so both texts are included: LICENSE (LGPLv3) and COPYING (GPLv3).
In short (this is a summary, not legal advice; the license text is what counts):
- Using the library: You can use
MrSquirrely.Flagsin any application, open source or proprietary, in every render mode, including Blazor WebAssembly. Your own code does not have to be released under the LGPL. - Shipping it to users: When you distribute the library (for example, the
.dllsent to the browser by a WebAssembly app, or a desktop app), include the license notice and let recipients replace the library with a modified version. Referencing it as the separateMrSquirrely.Flagsassembly, as the NuGet package does, keeps that possible. - Changing the library: If you modify the library itself and distribute it, release those modifications under the LGPLv3.
- Server-side rendering: With Blazor Server or static rendering, the library stays on your server and is not distributed to visitors.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net11.0 is compatible. |
-
net11.0
- Microsoft.AspNetCore.Components.Web (>= 11.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.0.0 | 47 | 11/17/2026 |