Skip to content

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

UX: add skeleton loading state to post reactions menu (#40188)

David Battersbyc381c60afe97
diff --git a/app/assets/stylesheets/common/modal/discourse-reactions-popup.scss b/app/assets/stylesheets/common/modal/discourse-reactions-popup.scss
index 5883450ab89..f7b9b067e76 100644
--- a/app/assets/stylesheets/common/modal/discourse-reactions-popup.scss
+++ b/app/assets/stylesheets/common/modal/discourse-reactions-popup.scss
@@ -15,6 +15,7 @@
}
.post-users-popup {
+ --skeleton-shimmer-rgb: #{hexToRGB($primary-50)};
width: 250px;
background: var(--secondary);
color: var(--primary);
@@ -138,6 +139,8 @@
}
.avatar {
+ background: var(--primary-low);
+
@include viewport.until(sm) {
width: 32px;
height: 32px;
@@ -187,12 +190,76 @@
}
}
- .loading-container {
- display: flex;
- justify-content: center;
+ &__skeleton-item {
+ pointer-events: none;
+ }
+
+ &__skeleton-avatar,
+ &__skeleton-name,
+ &__skeleton-username,
+ &__skeleton-reaction {
+ background: var(--primary-low);
+ border-radius: var(--d-border-radius);
+ position: relative;
+ overflow: hidden;
+
+ &::after {
+ content: "";
+ position: absolute;
+ inset: 0;
+ transform: translateX(-100%);
+ background: linear-gradient(
+ 90deg,
+ rgb(var(--skeleton-shimmer-rgb), 0) 0,
+ rgb(var(--skeleton-shimmer-rgb), 0.3) 50%,
+ rgb(var(--skeleton-shimmer-rgb), 0.5) 100%
+ );
+
+ @media (prefers-reduced-motion: no-preference) {
+ animation: post-users-popup-shimmer 1.25s infinite;
+ }
+ }
+ }
+
+ &__skeleton-avatar {
+ width: 24px;
+ height: 24px;
+ border-radius: 50%;
+ flex-shrink: 0;
+
+ @include viewport.until(sm) {
+ width: 32px;
+ height: 32px;
+ }
+ }
+
+ &__skeleton-name {
+ height: 12px;
+ width: 60%;
+ margin-top: 2px;
+ }
+
+ &__skeleton-username {
+ height: 10px;
+ width: 40%;
+ margin-top: var(--space-2);
+ }
+
+ &__skeleton-reaction {
+ width: 1.15em;
+ height: 1.15em;
+ flex-shrink: 0;
+ margin-left: auto;
+
+ @include viewport.until(sm) {
+ width: 1.25em;
+ height: 1.25em;
+ }
+ }
- .spinner {
- margin: var(--space-3);
+ @keyframes post-users-popup-shimmer {
+ 100% {
+ transform: translateX(100%);
}
}
}
diff --git a/frontend/discourse/app/components/post/menu/liked-users-menu.gjs b/frontend/discourse/app/components/post/menu/liked-users-menu.gjs
index b2fa8e75068..6c8234bf79a 100644
--- a/frontend/discourse/app/components/post/menu/liked-users-menu.gjs
+++ b/frontend/discourse/app/components/post/menu/liked-users-menu.gjs
@@ -39,6 +39,7 @@ export default class PostLikedUsersMenu extends Component {
<PostUsersMenu
@fetchUsers={{this.fetchUsers}}
@titleText={{this.titleText}}
+ @totalUsers={{this.post.likeCount}}
>
<:avatar as |user|>
<PluginOutlet
diff --git a/frontend/discourse/app/components/post/menu/post-users-menu.gjs b/frontend/discourse/app/components/post/menu/post-users-menu.gjs
index c33c2f0ecee..5d4650ebb9f 100644
--- a/frontend/discourse/app/components/post/menu/post-users-menu.gjs
+++ b/frontend/discourse/app/components/post/menu/post-users-menu.gjs
@@ -5,13 +5,29 @@ import didInsert from "@ember/render-modifiers/modifiers/did-insert";
import { schedule } from "@ember/runloop";
import { service } from "@ember/service";
import { trustHTML } from "@ember/template";
-import DConditionalLoadingSpinner from "discourse/ui-kit/d-conditional-loading-spinner";
import DLoadMore from "discourse/ui-kit/d-load-more";
import DUserAvatar from "discourse/ui-kit/d-user-avatar";
import DUserLink from "discourse/ui-kit/d-user-link";
import dIcon from "discourse/ui-kit/helpers/d-icon";
const PAGE_SIZE = 30;
+const FALLBACK_SKELETON_ROWS = 3;
+
+const SkeletonRow = <template>
+ <div
+ class="post-users-popup__item post-users-popup__skeleton-item"
+ aria-hidden="true"
+ >
+ <div class="post-users-popup__skeleton-avatar"></div>
+ <div class="post-users-popup__user-info">
+ <div class="post-users-popup__skeleton-name"></div>
+ {{#unless @prioritizeUsername}}
+ <div class="post-users-popup__skeleton-username"></div>
+ {{/unless}}
+ </div>
+ <div class="post-users-popup__skeleton-reaction"></div>
+ </div>
+</template>;
export default class PostUsersMenu extends Component {
@service siteSettings;
@@ -43,6 +59,18 @@ export default class PostUsersMenu extends Component {
return null;
}
+ get skeletonRows() {
+ if (!this.loading) {
+ return [];
+ }
+
+ const remaining = this.args.totalUsers - this.users.length;
+ const count = Number.isFinite(remaining)
+ ? Math.min(Math.max(remaining, 0), PAGE_SIZE)
+ : FALLBACK_SKELETON_ROWS;
+ return Array.from({ length: count });
+ }
+
@action
async loadInitial(element) {
await this.#loadMore();
@@ -130,10 +158,11 @@ export default class PostUsersMenu extends Component {
{{/if}}
</div>
{{/each}}
- <DConditionalLoadingSpinner
- @condition={{this.loading}}
- @size="small"
- />
+ {{#each this.skeletonRows}}
+ <SkeletonRow
+ @prioritizeUsername={{this.siteSettings.prioritize_username_in_ux}}
+ />
+ {{/each}}
</DLoadMore>
</div>
</div>
diff --git a/frontend/discourse/tests/integration/components/post/menu/post-users-menu-test.gjs b/frontend/discourse/tests/integration/components/post/menu/post-users-menu-test.gjs
new file mode 100644
index 00000000000..23139ac59ff
--- /dev/null
+++ b/frontend/discourse/tests/integration/components/post/menu/post-users-menu-test.gjs
@@ -0,0 +1,179 @@
+import { render, settled, waitFor, waitUntil } from "@ember/test-helpers";
+import { module, test } from "qunit";
+import PostUsersMenu from "discourse/components/post/menu/post-users-menu";
+import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import stubIntersectionObserver from "discourse/tests/helpers/stub-intersection-observer";
+import {
+ disableLoadMoreObserver,
+ enableLoadMoreObserver,
+} from "discourse/ui-kit/d-load-more";
+
+function makeUsers(count) {
+ return Array.from({ length: count }, (_, i) => ({
+ id: i + 1,
+ username: `u${i + 1}`,
+ name: `User ${i + 1}`,
+ avatar_template: "/user_avatar/avatar/{size}/1_1.png",
+ }));
+}
+
+function deferredFetch(response) {
+ let resolve;
+ const promise = new Promise((r) => (resolve = r));
+ const fetchUsers = () => promise;
+ return {
+ fetchUsers,
+ resolve: () => resolve(response),
+ };
+}
+
+module("Integration | Component | post/menu/post-users-menu", function (hooks) {
+ setupRenderingTest(hooks);
+
+ hooks.beforeEach(function () {
+ enableLoadMoreObserver();
+ this.observations = stubIntersectionObserver();
+ });
+
+ hooks.afterEach(function () {
+ disableLoadMoreObserver();
+ });
+
+ test("renders skeleton rows while the initial fetch is pending", async function (assert) {
+ const { fetchUsers, resolve } = deferredFetch({
+ users: makeUsers(5),
+ canLoadMore: false,
+ });
+
+ const renderPromise = render(
+ <template>
+ <PostUsersMenu
+ @fetchUsers={{fetchUsers}}
+ @titleText="Likes"
+ @totalUsers={{5}}
+ />
+ </template>
+ );
+
+ await waitFor(".post-users-popup__skeleton-item");
+
+ assert
+ .dom(".post-users-popup__skeleton-item")
+ .exists(
+ { count: 5 },
+ "renders one skeleton per pending user up to PAGE_SIZE"
+ );
+
+ resolve();
+ await renderPromise;
+ await settled();
+
+ assert
+ .dom(".post-users-popup__skeleton-item")
+ .doesNotExist("skeleton rows clear once the fetch resolves");
+ assert
+ .dom(".post-users-popup__item:not(.post-users-popup__skeleton-item)")
+ .exists({ count: 5 }, "renders real user rows after load");
+ });
+
+ test("caps skeleton rows at PAGE_SIZE when totalUsers is larger", async function (assert) {
+ const { fetchUsers, resolve } = deferredFetch({
+ users: makeUsers(30),
+ canLoadMore: true,
+ });
+
+ const renderPromise = render(
+ <template>
+ <PostUsersMenu
+ @fetchUsers={{fetchUsers}}
+ @titleText="Likes"
+ @totalUsers={{200}}
+ />
+ </template>
+ );
+
+ await waitFor(".post-users-popup__skeleton-item");
+
+ assert
+ .dom(".post-users-popup__skeleton-item")
+ .exists({ count: 30 }, "skeleton count is capped at PAGE_SIZE");
+
+ resolve();
+ await renderPromise;
+ await settled();
+ });
+
+ test("does not fall back to skeleton rows when load more starts with every known user loaded", async function (assert) {
+ let fetchCallCount = 0;
+ let resolveSecondFetch;
+ const secondFetchPromise = new Promise((resolve) => {
+ resolveSecondFetch = resolve;
+ });
+ const fetchUsers = () => {
+ fetchCallCount++;
+
+ if (fetchCallCount === 1) {
+ return Promise.resolve({
+ users: makeUsers(30),
+ canLoadMore: true,
+ });
+ }
+
+ return secondFetchPromise;
+ };
+
+ await render(
+ <template>
+ <PostUsersMenu
+ @fetchUsers={{fetchUsers}}
+ @titleText="Likes"
+ @totalUsers={{30}}
+ />
+ </template>
+ );
+
+ assert
+ .dom(".post-users-popup__item:not(.post-users-popup__skeleton-item)")
+ .exists({ count: 30 }, "renders the initially loaded full page");
+
+ const triggerPromise =
+ this.observations[this.observations.length - 1]?.trigger();
+ await waitUntil(() => fetchCallCount === 2);
+
+ assert
+ .dom(".post-users-popup__skeleton-item")
+ .doesNotExist(
+ "does not render fallback skeleton rows when totalUsers has already been reached"
+ );
+
+ resolveSecondFetch({ users: [], canLoadMore: false });
+ await triggerPromise;
+ await settled();
+ });
+
+ test("falls back to a small skeleton count when totalUsers is missing", async function (assert) {
+ const { fetchUsers, resolve } = deferredFetch({
+ users: makeUsers(2),
+ canLoadMore: false,
+ });
+
+ const renderPromise = render(
+ <template>
+ <PostUsersMenu @fetchUsers={{fetchUsers}} @titleText="Likes" />
+ </template>
+ );
+
+ await waitFor(".post-users-popup__skeleton-item");
+
+ assert
+ .dom(".post-users-popup__skeleton-item")
+ .exists(
+ { count: 3 },
+ "still shows a small skeleton fallback when count is unknown"
+ );
+
+ resolve();
+ await renderPromise;
+ await settled();
+ });
+});
diff --git a/plugins/discourse-reactions/assets/javascripts/discourse/components/discourse-reactions-users-menu.gjs b/plugins/discourse-reactions/assets/javascripts/discourse/components/discourse-reactions-users-menu.gjs
index 4f36a6563a8..e9281bde92d 100644
--- a/plugins/discourse-reactions/assets/javascripts/discourse/components/discourse-reactions-users-menu.gjs
+++ b/plugins/discourse-reactions/assets/javascripts/discourse/components/discourse-reactions-users-menu.gjs
@@ -79,6 +79,13 @@ export default class DiscourseReactionsUsersMenu extends Component {
});
}
+ get activeFilterTotalUsers() {
+ if (!this.activeFilter) {
+ return this.post.reaction_users_count;
+ }
+ return this.reactions.find((r) => r.id === this.activeFilter)?.count;
+ }
+
@action
registerReset(resetFn) {
this.#resetCallback = resetFn;
@@ -100,6 +107,7 @@ export default class DiscourseReactionsUsersMenu extends Component {
<PostUsersMenu
@fetchUsers={{this.fetchUsers}}
@titleText={{this.titleText}}
+ @totalUsers={{this.activeFilterTotalUsers}}
>
<:header as |resetAndReload|>
{{this.registerReset resetAndReload}}