Blazor.OverlayScrollbars 1.0.0

dotnet add package Blazor.OverlayScrollbars --version 1.0.0
                    
NuGet\Install-Package Blazor.OverlayScrollbars -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="Blazor.OverlayScrollbars" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Blazor.OverlayScrollbars" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Blazor.OverlayScrollbars" />
                    
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 Blazor.OverlayScrollbars --version 1.0.0
                    
#r "nuget: Blazor.OverlayScrollbars, 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 Blazor.OverlayScrollbars@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=Blazor.OverlayScrollbars&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Blazor.OverlayScrollbars&version=1.0.0
                    
Install as a Cake Tool

Blazor.OverlayScrollbars

A lightweight, fully-featured Blazor component wrapper for the excellent OverlayScrollbars JavaScript library.

Provides beautiful, highly customizable scrollbars with zero manual JS interop. Works seamlessly with both Blazor Server and Blazor WebAssembly.

Installation

dotnet add package Blazor.OverlayScrollbars

Quick Start

App.razor
<head>
    ...
    <link rel="stylesheet" href="@Assets["_content/Blazor.OverlayScrollbars/OverlayScrollbars.min.css"]">
</head>

<body>
    ...
    <script type="text/javascript" src="@Assets["_content/Blazor.OverlayScrollbars/OverlayScrollbars.js"]"></script>
</body>
Use the component:
<OverlayScrollbar Theme="OverlayScrollbarTheme.Dark"
                  AutoHide="AutoHideBehavior.Move"
                  Visibility="ScrollbarVisibility.Auto">
    <h1>Hello, world!</h1>
    <p>This content is scrollable with custom stylish scrollbars.</p>
    <div style="height: 1500px; background: linear-gradient(to bottom, #ff8a00, #da1b60);">
        
    </div>
</OverlayScrollbar>

Parameters

Parameter Type Default Description
ChildContent RenderFragment Required Scrollable content
Class string? null Additional CSS classes
Theme OverlayScrollbarTheme Dark Dark, Light, None
OverflowX OverflowBehavior Scroll Horizontal overflow behavior
OverflowY OverflowBehavior Scroll Vertical overflow behavior
Visibility ScrollbarVisibility Auto Auto, Visible, Hidden
AutoHide AutoHideBehavior Never Never, Scroll, Leave, Move
AutoHideDelay int 1300 Delay in milliseconds
AutoHideSuspend bool false Suspend auto-hide until first scroll
PaddingAbsolute bool false macOS-style padding
ShowNativeOverlaid bool false Show native scrollbars underneath
DragScroll bool true Enable dragging the scrollbar handle
ClickScroll ClickScrollBehavior Instant Disabled, Normal, Instant
Pointers string? "mouse, touch, pen" Supported pointer types
AdditionalAttributes Dictionary<string, object>? null Any other HTML attributes
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 is compatible.  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 is compatible.  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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 270 11/26/2025 1.0.0 is deprecated because it has critical bugs.