Poll history - extract poll option display components (#10107)

* wip

* remove dupe

* use poll model relations in all cases

* update mpollbody tests to use poll instance

* update poll fetching login in pinned messages card

* add pinned polls to room polls state

* add spinner while relations are still loading

* handle no poll in end poll dialog

* strict errors

* render a poll body that errors for poll end events

* add fetching logic to pollend tile

* extract poll testing utilities

* test mpollend

* strict fix

* more strict fix

* strict fix for forwardref

* add filter component

* update poll test utils

* add unstyled filter tab group

* filtertabgroup snapshot

* lint

* update test util setupRoomWithPollEvents to allow testing multiple polls in one room

* style filter tabs

* test error message for past polls

* sort polls list by latest

* extract poll option display components

* strict fixes
This commit is contained in:
Kerry 2023-02-13 15:55:39 +13:00 committed by GitHub
parent 18ab325eaf
commit 1c6b06bb58
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 597 additions and 494 deletions

View file

@ -15,7 +15,6 @@ limitations under the License.
*/
import React, { ReactNode } from "react";
import classNames from "classnames";
import { logger } from "matrix-js-sdk/src/logger";
import { MatrixEvent } from "matrix-js-sdk/src/models/event";
import { Relations } from "matrix-js-sdk/src/models/relations";
@ -30,13 +29,13 @@ import { _t } from "../../../languageHandler";
import Modal from "../../../Modal";
import { IBodyProps } from "./IBodyProps";
import { formatCommaSeparatedList } from "../../../utils/FormattingUtils";
import StyledRadioButton from "../elements/StyledRadioButton";
import MatrixClientContext from "../../../contexts/MatrixClientContext";
import ErrorDialog from "../dialogs/ErrorDialog";
import { GetRelationsForEvent } from "../rooms/EventTile";
import PollCreateDialog from "../elements/PollCreateDialog";
import { MatrixClientPeg } from "../../../MatrixClientPeg";
import Spinner from "../elements/Spinner";
import { PollOption } from "../polls/PollOption";
interface IState {
poll?: Poll;
@ -230,10 +229,6 @@ export default class MPollBody extends React.Component<IBodyProps, IState> {
this.setState({ selected: answerId });
}
private onOptionSelected = (e: React.FormEvent<HTMLInputElement>): void => {
this.selectOption(e.currentTarget.value);
};
/**
* @returns userId -> UserVote
*/
@ -329,47 +324,26 @@ export default class MPollBody extends React.Component<IBodyProps, IState> {
<div className="mx_MPollBody_allOptions">
{pollEvent.answers.map((answer: PollAnswerSubevent) => {
let answerVotes = 0;
let votesText = "";
if (showResults) {
answerVotes = votes.get(answer.id) ?? 0;
votesText = _t("%(count)s votes", { count: answerVotes });
}
const checked =
(!poll.isEnded && myVote === answer.id) || (poll.isEnded && answerVotes === winCount);
const cls = classNames({
mx_MPollBody_option: true,
mx_MPollBody_option_checked: checked,
mx_MPollBody_option_ended: poll.isEnded,
});
const answerPercent = totalVotes === 0 ? 0 : Math.round((100.0 * answerVotes) / totalVotes);
return (
<div
data-testid={`pollOption-${answer.id}`}
<PollOption
key={answer.id}
className={cls}
onClick={() => this.selectOption(answer.id)}
>
{poll.isEnded ? (
<EndedPollOption answer={answer} checked={checked} votesText={votesText} />
) : (
<LivePollOption
pollId={pollId}
answer={answer}
checked={checked}
votesText={votesText}
onOptionSelected={this.onOptionSelected}
/>
)}
<div className="mx_MPollBody_popularityBackground">
<div
className="mx_MPollBody_popularityAmount"
style={{ width: `${answerPercent}%` }}
/>
</div>
</div>
pollId={pollId}
answer={answer}
isChecked={checked}
isEnded={poll.isEnded}
voteCount={answerVotes}
totalVoteCount={totalVotes}
displayVoteCount={showResults}
onOptionSelected={this.selectOption.bind(this)}
/>
);
})}
</div>
@ -381,53 +355,6 @@ export default class MPollBody extends React.Component<IBodyProps, IState> {
);
}
}
interface IEndedPollOptionProps {
answer: PollAnswerSubevent;
checked: boolean;
votesText: string;
}
function EndedPollOption(props: IEndedPollOptionProps): JSX.Element {
const cls = classNames({
mx_MPollBody_endedOption: true,
mx_MPollBody_endedOptionWinner: props.checked,
});
return (
<div className={cls} data-value={props.answer.id}>
<div className="mx_MPollBody_optionDescription">
<div className="mx_MPollBody_optionText">{props.answer.text}</div>
<div className="mx_MPollBody_optionVoteCount">{props.votesText}</div>
</div>
</div>
);
}
interface ILivePollOptionProps {
pollId: string;
answer: PollAnswerSubevent;
checked: boolean;
votesText: string;
onOptionSelected: (e: React.FormEvent<HTMLInputElement>) => void;
}
function LivePollOption(props: ILivePollOptionProps): JSX.Element {
return (
<StyledRadioButton
className="mx_MPollBody_live-option"
name={`poll_answer_select-${props.pollId}`}
value={props.answer.id}
checked={props.checked}
onChange={props.onOptionSelected}
>
<div className="mx_MPollBody_optionDescription">
<div className="mx_MPollBody_optionText">{props.answer.text}</div>
<div className="mx_MPollBody_optionVoteCount">{props.votesText}</div>
</div>
</StyledRadioButton>
);
}
export class UserVote {
public constructor(public readonly ts: number, public readonly sender: string, public readonly answers: string[]) {}
}

View file

@ -0,0 +1,123 @@
/*
Copyright 2023 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 from "react";
import classNames from "classnames";
import { PollAnswerSubevent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
import { _t } from "../../../languageHandler";
import { Icon as TrophyIcon } from "../../../../res/img/element-icons/trophy.svg";
import StyledRadioButton from "../elements/StyledRadioButton";
type PollOptionContentProps = {
answer: PollAnswerSubevent;
voteCount: number;
displayVoteCount?: boolean;
isWinner?: boolean;
};
const PollOptionContent: React.FC<PollOptionContentProps> = ({ isWinner, answer, voteCount, displayVoteCount }) => {
const votesText = displayVoteCount ? _t("%(count)s votes", { count: voteCount }) : "";
return (
<div className="mx_PollOption_content">
<div className="mx_PollOption_optionText">{answer.text}</div>
<div className="mx_PollOption_optionVoteCount">
{isWinner && <TrophyIcon className="mx_PollOption_winnerIcon" />}
{votesText}
</div>
</div>
);
};
interface PollOptionProps extends PollOptionContentProps {
pollId: string;
totalVoteCount: number;
isEnded?: boolean;
isChecked?: boolean;
onOptionSelected?: (id: string) => void;
}
const EndedPollOption: React.FC<Omit<PollOptionProps, "voteCount" | "totalVoteCount">> = ({
isChecked,
children,
answer,
}) => (
<div
className={classNames("mx_PollOption_endedOption", {
mx_PollOption_endedOptionWinner: isChecked,
})}
data-value={answer.id}
>
{children}
</div>
);
const ActivePollOption: React.FC<Omit<PollOptionProps, "voteCount" | "totalVoteCount">> = ({
pollId,
isChecked,
children,
answer,
onOptionSelected,
}) => (
<StyledRadioButton
className="mx_PollOption_live-option"
name={`poll_answer_select-${pollId}`}
value={answer.id}
checked={isChecked}
onChange={() => onOptionSelected?.(answer.id)}
>
{children}
</StyledRadioButton>
);
export const PollOption: React.FC<PollOptionProps> = ({
pollId,
answer,
voteCount,
totalVoteCount,
displayVoteCount,
isEnded,
isChecked,
onOptionSelected,
}) => {
const cls = classNames({
mx_PollOption: true,
mx_PollOption_checked: isChecked,
mx_PollOption_ended: isEnded,
});
const isWinner = isEnded && isChecked;
const answerPercent = totalVoteCount === 0 ? 0 : Math.round((100.0 * voteCount) / totalVoteCount);
const PollOptionWrapper = isEnded ? EndedPollOption : ActivePollOption;
return (
<div data-testid={`pollOption-${answer.id}`} className={cls} onClick={() => onOptionSelected?.(answer.id)}>
<PollOptionWrapper
pollId={pollId}
answer={answer}
isChecked={isChecked}
onOptionSelected={onOptionSelected}
>
<PollOptionContent
isWinner={isWinner}
answer={answer}
voteCount={voteCount}
displayVoteCount={displayVoteCount}
/>
</PollOptionWrapper>
<div className="mx_PollOption_popularityBackground">
<div className="mx_PollOption_popularityAmount" style={{ width: `${answerPercent}%` }} />
</div>
</div>
);
};