Home Docs

Flag

BitFlag is a component that renders the flag image of a country.

Notes

To use this component, you need to install the
Bit.BlazorUI.Extras
 nuget package, as described in the Optional steps of the Getting started page.

Usage

Basic
<BitFlag Country="BitCountries.Iran" />
ISO & Code
Explore the additional parameters of the BitFlag for specifing the country:


Iso2: "nl"





Iso3: "NLD"





Code (dialing code): "31"

<BitFlag Iso2="nl" />

<BitFlag Iso3="NLD" />

<BitFlag Code="31" />
All countries
<div style="display:flex;gap:2px;flex-wrap:wrap">
    @foreach (var country in BitCountries.All)
    {
        <BitFlag Country="country" Title="@($"{country.Name} - {country.Iso2}")" />
    }
</div>

API

BitFlag parameters
Name
Type
Default value
Description
Code string? null The dialing code of the country.
Country BitCountry? null The country to render the flag.
Iso2 string? null The ISO 3166-1 alpha-2 code of the country.
Iso3 string? null The ISO 3166-1 alpha-3 code of the country.
Title string? null The tooltip value of the flag element.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
Dir BitDir? null Determines the component direction.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
BitCountry properties
Represents the basic information of a specific country.
Name
Type
Default value
Description
Name string The full name of the country.
Code string The dialing code of the country.
Iso2 string The ISO 3166-1 alpha-2 code of the country.
Iso3 string The ISO 3166-1 alpha-3 code of the country.
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

You can give us your feedback through our GitHub repo by filing a new Issue or starting a new Discussion.

Or you can review / edit this page on GitHub.

Or you can review / edit this component on GitHub.
  • On this page