Skip to content

Adds support for status txt overrides in uptime widgets #2323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lissy93 merged 1 commit into from
Aug 31, 2026
+14 −2
Merged

Adds support for status txt overrides in uptime widgets #2323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/widgets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2811,6 +2811,7 @@ This widget displays the status of your Uptime Kuma monitors from a given status
| **`hideHistory`** | `boolean` | _Optional_ | Optionally hide the strip of recent heartbeats |
| **`hideUptime`** | `boolean` | _Optional_ | Optionally hide the 24-hour uptime percentage |
| **`hideStatus`** | `boolean` | _Optional_ | Optionally hide the up/ down status pill |
| **`statusLabels`** | `object` | _Optional_ | Optional text overrides for the status pill, keyed by status: `up`, `down`, `pending`, `maintenance`, `unknown` |

#### Example

Expand Down Expand Up @@ -2845,6 +2846,7 @@ This widget displays the status of your Uptime Kuma monitors from a given status
| **`hideStatus`** | `boolean` | _Optional_ | Optionally hide the up/ down status pill |
| **`hideResponseTime`** | `boolean` | _Optional_ | Optionally hide the response time |
| **`hideUptime`** | `boolean` | _Optional_ | Optionally hide the 24-hour uptime percentage |
| **`statusLabels`** | `object` | _Optional_ | Optional text overrides for the status pill, keyed by status: `up`, `down`, `pending`, `maintenance`, `unknown` |

Each monitor shows its status, response time and 24-hour uptime. Hover a monitor for its 30-day and 1-year uptime, and average response times. Hide any of the columns with the options above.

Expand Down
7 changes: 6 additions & 1 deletion src/components/Widgets/UptimeKuma.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ export default {
hideUptime() {
return this.options.hideUptime || false;
},
/* Optional status pill text overrides, keyed by status (e.g. `down: Error`) */
statusLabels() {
return this.options.statusLabels || {};
},
/* Create authorisation header for the instance from the apiKey */
authHeaders() {
if (!this.apiKey) {
Expand All @@ -88,7 +92,8 @@ export default {
},
methods: {
getStatusText(status) {
return (STATUSES[status] || UNKNOWN).text;
const { text, class: key } = STATUSES[status] || UNKNOWN;
return this.statusLabels[key] || text;
},
getStatusClass(status) {
return (STATUSES[status] || UNKNOWN).class;
Expand Down
7 changes: 6 additions & 1 deletion src/components/Widgets/UptimeKumaStatusPage.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ export default {
hideStatus() {
return this.options.hideStatus || false;
},
/* Status pill text overrides */
statusLabels() {
return this.options.statusLabels || {};
},
endpoint() {
return `${this.host}/api/status-page/heartbeat/${this.slug}`;
},
Expand All @@ -91,7 +95,8 @@ export default {
},
methods: {
getStatusText(status) {
return (STATUSES[status] || UNKNOWN).text;
const { text, class: key } = STATUSES[status] || UNKNOWN;
return this.statusLabels[key] || text;
},
getStatusClass(status) {
return (STATUSES[status] || UNKNOWN).class;
Expand Down