Skip to content

Latest commit

 

History

History
1853 lines (1267 loc) · 68.5 KB

call-dotnet-from-javascript.md

File metadata and controls

1853 lines (1267 loc) · 68.5 KB
Raw
title author description monikerRange ms.author ms.custom ms.date uid
Call .NET methods from JavaScript functions in ASP.NET Core Blazor
guardrex
Learn how to invoke .NET methods from JavaScript functions in Blazor apps.
>= aspnetcore-3.1
riande
mvc
03/08/2023
blazor/js-interop/call-dotnet-from-javascript

Call .NET methods from JavaScript functions in ASP.NET Core Blazor

[!INCLUDE]

This article explains how to invoke .NET methods from JavaScript (JS).

For information on how to call JS functions from .NET, see xref:blazor/js-interop/call-javascript-from-dotnet.

[!INCLUDE]

Invoke a static .NET method

To invoke a static .NET method from JavaScript (JS), use the JS functions:

  • DotNet.invokeMethodAsync (recommended): Asynchronous for both server-side and client-side components.
  • DotNet.invokeMethod: Synchronous for client-side components only.

Pass in the name of the assembly containing the method, the identifier of the static .NET method, and any arguments.

In the following example:

  • The {ASSEMBLY NAME} placeholder is the app's assembly name.
  • The {.NET METHOD ID} placeholder is the .NET method identifier.
  • The {ARGUMENTS} placeholder are optional, comma-separated arguments to pass to the method, each of which must be JSON-serializable.
DotNet.invokeMethodAsync('{ASSEMBLY NAME}', '{.NET METHOD ID}', {ARGUMENTS});

DotNet.invokeMethodAsync returns a JS Promise representing the result of the operation. DotNet.invokeMethod (client-side components) returns the result of the operation.

Important

For server-side components, we recommend the asynchronous function (invokeMethodAsync) over the synchronous version (invokeMethod).

The .NET method must be public, static, and have the [JSInvokable] attribute.

In the following example:

  • The {<T>} placeholder indicates the return type, which is only required for methods that return a value.
  • The {.NET METHOD ID} placeholder is the method identifier.
@code {
    [JSInvokable]
    public static Task{<T>} {.NET METHOD ID}()
    {
        ...
    }
}

Note

Calling open generic methods isn't supported with static .NET methods but is supported with instance methods. For more information, see the Call .NET generic class methods section.

In the following CallDotNetExample1 component, the ReturnArrayAsync C# method returns an int array. The [JSInvokable] attribute is applied to the method, which makes the method invokable by JS.

CallDotNetExample1.razor:

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

@page "/call-dotnet-example-1"
@rendermode InteractiveServer

<h1>Call .NET Example 1</h1>

<p>
    <button onclick="returnArrayAsync()">
        Trigger .NET static method
    </button>
</p>

