BlazorPageScript 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package BlazorPageScript --version 1.0.0
                    


                    

                
NuGet\Install-Package BlazorPageScript -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BlazorPageScript" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="BlazorPageScript" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="BlazorPageScript" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add BlazorPageScript --version 1.0.0
                    


                    

                
#r "nuget: BlazorPageScript, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package BlazorPageScript@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=BlazorPageScript&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=BlazorPageScript&version=1.0.0
                    


                            Install as a Cake Tool

BlazorPageScript

A Blazor <PageScript> component enabling per-page JavaScript navigation callbacks.

This allows Blazor Web applications to have page-specific JavaScript that works with enhanced navigation enabled or disabled.

Basic usage

Example.razor

@page "/example"

<PageTitle>Example</PageTitle>

<PageScript Src="./Example.razor.js" />

Welcome to the example page.

Example.razor.js

// Called when the script first gets loaded on the page.
export function onLoad() {
    console.log('Load');
}

// Called when an enhanced page update occurs, plus once immediately after
// the initial load.
export function onUpdate() {
    console.log('Update');
}

// Called when an enhanced page update removes the script from the page.
export function onDispose() {
    console.log('Dispose');
}

Take a look at the samples folder in this repository for more usage examples.

Expected usage patterns

A <PageScript> in a @page component

This is expected to be the most common use case. This allows pages to put initialization logic in onLoad and cleanup logic in onDispose, while reacting to enhanced page updates in onUpdate.

A <PageScript> in the application's layout

A <PageScript> placed in the app's layout will get its onLoad callback invoked once per full page load and the onUpdate callback invoked once per enhanced page update.

Other notes

Duplicating <PageScript> components with the same Src won't cause duplicate callback invocations. Likewise, if multiple pages render <PageScript> components with the same Src, then an enhanced navigation between those pages won't invoke the onDispose and onLoad callbacks.

If you want to override this behavior, you can deduplicate two <PageScript> components by giving them unique querystring values in their Src parameters. For example:

Home.razor

<PageScript Src="./common-logic.js?home" />

Counter.razor

<PageScript Src="./common-logic.js?counter" />
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on BlazorPageScript:

Package Downloads
Osirion.Blazor.Core

Core components and utilities for Osirion.Blazor ecosystem. This package provides the foundation for building SSR-compatible Blazor components.
LEC.Blazor.Recaptcha

Package Description
LEC.Blazor.Localization.Client

Package Description

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on BlazorPageScript:

Repository Stars
fdonnet/ubik_accounting
Double entry accounting app in Net 9
Version Downloads Last Updated
1.0.0 69,828 11/16/2023
0.1.0-preview.2 307 11/3/2023
0.1.0-preview.1 113 11/3/2023