IgbGridLite is a component for displaying data in a tabular format quick and easy.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- IAsyncDisposable
Constructors
Section titled "Constructors"constructor
public IgbGridLite()Returns IgbGridLite<TItem>
Properties
Section titled "Properties"AdditionalAttributes
Section titled "AdditionalAttributes"Additional attributes for the component's HTML element element.
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object>? AdditionalAttributes { get; set; }AdoptRootStyles
Section titled "AdoptRootStyles"Whether the grid will adopt document-level styles into its shadow DOM. Useful when using cell and header templates that rely on styles defined at the document level.
[Parameter]
public bool AdoptRootStyles { get; set; }AutoGenerate
Section titled "AutoGenerate"Whether the grid will try to "resolve" its column configuration based on the passed data source. This is usually executed on initial rendering in the DOM.
[Parameter]
public bool AutoGenerate { get; set; }ChildContent
Section titled "ChildContent"Child content for declarative column definitions
[Parameter]
public RenderFragment? ChildContent { get; set; }The data to display in the grid
[Parameter]
public IEnumerable<TItem>? Data { get; set; }FilterExpressions
Section titled "FilterExpressions"Initial filter expressions to apply when the grid is rendered
[Parameter]
public IEnumerable<IgbGridLiteFilterExpression>? FilterExpressions { get; set; }GridId
Section titled "GridId"The unique identifier for this grid instance
[Obsolete("The grid's internal id is not needed to use it. It will be removed in a future release.")]
public string GridId { get; }SortingExpressions
Section titled "SortingExpressions"Initial sort expressions to apply when the grid is rendered
[Parameter]
public IEnumerable<IgbGridLiteSortingExpression>? SortingExpressions { get; set; }SortingOptions
Section titled "SortingOptions"Sort options property for the grid.
[Parameter]
public IgbGridLiteSortingOptions? SortingOptions { get; set; }Methods
Section titled "Methods"BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"protected override void BuildRenderTree(RenderTreeBuilder __builder)Parameters
- __builder:
RenderTreeBuilder
Returns any
ClearFilterAsync(string?)
Section titled "ClearFilterAsync(string?)"Resets the current filter state of the grid.
public Task ClearFilterAsync(string? key = null)Parameters
- key:
string
Returns any
ClearSortAsync(string?)
Section titled "ClearSortAsync(string?)"Resets the current sort state of the grid.
public Task ClearSortAsync(string? key = null)Parameters
- key:
string
Returns any
DisposeAsync()
Section titled "DisposeAsync()"public ValueTask DisposeAsync()Returns any
FilterAsync(IgbGridLiteFilterExpression)
Section titled "FilterAsync(IgbGridLiteFilterExpression)"Performs a filter operation in the grid based on the passed expression(s).
public Task FilterAsync(IgbGridLiteFilterExpression expression)Parameters
- expression:
IgbGridLiteFilterExpression
Returns any
FilterAsync(IEnumerable<IgbGridLiteFilterExpression>)
Section titled "FilterAsync(IEnumerable<IgbGridLiteFilterExpression>)"Performs a filter operation in the grid based on the passed expression(s).
public Task FilterAsync(IEnumerable<IgbGridLiteFilterExpression> expressions)Parameters
- expressions:
IEnumerable
Returns any
GetColumnsAsync()
Section titled "GetColumnsAsync()"Returns the current column configuration list.
public ValueTask<IgbColumnConfiguration[]> GetColumnsAsync()Returns any
NavigateToAsync(long, string?, bool)
Section titled "NavigateToAsync(long, string?, bool)"Navigates to a position in the grid based on provided row index and column field.
public Task NavigateToAsync(long row, string? field = null, bool activate = false)Parameters
- row:
long - field:
string - activate:
bool
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
RefreshAsync()
Section titled "RefreshAsync()"Refreshes the grid by re-rendering it with the current data and configuration.
[Obsolete("The grid renders on its own and updates from its parameters; assign a new collection instead of changing one in place. It will be removed in a future release.")]
public Task RefreshAsync()Returns any
RenderAsync()
Section titled "RenderAsync()"Re-renders the grid on the client with the current data and configuration.
[Obsolete("The grid renders on its own and updates from its parameters; assign a new collection instead of changing one in place. It will be removed in a future release.")]
public Task RenderAsync()Returns any
SetParametersAsync(ParameterView)
Section titled "SetParametersAsync(ParameterView)"public override Task SetParametersAsync(ParameterView parameters)Parameters
- parameters:
ParameterView
Returns any
SortAsync(IgbGridLiteSortingExpression)
Section titled "SortAsync(IgbGridLiteSortingExpression)"Performs a sort operation in the grid based on the passed expression(s).
public Task SortAsync(IgbGridLiteSortingExpression expressions)Parameters
- expressions:
IgbGridLiteSortingExpression
Returns any
SortAsync(IEnumerable<IgbGridLiteSortingExpression>)
Section titled "SortAsync(IEnumerable<IgbGridLiteSortingExpression>)"Performs a sort operation in the grid based on the passed expression(s).
public Task SortAsync(IEnumerable<IgbGridLiteSortingExpression> expressions)Parameters
- expressions:
IEnumerable
Returns any
UpdateDataAsync(IEnumerable<TItem>)
Section titled "UpdateDataAsync(IEnumerable<TItem>)"Updates the data source for the grid.
[Obsolete("Assign a new collection to the Data parameter instead. It will be removed in a future release.")]
public Task UpdateDataAsync(IEnumerable<TItem> newData)Parameters
- newData:
IEnumerable
Returns any
Events
Section titled "Events"Filtered
Section titled "Filtered"Fires when a filter operation initiated through the UI has completed. Returns the filter state for the affected column.
[Parameter]
public EventCallback<IgbGridLiteFilteredEventArgs> Filtered { get; set; }Filtering
Section titled "Filtering"Fires when filtering is initiated through the UI.
[Parameter]
public EventCallback<IgbGridLiteFilteringEventArgs> Filtering { get; set; }Rendered
Section titled "Rendered"Fires once, when the grid has rendered on the client for the first time.
[Parameter]
public EventCallback Rendered { get; set; }Sorted
Section titled "Sorted"Fires when a sort operation initiated through the UI has completed. Returns the sort expression used for the operation.
[Parameter]
public EventCallback<IgbGridLiteSortedEventArgs> Sorted { get; set; }Sorting
Section titled "Sorting"Fires when sorting is initiated through the UI. Returns the sort expression which will be used for the operation.
[Parameter]
public EventCallback<IgbGridLiteSortingEventArgs> Sorting { get; set; }