@code {
    [JSInvokable]
    public static Task<int[]> ReturnArrayAsync()
    {
        return Task.FromResult(new int[] { 1, 2, 3 });
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample1.razor" highlight="12-16":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample1.razor" highlight="12-16":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample1.razor" highlight="12-16":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample1.razor" highlight="12-16":::

:::moniker-end

The <button> element's onclick HTML attribute is JavaScript's onclick event handler assignment for processing click events, not Blazor's @onclick directive attribute. The returnArrayAsync JS function is assigned as the handler.

The following returnArrayAsync JS function, calls the ReturnArrayAsync .NET method of the preceding CallDotNetExample1 component and logs the result to the browser's web developer tools console. BlazorSample is the app's assembly name.

<script>
  window.returnArrayAsync = () => {
    DotNet.invokeMethodAsync('BlazorSample', 'ReturnArrayAsync')
      .then(data => {
        console.log(data);
      });
    };
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

When the Trigger .NET static method button is selected, the browser's developer tools console output displays the array data. The format of the output differs slightly among browsers. The following output shows the format used by Microsoft Edge:

Array(3) [ 1, 2, 3 ]

Pass data to a .NET method when calling the invokeMethodAsync function by passing the data as arguments.

To demonstrate passing data to .NET, make the preceding returnArrayAsync JS function receive a starting position when the function is called and pass the value as an argument to the invokeMethodAsync function:

<script>
  window.returnArrayAsync = (startPosition) => {
    DotNet.invokeMethodAsync('BlazorSample', 'ReturnArrayAsync', startPosition)
      .then(data => {
        console.log(data);
      });
    };
</script>

In the CallDotNetExample1 component, change the function call to include a starting position. The following example uses a value of 5:

<button onclick="returnArrayAsync(5)">
    ...
</button>

The component's invokable ReturnArrayAsync method receives the starting position and constructs the array from it. The array is returned for logging to the console:

[JSInvokable]
public static Task<int[]> ReturnArrayAsync(int startPosition)
{
    return Task.FromResult(Enumerable.Range(startPosition, 3).ToArray());
}

After the app is recompiled and the browser is refreshed, the following output appears in the browser's console when the button is selected:

Array(3) [ 5, 6, 7 ]

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

By default, the .NET method identifier for the JS call is the .NET method name, but you can specify a different identifier using the [JSInvokable] attribute constructor. In the following example, DifferentMethodName is the assigned method identifier for the ReturnArrayAsync method:

[JSInvokable("DifferentMethodName")]

:::moniker-end

In the call to DotNet.invokeMethodAsync (server-side or client-side components) or DotNet.invokeMethod (client-side components only), call DifferentMethodName to execute the ReturnArrayAsync .NET method:

  • DotNet.invokeMethodAsync('BlazorSample', 'DifferentMethodName');
  • DotNet.invokeMethod('BlazorSample', 'DifferentMethodName'); (client-side components only)

Note

The ReturnArrayAsync method example in this section returns the result of a xref:System.Threading.Tasks.Task without the use of explicit C# async and await keywords. Coding methods with async and await is typical of methods that use the await keyword to return the value of asynchronous operations.

ReturnArrayAsync method composed with async and await keywords:

[JSInvokable]
public static async Task<int[]> ReturnArrayAsync()
{
    return await Task.FromResult(new int[] { 1, 2, 3 });
}

For more information, see Asynchronous programming with async and await in the C# guide.

Create JavaScript object and data references to pass to .NET

Call DotNet.createJSObjectReference(jsObject) to construct a JS object reference so that it can be passed to .NET, where jsObject is the JS Object used to create the JS object reference. The following example passes a reference to the non-serializable window object to .NET, which receives it in the ReceiveWindowObject C# method as an xref:Microsoft.JSInterop.IJSObjectReference:

DotNet.invokeMethodAsync('{ASSEMBLY NAME}', 'ReceiveWindowObject', 
  DotNet.createJSObjectReference(window));
[JSInvokable]
public static void ReceiveWindowObject(IJSObjectReference objRef)
{
    ...
}

In the preceding example, the {ASSEMBLY NAME} placeholder is the app's namespace.

Note

The preceding example doesn't require disposal of the JSObjectReference, as a reference to the window object isn't held in JS.

Maintaining a reference to a JSObjectReference requires disposing of it to avoid leaking JS memory on the client. The following example refactors the preceding code to capture a reference to the JSObjectReference, followed by a call to DotNet.disposeJSObjectReference() to dispose of the reference:

var jsObjectReference = DotNet.createJSObjectReference(window);

DotNet.invokeMethodAsync('{ASSEMBLY NAME}', 'ReceiveWindowObject', jsObjectReference);

DotNet.disposeJSObjectReference(jsObjectReference);

In the preceding example, the {ASSEMBLY NAME} placeholder is the app's namespace.

Call DotNet.createJSStreamReference(streamReference) to construct a JS stream reference so that it can be passed to .NET, where streamReference is an ArrayBuffer, Blob, or any typed array, such as Uint8Array or Float32Array, used to create the JS stream reference.

Invoke an instance .NET method

To invoke an instance .NET method from JavaScript (JS):

  • Pass the .NET instance by reference to JS by wrapping the instance in a xref:Microsoft.JSInterop.DotNetObjectReference and calling xref:Microsoft.JSInterop.DotNetObjectReference.Create%2A on it.

  • Invoke a .NET instance method from JS using invokeMethodAsync (recommended) or invokeMethod (client-side components only) from the passed xref:Microsoft.JSInterop.DotNetObjectReference. Pass the identifier of the instance .NET method and any arguments. The .NET instance can also be passed as an argument when invoking other .NET methods from JS.

    In the following example:

    • dotNetHelper is a xref:Microsoft.JSInterop.DotNetObjectReference.
    • The {.NET METHOD ID} placeholder is the .NET method identifier.
    • The {ARGUMENTS} placeholder are optional, comma-separated arguments to pass to the method, each of which must be JSON-serializable.
    dotNetHelper.invokeMethodAsync('{.NET METHOD ID}', {ARGUMENTS});

    [!NOTE] invokeMethodAsync and invokeMethod don't accept an assembly name parameter when invoking an instance method.

    invokeMethodAsync returns a JS Promise representing the result of the operation. invokeMethod (client-side components only) returns the result of the operation.

    [!IMPORTANT] For server-side components, we recommend the asynchronous function (invokeMethodAsync) over the synchronous version (invokeMethod).

  • Dispose of the xref:Microsoft.JSInterop.DotNetObjectReference.

The following sections of this article demonstrate various approaches for invoking an instance .NET method:

:::moniker range=">= aspnetcore-6.0"

:::moniker-end

:::moniker range="< aspnetcore-6.0"

:::moniker-end

:::moniker range=">= aspnetcore-6.0"

Avoid trimming JavaScript-invokable .NET methods

This section applies to client-side apps with ahead-of-time (AOT) compilation and runtime relinking enabled.

Several of the examples in the following sections are based on a class instance approach, where the JavaScript-invokable .NET method marked with the [JSInvokable] attribute is a member of a class that isn't a Razor component. When such .NET methods are located in a Razor component, they're protected from runtime relinking/trimming. In order to protect the .NET methods from trimming outside of Razor components, implement the methods with the DynamicDependency attribute on the class's constructor, as the following example demonstrates:

using System.Diagnostics.CodeAnalysis;
using Microsoft.JSInterop;

public class ExampleClass {

    [DynamicDependency(nameof(ExampleJSInvokableMethod))]
    public ExampleClass()
    {
    }

    [JSInvokable]
    public string ExampleJSInvokableMethod()
    {
        ...
    }
}

For more information, see Prepare .NET libraries for trimming: DynamicDependency.

:::moniker-end

Pass a DotNetObjectReference to an individual JavaScript function

The example in this section demonstrates how to pass a xref:Microsoft.JSInterop.DotNetObjectReference to an individual JavaScript (JS) function.

The following sayHello1 JS function receives a xref:Microsoft.JSInterop.DotNetObjectReference and calls invokeMethodAsync to call the GetHelloMessage .NET method of a component:

<script>
  window.sayHello1 = (dotNetHelper) => {
    return dotNetHelper.invokeMethodAsync('GetHelloMessage');
  };
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

For the following CallDotNetExample2 component:

  • The component has a JS-invokable .NET method named GetHelloMessage.
  • When the Trigger .NET instance method button is selected, the JS function sayHello1 is called with the xref:Microsoft.JSInterop.DotNetObjectReference.
  • sayHello1:
    • Calls GetHelloMessage and receives the message result.
    • Returns the message result to the calling TriggerDotNetInstanceMethod method.
  • The returned message from sayHello1 in result is displayed to the user.
  • To avoid a memory leak and allow garbage collection, the .NET object reference created by xref:Microsoft.JSInterop.DotNetObjectReference is disposed in the Dispose method.

CallDotNetExample2.razor:

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

@page "/call-dotnet-example-2"
@rendermode InteractiveServer
@implements IDisposable
@inject IJSRuntime JS

<h1>Call .NET Example 2</h1>

<p>
    <label>
        Name: <input @bind="name" />
    </label>
</p>

<p>
    <button @onclick="TriggerDotNetInstanceMethod">
        Trigger .NET instance method
    </button>
</p>

<p>
    @result
</p>

@code {
    private string? name;
    private string? result;
    private DotNetObjectReference<CallDotNetExample2>? objRef;

    protected override void OnInitialized()
    {
        objRef = DotNetObjectReference.Create(this);
    }

    public async Task TriggerDotNetInstanceMethod()
    {
        result = await JS.InvokeAsync<string>("sayHello1", objRef);
    }

    [JSInvokable]
    public string GetHelloMessage() => $"Hello, {name}!";

    public void Dispose()
    {
        objRef?.Dispose();
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample2.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample2.razor":::

:::moniker-end

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

Use the following guidance to pass arguments to an instance method:

Add parameters to the .NET method invocation. In the following example, a name is passed to the method. Add additional parameters to the list as needed.

<script>
  window.sayHello2 = (dotNetHelper, name) => {
    return dotNetHelper.invokeMethodAsync('GetHelloMessage', name);
  };
</script>

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

Provide the parameter list to the .NET method.

CallDotNetExample3.razor:

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

@page "/call-dotnet-example-3"
@rendermode InteractiveServer
@implements IDisposable
@inject IJSRuntime JS

<h1>Call .NET Example 3</h1>

<p>
    <label>
        Name: <input @bind="name" />
    </label>
</p>

<p>
    <button @onclick="TriggerDotNetInstanceMethod">
        Trigger .NET instance method
    </button>
</p>

<p>
    @result
</p>

@code {
    private string? name;
    private string? result;
    private DotNetObjectReference<CallDotNetExample3>? objRef;

    protected override void OnInitialized()
    {
        objRef = DotNetObjectReference.Create(this);
    }

    public async Task TriggerDotNetInstanceMethod()
    {
        result = await JS.InvokeAsync<string>("sayHello2", objRef, name);
    }

    [JSInvokable]
    public string GetHelloMessage(string passedName) => $"Hello, {passedName}!";

    public void Dispose()
    {
        objRef?.Dispose();
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample3.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample3.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample3.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample3.razor":::

:::moniker-end

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

Pass a DotNetObjectReference to a class with multiple JavaScript functions

The example in this section demonstrates how to pass a xref:Microsoft.JSInterop.DotNetObjectReference to a JavaScript (JS) class with multiple functions.

Create and pass a xref:Microsoft.JSInterop.DotNetObjectReference from the OnAfterRenderAsync lifecycle method to a JS class for multiple functions to use. Make sure that the .NET code disposes of the xref:Microsoft.JSInterop.DotNetObjectReference, as the following example shows.

In the following CallDotNetExampleOneHelper component, the Trigger JS function buttons call JS functions by setting the JS onclick property, not Blazor's @onclick directive attribute.

CallDotNetExampleOneHelper.razor:

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

@page "/call-dotnet-example-one-helper"
@rendermode InteractiveServer
@implements IDisposable
@inject IJSRuntime JS

<PageTitle>Call .NET Example</PageTitle>

<h1>Pass <code>DotNetObjectReference</code> to a JavaScript class</h1>

<p>
    <label>
        Message: <input @bind="name" />
    </label>
</p>

<p>
    <button onclick="GreetingHelpers.sayHello()">
        Trigger JS function <code>sayHello</code>
    </button>
</p>

<p>
    <button onclick="GreetingHelpers.welcomeVisitor()">
        Trigger JS function <code>welcomeVisitor</code>
    </button>
</p>

@code {
    private string? name;
    private DotNetObjectReference<CallDotNetExampleOneHelper>? dotNetHelper;

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender)
        {
            dotNetHelper = DotNetObjectReference.Create(this);
            await JS.InvokeVoidAsync("GreetingHelpers.setDotNetHelper", 
                dotNetHelper);
        }
    }

    [JSInvokable]
    public string GetHelloMessage() => $"Hello, {name}!";

    [JSInvokable]
    public string GetWelcomeMessage() => $"Welcome, {name}!";

    public void Dispose()
    {
        dotNetHelper?.Dispose();
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-8.0"

@page "/call-dotnet-example-one-helper"
@implements IDisposable
@inject IJSRuntime JS

<PageTitle>Call .NET Example</PageTitle>

<h1>Pass <code>DotNetObjectReference</code> to a JavaScript class</h1>

<p>
    <label>
        Message: <input @bind="name" />
    </label>
</p>

<p>
    <button onclick="GreetingHelpers.sayHello()">
        Trigger JS function <code>sayHello</code>
    </button>
</p>

<p>
    <button onclick="GreetingHelpers.welcomeVisitor()">
        Trigger JS function <code>welcomeVisitor</code>
    </button>
</p>

@code {
    private string? name;
    private DotNetObjectReference<CallDotNetExampleOneHelper>? dotNetHelper;

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender)
        {
            dotNetHelper = DotNetObjectReference.Create(this);
            await JS.InvokeVoidAsync("GreetingHelpers.setDotNetHelper", 
                dotNetHelper);
        }
    }

    [JSInvokable]
    public string GetHelloMessage() => $"Hello, {name}!";

    [JSInvokable]
    public string GetWelcomeMessage() => $"Welcome, {name}!";

    public void Dispose()
    {
        dotNetHelper?.Dispose();
    }
}

:::moniker-end

:::moniker range="< aspnetcore-6.0"

@page "/call-dotnet-example-one-helper"
@implements IDisposable
@inject IJSRuntime JS

<PageTitle>Call .NET Example</PageTitle>

<h1>Pass <code>DotNetObjectReference</code> to a JavaScript class</h1>

<p>
    <label>
        Message: <input @bind="name" />
    </label>
</p>

<p>
    <button onclick="GreetingHelpers.sayHello()">
        Trigger JS function <code>sayHello</code>
    </button>
</p>

<p>
    <button onclick="GreetingHelpers.welcomeVisitor()">
        Trigger JS function <code>welcomeVisitor</code>
    </button>
</p>

@code {
    private string name;
    private DotNetObjectReference<CallDotNetExampleOneHelper>? dotNetHelper;

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender)
        {
            dotNetHelper = DotNetObjectReference.Create(this);
            await JS.InvokeVoidAsync("GreetingHelpers.setDotNetHelper", 
                dotNetHelper);
        }
    }

    [JSInvokable]
    public string GetHelloMessage() => $"Hello, {name}!";

    [JSInvokable]
    public string GetWelcomeMessage() => $"Welcome, {name}!";

    public void Dispose()
    {
        if (dotNetHelper is not null)
        {
            dotNetHelper.Dispose();
        }
    }
}

:::moniker-end

In the preceding example:

  • JS is an injected xref:Microsoft.JSInterop.IJSRuntime instance. xref:Microsoft.JSInterop.IJSRuntime is registered by the Blazor framework.
  • The variable name dotNetHelper is arbitrary and can be changed to any preferred name.
  • The component must explicitly dispose of the xref:Microsoft.JSInterop.DotNetObjectReference to permit garbage collection and prevent a memory leak.
<script>
  class GreetingHelpers {
    static dotNetHelper;

    static setDotNetHelper(value) {
      GreetingHelpers.dotNetHelper = value;
    }

    static async sayHello() {
      const msg = 
        await GreetingHelpers.dotNetHelper.invokeMethodAsync('GetHelloMessage');
      alert(`Message from .NET: "${msg}"`);
    }

    static async welcomeVisitor() {
      const msg = 
        await GreetingHelpers.dotNetHelper.invokeMethodAsync('GetWelcomeMessage');
      alert(`Message from .NET: "${msg}"`);
    }
  }
    
  window.GreetingHelpers = GreetingHelpers;
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

In the preceding example:

  • The GreetingHelpers class is added to the window object to globally define the class, which permits Blazor to locate the class for JS interop.
  • The variable name dotNetHelper is arbitrary and can be changed to any preferred name.

:::moniker range=">= aspnetcore-6.0"

Call .NET generic class methods

JavaScript (JS) functions can call .NET generic class methods, where a JS function calls a .NET method of a generic class.

In the following generic type class (GenericType<TValue>):

  • The class has a single type parameter (TValue) with a single generic Value property.
  • The class has two non-generic methods marked with the [JSInvokable] attribute, each with a generic type parameter named newValue:
    • Update synchronously updates the value of Value from newValue.
    • UpdateAsync asynchronously updates the value of Value from newValue after creating an awaitable task with xref:System.Threading.Tasks.Task.Yield%2A?displayProperty=nameWithType that asynchronously yields back to the current context when awaited.
  • Each of the class methods write the type of TValue and the value of Value to the console. Writing to the console is only for demonstration purposes. Production apps usually avoid writing to the console in favor of app logging. For more information, see xref:blazor/fundamentals/logging and xref:fundamentals/logging/index.

Note

Open generic types and methods don't specify types for type placeholders. Conversely, closed generics supply types for all type placeholders. The examples in this section demonstrate closed generics, but invoking JS interop instance methods with open generics is supported. Use of open generics is not supported for static .NET method invocations, which were described earlier in this article.

For more information, see the following articles:

GenericType.cs:

using Microsoft.JSInterop;

public class GenericType<TValue>
{
    public TValue? Value { get; set; }

    [JSInvokable]
    public void Update(TValue newValue)
    {
        Value = newValue;

        Console.WriteLine($"Update: GenericType<{typeof(TValue)}>: {Value}");
    }

    [JSInvokable]
    public async void UpdateAsync(TValue newValue)
    {
        await Task.Yield();
        Value = newValue;

        Console.WriteLine($"UpdateAsync: GenericType<{typeof(TValue)}>: {Value}");
    }
}

In the following invokeMethodsAsync function:

  • The generic type class's Update and UpdateAsync methods are called with arguments representing strings and numbers.
  • Client-side components support calling .NET methods synchronously with invokeMethod. syncInterop receives a boolean value indicating if the JS interop is occurring on the client. When syncInterop is true, invokeMethod is safely called. If the value of syncInterop is false, only the asynchronous function invokeMethodAsync is called because the JS interop is executing in a server-side component.
  • For demonstration purposes, the xref:Microsoft.JSInterop.DotNetObjectReference function call (invokeMethod or invokeMethodAsync), the .NET method called (Update or UpdateAsync), and the argument are written to the console. The arguments use a random number to permit matching the JS function call to the .NET method invocation (also written to the console on the .NET side). Production code usually doesn't write to the console, either on the client or the server. Production apps usually rely upon app logging. For more information, see xref:blazor/fundamentals/logging and xref:fundamentals/logging/index.
<script>
  const randomInt = () => Math.floor(Math.random() * 99999);

  window.invokeMethodsAsync = async (syncInterop, dotNetHelper1, dotNetHelper2) => {
    var n = randomInt();
    console.log(`JS: invokeMethodAsync:Update('string ${n}')`);
    await dotNetHelper1.invokeMethodAsync('Update', `string ${n}`);

    n = randomInt();
    console.log(`JS: invokeMethodAsync:UpdateAsync('string ${n}')`);
    await dotNetHelper1.invokeMethodAsync('UpdateAsync', `string ${n}`);

    if (syncInterop) {
      n = randomInt();
      console.log(`JS: invokeMethod:Update('string ${n}')`);
      dotNetHelper1.invokeMethod('Update', `string ${n}`);
    }

    n = randomInt();
    console.log(`JS: invokeMethodAsync:Update(${n})`);
    await dotNetHelper2.invokeMethodAsync('Update', n);

    n = randomInt();
    console.log(`JS: invokeMethodAsync:UpdateAsync(${n})`);
    await dotNetHelper2.invokeMethodAsync('UpdateAsync', n);

    if (syncInterop) {
      n = randomInt();
      console.log(`JS: invokeMethod:Update(${n})`);
      dotNetHelper2.invokeMethod('Update', n);
    }
  };
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

In the following GenericsExample component:

  • The JS function invokeMethodsAsync is called when the Invoke Interop button is selected.
  • A pair of xref:Microsoft.JSInterop.DotNetObjectReference types are created and passed to the JS function for instances of the GenericType as a string and an int.

GenericsExample.razor:

:::moniker-end

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

@page "/generics-example"
@rendermode InteractiveServer
@using System.Runtime.InteropServices
@inject IJSRuntime JS
@implements IDisposable

<p>
    <button @onclick="InvokeInterop">Invoke Interop</button>
</p>

<ul>
    <li>genericType1: @genericType1?.Value</li>
    <li>genericType2: @genericType2?.Value</li>
</ul>

@code {
    private GenericType<string> genericType1 = new() { Value = "string 0" };
    private GenericType<int> genericType2 = new() { Value = 0 };
    private DotNetObjectReference<GenericType<string>>? objRef1;
    private DotNetObjectReference<GenericType<int>>? objRef2;

    protected override void OnInitialized()
    {
        objRef1 = DotNetObjectReference.Create(genericType1);
        objRef2 = DotNetObjectReference.Create(genericType2);
    }

    public async Task InvokeInterop()
    {
        var syncInterop =
            RuntimeInformation.IsOSPlatform(OSPlatform.Create("BROWSER"));

        await JS.InvokeVoidAsync(
            "invokeMethodsAsync", syncInterop, objRef1, objRef2);
    }

    public void Dispose()
    {
        objRef1?.Dispose();
        objRef2?.Dispose();
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-8.0"

@page "/generics-example"
@using System.Runtime.InteropServices
@inject IJSRuntime JS
@implements IDisposable

<p>
    <button @onclick="InvokeInterop">Invoke Interop</button>
</p>

<ul>
    <li>genericType1: @genericType1?.Value</li>
    <li>genericType2: @genericType2?.Value</li>
</ul>

@code {
    private GenericType<string> genericType1 = new() { Value = "string 0" };
    private GenericType<int> genericType2 = new() { Value = 0 };
    private DotNetObjectReference<GenericType<string>>? objRef1;
    private DotNetObjectReference<GenericType<int>>? objRef2;

    protected override void OnInitialized()
    {
        objRef1 = DotNetObjectReference.Create(genericType1);
        objRef2 = DotNetObjectReference.Create(genericType2);
    }

    public async Task InvokeInterop()
    {
        var syncInterop =
            RuntimeInformation.IsOSPlatform(OSPlatform.Create("BROWSER"));

        await JS.InvokeVoidAsync(
            "invokeMethodsAsync", syncInterop, objRef1, objRef2);
    }

    public void Dispose()
    {
        objRef1?.Dispose();
        objRef2?.Dispose();
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-6.0"

In the preceding example, JS is an injected xref:Microsoft.JSInterop.IJSRuntime instance. xref:Microsoft.JSInterop.IJSRuntime is registered by the Blazor framework.

The following demonstrates typical output of the preceding example when the Invoke Interop button is selected in a client-side component:

JS: invokeMethodAsync:Update('string 37802')
.NET: Update: GenericType<System.String>: string 37802
JS: invokeMethodAsync:UpdateAsync('string 53051')
JS: invokeMethod:Update('string 26784')
.NET: Update: GenericType<System.String>: string 26784
JS: invokeMethodAsync:Update(14107)
.NET: Update: GenericType<System.Int32>: 14107
JS: invokeMethodAsync:UpdateAsync(48995)
JS: invokeMethod:Update(12872)
.NET: Update: GenericType<System.Int32>: 12872
.NET: UpdateAsync: GenericType<System.String>: string 53051
.NET: UpdateAsync: GenericType<System.Int32>: 48995

If the preceding example is implemented in a server-side component, the synchronous calls with invokeMethod are avoided. For server-side components, we recommend the asynchronous function (invokeMethodAsync) over the synchronous version (invokeMethod).

Typical output of a server-side component:

JS: invokeMethodAsync:Update('string 34809')
.NET: Update: GenericType<System.String>: string 34809
JS: invokeMethodAsync:UpdateAsync('string 93059')
JS: invokeMethodAsync:Update(41997)
.NET: Update: GenericType<System.Int32>: 41997
JS: invokeMethodAsync:UpdateAsync(24652)
.NET: UpdateAsync: GenericType<System.String>: string 93059
.NET: UpdateAsync: GenericType<System.Int32>: 24652

The preceding output examples demonstrate that asynchronous methods execute and complete in an arbitrary order depending on several factors, including thread scheduling and the speed of method execution. It isn't possible to reliably predict the order of completion for asynchronous method calls.

:::moniker-end

Class instance examples

The following sayHello1 JS function:

  • Calls the GetHelloMessage .NET method on the passed xref:Microsoft.JSInterop.DotNetObjectReference.
  • Returns the message from GetHelloMessage to the sayHello1 caller.
<script>
  window.sayHello1 = (dotNetHelper) => {
    return dotNetHelper.invokeMethodAsync('GetHelloMessage');
  };
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

The following HelloHelper class has a JS-invokable .NET method named GetHelloMessage. When HelloHelper is created, the name in the Name property is used to return a message from GetHelloMessage.

HelloHelper.cs:

:::moniker range=">= aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/HelloHelper.cs" highlight="5,12-13":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/HelloHelper.cs" highlight="5,12-13":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="csharp" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/HelloHelper.cs" highlight="5,12-13":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="csharp" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/HelloHelper.cs" highlight="5,12-13":::

:::moniker-end

The CallHelloHelperGetHelloMessage method in the following JsInteropClasses3 class invokes the JS function sayHello1 with a new instance of HelloHelper.

JsInteropClasses3.cs:

:::moniker range=">= aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/JsInteropClasses3.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/JsInteropClasses3.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="csharp" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/JsInteropClasses3.cs":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="csharp" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/JsInteropClasses3.cs":::

:::moniker-end

To avoid a memory leak and allow garbage collection, the .NET object reference created by xref:Microsoft.JSInterop.DotNetObjectReference is disposed when the object reference goes out of scope with using var syntax.

When the Trigger .NET instance method button is selected in the following CallDotNetExample4 component, JsInteropClasses3.CallHelloHelperGetHelloMessage is called with the value of name.

CallDotNetExample4.razor:

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

@page "/call-dotnet-example-4"
@rendermode InteractiveServer
@inject IJSRuntime JS

<h1>Call .NET Example 4</h1>

<p>
    <label>
        Name: <input @bind="name" />
    </label>
</p>

<p>
    <button @onclick="TriggerDotNetInstanceMethod">
        Trigger .NET instance method
    </button>
</p>

<p>
    @result
</p>

@code {
    private string? name;
    private string? result;
    private JsInteropClasses3? jsInteropClasses;

    protected override void OnInitialized()
    {
        jsInteropClasses = new JsInteropClasses3(JS);
    }

    private async Task TriggerDotNetInstanceMethod()
    {
        if (jsInteropClasses is not null)
        {
            result = await jsInteropClasses.CallHelloHelperGetHelloMessage(name);
        }
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample4.razor" highlight="36":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample4.razor" highlight="36":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample4.razor" highlight="36":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample4.razor" highlight="36":::

:::moniker-end

The following image shows the rendered component with the name Amy Pond in the Name field. After the button is selected, Hello, Amy Pond! is displayed in the UI:

Rendered 'CallDotNetExample4' component example

The preceding pattern shown in the JsInteropClasses3 class can also be implemented entirely in a component.

CallDotNetExample5.razor:

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

@page "/call-dotnet-example-5"
@rendermode InteractiveServer
@inject IJSRuntime JS

<h1>Call .NET Example 5</h1>

<p>
    <label>
        Name: <input @bind="name" />
    </label>
</p>

<p>
    <button @onclick="TriggerDotNetInstanceMethod">
        Trigger .NET instance method
    </button>
</p>

<p>
    @result
</p>

@code {
    private string? name;
    private string? result;

    public async Task TriggerDotNetInstanceMethod()
    {
        using var objRef = DotNetObjectReference.Create(new HelloHelper(name));
        result = await JS.InvokeAsync<string>("sayHello1", objRef);
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample5.razor" highlight="28-29":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample5.razor" highlight="28-29":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample5.razor" highlight="28-29":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample5.razor" highlight="28-29":::

:::moniker-end

To avoid a memory leak and allow garbage collection, the .NET object reference created by xref:Microsoft.JSInterop.DotNetObjectReference is disposed when the object reference goes out of scope with using var syntax.

The output displayed by the CallDotNetExample5 component is Hello, Amy Pond! when the name Amy Pond is provided in the name field.

In the preceding CallDotNetExample5 component, the .NET object reference is disposed. If a class or component doesn't dispose the xref:Microsoft.JSInterop.DotNetObjectReference, dispose it from the client by calling dispose on the passed xref:Microsoft.JSInterop.DotNetObjectReference:

window.{JS FUNCTION NAME} = (dotNetHelper) => {
  dotNetHelper.invokeMethodAsync('{.NET METHOD ID}');
  dotNetHelper.dispose();
}

In the preceding example:

  • The {JS FUNCTION NAME} placeholder is the JS function's name.
  • The variable name dotNetHelper is arbitrary and can be changed to any preferred name.
  • The {.NET METHOD ID} placeholder is the .NET method identifier.

Component instance .NET method helper class

A helper class can invoke a .NET instance method as an xref:System.Action. Helper classes are useful in the following scenarios:

  • When several components of the same type are rendered on the same page.
  • In server-side apps with multiple users concurrently using the same component.

In the following example:

  • The CallDotNetExample6 component contains several ListItem1 components, which is a shared component in the app's Shared folder.
  • Each ListItem1 component is composed of a message and a button.
  • When a ListItem1 component button is selected, that ListItem1's UpdateMessage method changes the list item text and hides the button.

The following MessageUpdateInvokeHelper class maintains a JS-invokable .NET method, UpdateMessageCaller, to invoke the xref:System.Action specified when the class is instantiated.

MessageUpdateInvokeHelper.cs:

:::moniker range=">= aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/MessageUpdateInvokeHelper.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/MessageUpdateInvokeHelper.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="csharp" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/MessageUpdateInvokeHelper.cs":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="csharp" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/MessageUpdateInvokeHelper.cs":::

:::moniker-end

The following updateMessageCaller JS function invokes the UpdateMessageCaller .NET method.

<script>
  window.updateMessageCaller = (dotNetHelper) => {
    dotNetHelper.invokeMethodAsync('UpdateMessageCaller');
    dotNetHelper.dispose();
  }
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

The following ListItem1 component is a shared component that can be used any number of times in a parent component and creates list items (<li>...</li>) for an HTML list (<ul>...</ul> or <ol>...</ol>). Each ListItem1 component instance establishes an instance of MessageUpdateInvokeHelper with an xref:System.Action set to its UpdateMessage method.

When a ListItem1 component's InteropCall button is selected, updateMessageCaller is invoked with a created xref:Microsoft.JSInterop.DotNetObjectReference for the MessageUpdateInvokeHelper instance. This permits the framework to call UpdateMessageCaller on that ListItem1's MessageUpdateInvokeHelper instance. The passed xref:Microsoft.JSInterop.DotNetObjectReference is disposed in JS (dotNetHelper.dispose()).

ListItem1.razor:

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

@rendermode InteractiveServer
@inject IJSRuntime JS

<li>
    @message
    <button @onclick="InteropCall" style="display:@display">InteropCall</button>
</li>

@code {
    private string message = "Select one of these list item buttons.";
    private string display = "inline-block";
    private MessageUpdateInvokeHelper? messageUpdateInvokeHelper;

    protected override void OnInitialized()
    {
        messageUpdateInvokeHelper = new MessageUpdateInvokeHelper(UpdateMessage);
    }

    protected async Task InteropCall()
    {
        if (messageUpdateInvokeHelper is not null)
        {
            await JS.InvokeVoidAsync("updateMessageCaller",
                DotNetObjectReference.Create(messageUpdateInvokeHelper));
        }
    }

    private void UpdateMessage()
    {
        message = "UpdateMessage Called!";
        display = "none";
        StateHasChanged();
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem1.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem1.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem1.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem1.razor":::

:::moniker-end

StateHasChanged is called to update the UI when message is set in UpdateMessage. If StateHasChanged isn't called, Blazor has no way of knowing that the UI should be updated when the xref:System.Action is invoked.

The following CallDotNetExample6 parent component includes four list items, each an instance of the ListItem1 component.

CallDotNetExample6.razor:

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

@page "/call-dotnet-example-6"

<h1>Call .NET Example 6</h1>

<ul>
    <ListItem1 />
    <ListItem1 />
    <ListItem1 />
    <ListItem1 />
</ul>

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample6.razor" highlight="6-9":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample6.razor" highlight="6-9":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample6.razor" highlight="6-9":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample6.razor" highlight="6-9":::

:::moniker-end

The following image shows the rendered CallDotNetExample6 parent component after the second InteropCall button is selected:

  • The second ListItem1 component has displayed the UpdateMessage Called! message.
  • The InteropCall button for the second ListItem1 component isn't visible because the button's CSS display property is set to none.

Rendered 'CallDotNetExample6' component example

Component instance .NET method called from DotNetObjectReference assigned to an element property

The assignment of a xref:Microsoft.JSInterop.DotNetObjectReference to a property of an HTML element permits calling .NET methods on a component instance:

  • An element reference is captured (xref:Microsoft.AspNetCore.Components.ElementReference).
  • In the component's OnAfterRender{Async} method, a JavaScript (JS) function is invoked with the element reference and the component instance as a xref:Microsoft.JSInterop.DotNetObjectReference. The JS function attaches the xref:Microsoft.JSInterop.DotNetObjectReference to the element in a property.
  • When an element event is invoked in JS (for example, onclick), the element's attached xref:Microsoft.JSInterop.DotNetObjectReference is used to call a .NET method.

Similar to the approach described in the Component instance .NET method helper class section, this approach is useful in the following scenarios:

  • When several components of the same type are rendered on the same page.
  • In server-side apps with multiple users concurrently using the same component.
  • The .NET method is invoked from a JS event (for example, onclick), not from a Blazor event (for example, @onclick).

In the following example:

  • The CallDotNetExample7 component contains several ListItem2 components, which is a shared component in the app's Shared folder.
  • Each ListItem2 component is composed of a list item message <span> and a second <span> with a display CSS property set to inline-block for display.
  • When a ListItem2 component list item is selected, that ListItem2's UpdateMessage method changes the list item text in the first <span> and hides the second <span> by setting its display property to none.

The following assignDotNetHelper JS function assigns the xref:Microsoft.JSInterop.DotNetObjectReference to an element in a property named dotNetHelper:

<script>
  window.assignDotNetHelper = (element, dotNetHelper) => {
    element.dotNetHelper = dotNetHelper;
  }
</script>

The following interopCall JS function uses the xref:Microsoft.JSInterop.DotNetObjectReference for the passed element to invoke a .NET method named UpdateMessage:

<script>
  window.interopCall = async (element) => {
    await element.dotNetHelper.invokeMethodAsync('UpdateMessage');
  }
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

In the preceding example, the variable name dotNetHelper is arbitrary and can be changed to any preferred name.

The following ListItem2 component is a shared component that can be used any number of times in a parent component and creates list items (<li>...</li>) for an HTML list (<ul>...</ul> or <ol>...</ol>).

Each ListItem2 component instance invokes the assignDotNetHelper JS function in OnAfterRenderAsync with an element reference (the first <span> element of the list item) and the component instance as a xref:Microsoft.JSInterop.DotNetObjectReference.

When a ListItem2 component's message <span> is selected, interopCall is invoked passing the <span> element as a parameter (this), which invokes the UpdateMessage .NET method. In UpdateMessage, StateHasChanged is called to update the UI when message is set and the display property of the second <span> is updated. If StateHasChanged isn't called, Blazor has no way of knowing that the UI should be updated when the method is invoked.

The xref:Microsoft.JSInterop.DotNetObjectReference is disposed when the component is disposed.

ListItem2.razor:

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

@rendermode InteractiveServer
@inject IJSRuntime JS

<li>
    <span @ref="elementRef" onclick="interopCall(this)">@message</span>
    <span style="display:@display">Not Updated Yet!</span>
</li>

@code {
    private DotNetObjectReference<ListItem2>? objRef;
    private ElementReference elementRef;
    private string display = "inline-block";
    private string message = "Select one of these list items.";

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender)
        {
            objRef = DotNetObjectReference.Create(this);
            await JS.InvokeVoidAsync("assignDotNetHelper", elementRef, objRef);
        }
    }

    [JSInvokable]
    public void UpdateMessage()
    {
        message = "UpdateMessage Called!";
        display = "none";
        StateHasChanged();
    }

    public void Dispose() => objRef?.Dispose();
}

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem2.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Shared/call-dotnet-from-js/ListItem2.razor":::

:::moniker-end

The following CallDotNetExample7 parent component includes four list items, each an instance of the ListItem2 component.

CallDotNetExample7.razor:

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

@page "/call-dotnet-example-7"

<h1>Call .NET Example 7</h1>

<ul>
    <ListItem2 />
    <ListItem2 />
    <ListItem2 />
    <ListItem2 />
</ul>

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample7.razor" highlight="6-9":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample7.razor" highlight="6-9":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample7.razor" highlight="6-9":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/call-dotnet-from-js/CallDotNetExample7.razor" highlight="6-9":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0"

Synchronous JS interop in client-side components

[!INCLUDE]

:::moniker-end

JavaScript location

Load JavaScript (JS) code using any of approaches described by the JS interop overview article:

:::moniker range=">= aspnetcore-6.0"

  • Load a script in <head> markup (Not generally recommended)
  • Load a script in <body> markup
  • Load a script from an external JavaScript file (.js) collocated with a component
  • Load a script from an external JavaScript file (.js)
  • Inject a script before or after Blazor starts

:::moniker-end

:::moniker range="< aspnetcore-6.0"

  • Load a script in <head> markup (Not generally recommended)
  • Load a script in <body> markup
  • Load a script from an external JavaScript file (.js)
  • Inject a script before or after Blazor starts

:::moniker-end

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

Using JS modules to load JS is described in this article in the JavaScript isolation in JavaScript modules section.

:::moniker-end

Warning

Don't place a <script> tag in a component file (.razor) because the <script> tag can't be updated dynamically.

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

JavaScript isolation in JavaScript modules

Blazor enables JavaScript (JS) isolation in standard JavaScript modules (ECMAScript specification). JavaScript module loading works the same way in Blazor as it does for other types of web apps, and you're free to customize how modules are defined in your app. For a guide on how to use JavaScript modules, see MDN Web Docs: JavaScript modules.

JS isolation provides the following benefits:

  • Imported JS no longer pollutes the global namespace.
  • Consumers of a library and components aren't required to import the related JS.

For more information, see xref:blazor/js-interop/call-javascript-from-dotnet#javascript-isolation-in-javascript-modules.

Dynamic import with the import() operator is supported with ASP.NET Core and Blazor:

if ({CONDITION}) import("/additionalModule.js");

In the preceding example, the {CONDITION} placeholder represents a conditional check to determine if the module should be loaded.

For browser compatibility, see Can I use: JavaScript modules: dynamic import.

:::moniker-end

Avoid circular object references

Objects that contain circular references can't be serialized on the client for either:

  • .NET method calls.
  • JavaScript method calls from C# when the return type has circular references.

:::moniker range=">= aspnetcore-6.0"

Byte array support

Blazor supports optimized byte array JavaScript (JS) interop that avoids encoding/decoding byte arrays into Base64. The following example uses JS interop to pass a byte array to .NET.

Provide a sendByteArray JS function. The function is called statically, which includes the assembly name parameter in the invokeMethodAsync call, by a button in the component and doesn't return a value:

<script>
  window.sendByteArray = () => {
    const data = new Uint8Array([0x45,0x76,0x65,0x72,0x79,0x74,0x68,0x69,
      0x6e,0x67,0x27,0x73,0x20,0x73,0x68,0x69,0x6e,0x79,0x2c,
      0x20,0x43,0x61,0x70,0x74,0x61,0x69,0x6e,0x2e,0x20,0x4e,
      0x6f,0x74,0x20,0x74,0x6f,0x20,0x66,0x72,0x65,0x74,0x2e]);
    DotNet.invokeMethodAsync('BlazorSample', 'ReceiveByteArray', data)
      .then(str => {
        alert(str);
      });
  };
</script>

Note

For general guidance on JS location and our recommendations for production apps, see xref:blazor/js-interop/index#javascript-location.

CallDotNetExample8.razor:

:::moniker-end

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

@page "/call-dotnet-example-8"
@rendermode InteractiveServer
@using System.Text

<h1>Call .NET Example 8</h1>

<p>
    <button onclick="sendByteArray()">Send Bytes</button>
</p>

<p>
    Quote &copy;2005 <a href="https://www.uphe.com">Universal Pictures</a>:
    <a href="https://www.uphe.com/movies/serenity-2005">Serenity</a><br>
    <a href="https://www.imdb.com/name/nm0821612/">Jewel Staite on IMDB</a>
</p>

@code {
    [JSInvokable]
    public static Task<string> ReceiveByteArray(byte[] receivedBytes)
    {
        return Task.FromResult(
            Encoding.UTF8.GetString(receivedBytes, 0, receivedBytes.Length));
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-8.0"

@page "/call-dotnet-example-8"
@using System.Text

<h1>Call .NET Example 8</h1>

<p>
    <button onclick="sendByteArray()">Send Bytes</button>
</p>

<p>
    Quote &copy;2005 <a href="https://www.uphe.com">Universal Pictures</a>:
    <a href="https://www.uphe.com/movies/serenity-2005">Serenity</a><br>
    <a href="https://www.imdb.com/name/nm0821612/">Jewel Staite on IMDB</a>
</p>

@code {
    [JSInvokable]
    public static Task<string> ReceiveByteArray(byte[] receivedBytes)
    {
        return Task.FromResult(
            Encoding.UTF8.GetString(receivedBytes, 0, receivedBytes.Length));
    }
}

:::moniker-end

:::moniker range=">= aspnetcore-6.0"

For information on using a byte array when calling JavaScript from .NET, see xref:blazor/js-interop/call-javascript-from-dotnet#byte-array-support.

:::moniker-end

:::moniker range=">= aspnetcore-6.0"

Stream from JavaScript to .NET

Blazor supports streaming data directly from JavaScript to .NET. Streams are requested using the Microsoft.JSInterop.IJSStreamReference interface.

Microsoft.JSInterop.IJSStreamReference.OpenReadStreamAsync returns a xref:System.IO.Stream and uses the following parameters:

  • maxAllowedSize: Maximum number of bytes permitted for the read operation from JavaScript, which defaults to 512,000 bytes if not specified.
  • cancellationToken: A xref:System.Threading.CancellationToken for cancelling the read.

In JavaScript:

function streamToDotNet() {
  return new Uint8Array(10000000);
}

In C# code:

var dataReference = 
    await JS.InvokeAsync<IJSStreamReference>("streamToDotNet");
using var dataReferenceStream = 
    await dataReference.OpenReadStreamAsync(maxAllowedSize: 10_000_000);

var outputPath = Path.Combine(Path.GetTempPath(), "file.txt");
using var outputFileStream = File.OpenWrite(outputPath);
await dataReferenceStream.CopyToAsync(outputFileStream);

In the preceding example:

  • JS is an injected xref:Microsoft.JSInterop.IJSRuntime instance. xref:Microsoft.JSInterop.IJSRuntime is registered by the Blazor framework.
  • The dataReferenceStream is written to disk (file.txt) at the current user's temporary folder path (xref:System.IO.Path.GetTempPath%2A).

xref:blazor/js-interop/call-javascript-from-dotnet#stream-from-net-to-javascript covers the reverse operation, streaming from .NET to JavaScript using a xref:Microsoft.JSInterop.DotNetStreamReference.

xref:blazor/file-uploads covers how to upload a file in Blazor. For a forms example that streams <textarea> data in a server-side component, see xref:blazor/forms/troubleshoot#large-form-payloads-and-the-signalr-message-size-limit.

:::moniker-end

:::moniker range=">= aspnetcore-7.0"

JavaScript [JSImport]/[JSExport] interop

This section applies to client-side components.

As an alternative to interacting with JavaScript (JS) in client-side components using Blazor's JS interop mechanism based on the xref:Microsoft.JSInterop.IJSRuntime interface, a JS [JSImport]/[JSExport] interop API is available to apps targeting .NET 7 or later.

For more information, see xref:blazor/js-interop/import-export-interop.

:::moniker-end

Disposal of JavaScript interop object references

Examples throughout the JavaScript (JS) interop articles demonstrate typical object disposal patterns:

  • When calling .NET from JS, as described in this article, dispose of a created xref:Microsoft.JSInterop.DotNetObjectReference either from .NET or from JS to avoid leaking .NET memory.

  • When calling JS from .NET, as described in xref:blazor/js-interop/call-javascript-from-dotnet, dispose any created xref:Microsoft.JSInterop.IJSObjectReference/xref:Microsoft.JSInterop.IJSInProcessObjectReference/JSObjectReference either from .NET or from JS to avoid leaking JS memory.

JS interop object references are implemented as a map keyed by an identifier on the side of the JS interop call that creates the reference. When object disposal is initiated from either the .NET or JS side, Blazor removes the entry from the map, and the object can be garbage collected as long as no other strong reference to the object is present.

At a minimum, always dispose objects created on the .NET side to avoid leaking .NET managed memory.

DOM cleanup tasks during component disposal

For more information, see xref:blazor/js-interop/index#dom-cleanup-tasks-during-component-disposal.

JavaScript interop calls without a circuit

For more information, see xref:blazor/js-interop/index#javascript-interop-calls-without-a-circuit.

Additional resources