Improve comments

Closes #1171

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

js/src/assets/oruga-tailwindcss.css

@@ -142,7 +142,7 @@ body {
 }
 
 .dropdown-item-active {
-  @apply bg-white text-black;
+  @apply bg-white dark:bg-zinc-700 dark:text-zinc-100 text-black;
 }
 .dropdown-button {
   @apply inline-flex gap-1;

js/src/components/Comment/CommentTree.vue

@@ -1,10 +1,9 @@
 <template>
   <div>
     <form
-      class=""
       v-if="isAbleToComment"
       @submit.prevent="createCommentForEvent(newComment)"
-      @keyup.ctrl.enter="createCommentForEvent(newComment)"
+      class="mt-2"
     >
       <o-notification
         v-if="isEventOrganiser && !areCommentsClosed"
@@ -26,6 +25,7 @@
                 mode="comment"
                 v-model="newComment.text"
                 :aria-label="t('Comment body')"
+                @submit="createCommentForEvent(newComment)"
               />
               <p class="" v-if="emptyCommentError">
                 {{ t("Comment text can't be empty") }}
@@ -53,7 +53,7 @@
     <p v-if="commentsLoading" class="text-center">
       {{ t("Loading comments…") }}
     </p>
-    <transition-group tag="div" name="comment-empty-list" v-else>
+    <transition-group tag="div" name="comment-empty-list" v-else class="mt-2">
       <transition-group
         key="list"
         name="comment-list"
@@ -61,18 +61,17 @@
         class="comment-list"
         tag="ul"
       >
-        <comment
+        <event-comment
-          class="root-comment"
+          class="root-comment my-2"
           :comment="comment"
           :event="event"
           :currentActor="currentActor"
           v-for="comment in filteredOrderedComments"
           :key="comment.id"
           @create-comment="createCommentForEvent"
-          @delete-comment="
+          @delete-comment="commentToDelete => deleteComment({
-            deleteComment({
+              commentId: commentToDelete.id as string,
-              commentId: comment.id as string,
+              originCommentId: commentToDelete.originComment?.id,
-              originCommentId: comment.originComment?.id,
             })
           "
         />
@@ -85,7 +84,7 @@
 </template>
 
 <script lang="ts" setup>
-import Comment from "@/components/Comment/EventComment.vue";
+import EventComment from "@/components/Comment/EventComment.vue";
 import IdentityPickerWrapper from "@/views/Account/IdentityPickerWrapper.vue";
 import { CommentModeration } from "@/types/enums";
 import { CommentModel, IComment } from "../../types/comment.model";

js/src/components/Comment/EventComment.vue

@@ -6,9 +6,9 @@
       'bg-violet-1': commentSelected,
       'shadow-none': !rootComment,
     }"
-    class="mbz-card p-2"
+    class="bg-white dark:bg-zinc-900 rounded p-2"
   >
-    <article :id="commentId" dir="auto">
+    <article :id="commentId" dir="auto" class="mbz-comment">
       <div>
         <div class="flex items-center gap-2">
           <div class="flex items-center gap-1" v-if="actorComment">
@@ -36,9 +36,9 @@
             >
           </div>
 
-          <a v-else :href="commentURL">
+          <p v-else :href="commentURL">
             <span>{{ t("[deleted]") }}</span>
-          </a>
+          </p>
           <a :href="commentURL">
             <small v-if="comment.updatedAt">{{
               formatDistanceToNow(new Date(comment.updatedAt), {
@@ -47,19 +47,6 @@
               })
             }}</small>
           </a>
-          <div v-if="!comment.deletedAt" class="flex">
-            <button
-              v-if="actorComment?.id === currentActor?.id"
-              @click="deleteComment"
-            >
-              <Delete :size="16" />
-              <span class="sr-only">{{ t("Delete") }}</span>
-            </button>
-            <button @click="reportModal">
-              <Alert :size="16" />
-              <span class="sr-only">{{ t("Report") }}</span>
-            </button>
-          </div>
         </div>
         <div
           v-if="!comment.deletedAt"
@@ -68,11 +55,53 @@
           :lang="comment.language"
         />
         <div v-else>{{ t("[This comment has been deleted]") }}</div>
