Build components
- Browse to each of the app's three pages in the Pages folder: Home, Counter, and Fetch data. These pages are implemented by the Razor component files Index.razor, Counter.razor, and FetchData.razor.
- On the Counter page, select the Click me button to increment the counter without a page refresh. Incrementing a counter in a webpage normally requires writing JavaScript, but Blazor provides a better approach using C#.
- Examine the implementation of the
Countercomponent in the Counter.razor file.Pages/Counter.razor:CSHTML@page "/counter" <h1>Counter</h1> <p>Current count: @currentCount</p> <button class="btn btn-primary" @onclick="IncrementCount">Click me</button> @code { private int currentCount = 0; private void IncrementCount() { currentCount++; } }The UI of theCountercomponent is defined using HTML. Dynamic rendering logic (for example, loops, conditionals, expressions) is added using an embedded C# syntax called Razor. The HTML markup and C# rendering logic are converted into a component class at build time. The name of the generated .NET class matches the file name.Members of the component class are defined in an@codeblock. In the@codeblock, component state (properties, fields) and methods are specified for event handling or for defining other component logic. These members are then used as part of the component's rendering logic and for handling events.When the Click me button is selected:- The
Countercomponent's registeredonclickhandler is called (theIncrementCountmethod). - The
Countercomponent regenerates its render tree. - The new render tree is compared to the previous one.
- Only modifications to the Document Object Model (DOM) are applied. The displayed count is updated.
- The
- Modify the C# logic of the
Countercomponent to make the count increment by two instead of one.CSHTML@page "/counter" <h1>Counter</h1> <p>Current count: @currentCount</p> <button class="btn btn-primary" @onclick="IncrementCount">Click me</button> @code { private int currentCount = 0; private void IncrementCount() { currentCount += 2; } } - Rebuild and run the app to see the changes. Select the Click me button. The counter increments by two.
Use components
Include a component in another component using an HTML syntax.
- Add the
Countercomponent to the app'sIndexcomponent by adding a<Counter />element to theIndexcomponent (Index.razor).If you're using Blazor WebAssembly for this experience, aSurveyPromptcomponent is used by theIndexcomponent. Replace the<SurveyPrompt>element with a<Counter />element. If you're using a Blazor Server app for this experience, add the<Counter />element to theIndexcomponent:Pages/Index.razor:CSHTML@page "/" <h1>Hello, world!</h1> Welcome to your new app. <Counter /> - Rebuild and run the app. The
Indexcomponent has its own counter.
Component parameters
Components can also have parameters. Component parameters are defined using public properties on the component class with the
[Parameter] attribute. Use attributes to specify arguments for a component in markup.- Update the component's
@codeC# code:- Add a public
IncrementAmountproperty with the[Parameter]attribute. - Change the
IncrementCountmethod to use theIncrementAmountwhen increasing the value ofcurrentCount.
Pages/Counter.razor:CSHTML@page "/counter" <h1>Counter</h1> <p>Current count: @currentCount</p> <button class="btn btn-primary" @onclick="IncrementCount">Click me</button> @code { private int currentCount = 0; [Parameter] public int IncrementAmount { get; set; } = 1; private void IncrementCount() { currentCount += IncrementAmount; } } - Add a public
- Specify an
IncrementAmountparameter in theIndexcomponent's<Counter>element using an attribute. Set the value to increment the counter by ten.Pages/Index.razor:CSHTML@page "/" <h1>Hello, world!</h1> Welcome to your new app. <Counter IncrementAmount="10" /> - Reload the
Indexcomponent. The counter increments by ten each time the Click me button is selected. The counter in theCountercomponent continues to increment by one.
Route to components
The
@page directive at the top of the Counter.razor file specifies that the Counter component is a routing endpoint. The Counter component handles requests sent to /counter. Without the @page directive, a component doesn't handle routed requests, but the component can still be used by other components.Dependency injection
If working with a Blazor Server app, the
WeatherForecastService service is registered as a singleton in Startup.ConfigureServices. An instance of the service is available throughout the app via dependency injection (DI):
C#
public void ConfigureServices(IServiceCollection services)
{
services.AddRazorPages();
services.AddServerSideBlazor();
services.AddSingleton<WeatherForecastService>();
}
The
@inject directive is used to inject the instance of the WeatherForecastService service into the FetchData component.
Pages/FetchData.razor:
CSHTML
@page "/fetchdata"
@using ToDoList.App.Services
@inject WeatherForecastService ForecastService
The
FetchData component uses the injected service, as ForecastService, to retrieve an array of WeatherForecast objects:
CSHTML
@code {
private WeatherForecast[] forecasts;
protected override async Task OnInitializedAsync()
{
forecasts = await ForecastService.GetForecastAsync(DateTime.Now);
}
}
If working with a Blazor WebAssembly app,
HttpClient is injected to obtain weather forecast data from the weather.json file in the wwwroot/sample-data folder.
Pages/FetchData.razor:
CSHTML
@inject HttpClient Http
...
protected override async Task OnInitializedAsync()
{
forecasts =
await Http.GetJsonAsync<WeatherForecast[]>("sample-data/weather.json");
}
A @foreach loop is used to render each forecast instance as a row in the table of weather data:
CSHTML
<table class="table">
<thead>
<tr>
<th>Date</th>
<th>Temp. (C)</th>
<th>Temp. (F)</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
@foreach (var forecast in forecasts)
{
<tr>
<td>@forecast.Date.ToShortDateString()</td>
<td>@forecast.TemperatureC</td>
<td>@forecast.TemperatureF</td>
<td>@forecast.Summary</td>
</tr>
}
</tbody>
</table>
Build a todo list
Add a new component to the app that implements a simple todo list.
- Add an empty file named Todo.razor to the app in the Pages folder:
- Provide the initial markup for the component:CSHTML
@page "/todo" <h1>Todo</h1> - Add the
Todocomponent to the navigation bar.TheNavMenucomponent (Shared/NavMenu.razor) is used in the app's layout. Layouts are components that allow you to avoid duplication of content in the app.Add a<NavLink>element for theTodocomponent by adding the following list item markup below the existing list items in the Shared/NavMenu.razor file:CSHTML<li class="nav-item px-3"> <NavLink class="nav-link" href="todo"> <span class="oi oi-list-rich" aria-hidden="true"></span> Todo </NavLink> </li> - Rebuild and run the app. Visit the new Todo page to confirm that the link to the
Todocomponent works. - Add a TodoItem.cs file to the root of the project to hold a class that represents a todo item. Use the following C# code for the
TodoItemclass:CSHTMLpublic class TodoItem { public string Title { get; set; } public bool IsDone { get; set; } } - Return to the
Todocomponent (Pages/Todo.razor):- Add a field for the todo items in an
@codeblock. TheTodocomponent uses this field to maintain the state of the todo list. - Add unordered list markup and a
foreachloop to render each todo item as a list item (<li>).
CSHTML@page "/todo" <h1>Todo</h1> <ul> @foreach (var todo in todos) { <li>@todo.Title</li> } </ul> @code { private IList<TodoItem> todos = new List<TodoItem>(); } - Add a field for the todo items in an
- The app requires UI elements for adding todo items to the list. Add a text input (
<input>) and a button (<button>) below the unordered list (<ul>...</ul>):CSHTML@page "/todo" <h1>Todo</h1> <ul> @foreach (var todo in todos) { <li>@todo.Title</li> } </ul> <input placeholder="Something todo" /> <button>Add todo</button> @code { private IList<TodoItem> todos = new List<TodoItem>(); } - Rebuild and run the app. When the Add todo button is selected, nothing happens because an event handler isn't wired up to the button.
- Add an
AddTodomethod to theTodocomponent and register it for button selections using the@onclickattribute. TheAddTodoC# method is called when the button is selected:CSHTML<input placeholder="Something todo" /> <button @onclick="AddTodo">Add todo</button> @code { private IList<TodoItem> todos = new List<TodoItem>(); private void AddTodo() { // Todo: Add the todo } } - To get the title of the new todo item, add a
newTodostring field at the top of the@codeblock and bind it to the value of the text input using thebindattribute in the<input>element:CSHTMLprivate IList<TodoItem> todos = new List<TodoItem>(); private string newTodo;CSHTML<input placeholder="Something todo" @bind="newTodo" /> - Update the
AddTodomethod to add theTodoItemwith the specified title to the list. Clear the value of the text input by settingnewTodoto an empty string:CSHTML@page "/todo" <h1>Todo</h1> <ul> @foreach (var todo in todos) { <li>@todo.Title</li> } </ul> <input placeholder="Something todo" @bind="newTodo" /> <button @onclick="AddTodo">Add todo</button> @code { private IList<TodoItem> todos = new List<TodoItem>(); private string newTodo; private void AddTodo() { if (!string.IsNullOrWhiteSpace(newTodo)) { todos.Add(new TodoItem { Title = newTodo }); newTodo = string.Empty; } } } - Rebuild and run the app. Add some todo items to the todo list to test the new code.
- The title text for each todo item can be made editable, and a check box can help the user keep track of completed items. Add a check box input for each todo item and bind its value to the
IsDoneproperty. Change@todo.Titleto an<input>element bound to@todo.Title:CSHTML<ul> @foreach (var todo in todos) { <li> <input type="checkbox" @bind="todo.IsDone" /> <input @bind="todo.Title" /> </li> } </ul> - To verify that these values are bound, update the
<h1>header to show a count of the number of todo items that aren't complete (IsDoneisfalse).CSHTML<h1>Todo (@todos.Count(todo => !todo.IsDone))</h1> - The completed
Todocomponent (Pages/Todo.razor):CSHTML@page "/todo" <h1>Todo (@todos.Count(todo => !todo.IsDone))</h1> <ul> @foreach (var todo in todos) { <li> <input type="checkbox" @bind="todo.IsDone" /> <input @bind="todo.Title" /> </li> } </ul> <input placeholder="Something todo" @bind="newTodo" /> <button @onclick="AddTodo">Add todo</button> @code { private IList<TodoItem> todos = new List<TodoItem>(); private string newTodo; private void AddTodo() { if (!string.IsNullOrWhiteSpace(newTodo)) { todos.Add(new TodoItem { Title = newTodo }); newTodo = string.Empty; } } } - Rebuild and run the app. Add todo items to test the new code.
No comments:
Post a Comment