InfiniteScrolling
BitInfiniteScrolling is a container that enables scrolling through a list of items infinitely as long as there are items to fetch and render.
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
There is no item
EmptyTemplate
--- No item ---
Advanced
Item 0
Item 1
Item 2
Item 3
Item 4
Item 5
Item 6
Item 7
Item 8
Item 9
Item 10
Item 11
Item 12
Item 13
Item 14
Item 15
Item 16
Item 17
Item 18
Item 19
Item 20
Item 21
Item 22
Item 23
Item 24
Item 25
Item 26
Item 27
Item 28
Item 29
Item 30
Item 31
Item 32
Item 33
Item 34
Item 35
Item 36
Item 37
Item 38
Item 39
Item 40
Item 41
Item 42
Item 43
Item 44
Item 45
Item 46
Item 47
Item 48
Item 49
API
BitInfiniteScrolling parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| ChildContent | RenderFragment<TItem>? | null | The custom template to render each item. |
| EmptyTemplate | RenderFragment? | null | The custom template to render when there is no item available. |
| ItemsProvider | BitInfiniteScrollingItemsProvider<TItem>? | null | The item provider function that will be called when scrolling ends. |
| ItemTemplate | RenderFragment<TItem>? | null | Alias for ChildContent. |
| LastElementClass | string? | null | The CSS class of the last element that triggers the loading. |
| LastElementHeight | string? | null | The height of the last element that triggers the loading. |
| LastElementStyle | string? | null | The CSS style of the last element that triggers the loading. |
| LoadingTemplate | RenderFragment? | null | The custom template to render while loading the new items. |
| Preload | bool | null | Pre-loads the data at the initialization of the component. Useful in prerendering mode. |
| ScrollerSelector | string? | null | The CSS selector of the scroll container, by default the root element of the component is selected for this purpose. |
| Threshold | decimal? | null | The threshold parameter for the IntersectionObserver that specifies a ratio of intersection area to total bounding box area of the last element. |
BitInfiniteScrolling public members
Name |
Type |
Default value |
Description |
|---|---|---|---|
| RefreshDataAsync | Func<Task> | Refreshes the items and re-renders them from scratch. |
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. |
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