Layout
Layout can be used to create a base UI structure for an application.
Usage
Basic
Header
Main
NavPanel
Header
Main
Styles & Classes
Main
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 | Gets or sets the accessible label for the component, used by assistive technologies. |
| Class | string? | null | Gets or sets the CSS class name(s) to apply to the rendered element. |
| Dir | BitDir? | null | Gets or sets the text directionality for the component's content. |
| HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. |
| Id | string? | null | Gets or sets the unique identifier for the component's root element. |
| IsEnabled | bool | true | Gets or sets a value indicating whether the component is enabled and can respond to user interaction. |
| Style | string? | null | Gets or sets the CSS style string to apply to the rendered element. |
| TabIndex | string? | null | Gets or sets the tab order index for the component when navigating with the keyboard. |
| Visibility | BitVisibility | BitVisibility.Visible | Gets or sets the visibility state (visible, hidden, or collapsed) of the component. |
BitComponentBase public members
Name |
Type |
Default value |
Description |
|---|---|---|---|
| UniqueId | Guid | Guid.NewGuid() | Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed. |
| RootElement | ElementReference | Gets the reference to the root HTML element associated with this component. |
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