Mythetech.BlazorOverlayScrollbars
1.0.2
dotnet add package Mythetech.BlazorOverlayScrollbars --version 1.0.2
NuGet\Install-Package Mythetech.BlazorOverlayScrollbars -Version 1.0.2
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="Mythetech.BlazorOverlayScrollbars" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Mythetech.BlazorOverlayScrollbars" Version="1.0.2" />
<PackageReference Include="Mythetech.BlazorOverlayScrollbars" />
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 Mythetech.BlazorOverlayScrollbars --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Mythetech.BlazorOverlayScrollbars, 1.0.2"
#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 Mythetech.BlazorOverlayScrollbars@1.0.2
#: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=Mythetech.BlazorOverlayScrollbars&version=1.0.2
#tool nuget:?package=Mythetech.BlazorOverlayScrollbars&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Mythetech.BlazorOverlayScrollbars
A Blazor wrapper component for OverlayScrollbars - beautiful, customizable scrollbars for your Blazor applications.
Features
- Simple Blazor component wrapper for OverlayScrollbars
- Includes MudBlazor theme integration (dark/light mode support)
- Configurable scrollbar behavior and appearance
- Preset configurations for common use cases
- Cross-platform support (Blazor Server, WebAssembly, and Desktop via Photino/Hermes)
Installation
dotnet add package Mythetech.BlazorOverlayScrollbars
Setup
- Add the CSS references to your
index.htmlor_Host.cshtml:
<link href="_content/Mythetech.BlazorOverlayScrollbars/css/overlayscrollbars.min.css" rel="stylesheet" />
<link href="_content/Mythetech.BlazorOverlayScrollbars/css/overlayscrollbars-mudblazor-theme.css" rel="stylesheet" />
- Add the JavaScript reference (before
</body>):
<script src="_content/Mythetech.BlazorOverlayScrollbars/js/overlayscrollbars.min.js"></script>
Usage
Basic Usage
@using Blazor.OverlayScrollbars
<OverlayScrollbar Style="height: 300px;">
<div>
</div>
</OverlayScrollbar>
With Preset Options
<OverlayScrollbar Options="@OverlayScrollbarDefaults.HideOnScroll">
</OverlayScrollbar>
Available Presets
| Preset | Description |
|---|---|
OverlayScrollbarDefaults.AlwaysVisible |
Scrollbars always visible |
OverlayScrollbarDefaults.HideOnScroll |
Hide after scrolling stops (800ms delay) |
OverlayScrollbarDefaults.HorizontalOnly |
Horizontal-only scrolling with auto-hide |
OverlayScrollbarDefaults.VerticalOnly |
Vertical-only scrolling with auto-hide |
Custom Options
<OverlayScrollbar Options="@_customOptions">
</OverlayScrollbar>
@code {
private OverlayScrollbarOptions _customOptions = new()
{
Scrollbars = new ScrollbarOptions
{
Theme = "os-theme-dark",
AutoHide = "scroll",
AutoHideDelay = 1000,
ClickScroll = true
},
ScrollBehavior = new ScrollBehaviorOptions
{
X = "hidden",
Y = "scroll"
}
};
}
Parameters
| Parameter | Type | Description |
|---|---|---|
ChildContent |
RenderFragment |
The content to wrap with scrollbars |
Class |
string |
Additional CSS classes |
Style |
string |
Inline styles |
Options |
OverlayScrollbarOptions |
Scrollbar configuration |
MudBlazor Integration
The included overlayscrollbars-mudblazor-theme.css provides automatic theming using MudBlazor CSS variables. Scrollbars will automatically adapt to your MudBlazor theme's colors and respond to dark/light mode changes.
License
MIT License - Copyright (c) 2026 Mythetech
OverlayScrollbars is licensed under the MIT License by KingSora.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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.
-
net10.0
- Microsoft.AspNetCore.Components.Web (>= 10.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.