+        <nav class="flex gap-1 mt-1" v-if="!comment.deletedAt">
+          <button
+            class="cursor-pointer flex hover:bg-zinc-300 dark:hover:bg-zinc-600 rounded p-1"
+            v-if="
+              currentActor?.id &&
+              event.options.commentModeration !== CommentModeration.CLOSED &&
+              !comment.deletedAt
+            "
+            @click="createReplyToComment()"
+          >
+            <Reply />
+            <span>{{ t("Reply") }}</span>
+          </button>
+          <o-dropdown aria-role="list">
+            <template #trigger>
+              <button
+                class="cursor-pointer flex hover:bg-zinc-300 dark:hover:bg-zinc-600 rounded p-1"
+              >
+                <DotsHorizontal />
+                <span class="sr-only">{{ t("More options") }}</span>
+              </button>
+            </template>
+            <o-dropdown-item
+              aria-role="listitem"
+              v-if="actorComment?.id === currentActor?.id"
+            >
+              <button class="flex items-center gap-1" @click="deleteComment">
+                <Delete :size="16" />
+                <span>{{ t("Delete") }}</span>
+              </button>
+            </o-dropdown-item>
+            <o-dropdown-item aria-role="listitem">
+              <button
+                @click="isReportModalActive = true"
+                class="flex items-center gap-1"
+              >
+                <Alert :size="16" />
+                <span>{{ t("Report") }}</span>
+              </button>
+            </o-dropdown-item>
+          </o-dropdown>
+        </nav>
         <div class="" v-if="comment.totalReplies">
-          <p
+          <button
             v-if="!showReplies"
             @click="showReplies = true"
-            class="flex cursor-pointer"
+            class="flex cursor-pointer hover:bg-zinc-300 dark:hover:bg-zinc-600 rounded p-1"
           >
             <ChevronDown />
             <span>{{
@@ -84,28 +113,16 @@
                 comment.totalReplies
               )
             }}</span>
-          </p>
+          </button>
-          <p
+          <button
             v-else-if="comment.totalReplies && showReplies"
             @click="showReplies = false"
-            class="flex cursor-pointer"
+            class="flex cursor-pointer hover:bg-zinc-300 dark:hover:bg-zinc-600 rounded p-1"
           >
             <ChevronUp />
             <span>{{ t("Hide replies") }}</span>
-          </p>
+          </button>
         </div>
-        <nav
-          v-if="
-            currentActor?.id &&
-            event.options.commentModeration !== CommentModeration.CLOSED &&
-            !comment.deletedAt
-          "
-          @click="createReplyToComment()"
-          class="flex gap-1 cursor-pointer"
-        >
-          <Reply />
-          <span>{{ t("Reply") }}</span>
-        </nav>
       </div>
     </article>
     <form
@@ -137,6 +154,7 @@
               :current-actor="currentActor"
               :aria-label="t('Comment body')"
               class="flex-1"
+              @submit="replyToComment"
             />
             <o-button
               :disabled="newComment.text.trim().length === 0"
@@ -149,29 +167,37 @@
         </div>
       </article>
     </form>
-    <div>
+    <transition-group
-      <div>
+      name="comment-replies"
-        <div @click="showReplies = false" />
+      v-if="showReplies"
-      </div>
+      tag="ul"
-      <transition-group
+      class="flex flex-col gap-2"
-        name="comment-replies"
+    >
-        v-if="showReplies"
+      <EventComment
-        tag="ul"
+        v-for="reply in comment.replies"
-        class="flex flex-col gap-2"
+        :key="reply.id"
-      >
+        :comment="reply"
-        <Comment
+        :event="event"
-          v-for="reply in comment.replies"
+        :currentActor="currentActor"
-          :key="reply.id"
+        :rootComment="false"
-          :comment="reply"
+        @create-comment="emit('create-comment', $event)"
-          :event="event"
+        @delete-comment="emit('delete-comment', $event)"
-          :currentActor="currentActor"
+        @report-comment="emit('report-comment', $event)"
-          :rootComment="false"
+        class="ml-2"
-          @create-comment="emit('create-comment', $event)"
+      />
-          @delete-comment="emit('delete-comment', $event)"
+    </transition-group>
-          @report-comment="emit('report-comment', $event)"
+    <o-modal
-        />
+      v-model:active="isReportModalActive"
-      </transition-group>
+      has-modal-card
-    </div>
+      ref="reportModal"
+      :close-button-aria-label="t('Close')"
+    >
+      <ReportModal
+        :on-confirm="reportComment"
+        :title="t('Report this comment')"
+        :outside-domain="comment.actor?.domain"
+      />
+    </o-modal>
   </li>
 </template>
 <script lang="ts" setup>
