Merge pull request #9410 from matrix-org/feat/add-formating-buttons-to-wysiwyg

Add formatting buttons to the WysiwygComposer

Author: florianduros

package.json

@@ -57,7 +57,7 @@
   "dependencies": {
     "@babel/runtime": "^7.12.5",
     "@matrix-org/analytics-events": "^0.2.0",
-    "@matrix-org/matrix-wysiwyg": "^0.0.2",
+    "@matrix-org/matrix-wysiwyg": "^0.2.0",
     "@matrix-org/react-sdk-module-api": "^0.0.3",
     "@sentry/browser": "^6.11.0",
     "@sentry/tracing": "^6.11.0",

res/css/_components.pcss

@@ -297,6 +297,7 @@
 @import "./views/rooms/_TopUnreadMessagesBar.pcss";
 @import "./views/rooms/_VoiceRecordComposerTile.pcss";
 @import "./views/rooms/_WhoIsTypingTile.pcss";
+@import "./views/rooms/wysiwyg_composer/_FormattingButtons.pcss";
 @import "./views/rooms/wysiwyg_composer/_WysiwygComposer.pcss";
 @import "./views/settings/_AvatarSetting.pcss";
 @import "./views/settings/_CrossSigningPanel.pcss";

res/css/views/rooms/_MessageComposer.pcss

@@ -233,6 +233,17 @@ limitations under the License.
     }
 }
 
+/*
+    The wysisyg composer increase the size of the MessageComposer. We temporary move the buttons
+    Soon the dom structure of the MessageComposer will change with the next evolution of the wysiwyg composer
+    and this workaround will disappear
+*/
+.mx_MessageComposer_wysiwyg {
+    .mx_MessageComposer_e2eIcon.mx_E2EIcon,.mx_MessageComposer_button, .mx_MessageComposer_sendMessage {
+        margin-top: 22px;
+    }
+}
+
 .mx_MessageComposer_upload::before {
     mask-image: url('$(res)/img/element-icons/room/composer/attach.svg');
 }

res/css/views/rooms/wysiwyg_composer/_FormattingButtons.pcss

@@ -0,0 +1,118 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+.mx_FormattingButtons {
+    display: flex;
+    justify-content: start;
+
+    .mx_FormattingButtons_Button {
+        --size: 28px;
+        position: relative;
+        cursor: pointer;
+        height: var(--size);
+        line-height: var(--size);
+        width: auto;
+        padding-left: 22px;
+        margin-right: 8px;
+        background-color: transparent;
+        border: none;
+
+        &:first-child {
+            margin-left: 12px;
+        }
+
+        &:last-child {
+            margin-right: auto;
+        }
+
+        &::before {
+            content: '';
+            position: absolute;
+            top: 6px;
+            left: 6px;
+            height: 16px;
+            width: 16px;
+            background-color: $icon-button-color;
+            mask-repeat: no-repeat;
+            mask-size: contain;
+            mask-position: center;
+        }
+
+        &::after {
+            content: '';
+            position: absolute;
+            left: 0;
+            top: 0;
+            z-index: 0;
+            width: var(--size);
+            height: var(--size);
+            border-radius: 5px;
+        }
+
+        &:hover {
+            &::after {
+                background: rgba($secondary-content, 0.1);
+            }
+
+            &::before {
+                background-color: $secondary-content;
+            }
+        }
+    }
+
+    .mx_FormattingButtons_active {
+        &::after {
+            background: rgba($accent, 0.1);
+        }
+
+        &::before {
+            background-color: $accent;
+        }
+    }
+
+    .mx_FormattingButtons_Button_bold::before {
+        mask-image: url('$(res)/img/element-icons/room/composer/bold.svg');
+    }
+
+    .mx_FormattingButtons_Button_italic::before {
+        mask-image: url('$(res)/img/element-icons/room/composer/italic.svg');
+    }
+
+    .mx_FormattingButtons_Button_underline::before {
+        mask-image: url('$(res)/img/element-icons/room/composer/underline.svg');
+    }
+
+    .mx_FormattingButtons_Button_strikethrough::before {
+        mask-image: url('$(res)/img/element-icons/room/composer/strikethrough.svg');
+    }
+}
+
+.mx_FormattingButtons_Tooltip {
+    padding: 0 2px 0 2px;
+
+    .mx_FormattingButtons_Tooltip_KeyboardShortcut {
+        color: $tertiary-content;
+
+        kbd {
+            margin-top: 2px;
+            text-align: center;
+            display: inline-block;
+            text-transform: capitalize;
+            font-size: 12px;
+            font-family: Inter, sans-serif;
+        }
+    }
+}

res/img/element-icons/room/composer/bold.svg

@@ -389,6 +389,7 @@ export default class MessageComposer extends React.Component<IProps, IState> {
     }
 
     public render() {
+        const isWysiwygComposerEnabled = SettingsStore.getValue("feature_wysiwyg_composer");
         const controls = [
             this.props.e2eStatus ?
                 <E2EIcon key="e2eIcon" status={this.props.e2eStatus} className="mx_MessageComposer_e2eIcon" /> :
@@ -403,8 +404,6 @@ export default class MessageComposer extends React.Component<IProps, IState> {
 
         const canSendMessages = this.context.canSendMessages && !this.context.tombstone;
         if (canSendMessages) {
-            const isWysiwygComposerEnabled = SettingsStore.getValue("feature_wysiwyg_composer");
-
             if (isWysiwygComposerEnabled) {
                 controls.push(
                     <WysiwygComposer key="controls_input"
@@ -503,6 +502,7 @@ export default class MessageComposer extends React.Component<IProps, IState> {
             "mx_MessageComposer": true,
             "mx_MessageComposer--compact": this.props.compact,
             "mx_MessageComposer_e2eStatus": this.props.e2eStatus != undefined,
+            "mx_MessageComposer_wysiwyg": isWysiwygComposerEnabled,
         });
 
         return (

res/img/element-icons/room/composer/italic.svg

@@ -0,0 +1,41 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import React, { forwardRef, memo } from 'react';
+
+interface EditorProps {
+    disabled: boolean;
+}
+
+export const Editor = memo(
+    forwardRef<HTMLDivElement, EditorProps>(
+        function Editor({ disabled }: EditorProps, ref,
+        ) {
+            return <div className="mx_WysiwygComposer_container">
+                <div className="mx_WysiwygComposer_content"
+                    ref={ref!}
+                    contentEditable={!disabled}
+                    role="textbox"
+                    aria-multiline="true"
+                    aria-autocomplete="list"
+                    aria-haspopup="listbox"
+                    dir="auto"
+                    aria-disabled={disabled}
+                />
+            </div>;
+        },
+    ),
+);