Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/augustoproiete/hangfire-dashboard-customize

Customize your Hangfire Dashboard (e.g. Change the Title of the Dashboard)
https://github.com/augustoproiete/hangfire-dashboard-customize

background-jobs customization dashboard dotnet dotnet-core hacktoberfest hangfire scheduled-jobs

Last synced: 12 days ago
JSON representation

Customize your Hangfire Dashboard (e.g. Change the Title of the Dashboard)

Awesome Lists containing this project

README

        

| README.md |
|:---|

Hangfire.Dashboard.Customize


Customize the title of your [Hangfire](https://www.hangfire.io) Dashboard.

[![NuGet Version](https://img.shields.io/nuget/v/Hangfire.Dashboard.Customize.svg?style=flat)](https://www.nuget.org/packages/Hangfire.Dashboard.Customize/) [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-hangfire-orange.svg)](http://stackoverflow.com/questions/tagged/hangfire)

![Hangfire.Dashboard.Customize screenshot](assets/hangfire-dashboard-customize-small.png)

## Give a Star! :star:

If you like or are using this project please give it a star. Thanks!

## Getting started :rocket:

Install the [Hangfire.Dashboard.Customize](https://www.nuget.org/packages/Hangfire.Dashboard.Customize/) package from NuGet:

```powershell
Install-Package Hangfire.Dashboard.Customize
```

Call the method `UseHangfireDashboardCustomOptions` just before calling Hangfire's `UseHangfireDashboard`, in the configuration of your app:

```csharp
public class Startup
{
// ...

public void Configure(IApplicationBuilder app)
{
// ...

app.UseHangfireDashboardCustomOptions(new HangfireDashboardCustomOptions
{
DashboardTitle = () => "My Dashboard Title :)",
});

// ...

app.UseHangfireDashboard();

// ...
}
}
```

In your `HangfireDashboardCustomOptions` instance, you can define a function that returns the title you would like to display in your Hangfire Dashboard.

The `string` defined in the `DashboardTitle` will be written to the page as a _raw_ string, allowing the use of images and other HTML elements.

```csharp
app.UseHangfireDashboardCustomOptions(new HangfireDashboardCustomOptions
{
DashboardTitle = () => " Scheduled Jobs",
});
```

## Release History

Click on the [Releases](https://github.com/augustoproiete/hangfire-dashboard-customize/releases) tab on GitHub.

---

_Copyright © 2019-2020 C. Augusto Proiete & Contributors - Provided under the [Apache License, Version 2.0](LICENSE)._