Skip to content

A platform for community discussion. Free, open, simple.

UI: Loading skeleton for dashboard (#39989)

Natalie Tay0afb43941063
diff --git a/app/assets/stylesheets/admin/admin-dashboard-skeleton.scss b/app/assets/stylesheets/admin/admin-dashboard-skeleton.scss
new file mode 100644
index 00000000000..eb78ffa9c44
--- /dev/null
+++ b/app/assets/stylesheets/admin/admin-dashboard-skeleton.scss
@@ -0,0 +1,313 @@
+.db-skeleton {
+ --db-skeleton-animation-rgb: #{hexToRGB($primary-50)};
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-12);
+
+ &__section {
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-4);
+ }
+
+ &__section-header {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ height: 14px;
+ width: 140px;
+ }
+
+ &__section-wrapper {
+ border: 1px solid var(--primary-low);
+ border-radius: var(--d-border-radius-large);
+ padding: var(--space-4);
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-4);
+
+ // negative margin offsets the wrapper padding so the row's top border spans full width
+ .db-skeleton__row {
+ margin-inline: calc(var(--space-4) * -1);
+ }
+ }
+
+ &__kpi-row {
+ display: flex;
+ flex-wrap: nowrap;
+ gap: var(--space-4);
+ border: 1px solid var(--primary-low);
+ border-radius: var(--d-border-radius-large);
+ }
+
+ &__kpi {
+ flex: 1;
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-2);
+ padding: var(--space-4);
+
+ &:not(:last-child) {
+ border-right: 1px solid var(--primary-low);
+ }
+ }
+
+ &__kpi-value {
+ background: var(--primary-200);
+ border-radius: var(--d-border-radius);
+ width: 60%;
+ height: 28px;
+ }
+
+ &__kpi-label {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ width: 75%;
+ height: 12px;
+ }
+
+ &__kpi-delta {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ width: 30%;
+ height: 12px;
+ }
+
+ &__report-grid {
+ display: grid;
+ grid-template-columns: 1fr 1fr;
+ gap: var(--space-4);
+ }
+
+ &__report-card {
+ border: 1px solid var(--primary-low);
+ border-radius: var(--d-border-radius-large);
+ padding: var(--space-4);
+ box-sizing: border-box;
+ background: var(--secondary);
+ height: 250px;
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-3);
+ }
+
+ &__report-card-header {
+ display: flex;
+ align-items: center;
+ gap: var(--space-2);
+ }
+
+ &__report-card-title {
+ background: var(--primary-200);
+ border-radius: var(--d-border-radius);
+ width: 40%;
+ height: 14px;
+ }
+
+ &__report-card-label {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ width: 64px;
+ height: 14px;
+ }
+
+ &__report-card-chart {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ flex: 1;
+ }
+
+ &__subheader {
+ display: flex;
+ justify-content: space-between;
+ gap: var(--space-8);
+ }
+
+ &__subintro {
+ flex: 1;
+ max-width: 60ch;
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-2);
+ }
+
+ &__heading-line {
+ background: var(--primary-200);
+ border-radius: var(--d-border-radius);
+ width: 70%;
+ height: 16px;
+ }
+
+ &__text-line {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ width: 100%;
+ height: 10px;
+
+ &.--short {
+ width: 80%;
+ }
+ }
+
+ &__metric-row {
+ display: flex;
+ justify-content: flex-end;
+ gap: var(--space-10);
+ }
+
+ &__metric {
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-2);
+ align-items: flex-start;
+ }
+
+ &__metric-number {
+ background: var(--primary-200);
+ border-radius: var(--d-border-radius);
+ width: 60px;
+ height: 22px;
+ }
+
+ &__metric-label {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ width: 90px;
+ height: 10px;
+ }
+
+ &__chart {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ height: 240px;
+ width: 100%;
+ }
+
+ &__row {
+ display: flex;
+ flex-wrap: nowrap;
+ gap: var(--space-4);
+ border-top: 1px solid var(--primary-low);
+ }
+
+ &__row-block {
+ flex: 1;
+ padding: var(--space-4);
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-3);
+
+ &:not(:last-child) {
+ border-right: 1px solid var(--primary-low);
+ }
+
+ &.--full {
+ flex: 1 1 100%;
+ }
+ }
+
+ &__row-block-title {
+ background: var(--primary-200);
+ border-radius: var(--d-border-radius);
+ width: 35%;
+ height: 14px;
+ }
+
+ &__list {
+ list-style: none;
+ margin: 0;
+ padding: 0;
+ display: flex;
+ flex-direction: column;
+ gap: var(--space-2);
+ }
+
+ &__list-row {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ gap: var(--space-4);
+ }
+
+ &__list-name {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ height: 12px;
+ flex: 0 1 60%;
+ }
+
+ &__list-value {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ height: 12px;
+ width: 50px;
+ }
+
+ &__pipeline {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ height: 60px;
+ width: 100%;
+ }
+
+ *[class*="db-skeleton__"]:not(
+ .db-skeleton__section,
+ .db-skeleton__section-wrapper,
+ .db-skeleton__kpi-row,
+ .db-skeleton__kpi,
+ .db-skeleton__report-grid,
+ .db-skeleton__report-card,
+ .db-skeleton__report-card-header,
+ .db-skeleton__subheader,
+ .db-skeleton__subintro,
+ .db-skeleton__metric-row,
+ .db-skeleton__metric,
+ .db-skeleton__row,
+ .db-skeleton__row-block,
+ .db-skeleton__list,
+ .db-skeleton__list-row
+ ) {
+ position: relative;
+ overflow: hidden;
+ }
+
+ &.-animation {
+ *[class*="db-skeleton__"]:not(
+ .db-skeleton__section,
+ .db-skeleton__section-wrapper,
+ .db-skeleton__kpi-row,
+ .db-skeleton__kpi,
+ .db-skeleton__report-grid,
+ .db-skeleton__report-card,
+ .db-skeleton__report-card-header,
+ .db-skeleton__subheader,
+ .db-skeleton__subintro,
+ .db-skeleton__metric-row,
+ .db-skeleton__metric,
+ .db-skeleton__row,
+ .db-skeleton__row-block,
+ .db-skeleton__list,
+ .db-skeleton__list-row
+ )::after {
+ position: absolute;
+ inset: 0;
+ transform: translateX(-100%);
+ background: linear-gradient(
+ 90deg,
+ rgb(var(--db-skeleton-animation-rgb), 0) 0,
+ rgb(var(--db-skeleton-animation-rgb), 0.3) 50%,
+ rgb(var(--db-skeleton-animation-rgb), 0.5) 100%
+ );
+ content: "";
+
+ @media (prefers-reduced-motion: no-preference) {
+ animation: db-skeleton-shimmer 1.25s infinite;
+ }
+ }
+
+ @keyframes db-skeleton-shimmer {
+ 100% {
+ transform: translateX(100%);
+ }
+ }
+ }
+}
diff --git a/app/assets/stylesheets/admin/admin_base.scss b/app/assets/stylesheets/admin/admin_base.scss
index 3540da6dd57..ac80ee9534e 100644
--- a/app/assets/stylesheets/admin/admin_base.scss
+++ b/app/assets/stylesheets/admin/admin_base.scss
@@ -1286,6 +1286,7 @@ a.inline-editable-field {
@import "admin/admin_config_area";
@import "admin/search";
@import "admin/admin_dashboard";
+@import "admin/admin-dashboard-skeleton";
@import "admin/admin_table";
@import "admin/admin_filter";
@import "admin/admin_filter_controls";
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index a02a5c031bb..4dd981eab18 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -6840,6 +6840,7 @@ en:
too_many_requests: You’ve performed this action too many times. Please wait before trying again.
not_found_error: Sorry, this report doesn’t exist
custom_date_range: Custom date range
+ loading: "Loading dashboard…"
sections:
highlights:
diff --git a/frontend/discourse/admin/components/dashboard/skeleton.gjs b/frontend/discourse/admin/components/dashboard/skeleton.gjs
new file mode 100644
index 00000000000..33053214fde
--- /dev/null
+++ b/frontend/discourse/admin/components/dashboard/skeleton.gjs
@@ -0,0 +1,133 @@
+import { i18n } from "discourse-i18n";
+
+const KPIS = Array.from({ length: 4 });
+const REPORT_CARDS = Array.from({ length: 4 });
+const TRAFFIC_LIST_ROWS = Array.from({ length: 5 });
+const METRICS = Array.from({ length: 3 });
+const ENGAGEMENT_ACTIVITY_ROWS = Array.from({ length: 4 });
+
+<template>
+ <div
+ class="db-skeleton -animation"
+ role="status"
+ aria-label={{i18n "admin.dashboard.loading"}}
+ >
+ <section class="db-skeleton__section db-skeleton__highlights">
+ <div class="db-skeleton__section-header"></div>
+ <div class="db-skeleton__kpi-row">
+ {{#each KPIS}}
+ <div class="db-skeleton__kpi">
+ <div class="db-skeleton__kpi-value"></div>
+ <div class="db-skeleton__kpi-label"></div>
+ <div class="db-skeleton__kpi-delta"></div>
+ </div>
+ {{/each}}
+ </div>
+ </section>
+
+ <section class="db-skeleton__section db-skeleton__reports">
+ <div class="db-skeleton__section-header"></div>
+ <div class="db-skeleton__report-grid">
+ {{#each REPORT_CARDS}}
+ <div class="db-skeleton__report-card">
+ <div class="db-skeleton__report-card-header">
+ <div class="db-skeleton__report-card-title"></div>
+ <div class="db-skeleton__report-card-label"></div>
+ </div>
+ <div class="db-skeleton__report-card-chart"></div>
+ </div>
+ {{/each}}
+ </div>
+ </section>
+
+ <section class="db-skeleton__section db-skeleton__traffic">
+ <div class="db-skeleton__section-header"></div>
+ <div class="db-skeleton__section-wrapper">
+ <div class="db-skeleton__subheader">
+ <div class="db-skeleton__subintro">
+ <div class="db-skeleton__heading-line"></div>
+ <div class="db-skeleton__text-line"></div>
+ <div class="db-skeleton__text-line --short"></div>
+ </div>
+ <div class="db-skeleton__metric-row">
+ {{#each METRICS}}
+ <div class="db-skeleton__metric">
+ <div class="db-skeleton__metric-number"></div>
+ <div class="db-skeleton__metric-label"></div>
+ </div>
+ {{/each}}
+ </div>
+ </div>
+ <div class="db-skeleton__chart"></div>
+ <div class="db-skeleton__row">
+ <div class="db-skeleton__row-block">
+ <div class="db-skeleton__row-block-title"></div>
+ <ul class="db-skeleton__list">
+ {{#each TRAFFIC_LIST_ROWS}}
+ <li class="db-skeleton__list-row">
+ <span class="db-skeleton__list-name"></span>
+ <span class="db-skeleton__list-value"></span>
+ </li>
+ {{/each}}
+ </ul>
+ </div>
+ <div class="db-skeleton__row-block">
+ <div class="db-skeleton__row-block-title"></div>
+ <ul class="db-skeleton__list">
+ {{#each TRAFFIC_LIST_ROWS}}
+ <li class="db-skeleton__list-row">
+ <span class="db-skeleton__list-name"></span>
+ <span class="db-skeleton__list-value"></span>
+ </li>
+ {{/each}}
+ </ul>
+ </div>
+ </div>
+ </div>
+ </section>
+
+ <section class="db-skeleton__section db-skeleton__engagement">
+ <div class="db-skeleton__section-header"></div>
+ <div class="db-skeleton__section-wrapper">
+ <div class="db-skeleton__subheader">
+ <div class="db-skeleton__subintro">
+ <div class="db-skeleton__heading-line"></div>
+ <div class="db-skeleton__text-line"></div>
+ <div class="db-skeleton__text-line --short"></div>
+ </div>
+ <div class="db-skeleton__metric-row">
+ {{#each METRICS}}
+ <div class="db-skeleton__metric">
+ <div class="db-skeleton__metric-number"></div>
+ <div class="db-skeleton__metric-label"></div>
+ </div>
+ {{/each}}
+ </div>
+ </div>
+ <div class="db-skeleton__row">
+ <div class="db-skeleton__row-block">
+ <div class="db-skeleton__row-block-title"></div>
+ <div class="db-skeleton__pipeline"></div>
+ </div>
+ <div class="db-skeleton__row-block">
+ <div class="db-skeleton__row-block-title"></div>
+ <div class="db-skeleton__pipeline"></div>
+ </div>
+ </div>
+ <div class="db-skeleton__row">
+ <div class="db-skeleton__row-block --full">
+ <div class="db-skeleton__row-block-title"></div>
+ <ul class="db-skeleton__list">
+ {{#each ENGAGEMENT_ACTIVITY_ROWS}}
+ <li class="db-skeleton__list-row">
+ <span class="db-skeleton__list-name"></span>
+ <span class="db-skeleton__list-value"></span>
+ </li>
+ {{/each}}
+ </ul>
+ </div>
+ </div>
+ </div>
+ </section>
+ </div>
+</template>
diff --git a/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs b/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs
index 59c64c14098..c2f9eefff05 100644
--- a/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs
+++ b/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs
@@ -7,6 +7,7 @@ import DashboardDateRange from "discourse/admin/components/dashboard/date-range"
import DashboardEngagement from "discourse/admin/components/dashboard/engagement";
import DashboardHighlights from "discourse/admin/components/dashboard/highlights";
import DashboardReports from "discourse/admin/components/dashboard/reports";
+import DashboardSkeleton from "discourse/admin/components/dashboard/skeleton";
import DashboardTraffic from "discourse/admin/components/dashboard/traffic";
import DMenu from "discourse/float-kit/components/d-menu";
import { popupAjaxError } from "discourse/lib/ajax-error";
@@ -35,6 +36,10 @@ export default class RedesignedAdminDashboard extends Component {
return this.args.configuration?.sections ?? [];
}
+ get showSkeleton() {
+ return this.args.loadingSections && !this.args.sections;
+ }
+
@action
onMenuOpen() {
this._opened = true;
@@ -114,39 +119,49 @@ export default class RedesignedAdminDashboard extends Component {
</div>
<div class="db-main">
- {{#each @sections key="id" as |section|}}
- <div class="db-main__section" data-section-id={{section.id}}>
- {{#if (eq section.id "highlights")}}
- <DashboardHighlights
- @highlights={{section.data}}
- @period={{@period}}
- @loading={{@loadingSections}}
- @fetchError={{@sectionsFetchError}}
- @startDate={{@startDate}}
- @endDate={{@endDate}}
- />
- {{else if (eq section.id "reports")}}
- <DashboardReports @startDate={{@startDate}} @endDate={{@endDate}} />
- {{else if (eq section.id "traffic")}}
- <DashboardTraffic @startDate={{@startDate}} @endDate={{@endDate}} />
- {{else if (eq section.id "engagement")}}
- <DashboardEngagement
- @startDate={{@startDate}}
- @endDate={{@endDate}}
- />
- {{/if}}
- </div>
- {{/each}}
-
- {{#unless @sections.length}}
- <div class="db-main__empty" role="status" aria-live="polite">
- {{#if this.currentUser.admin}}
- {{i18n "admin.dashboard.configure.empty_state_admin"}}
- {{else}}
- {{i18n "admin.dashboard.configure.empty_state_moderator"}}
- {{/if}}
- </div>
- {{/unless}}
+ {{#if this.showSkeleton}}
+ <DashboardSkeleton />
+ {{else}}
+ {{#each @sections key="id" as |section|}}
+ <div class="db-main__section" data-section-id={{section.id}}>
+ {{#if (eq section.id "highlights")}}
+ <DashboardHighlights
+ @highlights={{section.data}}
+ @period={{@period}}
+ @loading={{@loadingSections}}
+ @fetchError={{@sectionsFetchError}}
+ @startDate={{@startDate}}
+ @endDate={{@endDate}}
+ />
+ {{else if (eq section.id "reports")}}
+ <DashboardReports
+ @startDate={{@startDate}}
+ @endDate={{@endDate}}
+ />
+ {{else if (eq section.id "traffic")}}
+ <DashboardTraffic
+ @startDate={{@startDate}}
+ @endDate={{@endDate}}
+ />
+ {{else if (eq section.id "engagement")}}
+ <DashboardEngagement
+ @startDate={{@startDate}}
+ @endDate={{@endDate}}
+ />
+ {{/if}}
+ </div>
+ {{/each}}
+
+ {{#unless @sections.length}}
+ <div class="db-main__empty" role="status" aria-live="polite">
+ {{#if this.currentUser.admin}}
+ {{i18n "admin.dashboard.configure.empty_state_admin"}}
+ {{else}}
+ {{i18n "admin.dashboard.configure.empty_state_moderator"}}
+ {{/if}}
+ </div>
+ {{/unless}}
+ {{/if}}
</div>
</template>
}
diff --git a/frontend/discourse/tests/integration/components/dashboard/skeleton-test.gjs b/frontend/discourse/tests/integration/components/dashboard/skeleton-test.gjs
new file mode 100644
index 00000000000..2d6a0b231f0
--- /dev/null
+++ b/frontend/discourse/tests/integration/components/dashboard/skeleton-test.gjs
@@ -0,0 +1,40 @@
+import { render } from "@ember/test-helpers";
+import { module, test } from "qunit";
+import DashboardSkeleton from "discourse/admin/components/dashboard/skeleton";
+import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import { i18n } from "discourse-i18n";
+
+module("Integration | Component | Dashboard | Skeleton", function (hooks) {
+ setupRenderingTest(hooks);
+
+ test("renders an accessible status wrapper", async function (assert) {
+ await render(<template><DashboardSkeleton /></template>);
+
+ assert
+ .dom(".db-skeleton")
+ .hasAttribute("role", "status")
+ .hasAria("label", i18n("admin.dashboard.loading"));
+ });
+
+ test("renders placeholder blocks for all four dashboard sections", async function (assert) {
+ await render(<template><DashboardSkeleton /></template>);
+
+ assert.dom(".db-skeleton__highlights").exists();
+ assert.dom(".db-skeleton__reports").exists();
+ assert.dom(".db-skeleton__traffic").exists();
+ assert.dom(".db-skeleton__engagement").exists();
+ });
+
+ test("renders four KPI placeholders and four report cards", async function (assert) {
+ await render(<template><DashboardSkeleton /></template>);
+
+ assert.dom(".db-skeleton__kpi").exists({ count: 4 });
+ assert.dom(".db-skeleton__report-card").exists({ count: 4 });
+ });
+
+ test("opts into the shimmer animation", async function (assert) {
+ await render(<template><DashboardSkeleton /></template>);
+
+ assert.dom(".db-skeleton").hasClass("-animation");
+ });
+});