Skip to content

Enhance the Options config example #34459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guardrex merged 4 commits into from
Jan 10, 2025
Merged

Enhance the Options config example #34459

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c2ebf4
Enhance the Options config example
guardrex Jan 9, 2025
1766ed1
Updates
guardrex Jan 9, 2025
b0c1c37
Updates
guardrex Jan 10, 2025
7341bab
Updates
guardrex Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 56 additions & 2 deletions aspnetcore/blazor/fundamentals/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,63 @@ For more information on how background updates are handled by PWAs, see <xref:bl

Example:

`OptionsExample.cs`:

```csharp
public class OptionsExample
{
public string? Option1 { get; set; }
public string? Option2 { get; set; }
}
```

In `appsettings.json`:

```json
"OptionsExample": {
"Option1": "Option1 Value",
"Option2": "Option2 Value"
}
```

```csharp
builder.Services.Configure<MyOptions>(
builder.Configuration.GetSection("MyOptions"));
builder.Services.Configure<OptionsExample>(
builder.Configuration.GetSection("OptionsExample"));
```

The following Razor component retrieves the settings with the [`@inject`](xref:mvc/views/razor#inject) directive or [`[Inject]` attribute](xref:Microsoft.AspNetCore.Components.InjectAttribute).

`Options.razor`:

```razor
@page "/options"
@using Microsoft.Extensions.Options
@inject IOptions<OptionsExample>? OptionsExample1

<h1>Options</h1>

<h2>
&commat;inject approach
</h2>

<ul>
<li>@OptionsExample1?.Value.Option1</li>
<li>@OptionsExample1?.Value.Option2</li>
</ul>

<h2>
[Inject] approach
</h2>

<ul>
<li>@OptionsExample2?.Value.Option1</li>
<li>@OptionsExample2?.Value.Option2</li>
</ul>

@code {
[Inject]
public IOptions<OptionsExample>? OptionsExample2 { get; set; }
}
```

Not all of the ASP.NET Core Options features are supported in Razor components. For example, <xref:Microsoft.Extensions.Options.IOptionsSnapshot%601> and <xref:Microsoft.Extensions.Options.IOptionsMonitor%601> configuration is supported, but recomputing option values for these interfaces isn't supported outside of reloading the app by either requesting the app in a new browser tab or selecting the browser's reload button. Merely calling [`StateHasChanged`](xref:blazor/components/lifecycle#state-changes-statehaschanged) doesn't update snapshot or monitored option values when the underlying configuration changes.
Loading