Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Refactor edit header (#65577)

Fraser4e1d6c0796fa
diff --git a/frontend/src/metabase/reference/components/EditHeader.jsx b/frontend/src/metabase/reference/components/EditHeader.jsx
deleted file mode 100644
index 3a6c05643a9..00000000000
--- a/frontend/src/metabase/reference/components/EditHeader.jsx
+++ /dev/null
@@ -1,77 +0,0 @@
-import cx from "classnames";
-import PropTypes from "prop-types";
-import { memo } from "react";
-import { t } from "ttag";
-
-import ButtonsS from "metabase/css/components/buttons.module.css";
-import CS from "metabase/css/core/index.css";
-import RevisionMessageModal from "metabase/reference/components/RevisionMessageModal";
-
-import S from "./EditHeader.module.css";
-
-const EditHeader = ({
- hasRevisionHistory,
- endEditing,
- reinitializeForm = () => undefined,
- submitting,
- onSubmit,
- revisionMessageFormField,
-}) => (
- <div className={cx(CS.wrapper, CS.px3, S.editHeader)}>
- <div className={S.editHeaderButtons}>
- <button
- type="button"
- className={cx(ButtonsS.Button, S.cancelButton)}
- onClick={() => {
- endEditing();
- reinitializeForm();
- }}
- >
- {t`Cancel`}
- </button>
-
- {hasRevisionHistory ? (
- <RevisionMessageModal
- action={() => onSubmit()}
- field={revisionMessageFormField}
- submitting={submitting}
- >
- <button
- className={cx(
- ButtonsS.Button,
- ButtonsS.ButtonPrimary,
- S.saveButton,
- )}
- type="button"
- disabled={submitting}
- >
- {t`Save`}
- </button>
- </RevisionMessageModal>
- ) : (
- <button
- className={cx(
- ButtonsS.Button,
- ButtonsS.ButtonPrimary,
- ButtonsS.ButtonWhite,
- S.saveButton,
- )}
- type="submit"
- disabled={submitting}
- >
- {t`Save`}
- </button>
- )}
- </div>
- </div>
-);
-EditHeader.propTypes = {
- hasRevisionHistory: PropTypes.bool,
- endEditing: PropTypes.func.isRequired,
- reinitializeForm: PropTypes.func,
- submitting: PropTypes.bool.isRequired,
- onSubmit: PropTypes.func,
- revisionMessageFormField: PropTypes.object,
-};
-
-export default memo(EditHeader);
diff --git a/frontend/src/metabase/reference/components/EditHeader.tsx b/frontend/src/metabase/reference/components/EditHeader.tsx
new file mode 100644
index 00000000000..8b1593199a9
--- /dev/null
+++ b/frontend/src/metabase/reference/components/EditHeader.tsx
@@ -0,0 +1,73 @@
+import { useDisclosure } from "@mantine/hooks";
+import cx from "classnames";
+import { memo } from "react";
+import { t } from "ttag";
+
+import CS from "metabase/css/core/index.css";
+import { RevisionMessageModal } from "metabase/reference/components/RevisionMessageModal";
+import { Button } from "metabase/ui";
+
+import S from "./EditHeader.module.css";
+
+interface EditHeaderProps {
+ hasRevisionHistory?: boolean;
+ endEditing: () => void;
+ reinitializeForm?: () => void;
+ submitting: boolean;
+ onSubmit?: () => void;
+ revisionMessageFormField?: {
+ value: string;
+ onChange: (e: React.ChangeEvent<HTMLTextAreaElement>) => void;
+ error?: string;
+ name: string;
+ };
+}
+
+export const EditHeader = memo(function EditHeader({
+ hasRevisionHistory,
+ endEditing,
+ reinitializeForm = () => undefined,
+ submitting,
+ onSubmit = () => undefined,
+ revisionMessageFormField,
+}: EditHeaderProps) {
+ const [modalOpened, { open: openModal, close: closeModal }] =
+ useDisclosure(false);
+
+ return (
+ <>
+ <div className={cx(CS.wrapper, CS.px3, S.editHeader)}>
+ <div className={S.editHeaderButtons}>
+ <Button
+ variant="outline"
+ onClick={() => {
+ endEditing();
+ reinitializeForm();
+ }}
+ >
+ {t`Cancel`}
+ </Button>
+ {hasRevisionHistory ? (
+ <Button variant="filled" disabled={submitting} onClick={openModal}>
+ {t`Save`}
+ </Button>
+ ) : (
+ <Button type="submit" variant="filled" disabled={submitting}>
+ {t`Save`}
+ </Button>
+ )}
+ </div>
+ </div>
+
+ {hasRevisionHistory && revisionMessageFormField && (
+ <RevisionMessageModal
+ opened={modalOpened}
+ onClose={closeModal}
+ action={onSubmit}
+ field={revisionMessageFormField}
+ submitting={submitting}
+ />
+ )}
+ </>
+ );
+});
diff --git a/frontend/src/metabase/reference/components/RevisionMessageModal.jsx b/frontend/src/metabase/reference/components/RevisionMessageModal.jsx
deleted file mode 100644
index 60c07dc55a0..00000000000
--- a/frontend/src/metabase/reference/components/RevisionMessageModal.jsx
+++ /dev/null
@@ -1,68 +0,0 @@
-/* eslint "react/prop-types": "warn" */
-import cx from "classnames";
-import PropTypes from "prop-types";
-import { Component, createRef } from "react";
-import { t } from "ttag";
-
-import ModalContent from "metabase/common/components/ModalContent";
-import ModalWithTrigger from "metabase/common/components/ModalWithTrigger";
-import ButtonsS from "metabase/css/components/buttons.module.css";
-import CS from "metabase/css/core/index.css";
-
-import S from "./RevisionMessageModal.module.css";
-
-export default class RevisionMessageModal extends Component {
- static propTypes = {
- action: PropTypes.func.isRequired,
- field: PropTypes.object.isRequired,
- submitting: PropTypes.bool,
- children: PropTypes.any,
- };
-
- constructor(props) {
- super(props);
-
- this.modal = createRef();
- }
-
- render() {
- const { action, children, field, submitting } = this.props;
-
- const onClose = () => {
- this.modal.current.close();
- };
-
- const onAction = () => {
- onClose();
- action();
- };
-
- return (
- <ModalWithTrigger ref={this.modal} triggerElement={children}>
- <ModalContent title={t`Reason for changes`} onClose={onClose}>
- <div className={S.modalBody}>
- <textarea
- className={S.modalTextArea}
- placeholder={t`Leave a note to explain what changes you made and why they were required`}
- {...field}
- />
- </div>
-
- <div className="Form-actions">
- <button
- type="button"
- className={cx(ButtonsS.Button, ButtonsS.ButtonPrimary)}
- onClick={onAction}
- disabled={submitting || field.error}
- >{t`Save changes`}</button>
- <button
- type="button"
- className={cx(ButtonsS.Button, CS.ml1)}
- onClick={onClose}
- >{t`Cancel`}</button>
- </div>
- </ModalContent>
- </ModalWithTrigger>
- );
- }
-}
diff --git a/frontend/src/metabase/reference/components/RevisionMessageModal.tsx b/frontend/src/metabase/reference/components/RevisionMessageModal.tsx
new file mode 100644
index 00000000000..a7d0f7b8fd6
--- /dev/null
+++ b/frontend/src/metabase/reference/components/RevisionMessageModal.tsx
@@ -0,0 +1,67 @@
+import { t } from "ttag";
+
+import { Button, Flex, Modal, Textarea } from "metabase/ui";
+
+interface RevisionMessageModalProps {
+ opened: boolean;
+ onClose: () => void;
+ action: () => void;
+ field: {
+ value: string;
+ onChange: (e: React.ChangeEvent<HTMLTextAreaElement>) => void;
+ error?: string;
+ name: string;
+ };
+ submitting?: boolean;
+}
+
+export function RevisionMessageModal({
+ opened,
+ onClose,
+ action,
+ field,
+ submitting,
+}: RevisionMessageModalProps) {
+ // eslint-disable-next-line no-console
+ console.log("RevisionMessageModal render:", {
+ fieldValue: field.value,
+ fieldError: field.error,
+ submitting,
+ isDisabled: submitting || !!field.error,
+ });
+
+ const handleAction = () => {
+ onClose();
+ action();
+ };
+
+ return (
+ <Modal
+ opened={opened}
+ onClose={onClose}
+ title={t`Reason for changes`}
+ size="lg"
+ >
+ <Flex direction="column" gap="md">
+ <Textarea
+ placeholder={t`Leave a note to explain what changes you made and why they were required`}
+ value={field.value}
+ onChange={field.onChange}
+ name={field.name}
+ autosize
+ minRows={4}
+ />
+ <Flex justify="flex-end" gap="sm">
+ <Button onClick={onClose}>{t`Cancel`}</Button>
+ <Button
+ variant="filled"
+ onClick={handleAction}
+ disabled={submitting || !!field.error}
+ >
+ {t`Save changes`}
+ </Button>
+ </Flex>
+ </Flex>
+ </Modal>
+ );
+}
diff --git a/frontend/src/metabase/reference/databases/DatabaseDetail.jsx b/frontend/src/metabase/reference/databases/DatabaseDetail.jsx
index 41451a496d3..9fc9b48f800 100644
--- a/frontend/src/metabase/reference/databases/DatabaseDetail.jsx
+++ b/frontend/src/metabase/reference/databases/DatabaseDetail.jsx
@@ -10,7 +10,7 @@ import CS from "metabase/css/core/index.css";
import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import Detail from "metabase/reference/components/Detail";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import * as actions from "metabase/reference/reference";
diff --git a/frontend/src/metabase/reference/databases/FieldDetail.jsx b/frontend/src/metabase/reference/databases/FieldDetail.jsx
index b0e52cd1237..f9a2f9538e7 100644
--- a/frontend/src/metabase/reference/databases/FieldDetail.jsx
+++ b/frontend/src/metabase/reference/databases/FieldDetail.jsx
@@ -11,7 +11,7 @@ import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import S from "metabase/reference/Reference.module.css";
import Detail from "metabase/reference/components/Detail";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import FieldTypeDetail from "metabase/reference/components/FieldTypeDetail";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
diff --git a/frontend/src/metabase/reference/databases/FieldList.jsx b/frontend/src/metabase/reference/databases/FieldList.jsx
index f782f994b59..7540b4c6972 100644
--- a/frontend/src/metabase/reference/databases/FieldList.jsx
+++ b/frontend/src/metabase/reference/databases/FieldList.jsx
@@ -12,7 +12,7 @@ import CS from "metabase/css/core/index.css";
import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import R from "metabase/reference/Reference.module.css";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import Field from "metabase/reference/components/Field";
import F from "metabase/reference/components/Field.module.css";
diff --git a/frontend/src/metabase/reference/databases/TableDetail.jsx b/frontend/src/metabase/reference/databases/TableDetail.jsx
index 452e711e3ff..7ba988a4031 100644
--- a/frontend/src/metabase/reference/databases/TableDetail.jsx
+++ b/frontend/src/metabase/reference/databases/TableDetail.jsx
@@ -11,7 +11,7 @@ import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import S from "metabase/reference/Reference.module.css";
import Detail from "metabase/reference/components/Detail";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
import * as actions from "metabase/reference/reference";
diff --git a/frontend/src/metabase/reference/segments/SegmentDetail.jsx b/frontend/src/metabase/reference/segments/SegmentDetail.jsx
index 6be8db50334..ec7c8d4ab55 100644
--- a/frontend/src/metabase/reference/segments/SegmentDetail.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentDetail.jsx
@@ -11,7 +11,7 @@ import CS from "metabase/css/core/index.css";
import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import Detail from "metabase/reference/components/Detail";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import { Formula } from "metabase/reference/components/Formula";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx b/frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx
index 3947a94c3ac..573e0337130 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldDetail.jsx
@@ -11,7 +11,7 @@ import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import S from "metabase/reference/Reference.module.css";
import Detail from "metabase/reference/components/Detail";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import FieldTypeDetail from "metabase/reference/components/FieldTypeDetail";
import UsefulQuestions from "metabase/reference/components/UsefulQuestions";
diff --git a/frontend/src/metabase/reference/segments/SegmentFieldList.jsx b/frontend/src/metabase/reference/segments/SegmentFieldList.jsx
index e999f7a8d13..068033a0b71 100644
--- a/frontend/src/metabase/reference/segments/SegmentFieldList.jsx
+++ b/frontend/src/metabase/reference/segments/SegmentFieldList.jsx
@@ -12,7 +12,7 @@ import CS from "metabase/css/core/index.css";
import { connect } from "metabase/lib/redux";
import * as metadataActions from "metabase/redux/metadata";
import R from "metabase/reference/Reference.module.css";
-import EditHeader from "metabase/reference/components/EditHeader";
+import { EditHeader } from "metabase/reference/components/EditHeader";
import EditableReferenceHeader from "metabase/reference/components/EditableReferenceHeader";
import Field from "metabase/reference/components/Field";
import F from "metabase/reference/components/Field.module.css";