# Shimmer **Also known as:** Skeleton ## Description Shimmer is a temporary animation placeholder for when a service call takes time to return data and you don't want to block rendering the rest of the UI. ## Parameters | Name | Type | Default Value | Description | | :--- | :--- | :------------ | :---------- | | Background | `BitColor?` | null | The background color of the container of the shimmer. | | ChildContent | `RenderFragment?` | null | The content that will be shown when the Loaded parameter changes to true. | | Circle | `bool` | false | Renders the shimmer as circle instead of a rectangle. | | Classes | `BitShimmerClassStyles?` | null | Custom CSS classes for different parts of the BitShimmer. | | Color | `BitColor?` | null | The color of the animated part of the shimmer. | | Content | `RenderFragment?` | null | Alias of ChildContent. | | Delay | `int?` | null | The animation delay value in ms. | | Duration | `int?` | null | The animation duration value in ms. | | Height | `string?` | null | The shimmer height value. | | Loaded | `bool` | false | Controls when the shimmer is swapped with actual data through an animated transition. | | Pulse | `bool` | false | Changes the animation type of the shimmer to pulse. | | Styles | `BitShimmerClassStyles?` | null | Custom CSS styles for different parts of the BitShimmer. | | Template | `RenderFragment?` | null | The custom template to replace the default shimmer container and animation. | | Width | `string?` | null | The shimmer width value. | | 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. | | ForceAnimation | `bool` | false | Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested. | | 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. | ## 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. | ## Enums ### BitColor Enum | Name | Value | Description | | :--- | :--- | :---------- | | Primary | 0 | Info Primary general color. | | Secondary | 1 | Secondary general color. | | Tertiary | 2 | Tertiary general color. | | Info | 3 | Info general color. | | Success | 4 | Success general color. | | Warning | 5 | Warning general color. | | SevereWarning | 6 | SevereWarning general color. | | Error | 7 | Error general color. | | PrimaryBackground | 8 | Primary background color. | | SecondaryBackground | 9 | Secondary background color. | | TertiaryBackground | 10 | Tertiary background color. | | PrimaryForeground | 11 | Primary foreground color. | | SecondaryForeground | 12 | Secondary foreground color. | | TertiaryForeground | 13 | Tertiary foreground color. | | PrimaryBorder | 14 | Primary border color. | | SecondaryBorder | 15 | Secondary border color. | | TertiaryBorder | 16 | Tertiary border color. | ### 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. | ## Sub Classes ### BitShimmerClassStyles Properties | Name | Type | Default Value | Description | | :--- | :--- | :------------ | :---------- | | Root | `string?` | null | Custom CSS classes/styles for the root element of the BitShimmer. | | Content | `string?` | null | Custom CSS classes/styles for the content of the BitShimmer. | | ShimmerWrapper | `string?` | null | Custom CSS classes/styles for the shimmer wrapper of the BitShimmer. | | Shimmer | `string?` | null | Custom CSS classes/styles for the shimmer of the BitShimmer. | ## Examples \n**Basic**: ```razor ``` \n**Size**: ```razor ``` \n**Circle**: ```razor ``` \n**Animation**: ```razor ``` \n**Loaded**: ```razor Content loaded successfully. ``` ```csharp private bool isDataLoaded; ``` \n**Advanced**: ```razor
``` ```csharp private bool isContentLoaded; ``` \n**Color**: ```razor ``` \n**BackgroundColor**: ```razor ``` \n**Style & Class**: ```razor ```