SplatDev.Umbraco.Plugins.OnOff
2.0.1
dotnet add package SplatDev.Umbraco.Plugins.OnOff --version 2.0.1
NuGet\Install-Package SplatDev.Umbraco.Plugins.OnOff -Version 2.0.1
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="SplatDev.Umbraco.Plugins.OnOff" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SplatDev.Umbraco.Plugins.OnOff" Version="2.0.1" />
<PackageReference Include="SplatDev.Umbraco.Plugins.OnOff" />
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 SplatDev.Umbraco.Plugins.OnOff --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SplatDev.Umbraco.Plugins.OnOff, 2.0.1"
#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 SplatDev.Umbraco.Plugins.OnOff@2.0.1
#: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=SplatDev.Umbraco.Plugins.OnOff&version=2.0.1
#tool nuget:?package=SplatDev.Umbraco.Plugins.OnOff&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
UmbracoCms.Plugins.OnOff
Feature toggle system for Umbraco CMS. Enable, disable and schedule site features via the backoffice dashboard.
Supports
- Umbraco 13 (net8.0)
- Umbraco 17 (net10.0)
Features
- Manage feature flags from the Umbraco Settings dashboard
- Enable/disable features with a single click
- Schedule automatic enable/disable with
ScheduledEnableAt/ScheduledDisableAt - EF Core persistence using the
onoffschema OnOffButtonEditorDataEditor property for use in document types- Lit 3 dashboard for Umbraco 17, AngularJS dashboard for Umbraco 13
OnOffViewComponentfor rendering feature state in Razor views
Installation
Add the NuGet package to your Umbraco project. The OnOffComposer registers the OnOffDbContext and IOnOffService automatically.
Run EF Core migrations to create the onoff.FeatureToggles table:
dotnet ef migrations add InitialOnOff --context OnOffDbContext
dotnet ef database update --context OnOffDbContext
Usage in Views
@await Component.InvokeAsync("OnOff", new { alias = "darkMode" })
REST API
| Method | Endpoint | Description |
|---|---|---|
| GET | /umbraco/api/onoff/GetAll |
List all feature toggles |
| GET | /umbraco/api/onoff/GetFeature?alias=x |
Get a single feature |
| POST | /umbraco/api/onoff/UpsertFeature |
Create or update a feature |
| POST | /umbraco/api/onoff/Enable?alias=x |
Enable a feature |
| POST | /umbraco/api/onoff/Disable?alias=x |
Disable a feature |
| POST | /umbraco/api/onoff/Schedule?alias=x&enableAt=...&disableAt=... |
Schedule changes |
| DELETE | /umbraco/api/onoff/Delete?id=1 |
Delete a feature |
| POST | /umbraco/api/onoff/ApplyScheduled |
Trigger scheduled changes |
| Product | Versions 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 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.EntityFrameworkCore.Design (>= 10.0.7)
- Microsoft.EntityFrameworkCore.SqlServer (>= 10.0.7)
- Umbraco.Cms.Core (>= 17.3.4)
- Umbraco.Cms.Web.Common (>= 17.3.4)
-
net8.0
- Microsoft.EntityFrameworkCore.Design (>= 8.0.20)
- Microsoft.EntityFrameworkCore.SqlServer (>= 8.0.20)
- Umbraco.Cms.Core (>= 13.12.0)
- Umbraco.Cms.Web.Common (>= 13.12.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.