Home Docs

Layout

Layout can be used to create a base UI structure for an application.

Usage

Basic
Header
Main
Footer
<style>
    .header {
        padding: 0.5rem;
        border: 1px solid gray;
    }

    .main {
        width: 100%;
        height: 100%;
        padding: 0.5rem;
        border: 1px solid gray;
    }

    .footer {
        padding: 0.5rem;
        border: 1px solid gray;
    }
</style>


<BitLayout>
    <Header>
        <div class="header">Header</div>
    </Header>
    <Main>
        <div class="main">Main</div>
    </Main>
    <Footer>
        <div class="footer">Footer</div>
    </Footer>
</BitLayout>
NavPanel

Header
NavPanel
Main
Footer
<style>
    .header {
        padding: 0.5rem;
        border: 1px solid gray;
    }

    .main {
        width: 100%;
        height: 100%;
        padding: 0.5rem;
        border: 1px solid gray;
    }

    .nav-menu {
        width: 100%;
        height: 100%;
        padding: 0.5rem;
        border: 1px solid gray;
    }

    .footer {
        padding: 0.5rem;
        border: 1px solid gray;
    }
</style>


<BitToggle Label="Hide NavPanel" @bind-Value="HideNavPanel" />

<BitLayout HideNavPanel="HideNavPanel">
    <Header>
        <div class="header">Header</div>
    </Header>
    <NavPanel>
        <div class="nav-menu">NavPanel</div>
    </NavPanel>
    <Main>
        <div class="main">Main</div>
    </Main>
    <Footer>
        <div class="footer">Footer</div>
    </Footer>
</BitLayout>
@code {
    private bool HideNavPanel;
}
Styles & Classes
Header
NavPanel
Main
Footer
<style>
    .header {
        color: black;
        display: flex;
        padding: 1rem;
        border: 1px solid red;
        justify-content: center;
        background-color: lightgreen;
    }

    .main {
        border: 1px solid green;
    }

    .nav-menu2 {
        color: black;
        height: 100%;
        display: flex;
        align-items: center;
        justify-content: center;
        background-color: lightblue;
        border: 1px solid lightgreen;
    }

    .main-content {
        color: black;
        height: 100%;
        display: flex;
        align-items: center;
        justify-content: center;
        border: 1px solid darkgreen;
        background-color: lightgoldenrodyellow;
    }

    .footer {
        color: black;
        display: flex;
        padding: 1rem;
        border: 1px solid blue;
        justify-content: center;
        background-color: lightpink;
    }
</style>


<BitLayout Styles="@(new() { Main = "height: 19rem;" })" 
           Classes="@(new() { Header = "header2",
                              Main = "main2",
                              NavPanel = "nav-menu2",
                              MainContent = "main-content2",
                              Footer = "footer2" })">
    <Header>Header</Header>
    <NavPanel>NavPanel</NavPanel>
    <Main>Main</Main>
    <Footer>Footer</Footer>
</BitLayout>

API

BitLayout parameters
Name
Type
Default value
Description
Classes BitLayoutClassStyles? null Custom CSS classes for different parts of the BitLayout.
Footer RenderFragment? null The content of the footer section.
Header RenderFragment? null The content of the header section.
HideNavPanel bool false Hides NavPanel content when true.
Main RenderFragment? null The content of the main section.
NavPanel RenderFragment? null The content of the nav panel section.
NavPanelWidth int 0 The width of the nav panel section in px.
ReverseNavPanel bool false Reverses the position of the nav panel inside the main container.
Styles BitLayoutClassStyles? null Custom CSS styles for different parts of the BitLayout.
StickyFooter bool false Enables sticky positioning of the footer at the bottom of the viewport.
StickyHeader bool false Enables sticky positioning of the header at the top of the viewport.
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.
BitLayoutClassStyles properties
Name
Type
Default value
Description
Root string? null Custom CSS classes/styles for the root element of the BitLayout.
Header string? null Custom CSS classes/styles for the header section of the BitLayout.
Main string? null Custom CSS classes/styles for the main section of the BitLayout.
NavPanel string? null Custom CSS classes/styles for the nav-menu section of the BitLayout.
MainContent string? null Custom CSS classes/styles for the main-content section of the BitLayout.
Footer string? null Custom CSS classes/styles for the footer section of the BitLayout.
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