Add an option to ignore (block) a user when reporting their events (#8471)

* Add an option to ignore (block) a user when reporting their events

This is primarily useful if the content being reported really doesn't belong on your screen, and the room moderators are slow to react.

Ideally we'd use the word "block" instead of "ignore", but we call it "ignore user" everywhere else. See https://github.com/vector-im/element-web/issues/19590 for further context on the word choice.

This change includes a minor refactor to the styles of labelled toggles (for reusability).

* Appease the linter

* Use a checkbox instead of toggle in the dialog

* Update classnames handling for toggle switch

* Appease the linter

test/components/views/elements/LabelledCheckbox-test.tsx

@@ -0,0 +1,124 @@
+/*
+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 from 'react';
+import { mount } from 'enzyme';
+import { act } from "react-dom/test-utils";
+
+import LabelledCheckbox from "../../../../src/components/views/elements/LabelledCheckbox";
+
+// Fake random strings to give a predictable snapshot for checkbox IDs
+jest.mock(
+    'matrix-js-sdk/src/randomstring',
+    () => {
+        return {
+            randomString: () => "abdefghi",
+        };
+    },
+);
+
+describe('<LabelledCheckbox />', () => {
+    type CompProps = React.ComponentProps<typeof LabelledCheckbox>;
+    const getComponent = (props: CompProps) => mount(<LabelledCheckbox {...props} />);
+    type CompClass = ReturnType<typeof getComponent>;
+
+    const getCheckbox = (component: CompClass) => component.find(`input[type="checkbox"]`);
+    const getLabel = (component: CompClass) => component.find(`.mx_LabelledCheckbox_label`);
+    const getByline = (component: CompClass) => component.find(`.mx_LabelledCheckbox_byline`);
+
+    const isChecked = (checkbox: ReturnType<typeof getCheckbox>) => checkbox.is(`[checked=true]`);
+    const isDisabled = (checkbox: ReturnType<typeof getCheckbox>) => checkbox.is(`[disabled=true]`);
+    const getText = (span: ReturnType<typeof getLabel>) => span.length > 0 ? span.at(0).text() : null;
+
+    test.each([null, "this is a byline"])(
+        "should render with byline of %p",
+        (byline) => {
+            const props: CompProps = {
+                label: "Hello world",
+                value: true,
+                byline: byline,
+                onChange: jest.fn(),
+            };
+            const component = getComponent(props);
+            const checkbox = getCheckbox(component);
+
+            expect(component).toMatchSnapshot();
+            expect(isChecked(checkbox)).toBe(true);
+            expect(isDisabled(checkbox)).toBe(false);
+            expect(getText(getLabel(component))).toBe(props.label);
+            expect(getText(getByline(component))).toBe(byline);
+        },
+    );
+
+    it('should support unchecked by default', () => {
+        const props: CompProps = {
+            label: "Hello world",
+            value: false,
+            onChange: jest.fn(),
+        };
+        const component = getComponent(props);
+
+        expect(isChecked(getCheckbox(component))).toBe(false);
+    });
+
+    it('should be possible to disable the checkbox', () => {
+        const props: CompProps = {
+            label: "Hello world",
+            value: false,
+            disabled: true,
+            onChange: jest.fn(),
+        };
+        const component = getComponent(props);
+
+        expect(isDisabled(getCheckbox(component))).toBe(true);
+    });
+
+    it('should emit onChange calls', () => {
+        const props: CompProps = {
+            label: "Hello world",
+            value: false,
+            onChange: jest.fn(),
+        };
+        const component = getComponent(props);
+
+        expect(props.onChange).not.toHaveBeenCalled();
+
+        act(() => {
+            getCheckbox(component).simulate('change');
+        });
+
+        expect(props.onChange).toHaveBeenCalledTimes(1);
+    });
+
+    it('should react to value and disabled prop changes', () => {
+        const props: CompProps = {
+            label: "Hello world",
+            value: false,
+            onChange: jest.fn(),
+        };
+        const component = getComponent(props);
+        let checkbox = getCheckbox(component);
+
+        expect(isChecked(checkbox)).toBe(false);
+        expect(isDisabled(checkbox)).toBe(false);
+
+        component.setProps({ value: true, disabled: true });
+        checkbox = getCheckbox(component); // refresh reference to checkbox
+
+        expect(isChecked(checkbox)).toBe(true);
+        expect(isDisabled(checkbox)).toBe(true);
+    });
+});

test/components/views/elements/__snapshots__/LabelledCheckbox-test.tsx.snap

@@ -0,0 +1,108 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<LabelledCheckbox /> should render with byline of "this is a byline" 1`] = `
+<LabelledCheckbox
+  byline="this is a byline"
+  label="Hello world"
+  onChange={[MockFunction]}
+  value={true}
+>
+  <label
+    className="mx_LabelledCheckbox"
+  >
+    <StyledCheckbox
+      checked={true}
+      className=""
+      onChange={[Function]}
+    >
+      <span
+        className="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid"
+      >
+        <input
+          checked={true}
+          id="checkbox_abdefghi"
+          onChange={[Function]}
+          type="checkbox"
+        />
+        <label
+          htmlFor="checkbox_abdefghi"
+        >
+          <div
+            className="mx_Checkbox_background"
+          >
+            <div
+              className="mx_Checkbox_checkmark"
+            />
+          </div>
+          <div />
+        </label>
+      </span>
+    </StyledCheckbox>
+    <div
+      className="mx_LabelledCheckbox_labels"
+    >
+      <span
+        className="mx_LabelledCheckbox_label"
+      >
+        Hello world
+      </span>
+      <span
+        className="mx_LabelledCheckbox_byline"
+      >
+        this is a byline
+      </span>
+    </div>
+  </label>
+</LabelledCheckbox>
+`;
+
+exports[`<LabelledCheckbox /> should render with byline of null 1`] = `
+<LabelledCheckbox
+  byline={null}
+  label="Hello world"
+  onChange={[MockFunction]}
+  value={true}
+>
+  <label
+    className="mx_LabelledCheckbox"
+  >
+    <StyledCheckbox
+      checked={true}
+      className=""
+      onChange={[Function]}
+    >
+      <span
+        className="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid"
+      >
+        <input
+          checked={true}
+          id="checkbox_abdefghi"
+          onChange={[Function]}
+          type="checkbox"
+        />
+        <label
+          htmlFor="checkbox_abdefghi"
+        >
+          <div
+            className="mx_Checkbox_background"
+          >
+            <div
+              className="mx_Checkbox_checkmark"
+            />
+          </div>
+          <div />
+        </label>
+      </span>
+    </StyledCheckbox>
+    <div
+      className="mx_LabelledCheckbox_labels"
+    >
+      <span
+        className="mx_LabelledCheckbox_label"
+      >
+        Hello world
+      </span>
+    </div>
+  </label>
+</LabelledCheckbox>
+`;