Skip to content

Commit fe33fa7

Browse files
authored
Terminology consistency updates (#31183)
1 parent 050c281 commit fe33fa7

28 files changed

+147
-134
lines changed

aspnetcore/blazor/call-web-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This article describes how to call a web API from a Blazor app.
2323
:::zone pivot="webassembly"
2424

2525
> [!NOTE]
26-
> This article has loaded **WebAssembly** render mode coverage for calling web APIs. The [Server render mode coverage](?pivots=server) addresses the following subjects:
26+
> This article has loaded **WebAssembly** client-side rendering (CSR) coverage for calling web APIs. The [coverage for **Server** interactive server-side rendering (interactive SSR)](?pivots=server) addresses the following subjects:
2727
>
2828
> * Use of the `HttpClient` factory infrastructure to provide an `HttpClient` to the app.
2929
> * Cross-Origin Resource Sharing (CORS) pertaining to server-side components.
@@ -61,7 +61,7 @@ The Blazor examples that demonstrate obtaining weather data from a server API ar
6161

6262
:::moniker range=">= aspnetcore-8.0"
6363

64-
For server-side components in Blazor Web Apps that require interactivity, add Interactive Server rendering to the component:
64+
For server-side components in Blazor Web Apps that require interactivity, add interactive server-side rendering (interactive SSR) to the component:
6565

6666
```razor
6767
@rendermode InteractiveServer
@@ -750,7 +750,7 @@ For more information, see <xref:blazor/fundamentals/handle-errors>.
750750
:::zone pivot="server"
751751

752752
> [!NOTE]
753-
> This article has loaded **Server** render mode coverage for calling web APIs. The [WebAssembly render mode coverage](?pivots=webassembly) addresses the following subjects:
753+
> This article has loaded **Server** interactive server-side rendering (interactive SSR) coverage for calling web APIs. The [**WebAssembly** client-side rendering (CSR) coverage](?pivots=webassembly) addresses the following subjects:
754754
>
755755
> * Client-side examples that call a web API to create, read, update, and delete todo list items.
756756
> * `System.Net.Http.Json` package.

aspnetcore/blazor/components/cascading-values-and-parameters.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Wrap the markup of the `Routes` component in a [`CascadingValue`](xref:Microsoft
151151
}
152152
```
153153

154-
In the `App` component (`Components/App.razor`), adopt an interactive render mode for the entire app. The following example adopts Interactive Server rendering:
154+
In the `App` component (`Components/App.razor`), adopt an interactive render mode for the entire app. The following example adopts interactive server-side rendering (interactive SSR):
155155

156156
```razor
157157
<Routes @rendermode="InteractiveServer" />
@@ -317,10 +317,10 @@ Similar to a regular component parameter, components accepting a cascading param
317317
318318
Cascading parameters don't pass data across render mode boundaries:
319319
320-
* Interactive sessions run in a different context than the Static Server-rendered pages. There's no requirement that the server producing the page is even the same machine that hosts some later Interactive Server session, including for WebAssembly components where the server is a different machine to the client. The benefit of Static Server rendering is to gain the full performance of pure stateless HTML rendering.
320+
* Interactive sessions run in a different context than the pages that use static server-side rendering (static SSR). There's no requirement that the server producing the page is even the same machine that hosts some later Interactive Server session, including for WebAssembly components where the server is a different machine to the client. The benefit of static server-side rendering (static SSR) is to gain the full performance of pure stateless HTML rendering.
321321
322-
* State crossing the boundary between static and interactive rendering must be serializable. Components are arbitrary objects that reference a vast chain of other objects, including the renderer, the DI container, and every DI service instance. You must explicitly cause state to be serialized from Static Server rendering to make it available in subsequent interactively-rendered components. Two approaches are adopted:
323-
* Via the Blazor framework, parameters passed across a Static Server rendering to interactive boundary are serialized automatically if they're JSON-serializable, or an error is thrown.
322+
* State crossing the boundary between static and interactive rendering must be serializable. Components are arbitrary objects that reference a vast chain of other objects, including the renderer, the DI container, and every DI service instance. You must explicitly cause state to be serialized from static SSR to make it available in subsequent interactively-rendered components. Two approaches are adopted:
323+
* Via the Blazor framework, parameters passed across a static SSR to interactive rendering boundary are serialized automatically if they're JSON-serializable, or an error is thrown.
324324
* State stored in [`PersistentComponentState`](xref:blazor/components/prerendering-and-integration#persist-prerendered-state) is serialized and recovered automatically if it's JSON-serializable, or an error is thrown.
325325
326326
Cascading parameters aren't JSON-serialize because the typical usage patterns for cascading parameters are somewhat like DI services. There are often platform-specific variants of cascading parameters, so it would be unhelpful to developers if the framework stopped developers from having server-interactive-specific versions or WebAssembly-specific versions. Also, many cascading parameter values in general aren't serializable, so it would be impractical to update existing apps if you had to stop using all nonserializable cascading parameter values.

aspnetcore/blazor/components/class-libraries-and-static-server-side-rendering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This article provides guidance for component library authors considering support
2020

2121
Blazor encourages the development of an ecosystem of open-source and commercial component libraries, formally called *Razor class libraries (RCLs)*. Developers might also create reusable components for sharing components privately across apps within their own companies. Ideally, components are developed for compatibility with as many hosting models and rendering modes as possible. Static SSR introduces additional restrictions that can be more challenging to support than interactive rendering modes.
2222

23-
## Understand the capabilities and restrictions of Static SSR
23+
## Understand the capabilities and restrictions of static SSR
2424

2525
Static SSR is a mode in which components run when the server handles an incoming HTTP request. Blazor renders the component as HTML, which is included in the response. Once the response is sent, the server-side component and renderer state is discarded, so all that remains is HTML in the browser.
2626

aspnetcore/blazor/components/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -907,7 +907,7 @@ Quote &copy;2005 [Universal Pictures](https://www.uphe.com): [Serenity](https://
907907

908908
## Route parameters
909909

910-
Components can specify route parameters in the route template of the [`@page`][9] directive. The [Blazor Router](xref:blazor/fundamentals/routing) uses route parameters to populate corresponding component parameters.
910+
Components can specify route parameters in the route template of the [`@page`][9] directive. The [Blazor router](xref:blazor/fundamentals/routing) uses route parameters to populate corresponding component parameters.
911911

912912
:::moniker range=">= aspnetcore-5.0"
913913

aspnetcore/blazor/components/integration.md

+27-30
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ Use the guidance in the following sections depending on the project's requiremen
3030

3131
This section covers adding Blazor support to an ASP.NET Core app:
3232

33-
* [Add Static Server Razor component rendering](#add-static-server-razor-component-rendering)
34-
* [Enable Interactive Server rendering](#enable-interactive-server-rendering)
35-
* [Enable interactive Auto or WebAssembly rendering](#enable-interactive-auto-and-webassembly-rendering)
33+
* [Add static server-side rendering (static SSR)](#add-static-server-side-rendering-static-ssr)
34+
* [Enable interactive server-side rendering (interactive SSR)](#enable-interactive-server-side-rendering-interactive-ssr)
35+
* [Enable interactive automatic (Auto) or client-side rendering (CSR)](#enable-interactive-automatic-auto-or-client-side-rendering-csr)
3636

3737
> [!NOTE]
3838
> For the examples in this section, the example app's name and namespace is `BlazorSample`.
3939
40-
### Add Static Server Razor component rendering
40+
### Add static server-side rendering (static SSR)
4141

4242
Add a `Components` folder to the app.
4343

@@ -60,7 +60,7 @@ Add the following `_Imports` file for namespaces used by Razor components.
6060

6161
Change the namespace `BlazorSample` in the preceding example to match the app.
6262

63-
Add the Blazor Router (`<Router>`, <xref:Microsoft.AspNetCore.Components.Routing.Router>) to the app in a `Routes` component, which is placed in the app's `Components` folder.
63+
Add the Blazor router (`<Router>`, <xref:Microsoft.AspNetCore.Components.Routing.Router>) to the app in a `Routes` component, which is placed in the app's `Components` folder.
6464

6565
`Components/Routes.razor`:
6666

@@ -113,7 +113,7 @@ For the `<link>` element in the preceding example, change `BlazorSample` in the
113113

114114
Add a `Pages` folder to the `Components` folder to hold routable Razor components.
115115

116-
Add the following `Welcome` component to demonstrate Static Server rendering.
116+
Add the following `Welcome` component to demonstrate static SSR.
117117

118118
`Components/Pages/Welcome.razor`:
119119

@@ -162,27 +162,25 @@ In the ASP.NET Core project's `Program` file:
162162

163163
When the app is run, the `Welcome` component is accessed at the `/welcome` endpoint.
164164

165-
### Enable Interactive Server rendering
165+
### Enable interactive server-side rendering (interactive SSR)
166166

167-
Follow the guidance in the [Add Static Server Razor component rendering](#add-static-server-razor-component-rendering) section.
167+
Follow the guidance in the [Add static server-side rendering (static SSR)](#add-static-server-side-rendering-static-ssr) section.
168168

169-
Make the following changes in the app's `Program` file:
169+
In the app's `Program` file, add a call to <xref:Microsoft.Extensions.DependencyInjection.ServerRazorComponentsBuilderExtensions.AddInteractiveServerComponents%2A> where Razor component services are added with <xref:Microsoft.Extensions.DependencyInjection.RazorComponentsServiceCollectionExtensions.AddRazorComponents%2A>:
170170

171-
* Add a call to <xref:Microsoft.Extensions.DependencyInjection.ServerRazorComponentsBuilderExtensions.AddInteractiveServerComponents%2A> where Razor component services are added with <xref:Microsoft.Extensions.DependencyInjection.RazorComponentsServiceCollectionExtensions.AddRazorComponents%2A>:
172-
173-
```csharp
174-
builder.Services.AddRazorComponents()
175-
.AddInteractiveServerComponents();
176-
```
171+
```csharp
172+
builder.Services.AddRazorComponents()
173+
.AddInteractiveServerComponents();
174+
```
177175

178-
* Add a call to <xref:Microsoft.AspNetCore.Builder.ServerRazorComponentsEndpointConventionBuilderExtensions.AddInteractiveServerRenderMode%2A> where Razor components are mapped with <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A>:
176+
Also in the `Program` file, add a call to <xref:Microsoft.AspNetCore.Builder.ServerRazorComponentsEndpointConventionBuilderExtensions.AddInteractiveServerRenderMode%2A> where Razor components are mapped with <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A>:
179177

180-
```csharp
181-
app.MapRazorComponents<App>()
182-
.AddInteractiveServerRenderMode();
183-
```
178+
```csharp
179+
app.MapRazorComponents<App>()
180+
.AddInteractiveServerRenderMode();
181+
```
184182

185-
Add the following `Counter` component to the app that adopts the Interactive Server render mode.
183+
Add the following `Counter` component to the app that adopts interactive server-side rendering (interactive SSR).
186184

187185
`Components/Pages/Counter.razor`:
188186

@@ -210,16 +208,16 @@ Add the following `Counter` component to the app that adopts the Interactive Ser
210208

211209
When the app is run, the `Counter` component is accessed at `/counter`.
212210

213-
### Enable interactive Auto and WebAssembly rendering
211+
### Enable interactive automatic (Auto) or client-side rendering (CSR)
214212

215-
Follow the guidance in the [Add Static Server Razor component rendering](#add-static-server-razor-component-rendering) section.
213+
Follow the guidance in the [Add static server-side rendering (static SSR)](#add-static-server-side-rendering-static-ssr) section.
216214

217-
Components using the Auto render mode initially use Interactive Server rendering, but then switch to render on the client after the Blazor bundle has been downloaded and the Blazor runtime activates. Components using the WebAssembly render mode only render interactively on the client after the Blazor bundle is downloaded and the Blazor runtime activates. Keep in mind that when using the Auto or WebAssembly render modes, component code downloaded to the client is ***not*** private. For more information, see <xref:blazor/components/render-modes>.
215+
Components using the Interactive Auto render mode initially use interactive SSR, but then switch to render on the client after the Blazor bundle has been downloaded and the Blazor runtime activates. Components using the Interactive WebAssembly render mode only render interactively on the client after the Blazor bundle is downloaded and the Blazor runtime activates. Keep in mind that when using the Interactive Auto or Interactive WebAssembly render modes, component code downloaded to the client is ***not*** private. For more information, see <xref:blazor/components/render-modes>.
218216

219217
After deciding which render mode to adopt:
220218

221-
* If you plan to adopt the Auto render mode, follow the guidance in the [Enable Interactive Server rendering](#enable-interactive-server-rendering) section.
222-
* If you plan to only adopt Interactive WebAssembly rendering, continue without adding Interactive Server rendering.
219+
* If you plan to adopt the Interactive Auto render mode, follow the guidance in the [Enable interactive server-side rendering (interactive SSR)](#enable-interactive-server-side-rendering-interactive-ssr) section.
220+
* If you plan to only adopt Interactive WebAssembly rendering, continue without adding interactive SSR.
223221

224222
Add a package reference for the [`Microsoft.AspNetCore.Components.WebAssembly.Server`](https://www.nuget.org/packages/Microsoft.AspNetCore.Components.WebAssembly.Server) NuGet package to the app.
225223

@@ -300,7 +298,7 @@ Make the following changes to the ASP.NET Core app's `Program` file:
300298

301299
* Add the Interactive WebAssembly render mode (<xref:Microsoft.AspNetCore.Builder.WebAssemblyRazorComponentsEndpointConventionBuilderExtensions.AddInteractiveWebAssemblyRenderMode%2A>) and additional assemblies for the `.Client` project where Razor components are mapped with <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A>.
302300

303-
For interactive Auto rendering:
301+
For interactive automatic (Auto) rendering:
304302

305303
```csharp
306304
app.MapRazorComponents<App>()
@@ -430,7 +428,7 @@ builder.Services.AddRazorComponents()
430428

431429
For more information on adding support for Interactive Server and WebAssembly components, see <xref:blazor/components/render-modes>.
432430

433-
In the `Program` file immediately after the call to map Razor Pages (<xref:Microsoft.AspNetCore.Builder.RazorPagesEndpointRouteBuilderExtensions.MapRazorPages%2A>), call <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A> to discover available components and specify the app's root component (the first component loaded). By default, the app's root component is the `App` component (`App.razor`). Chain a call to `AddInteractiveInteractiveServerRenderMode` to configure the Server render mode for the app:
431+
In the `Program` file immediately after the call to map Razor Pages (<xref:Microsoft.AspNetCore.Builder.RazorPagesEndpointRouteBuilderExtensions.MapRazorPages%2A>), call <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A> to discover available components and specify the app's root component (the first component loaded). By default, the app's root component is the `App` component (`App.razor`). Chain a call to `AddInteractiveInteractiveServerRenderMode` to configure interactive server-side rendering (interactive SSR) for the app:
434432

435433
```csharp
436434
app.MapRazorComponents<App>()
@@ -755,7 +753,7 @@ builder.Services.AddRazorComponents()
755753

756754
For more information on adding support for Interactive Server and WebAssembly components, see <xref:blazor/components/render-modes>.
757755

758-
In the `Program` file immediately after the call to map Razor Pages (<xref:Microsoft.AspNetCore.Builder.RazorPagesEndpointRouteBuilderExtensions.MapRazorPages%2A>), call <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A> to discover available components and specify the app's root component. By default, the app's root component is the `App` component (`App.razor`). Chain a call to <xref:Microsoft.AspNetCore.Builder.ServerRazorComponentsEndpointConventionBuilderExtensions.AddInteractiveServerRenderMode%2A> to configure the Server render mode for the app:
756+
In the `Program` file immediately after the call to map Razor Pages (<xref:Microsoft.AspNetCore.Builder.RazorPagesEndpointRouteBuilderExtensions.MapRazorPages%2A>), call <xref:Microsoft.AspNetCore.Builder.RazorComponentsEndpointRouteBuilderExtensions.MapRazorComponents%2A> to discover available components and specify the app's root component. By default, the app's root component is the `App` component (`App.razor`). Chain a call to <xref:Microsoft.AspNetCore.Builder.ServerRazorComponentsEndpointConventionBuilderExtensions.AddInteractiveServerRenderMode%2A> to configure interactive server-side rendering (interactive SSR) for the app:
759757

760758
```csharp
761759
app.MapRazorComponents<App>()
@@ -851,4 +849,3 @@ For more information, see <xref:blazor/components/index#class-name-and-namespace
851849
## Additional resources
852850

853851
<xref:blazor/components/prerender>
854-

aspnetcore/blazor/components/quickgrid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ For example, add the following component to render a grid.
8080
}
8181
```
8282

83-
The preceding example specifies server rendering (`@rendermode InteractiveServer`), which enables the `QuickGrid`'s interactive features. In this case, the only interactive feature is sortable columns.
83+
The preceding example specifies interactive server-side rendering (interactive SSR) with `@rendermode InteractiveServer`, which enables the `QuickGrid`'s interactive features. In this case, the only interactive feature is sortable columns.
8484

8585
For an example that uses an <xref:System.Linq.IQueryable> with Entity Framework Core as the queryable data source, see the [`SampleQuickGridComponent` component in the ASP.NET Core Basic Test App (`dotnet/aspnetcore` GitHub repository)](https://github.com/dotnet/aspnetcore/blob/main/src/Components/test/testassets/BasicTestApp/QuickGridTest/SampleQuickGridComponent.razor).
8686

0 commit comments

Comments
 (0)