Home Docs

AppShell

BitAppShell is an advanced container to handle the nuances of a cross-platform layout.

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
Since this component is a base layout container, it is not possible to show its capabilities in a demo sample here.
You can always check our Boilerplate project template samples (AdminPanel & Todo) to see the BitAppShell in action.

API

BitAppShell parameters
Name
Type
Default value
Description
AutoGoToTop bool false Enables auto-scroll to the top of the main container on navigation.
CascadingValues IEnumerable<BitCascadingValue>? null The cascading values to be provided for the children of the layout.
ChildContent RenderFragment? null The content of the layout.
Classes BitAppShellClassStyles? null Custom CSS classes for different parts of the layout.
Styles BitAppShellClassStyles? null Custom CSS styles for different parts of the layout.
BitAppShell public members
Name
Type
Default value
Description
GoToTop Func<BitScrollBehavior, Task> Scrolls the main container to top.
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.
BitCascadingValue properties
The cascading value to be provided using the BitCascadingValueProvider component.
Name
Type
Default value
Description
Name string? null The optional name of the cascading value.
Value object? null The value to be provided.
IsFixed bool null If true, indicates that Value will not change.
BitAppShellClassStyles properties
Name
Type
Default value
Description
Root string? null Custom CSS classes/styles for the root of the BitAppShell.
Top string? null Custom CSS classes/styles for the top area of the BitAppShell.
Center string? null Custom CSS classes/styles for the top center of the BitAppShell.
Left string? null Custom CSS classes/styles for the top left of the BitAppShell.
Main string? null Custom CSS classes/styles for the main area of the BitAppShell.
Right string? null Custom CSS classes/styles for the right area of the BitAppShell.
Bottom string? null Custom CSS classes/styles for the bottom area of the BitAppShell.
BitScrollBehavior enum
Name
Value
Description
Smooth 0 Scrolling should animate smoothly.
Instant 1 Scrolling should happen instantly in a single jump.
Auto 2 Scroll behavior is determined by the computed value of scroll-behavior.
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.
  • On this page