Skip to content

Commit

Permalink
Provide `Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAda…
Browse files Browse the repository at this point in the history
…pter` package README (#57794)
  • Loading branch information
MackinnonBuck authored Sep 11, 2024
1 parent 3b4e92a commit 040eba9
Showing 1 changed file with 29 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## About

`Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter` provides an Entity Framework Core (EF Core) adapter for the [`Microsoft.AspNetCore.Components.QuickGrid`](https://www.nuget.org/packages/Microsoft.AspNetCore.Components.QuickGrid) package.

## How to Use

To use `Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter`, follow these steps:

### Installation

```shell
dotnet add package Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter
```

### Configuration

To register an EF-aware `IAsyncQueryExecutor` implementation, call `AddQuickGridEntityFrameworkAdapter` on the service collection in `Program.cs`:

```csharp
builder.Services.AddQuickGridEntityFrameworkAdapter();
```

## Additional Documentation

For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/blazor/components/quickgrid#entity-framework-core-ef-core-data-source) on using EF Core with `QuickGrid`.

## Feedback & Contributing

`Microsoft.AspNetCore.Components.QuickGrid.EntityFrameworkAdapter` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).

0 comments on commit 040eba9

Please sign in to comment.