Home Docs

Header

The BitHeader component is used to display a title (and possibly other components) in a colored bar at the top of a site or application. For the background color it uses the current primary background color.

Usage

Basic
I'm a Header
<BitHeader>I'm a Header</BitHeader>
Usage
My Awesome App 
<BitHeader Style="gap: 1rem;">
    <BitButton Variant="BitVariant.Text" IconName="@BitIconName.GlobalNavButton" Title="Open Navigation"/>
    <BitText Typography="BitTypography.Caption1">My Awesome App</BitText>
    <BitSpacer />
    <BitButton Variant="BitVariant.Text" IconName="@BitIconName.Contact" Title="Sign in" />
    <BitMenuButton TItem="BitMenuButtonOption"
                   ChevronDownIcon="@BitIconName.More"
                   Variant="BitVariant.Text"
                   title="See more"
                   Styles="@(new() { OperatorButton = "padding: 0.5rem;" })">
        <BitMenuButtonOption Text="Settings" IconName="@BitIconName.Settings" />
        <BitMenuButtonOption Text="About" IconName="@BitIconName.Info" />
        <BitMenuButtonOption Text="Feedback" IconName="@BitIconName.Feedback" />
    </BitMenuButton>
</BitHeader>

API

BitHeader parameters
Name
Type
Default value
Description
ChildContent RenderFragment? null Gets or sets the content to be rendered inside the BitHeader.
Height int? null Gets or sets the height of the BitHeader (in pixels).
Fixed bool false Renders the header with a fixed position at the top of the page.
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.
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