Skip to content

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

FIX: Show event popup on category calendar click (#38999)

Régis Hanol1fda82315eef
diff --git a/plugins/discourse-calendar/assets/javascripts/discourse/components/category-calendar.gjs b/plugins/discourse-calendar/assets/javascripts/discourse/components/category-calendar.gjs
index 3563384de37..1fe14a984a7 100644
--- a/plugins/discourse-calendar/assets/javascripts/discourse/components/category-calendar.gjs
+++ b/plugins/discourse-calendar/assets/javascripts/discourse/components/category-calendar.gjs
@@ -3,17 +3,15 @@ import { action } from "@ember/object";
import { service } from "@ember/service";
import { popupAjaxError } from "discourse/lib/ajax-error";
import { bind } from "discourse/lib/decorators";
-import getURL from "discourse/lib/get-url";
import Category from "discourse/models/category";
-import { formatEventName } from "../helpers/format-event-name";
-import { isNotFullDayEvent } from "../lib/guess-best-date-format";
+import formatEventForCalendar from "../lib/format-event-for-calendar";
import FullCalendar from "./full-calendar";
export default class CategoryCalendar extends Component {
@service currentUser;
@service router;
@service siteSettings;
- @service discoursePostEventApi;
+ @service discoursePostEventService;
@bind
async loadEvents(info) {
@@ -26,17 +24,13 @@ export default class CategoryCalendar extends Component {
include_subcategories: true,
};
- const events = await this.discoursePostEventApi.events(params);
+ const events = await this.discoursePostEventService.fetchEvents(params);
return this.formattedEvents(events);
} catch (error) {
popupAjaxError(error);
}
}
- get tagsColorsMap() {
- return JSON.parse(this.siteSettings.map_events_to_color);
- }
-
get shouldRender() {
if (!this.siteSettings.discourse_post_event_enabled) {
return false;
@@ -111,40 +105,14 @@ export default class CategoryCalendar extends Component {
@action
formattedEvents(events = []) {
- return events.map((event) => {
- const { startsAt, endsAt, post, categoryId } = event;
-
- let backgroundColor;
-
- if (post.topic.tags) {
- const tagColorEntry = this.tagsColorsMap.find(
- (entry) =>
- entry.type === "tag" &&
- post.topic.tags.some(
- (t) => (typeof t === "string" ? t : t.name) === entry.slug
- )
- );
- backgroundColor = tagColorEntry ? tagColorEntry.color : null;
- }
-
- if (!backgroundColor) {
- const categoryColorFromMap = this.tagsColorsMap.find(
- (entry) =>
- entry.type === "category" && entry.slug === post.category_slug
- )?.color;
- backgroundColor =
- categoryColorFromMap || `#${Category.findById(categoryId)?.color}`;
- }
-
- return {
- title: formatEventName(event, this.currentUser?.user_option?.timezone),
- start: startsAt,
- end: endsAt || startsAt,
- allDay: !isNotFullDayEvent(moment(startsAt), moment(endsAt)),
- url: getURL(`/t/-/${post.topic.id}/${post.post_number}`),
- backgroundColor,
- };
- });
+ const timezone = this.currentUser?.user_option?.timezone;
+ return events.map((event) =>
+ formatEventForCalendar(
+ event,
+ this.siteSettings.map_events_to_color,
+ timezone
+ )
+ );
}
<template>
diff --git a/plugins/discourse-calendar/assets/javascripts/discourse/components/discourse-post-event/index.gjs b/plugins/discourse-calendar/assets/javascripts/discourse/components/discourse-post-event/index.gjs
index 4c4bf80a39b..794b5dcd34b 100644
--- a/plugins/discourse-calendar/assets/javascripts/discourse/components/discourse-post-event/index.gjs
+++ b/plugins/discourse-calendar/assets/javascripts/discourse/components/discourse-post-event/index.gjs
@@ -11,6 +11,7 @@ import replaceEmoji from "discourse/helpers/replace-emoji";
import routeAction from "discourse/helpers/route-action";
import { popupAjaxError } from "discourse/lib/ajax-error";
import { bind } from "discourse/lib/decorators";
+import { i18n } from "discourse-i18n";
import ChatChannel from "./chat-channel";
import Creator from "./creator";
import Dates from "./dates";
@@ -103,6 +104,15 @@ export default class DiscoursePostEvent extends Component {
return this.event.isExpired && this.event.recurrence;
}
+ get recurrenceLabel() {
+ if (!this.event?.recurrence) {
+ return null;
+ }
+ return i18n(
+ `discourse_post_event.builder_modal.recurrence.${this.event.recurrence}`
+ );
+ }
+
@bind
async loadEvent() {
if (this.event) {
@@ -201,6 +211,10 @@ export default class DiscoursePostEvent extends Component {
event=event
expiredAndRecurring=this.expiredAndRecurring
)
+ Recurrence=(component
+ InfoSection icon="arrows-rotate" class="event-recurrence"
+ )
+ recurrenceLabel=this.recurrenceLabel
Invitees=(component Invitees event=event)
Status=(component Status event=event)
ChatChannel=(component ChatChannel event=event)
@@ -210,6 +224,11 @@ export default class DiscoursePostEvent extends Component {
@event={{event}}
@expiredAndRecurring={{this.expiredAndRecurring}}
/>
+ {{#if event.recurrence}}
+ <InfoSection @icon="arrows-rotate" class="event-recurrence">
+ {{this.recurrenceLabel}}
+ </InfoSection>
+ {{/if}}
<Location @location={{event.location}} />
<Url @url={{event.url}} />
<ChatChannel @event={{event}} />
diff --git a/plugins/discourse-calendar/assets/javascripts/discourse/components/full-calendar.gjs b/plugins/discourse-calendar/assets/javascripts/discourse/components/full-calendar.gjs
index cdf4c542945..12309c3329e 100644
--- a/plugins/discourse-calendar/assets/javascripts/discourse/components/full-calendar.gjs
+++ b/plugins/discourse-calendar/assets/javascripts/discourse/components/full-calendar.gjs
@@ -6,6 +6,7 @@ import didUpdate from "@ember/render-modifiers/modifiers/did-update";
import { service } from "@ember/service";
import { trustHTML } from "@ember/template";
import { modifier as modifierFn } from "ember-modifier";
+import { iconHTML } from "discourse/lib/icon-library";
import loadFullCalendar from "discourse/lib/load-full-calendar";
import DiscourseURL from "discourse/lib/url";
import DiscoursePostEvent from "discourse/plugins/discourse-calendar/discourse/components/discourse-post-event";
@@ -108,6 +109,16 @@ export default class FullCalendar extends Component {
await this.activeMenu?.close?.();
await this.activeTooltip?.close?.();
},
+ eventDidMount: ({ el, event }) => {
+ const { postEvent } = event.extendedProps;
+ if (postEvent?.recurrence) {
+ el.classList.add("fc-recurring-event");
+ const titleEl = el.querySelector(".fc-event-title");
+ if (titleEl) {
+ titleEl.insertAdjacentHTML("afterbegin", iconHTML("arrows-rotate"));
+ }
+ }
+ },
datesSet: (info) => {
this.args.onDatesChange?.(info);
},
diff --git a/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-calendar.gjs b/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-calendar.gjs
index 331b46060ce..8967dbd1b40 100644
--- a/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-calendar.gjs
+++ b/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-calendar.gjs
@@ -3,12 +3,9 @@ import { action } from "@ember/object";
import { schedule } from "@ember/runloop";
import { service } from "@ember/service";
import moment from "moment";
-import getURL from "discourse/lib/get-url";
-import Category from "discourse/models/category";
import { i18n } from "discourse-i18n";
-import { formatEventName } from "../helpers/format-event-name";
import { normalizeViewForRoute } from "../lib/calendar-view-helper";
-import { isNotFullDayEvent } from "../lib/guess-best-date-format";
+import formatEventForCalendar from "../lib/format-event-for-calendar";
import FullCalendar from "./full-calendar";
export default class UpcomingEventsCalendar extends Component {
@@ -58,57 +55,15 @@ export default class UpcomingEventsCalendar extends Component {
attending_user: this.args.mine ? this.currentUser?.username : null,
});
- const tagsColorsMap = JSON.parse(this.siteSettings.map_events_to_color);
+ const timezone = this.currentUser?.user_option?.timezone;
- return events.map((event) => {
- const { startsAt, endsAt, post, categoryId } = event;
-
- let backgroundColor;
-
- if (post?.topic?.tags) {
- const tagColorEntry = tagsColorsMap.find(
- (entry) =>
- entry.type === "tag" &&
- post.topic.tags.some(
- (t) => (typeof t === "string" ? t : t.name) === entry.slug
- )
- );
- backgroundColor = tagColorEntry?.color;
- }
-
- if (!backgroundColor) {
- const categoryColorEntry = tagsColorsMap.find(
- (entry) =>
- entry.type === "category" && entry.slug === post?.category_slug
- );
- backgroundColor = categoryColorEntry?.color;
- }
-
- const categoryColor = Category.findById(categoryId)?.color;
- if (!backgroundColor && categoryColor) {
- backgroundColor = `#${categoryColor}`;
- }
-
- const isAllDay =
- event.allDay || !isNotFullDayEvent(moment(startsAt), moment(endsAt));
-
- // FullCalendar treats end as exclusive for allDay events,
- // so add one day to make the end date inclusive
- let calendarEnd = endsAt || startsAt;
- if (isAllDay && calendarEnd) {
- calendarEnd = moment(calendarEnd).add(1, "day").format("YYYY-MM-DD");
- }
-
- return {
- extendedProps: { postEvent: event },
- title: formatEventName(event, this.currentUser?.user_option?.timezone),
- start: startsAt,
- end: calendarEnd,
- allDay: isAllDay,
- url: getURL(`/t/-/${post?.topic?.id}/${post?.post_number}`),
- backgroundColor,
- };
- });
+ return events.map((event) =>
+ formatEventForCalendar(
+ event,
+ this.siteSettings.map_events_to_color,
+ timezone
+ )
+ );
}
get leftHeaderToolbar() {
diff --git a/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-list.gjs b/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-list.gjs
index 3db43c4eda8..4d93a65731a 100644
--- a/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-list.gjs
+++ b/plugins/discourse-calendar/assets/javascripts/discourse/components/upcoming-events-list.gjs
@@ -6,6 +6,7 @@ import { service } from "@ember/service";
import ConditionalLoadingSpinner from "discourse/components/conditional-loading-spinner";
import DButton from "discourse/components/d-button";
import PluginOutlet from "discourse/components/plugin-outlet";
+import icon from "discourse/helpers/d-icon";
import { ajax } from "discourse/lib/ajax";
import { applyValueTransformer } from "discourse/lib/transformer";
import { or } from "discourse/truth-helpers";
@@ -274,6 +275,9 @@ export default class UpcomingEventsList extends Component {
class="upcoming-events-list__event-name"
title={{or event.name event.post.topic.title}}
>
+ {{#if event.recurrence}}
+ {{icon "arrows-rotate"}}
+ {{/if}}
{{or event.name event.post.topic.title}}
</span>
{{#if this.timeFormat}}
diff --git a/plugins/discourse-calendar/assets/javascripts/discourse/lib/format-event-for-calendar.js b/plugins/discourse-calendar/assets/javascripts/discourse/lib/format-event-for-calendar.js
new file mode 100644
index 00000000000..beb00e68676
--- /dev/null
+++ b/plugins/discourse-calendar/assets/javascripts/discourse/lib/format-event-for-calendar.js
@@ -0,0 +1,64 @@
+import getURL from "discourse/lib/get-url";
+import Category from "discourse/models/category";
+import { formatEventName } from "../helpers/format-event-name";
+import { isNotFullDayEvent } from "./guess-best-date-format";
+
+function resolveBackgroundColor(event, tagsColorsMap) {
+ const { post, categoryId } = event;
+
+ if (post?.topic?.tags) {
+ const tagColorEntry = tagsColorsMap.find(
+ (entry) =>
+ entry.type === "tag" &&
+ post.topic.tags.some(
+ (t) => (typeof t === "string" ? t : t.name) === entry.slug
+ )
+ );
+ if (tagColorEntry?.color) {
+ return tagColorEntry.color;
+ }
+ }
+
+ const categoryColorEntry = tagsColorsMap.find(
+ (entry) => entry.type === "category" && entry.slug === post?.category_slug
+ );
+ if (categoryColorEntry?.color) {
+ return categoryColorEntry.color;
+ }
+
+ const categoryColor = Category.findById(categoryId)?.color;
+ if (categoryColor) {
+ return `#${categoryColor}`;
+ }
+
+ return null;
+}
+
+export default function formatEventForCalendar(
+ event,
+ mapEventsToColor,
+ timezone
+) {
+ const tagsColorsMap = JSON.parse(mapEventsToColor);
+ const { startsAt, endsAt, post } = event;
+
+ const isAllDay =
+ event.allDay || !isNotFullDayEvent(moment(startsAt), moment(endsAt));
+
+ // FullCalendar treats end as exclusive for allDay events,
+ // so add one day to make the end date inclusive
+ let calendarEnd = endsAt || startsAt;
+ if (isAllDay && calendarEnd) {
+ calendarEnd = moment(calendarEnd).add(1, "day").format("YYYY-MM-DD");
+ }
+
+ return {
+ extendedProps: { postEvent: event },
+ title: formatEventName(event, timezone),
+ start: startsAt,
+ end: calendarEnd,
+ allDay: isAllDay,
+ url: getURL(`/t/-/${post?.topic?.id}/${post?.post_number}`),
+ backgroundColor: resolveBackgroundColor(event, tagsColorsMap),
+ };
+}
diff --git a/plugins/discourse-calendar/assets/stylesheets/common/discourse-post-event.scss b/plugins/discourse-calendar/assets/stylesheets/common/discourse-post-event.scss
index 0860db72cf2..de602e1183d 100644
--- a/plugins/discourse-calendar/assets/stylesheets/common/discourse-post-event.scss
+++ b/plugins/discourse-calendar/assets/stylesheets/common/discourse-post-event.scss
@@ -365,6 +365,7 @@ $show-interested: inherit;
.event-location,
.event-url,
.event-dates,
+ .event-recurrence,
.event-chat-channel,
.event-invitees-avatars-container {
display: grid;
@@ -384,6 +385,20 @@ $show-interested: inherit;
}
}
+ .event-recurrence {
+ color: var(--primary-medium);
+ padding-top: 0;
+
+ > .d-icon {
+ color: var(--primary-medium);
+ font-size: var(--font-down-1);
+ }
+
+ > :not(.d-icon) {
+ font-size: var(--font-down-1);
+ }
+ }
+
.event-url {
.url {
max-width: 80%;
diff --git a/plugins/discourse-calendar/assets/stylesheets/common/full-calendar-ext.scss b/plugins/discourse-calendar/assets/stylesheets/common/full-calendar-ext.scss
index c4a6246d94a..2557132febb 100644
--- a/plugins/discourse-calendar/assets/stylesheets/common/full-calendar-ext.scss
+++ b/plugins/discourse-calendar/assets/stylesheets/common/full-calendar-ext.scss
@@ -55,6 +55,12 @@
opacity: 0.3;
}
+.fc-recurring-event .fc-event-title .d-icon {
+ margin-right: 0.25em;
+ font-size: var(--font-down-2);
+ opacity: 0.8;
+}
+
.fc-dayGridMonth-view {
.fc-event-time {
overflow: visible !important;
diff --git a/plugins/discourse-calendar/assets/stylesheets/common/upcoming-events-list.scss b/plugins/discourse-calendar/assets/stylesheets/common/upcoming-events-list.scss
index 6d5226fcda0..cc3171859bb 100644
--- a/plugins/discourse-calendar/assets/stylesheets/common/upcoming-events-list.scss
+++ b/plugins/discourse-calendar/assets/stylesheets/common/upcoming-events-list.scss
@@ -54,6 +54,12 @@
-webkit-box-orient: vertical;
overflow: hidden;
color: var(--primary);
+
+ .d-icon-arrows-rotate {
+ margin-right: 0.25em;
+ font-size: var(--font-down-1);
+ color: var(--primary-medium);
+ }
}
&__event-time {
diff --git a/plugins/discourse-calendar/test/javascripts/acceptance/category-events-calendar-test.js b/plugins/discourse-calendar/test/javascripts/acceptance/category-events-calendar-test.js
index ed661e655dc..cfbe9536868 100644
--- a/plugins/discourse-calendar/test/javascripts/acceptance/category-events-calendar-test.js
+++ b/plugins/discourse-calendar/test/javascripts/acceptance/category-events-calendar-test.js
@@ -1,4 +1,4 @@
-import { visit } from "@ember/test-helpers";
+import { click, visit } from "@ember/test-helpers";
import { test } from "qunit";
import { acceptance } from "discourse/tests/helpers/qunit-helpers";
import I18n from "discourse-i18n";
@@ -13,6 +13,37 @@ acceptance("Discourse Calendar - Category Events Calendar", function (needs) {
});
needs.pretender((server, helper) => {
+ server.get("/discourse-post-event/events/:id", () => {
+ return helper.response({
+ event: {
+ id: 67501,
+ starts_at: moment()
+ .tz("Asia/Calcutta")
+ .add(1, "days")
+ .format("YYYY-MM-DDT15:14:00.000Z"),
+ ends_at: moment()
+ .tz("Asia/Calcutta")
+ .add(1, "days")
+ .format("YYYY-MM-DDT16:14:00.000Z"),
+ timezone: "Asia/Calcutta",
+ post: {
+ id: 67501,
+ post_number: 1,
+ url: "/t/this-is-an-event/18449/1",
+ topic: {
+ id: 18449,
+ title: "This is an event",
+ },
+ },
+ name: "Awesome Event",
+ recurrence: "every_day",
+ creator: { id: 1, username: "admin", name: "Admin" },
+ status: "public",
+ should_display_invitees: false,
+ },
+ });
+ });
+
server.get("/discourse-post-event/events", () => {
return helper.response({
events: [
@@ -37,6 +68,7 @@ acceptance("Discourse Calendar - Category Events Calendar", function (needs) {
},
},
name: "Awesome Event",
+ recurrence: "every_day",
rrule: `DTSTART:${moment().format("YYYYMMDDTHHmmss")}Z\nRRULE:FREQ=DAILY;INTERVAL=1;UNTIL=${moment().add(2, "days").format("YYYYMMDD")}`,
occurrences: [
{
@@ -189,4 +221,68 @@ acceptance("Discourse Calendar - Category Events Calendar", function (needs) {
"events are in different days"
);
});
+
+ test("recurring events show a visual indicator", async function (assert) {
+ await visit("/c/bug/1");
+
+ const recurringEvent = document.querySelector(
+ ".fc-daygrid-event-harness a[href='/t/-/18449/1']"
+ );
+ assert
+ .dom(recurringEvent)
+ .hasClass("fc-recurring-event", "recurring event has the CSS class");
+ assert
+ .dom(".d-icon-arrows-rotate", recurringEvent)
+ .exists("recurring event shows the recurring icon");
+
+ const nonRecurringEvent = document.querySelector(
+ ".fc-daygrid-event-harness a[href='/t/-/18450/1']"
+ );
+ assert
+ .dom(nonRecurringEvent)
+ .doesNotHaveClass(
+ "fc-recurring-event",
+ "non-recurring event does not have the CSS class"
+ );
+ assert
+ .dom(".d-icon-arrows-rotate", nonRecurringEvent)
+ .doesNotExist("non-recurring event does not show the recurring icon");
+ });
+
+ test("clicking an event shows a popup instead of navigating away", async function (assert) {
+ await visit("/c/bug/1");
+
+ const eventLink = document.querySelector(
+ ".fc-daygrid-event-harness a[href='/t/-/18449/1']"
+ );
+ assert.notStrictEqual(eventLink, null, "event link exists");
+
+ await click(eventLink);
+
+ assert
+ .dom(".discourse-post-event")
+ .exists("event popup is shown after clicking");
+ assert
+ .dom("#category-events-calendar")
+ .exists("still on the category page after clicking");
+ });
+
+ test("event popup shows recurrence info for recurring events", async function (assert) {
+ await visit("/c/bug/1");
+
+ const eventLink = document.querySelector(
+ ".fc-daygrid-event-harness a[href='/t/-/18449/1']"
+ );
+ await click(eventLink);
+
+ assert
+ .dom(".event-recurrence")
+ .exists("recurrence section is shown in the popup");
+ assert
+ .dom(".event-recurrence .d-icon-arrows-rotate")
+ .exists("recurrence section has the recurring icon");
+ assert
+ .dom(".event-recurrence")
+ .hasText("Every day", "recurrence section shows the correct label");
+ });
});
diff --git a/plugins/discourse-calendar/test/javascripts/integration/components/upcoming-events-list-test.gjs b/plugins/discourse-calendar/test/javascripts/integration/components/upcoming-events-list-test.gjs
index bac4bc0d0d4..c03d01e8218 100644
--- a/plugins/discourse-calendar/test/javascripts/integration/components/upcoming-events-list-test.gjs
+++ b/plugins/discourse-calendar/test/javascripts/integration/components/upcoming-events-list-test.gjs
@@ -543,6 +543,58 @@ module("Integration | Component | upcoming-events-list", function (hooks) {
.hasText("Awesome Event", "displays the event name");
});
+ test("shows recurring icon for recurring events", async function (assert) {
+ pretender.get("/discourse-post-event/events", () => {
+ return response({
+ events: [
+ {
+ id: 67509,
+ starts_at: tomorrowAllDay,
+ ends_at: null,
+ timezone: "UTC",
+ post: {
+ id: 67509,
+ post_number: 1,
+ url: "/t/recurring-event/18459/1",
+ topic: { id: 18459, title: "Recurring event" },
+ },
+ name: "Weekly Standup",
+ category_id: 1,
+ recurrence: "every_week",
+ },
+ {
+ id: 67510,
+ starts_at: laterThisMonth,
+ ends_at: null,
+ timezone: "UTC",
+ post: {
+ id: 67510,
+ post_number: 1,
+ url: "/t/one-off-event/18460/1",
+ topic: { id: 18460, title: "One off event" },
+ },
+ name: "One Off Event",
+ category_id: 1,
+ },
+ ],
+ });
+ });
+
+ await render(<template><UpcomingEventsList /></template>);
+ this.appEvents.trigger("page:changed", { url: "/" });
+ await waitFor(".loading-container .spinner", { count: 0 });
+
+ const events = queryAll(".upcoming-events-list__event-name");
+
+ assert
+ .dom(events[0].querySelector(".d-icon-arrows-rotate"))
+ .exists("recurring event shows the arrows-rotate icon");
+
+ assert
+ .dom(events[1].querySelector(".d-icon-arrows-rotate"))
+ .doesNotExist("non-recurring event does not show the icon");
+ });
+
test("with all-day multi-day event shows correct date range", async function (assert) {
pretender.get("/discourse-post-event/events", () => {
return response({