@@ -197,8 +223,13 @@ import Delete from "vue-material-design-icons/Delete.vue";
 import Alert from "vue-material-design-icons/Alert.vue";
 import ChevronUp from "vue-material-design-icons/ChevronUp.vue";
 import ChevronDown from "vue-material-design-icons/ChevronDown.vue";
+import DotsHorizontal from "vue-material-design-icons/DotsHorizontal.vue";
 import Reply from "vue-material-design-icons/Reply.vue";
 import type { Locale } from "date-fns";
+import ReportModal from "@/components/Report/ReportModal.vue";
+import { useCreateReport } from "@/composition/apollo/report";
+import { Snackbar } from "@/plugins/snackbar";
+import { useProgrammatic } from "@oruga-ui/oruga-next";
 
 const Editor = defineAsyncComponent(
   () => import("@/components/TextEditor.vue")
@@ -214,26 +245,20 @@ const props = withDefaults(
   { rootComment: true }
 );
 
-const emit = defineEmits([
+const emit = defineEmits<{
-  "create-comment",
+  (e: "create-comment", comment: IComment): void;
-  "delete-comment",
+  (e: "delete-comment", comment: IComment): void;
-  "report-comment",
+  (e: "report-comment", comment: IComment): void;
-]);
+}>();
 
 const commentEditor = ref<typeof EditorComponent | null>(null);
 
-// Hack because Vue only exports it's own interface.
-// See https://github.com/kaorun343/vue-property-decorator/issues/257
-// @Ref() readonly commentEditor!: EditorComponent & {
-//   replyToComment: (comment: IComment) => void;
-//   focus: () => void;
-// };
-
 const newComment = ref<IComment>(new CommentModel());
 const replyTo = ref(false);
 const showReplies = ref(false);
 const route = useRoute();
 const { t } = useI18n({ useScope: "global" });
+const isReportModalActive = ref(false);
 
 onMounted(() => {
   if (route?.hash.includes(`#comment-${props.comment.uuid}`)) {
@@ -310,219 +335,57 @@ const reportModal = (): void => {
   // });
 };
 
-// const reportComment = async (
+const {
-//   content: string,
+  mutate: createReportMutation,
-//   forward: boolean
+  onError: onCreateReportError,
-// ): Promise<void> => {
+  onDone: oneCreateReportDone,
-//   try {
+} = useCreateReport();
-//     if (!props.comment.actor) return;
 
-//     const { onError, onDone } = useMutation(CREATE_REPORT, () => ({
+const reportComment = async (
-//       variables: {
+  content: string,
-//         eventId: props.event.id,
+  forward: boolean
-//         reportedId: props.comment.actor?.id,
+): Promise<void> => {
-//         commentsIds: [props.comment.id],
+  if (!props.comment.actor) return;
-//         content,
+  createReportMutation({
-//         forward,
+    eventId: props.event.id,
-//       },
+    reportedId: props.comment.actor?.id ?? "",
-//     }));
+    commentsIds: [props.comment.id ?? ""],
+    content,
+    forward,
+  });
+};
+
+const snackbar = inject<Snackbar>("snackbar");
+const { oruga } = useProgrammatic();
+
+onCreateReportError((e) => {
+  isReportModalActive.value = false;
+  if (e.message) {
+    snackbar?.open({
+      message: e.message,
+      variant: "danger",
+      position: "bottom",
+    });
+  }
+});
+
+oneCreateReportDone(() => {
+  isReportModalActive.value = false;
+  oruga.notification.open({
+    message: t("Comment from {'@'}{username} reported", {
+      username: props.comment.actor?.preferredUsername,
+    }),
+    variant: "success",
+    position: "bottom-right",
+    duration: 5000,
+  });
+});
 
-//     // this.$buefy.notification.open({
-//     //   message: this.t("Comment from @{username} reported", {
-//     //     username: this.comment.actor.preferredUsername,
-//     //   }) as string,
-//     //   type: "is-success",
-//     //   position: "is-bottom-right",
-//     //   duration: 5000,
-//     // });
-//   } catch (e: any) {
-//     if (e.message) {
-//       // Snackbar.open({
-//       //   message: e.message,
-//       //   type: "is-danger",
-//       //   position: "is-bottom",
-//       // });
-//     }
-//   }
-// };
 const actorComment = computed(() => props.comment.actor);
 const dateFnsLocale = inject<Locale>("dateFnsLocale");
 </script>
-<style lang="scss" scoped>
+<style>
-@use "@/styles/_mixins" as *;
+article.mbz-comment .mention.h-card {
-form.reply {
+  @apply inline-block border border-zinc-600 dark:border-zinc-300 rounded py-0.5 px-1;
-  padding-bottom: 1rem;
-}
-
-.first-line {
-  margin-bottom: 3px;
-
-  * {
-    padding: 0 5px 0 0;
-  }
-
-  strong.organizer {
-    border-radius: 12px;
-    color: white;
-    padding: 0 6px;
-  }
-
-  // & > small {
-  //   @include margin-left(0.3rem);
-  // }
-}
-
-.editor-line {
-  display: flex;
-  max-width: calc(80rem - 64px);
-
-  .editor {
-    flex: 1;
-    // @include padding-right(10px);
-    margin-bottom: 0;
-  }
-}
-
-a.comment-link {
-  text-decoration: none;
-  // @include margin-left(5px);
-  color: text;
-  &:hover {
-    text-decoration: underline;
-  }
-  small {
-    &:hover {
-      color: hsl(0, 0%, 21%);
-    }
-  }
-}
-
-.comment-element {
-  padding: 0.25rem;
-  border-radius: 5px;
-
-  &.announcement {
-    small {
-      color: hsl(0, 0%, 21%);
-    }
-  }
-
-  &.selected {
-    .reply-btn,
-    small,
-    span,
-    strong,
-    a.comment-link:hover {
-      text-decoration: underline;
-    }
-  }
-
-  // .media-left {
-  //   @include margin-right(5px);
-  // }
-}
-
-.root-comment .replies {
-  display: flex;
-
-  .left {
-    display: flex;
-    flex-direction: column;
-    align-items: center;
-    // @include margin-right(10px);
-
-    .vertical-border {
-      width: 3px;
-      height: 100%;
-      background-color: rgba(0, 0, 0, 0.05);
-      margin: 10px calc(1rem + 1px);
-      cursor: pointer;
-
-      &:hover {
-        background-color: rgba(0, 0, 0, 0.1);
-      }
-    }
-  }
-}
-
-.media .media-content {
-  overflow-x: initial;
-  .content {
-    text-align: start;
-    .editor-line {
-      display: flex;
-      align-items: center;
-    }
-  }
-
-  .icons {
-    display: none;
-  }
-}
-
-.media:hover .media-content .icons {
-  display: inline;
-
-  button {
-    cursor: pointer;
-    border: none;
-    background: none;
-  }
-}
-
-.load-replies {
-  cursor: pointer;
-
-  & > p > span {
-    font-weight: bold;
-  }
-}
-
-.level-item.reply-btn {
-  font-weight: bold;
-}
-
-article {
-  border-radius: 4px;
-  margin-bottom: 5px;
-}
-
-.comment-replies {
-  flex-grow: 1;
-}
-
-.comment-replies-enter-active,
-.comment-replies-leave-active,
-.comment-replies-move {
-  transition: 500ms cubic-bezier(0.59, 0.12, 0.34, 0.95);
-  transition-property: opacity, transform;
-}
-
-.comment-replies-enter {
-  opacity: 0;
-  transform: translateX(50px) scaleY(0.5);
-}
-
-.comment-replies-enter-to {
-  opacity: 1;
-  transform: translateX(0) scaleY(1);
-}
-
-.comment-replies-leave-active {
-  position: absolute;
-}
-
-.comment-replies-leave-to {
-  opacity: 0;
-  transform: scaleY(0);
-  transform-origin: center top;
-}
-
-// .reply-action .icon {
-//   @include padding-right(0.4rem);
-// }
-
-.visually-hidden {
-  display: none;
 }
 </style>

js/src/components/Editor/RichEditorKeyboardSubmit.ts

@@ -0,0 +1,22 @@
+import { Extension } from "@tiptap/vue-3";
+
+export interface RichEditorKeyboardSubmitOptions {
+  submit: () => void;
+}
+
+export default Extension.create<RichEditorKeyboardSubmitOptions>({
+  name: "RichEditorKeyboardSubmit",
+  addOptions() {
+    return {
+      submit: () => ({}),
+    };
+  },
+  addKeyboardShortcuts() {
+    return {
+      "Ctrl-Enter": () => {
+        this.options.submit();
+        return true;
+      },
+    };
+  },
+});

js/src/components/TextEditor.vue

@@ -208,6 +208,7 @@ import Gapcursor from "@tiptap/extension-gapcursor";
 import History from "@tiptap/extension-history";
 import { IActor, IPerson, usernameWithDomain } from "../types/actor";
 import CustomImage from "./Editor/Image";
+import RichEditorKeyboardSubmit from "./Editor/RichEditorKeyboardSubmit";
 import { UPLOAD_MEDIA } from "../graphql/upload";
 import { listenFileUpload } from "../utils/upload";
 import Mention from "@tiptap/extension-mention";
@@ -252,7 +253,7 @@ const props = withDefaults(
   }
 );
 
-const emit = defineEmits(["update:modelValue"]);
+const emit = defineEmits(["update:modelValue", "submit"]);
 
 const isDescriptionMode = computed((): boolean => {
   return props.mode === "description" || isBasicMode.value;
@@ -297,7 +298,7 @@ const editor = useEditor({
       "aria-label": props.ariaLabel ?? "",
       role: "textbox",
       class:
-        "prose dark:prose-invert prose-sm sm:prose lg:prose-lg xl:prose-xl m-5 focus:outline-none !max-w-full",
+        "prose dark:prose-invert prose-sm lg:prose-lg xl:prose-xl bg-zinc-50 dark:bg-zinc-700 focus:outline-none !max-w-full",
     },
     transformPastedHTML: transformPastedHTML,
   },
@@ -323,6 +324,9 @@ const editor = useEditor({
     Link.configure({
       HTMLAttributes: { target: "_blank", rel: "noopener noreferrer ugc" },
     }),
+    RichEditorKeyboardSubmit.configure({
+      submit: () => emit("submit"),
+    }),
   ],
   injectCSS: false,
   content: props.modelValue,
@@ -480,9 +484,7 @@ onBeforeUnmount(() => {
     div.ProseMirror {
       min-height: 2.5rem;
       box-shadow: inset 0 1px 2px rgba(10, 10, 10, 0.1);
-      background-color: white;
       border-radius: 4px;
-      color: #363636;
       border: 1px solid #dbdbdb;
       padding: 12px 6px;
 

js/src/composition/apollo/config.ts

@@ -61,7 +61,7 @@ export function useAnonymousReportsConfig() {
   }>(ANONYMOUS_REPORTS_CONFIG, undefined, { fetchPolicy: "cache-only" });
 
   const anonymousReportsConfig = computed(
-    () => configResult.value?.config?.anonymous?.participation
+    () => configResult.value?.config?.anonymous?.reports
   );
   return { anonymousReportsConfig, error, loading };
 }

js/src/i18n/en_US.json

@@ -52,7 +52,7 @@
   "Close": "Close",
   "Closed": "Closed",
   "Comment deleted": "Comment deleted",
-  "Comment from @{username} reported": "Comment from @{username} reported",
+  "Comment from {'@'}{username} reported": "Comment from {'@'}{username} reported",
   "Comments": "Comments",
   "Confirm my participation": "Confirm my participation",
   "Confirm my particpation": "Confirm my particpation",

js/src/i18n/fr_FR.json

@@ -192,7 +192,7 @@
   "Closed": "Fermé",
   "Comment body": "Corps du commentaire",
   "Comment deleted": "Commentaire supprimé",
-  "Comment from @{username} reported": "Commentaire de @{username} signalé",
+  "Comment from {'@'}{username} reported": "Commentaire de {'@'}{username} signalé",
   "Comment text can't be empty": "Le texte du commentaire ne peut être vide",
   "Comments": "Commentaires",
   "Comments are closed for everybody else.": "Les commentaires sont fermés pour tou·te·s les autres.",