Skip to content

Commit

Permalink
feat: superhero feedback (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
ifaouibadi authored Feb 20, 2024
1 parent fc6280a commit 854ddb1
Show file tree
Hide file tree
Showing 3 changed files with 173 additions and 2 deletions.
3 changes: 2 additions & 1 deletion components.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@
"src/linkify-matrix.ts": "src/linkify-matrix.ts",
"src/components/structures/LeftPanel.tsx": "src/components/structures/LeftPanel.tsx",
"src/components/views/rooms/RoomList.tsx": "src/components/views/rooms/RoomList.tsx",
"src/components/views/rooms/RoomSublist.tsx": "src/components/views/rooms/RoomSublist.tsx"
"src/components/views/rooms/RoomSublist.tsx": "src/components/views/rooms/RoomSublist.tsx",
"src/components/views/dialogs/FeedbackDialog.tsx": "src/components/views/dialogs/FeedbackDialog.tsx"
}
11 changes: 10 additions & 1 deletion config.sample.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,14 @@
"participant_limit": 8,
"brand": "Element Call"
},
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx",
"branding": {
"auth_header_logo_url": "themes/superhero/img/logos/superhero-logo.svg"
},
"feedback": {
"existing_issues_url": "https://github.com/superhero-com/superhero-chat-web/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc",
"new_issue_url": "https://github.com/superhero-com/superhero-chat-web/issues/new/choose"
},
"bug_report_endpoint_url": "https://github.com/superhero-com/superhero-chat-web/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc",
"support_channel_room_id": "#superhero_feedback:superhero.chat"
}
161 changes: 161 additions & 0 deletions src/components/views/dialogs/FeedbackDialog.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
/*
Copyright 2018 New Vector Ltd
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, { useEffect, useRef, useState } from "react";
import QuestionDialog from "matrix-react-sdk/src/components/views/dialogs/QuestionDialog";
import { _t } from "matrix-react-sdk/src/languageHandler";
import Field from "matrix-react-sdk/src/components/views/elements/Field";
import AccessibleButton from "matrix-react-sdk/src/components/views/elements/AccessibleButton";
import SdkConfig from "matrix-react-sdk/src/SdkConfig";
import Modal from "matrix-react-sdk/src/Modal";
import BugReportDialog from "matrix-react-sdk/src/components/views/dialogs/BugReportDialog";
import { useStateToggle } from "matrix-react-sdk/src/hooks/useStateToggle";
import StyledCheckbox from "matrix-react-sdk/src/components/views/elements/StyledCheckbox";
import ExternalLink from "matrix-react-sdk/src/components/views/elements/ExternalLink";
import { MatrixClientPeg } from "matrix-react-sdk/src/MatrixClientPeg";
interface IProps {
feature?: string;
onFinished(): void;
}

const FeedbackDialog: React.FC<IProps> = (props: IProps) => {
const feedbackRef = useRef<Field>(null);
const [comment, setComment] = useState<string>("");
const [canContact, toggleCanContact] = useStateToggle(false);
const client = MatrixClientPeg.safeGet();

useEffect(() => {
// autofocus doesn't work on textareas
feedbackRef.current?.focus();
}, []);

const onDebugLogsLinkClick = (): void => {
props.onFinished();
Modal.createDialog(BugReportDialog, {});
};

const hasFeedback = !!SdkConfig.get().bug_report_endpoint_url;
const supportChannelRoomId = (SdkConfig.get() as any).support_channel_room_id;

const onFinished = async (sendFeedback: boolean): Promise<void> => {
if (hasFeedback && sendFeedback) {
window.open(`#/room/${supportChannelRoomId}`, "_self");

const actualRoomId = await client.getRoomIdForAlias(supportChannelRoomId);
client.sendTextMessage(actualRoomId.room_id, comment);
}
props.onFinished();
};

let feedbackSection: JSX.Element | undefined;
if (hasFeedback) {
feedbackSection = (
<div className="mx_FeedbackDialog_section mx_FeedbackDialog_rateApp">
<h3>{_t("feedback|comment_label")}</h3>

{/* <p>{_t("feedback|platform_username")}</p> */}
<p>Ready to make a difference? Drop a message to share your feedback, thoughts, or suggestions.</p>

<Field
id="feedbackComment"
label={_t("common|feedback")}
type="text"
autoComplete="off"
value={comment}
element="textarea"
onChange={(ev) => {
setComment(ev.target.value);
}}
ref={feedbackRef}
/>

<StyledCheckbox checked={canContact} onChange={toggleCanContact}>
{_t("feedback|may_contact_label")}
</StyledCheckbox>
</div>
);
}

let bugReports: JSX.Element | undefined;
if (hasFeedback) {
bugReports = (
<p className="mx_FeedbackDialog_section_microcopy">
{_t(
"feedback|pro_type",
{},
{
debugLogsLink: (sub) => (
<AccessibleButton kind="link_inline" onClick={onDebugLogsLinkClick}>
{sub}
</AccessibleButton>
),
},
)}
</p>
);
}

const existingIssuesUrl = SdkConfig.getObject("feedback").get("existing_issues_url");
const newIssueUrl = SdkConfig.getObject("feedback").get("new_issue_url");

return (
<QuestionDialog
className="mx_FeedbackDialog"
hasCancelButton={hasFeedback}
title={_t("common|feedback")}
description={
<React.Fragment>
<div className="mx_FeedbackDialog_section mx_FeedbackDialog_reportBug">
<h3>{_t("common|report_a_bug")}</h3>
<p>
{_t(
"feedback|existing_issue_link",
{},
{
existingIssuesLink: (sub) => {
return (
<ExternalLink
target="_blank"
rel="noreferrer noopener"
href={existingIssuesUrl}
>
{sub}
</ExternalLink>
);
},
newIssueLink: (sub) => {
return (
<ExternalLink target="_blank" rel="noreferrer noopener" href={newIssueUrl}>
{sub}
</ExternalLink>
);
},
},
)}
</p>
{bugReports}
</div>
{feedbackSection}
</React.Fragment>
}
button={hasFeedback ? _t("feedback|send_feedback_action") : _t("action|go_back")}
buttonDisabled={hasFeedback && !comment}
onFinished={onFinished}
/>
);
};

export default FeedbackDialog;

0 comments on commit 854ddb1

Please sign in to comment.