The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Update ActionButton to typescript (#63454)
Ryan Laurie40387cc58672
diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsx b/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsxindex ff06dc0fc4a..70eb816cc5b 100644--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsx+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/components/EditSandboxingModal/EditSandboxingModal.tsx@@ -268,7 +268,6 @@ const EditSandboxingModal = ({<div className={cx(CS.flex, CS.alignCenter, CS.justifyEnd)}><Button onClick={onCancel}>{t`Cancel`}</Button><ActionButton- error={error}className={CS.ml1}actionFn={savePolicy}primarydiff --git a/frontend/src/metabase/admin/settings/components/UploadSettings/UploadSettingsForm.tsx b/frontend/src/metabase/admin/settings/components/UploadSettings/UploadSettingsForm.tsxindex c93724c7a83..f7ca65e7943 100644--- a/frontend/src/metabase/admin/settings/components/UploadSettings/UploadSettingsForm.tsx+++ b/frontend/src/metabase/admin/settings/components/UploadSettings/UploadSettingsForm.tsx@@ -8,7 +8,9 @@ import {useListSyncableDatabaseSchemasQuery,} from "metabase/api";import { getErrorMessage, useAdminSetting } from "metabase/api/utils";-import ActionButton from "metabase/common/components/ActionButton";+import ActionButton, {+ type ActionButtonHandle,+} from "metabase/common/components/ActionButton";import Alert from "metabase/common/components/Alert";import Link from "metabase/common/components/Link";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";@@ -76,9 +78,9 @@ export function UploadSettingsFormView({const isHosted = useSetting("is-hosted?");- const enableButtonRef = useRef<ActionButton>(null);- const disableButtonRef = useRef<ActionButton>(null);- const updateButtonRef = useRef<ActionButton>(null);+ const enableButtonRef = useRef<ActionButtonHandle>(null);+ const disableButtonRef = useRef<ActionButtonHandle>(null);+ const updateButtonRef = useRef<ActionButtonHandle>(null);const resetButtons = () => {enableButtonRef?.current?.resetState();diff --git a/frontend/src/metabase/common/components/ActionButton/ActionButton.jsx b/frontend/src/metabase/common/components/ActionButton/ActionButton.jsxdeleted file mode 100644index 9f9a79e81e7..00000000000--- a/frontend/src/metabase/common/components/ActionButton/ActionButton.jsx+++ /dev/null@@ -1,169 +0,0 @@-/* eslint-disable react/prop-types */-import cx from "classnames";-import PropTypes from "prop-types";-import { Component } from "react";-import { t } from "ttag";--import Button from "metabase/common/components/Button";-import ButtonsS from "metabase/css/components/buttons.module.css";-import CS from "metabase/css/core/index.css";-import { cancelable } from "metabase/lib/promise";-import { Icon } from "metabase/ui";--import { SmallSpinner } from "./ActionButton.styled";--export default class ActionButton extends Component {- constructor(props) {- super(props);-- this.state = {- active: false,- result: null,- };- this.resetState.bind(this);- }-- static propTypes = {- actionFn: PropTypes.func.isRequired,- };-- static defaultProps = {- className: ButtonsS.Button,- successClassName: ButtonsS.ButtonSuccess,- failedClassName: ButtonsS.ButtonDanger,- get normalText() {- return t`Save`;- },- get activeText() {- return t`Saving...`;- },- get failedText() {- return t`Save failed`;- },- get successText() {- return t`Saved`;- },- forceActiveStyle: false,- };-- componentWillUnmount() {- clearTimeout(this.timeout);- if (this.actionPromise) {- this.actionPromise.cancel();- }- }-- resetState() {- clearTimeout(this.timeout);- this.setState({- active: false,- result: null,- });- }-- resetStateOnTimeout = () => {- // clear any previously set timeouts then start a new one- clearTimeout(this.timeout);- this.timeout = setTimeout(- () =>- this.setState({- active: false,- result: null,- }),- 5000,- );- };-- onClick = (event) => {- event.preventDefault();-- // set state to active- this.setState({- active: true,- result: null,- });-- // run the function we want bound to this button- this.actionPromise = cancelable(this.props.actionFn());- this.actionPromise.then(- (success) => {- this.setState(- {- active: false,- result: "success",- },- this.resetStateOnTimeout,- );- },- (error) => {- if (!error.isCanceled) {- console.error(error);- this.setState(- {- active: false,- result: "failed",- },- this.resetStateOnTimeout,- );- }- },- );- };-- render() {- const {- innerRef,- normalText,- activeText,- failedText,- successText,- useLoadingSpinner = false,- resetState,- actionFn,- className,- successClassName,- failedClassName,- forceActiveStyle,- children,- ...props- } = this.props;- const { active, result } = this.state;- const isActionDisabled = active || result === "success";- const actionStatus = active ? "pending" : (result ?? "idle");-- return (- <Button- ref={innerRef}- {...props}- data-action-status={actionStatus}- className={- forceActiveStyle- ? ButtonsS.Button- : cx(className, {- [successClassName]: result === "success",- [failedClassName]: result === "failed",- [CS.pointerEventsNone]: isActionDisabled,- })- }- onClick={this.onClick}- >- {active ? (- useLoadingSpinner ? (- <SmallSpinner />- ) : (- activeText- )- ) : result === "success" ? (- <span>- {forceActiveStyle ? null : <Icon name="check" size={12} />}- <span className={CS.ml1}>{successText}</span>- </span>- ) : result === "failed" ? (- failedText- ) : (- children || normalText- )}- </Button>- );- }-}diff --git a/frontend/src/metabase/common/components/ActionButton/ActionButton.styled.tsx b/frontend/src/metabase/common/components/ActionButton/ActionButton.styled.tsxdeleted file mode 100644index 48b010c3afe..00000000000--- a/frontend/src/metabase/common/components/ActionButton/ActionButton.styled.tsx+++ /dev/null@@ -1,16 +0,0 @@-// eslint-disable-next-line no-restricted-imports-import styled from "@emotion/styled";--import LoadingSpinner from "metabase/common/components/LoadingSpinner/LoadingSpinner";--export const SmallSpinner = styled(LoadingSpinner)`- display: flex;- justify-content: center;- width: 5rem;- font-size: 0.5rem;-- div {- height: 1.2rem;- width: 1.2rem;- }-`;diff --git a/frontend/src/metabase/common/components/ActionButton/ActionButton.tsx b/frontend/src/metabase/common/components/ActionButton/ActionButton.tsxnew file mode 100644index 00000000000..9d53ee93c37--- /dev/null+++ b/frontend/src/metabase/common/components/ActionButton/ActionButton.tsx@@ -0,0 +1,160 @@+import cx from "classnames";+import {+ forwardRef,+ useCallback,+ useEffect,+ useImperativeHandle,+ useRef,+ useState,+} from "react";+import { t } from "ttag";++import Button, { type ButtonProps } from "metabase/common/components/Button";+import ButtonsS from "metabase/css/components/buttons.module.css";+import CS from "metabase/css/core/index.css";+import type { CancellablePromise } from "metabase/lib/promise";+import { cancelable } from "metabase/lib/promise";+import { Center, Icon, Loader } from "metabase/ui";++export interface ActionButtonProps extends Omit<ButtonProps, "onClick"> {+ // need to expose this ref to allow Tooltip to bind to the correct element+ innerRef?: React.Ref<HTMLButtonElement>;+ normalText?: React.ReactNode;+ activeText?: React.ReactNode;+ failedText?: React.ReactNode;+ successText?: React.ReactNode;+ useLoadingSpinner?: boolean;+ actionFn: () => Promise<unknown>;+ className?: string;+ successClassName?: string;+ failedClassName?: string;+ forceActiveStyle?: boolean;+ children?: React.ReactNode;+}++export type ActionButtonHandle = {+ resetState: () => void;+};++const ActionButton = forwardRef<ActionButtonHandle, ActionButtonProps>(+ function ActionButtonInner(+ {+ normalText = t`Save`,+ activeText = t`Saving...`,+ failedText = t`Save failed`,+ successText = t`Saved`,+ useLoadingSpinner = false,+ actionFn,+ className = ButtonsS.Button,+ successClassName = ButtonsS.ButtonSuccess, // not used+ failedClassName = ButtonsS.ButtonDanger, // not used+ forceActiveStyle = false,+ children,+ innerRef,+ ...buttonProps+ },+ ref,+ ) {+ const [active, setActive] = useState(false);+ const [result, setResult] = useState<null | "failed" | "success">(null);+ const timeout = useRef<null | ReturnType<typeof setTimeout>>(null);+ const actionPromise = useRef<CancellablePromise<unknown> | null>(null);++ const resetTimeout = () => {+ timeout.current && clearTimeout(timeout.current);+ };++ useEffect(() => {+ const promise = actionPromise.current;+ return () => {+ resetTimeout();+ if (promise) {+ promise?.cancel?.();+ }+ };+ }, [actionPromise]);++ const resetState = useCallback(() => {+ resetTimeout();+ setActive(false);+ setResult(null);+ }, []);++ // very rarely, we need to reset a button based on changes outside this button+ useImperativeHandle(ref, () => ({ resetState }), [resetState]);++ const resetStateOnTimeout = () => {+ // clear any previously set timeouts then start a new one+ resetTimeout();+ timeout.current = setTimeout(resetState, 5000);+ };++ const handleClick = (event: React.MouseEvent<HTMLButtonElement>) => {+ event.preventDefault();++ // set state to active+ setActive(true);+ setResult(null);++ // run the function we want bound to this button+ actionPromise.current = cancelable(actionFn());+ actionPromise.current.then(+ () => {+ setActive(false);+ setResult("success");+ resetStateOnTimeout();+ },+ (error: Error & { isCanceled?: boolean }) => {+ if (!error.isCanceled) {+ console.error(error);+ setActive(false);+ setResult("failed");+ resetStateOnTimeout();+ }+ },+ );+ };+ const isActionDisabled = active || result === "success";+ const actionStatus = active ? "pending" : (result ?? "idle");++ return (+ <Button+ {...buttonProps}+ ref={innerRef}+ data-action-status={actionStatus}+ className={+ forceActiveStyle+ ? ButtonsS.Button+ : cx(className, {+ [successClassName]: result === "success",+ [failedClassName]: result === "failed",+ [CS.pointerEventsNone]: isActionDisabled,+ })+ }+ onClick={handleClick}+ >+ {active ? (+ useLoadingSpinner ? (+ <Center px="2rem">+ <Loader size="sm" color="white" data-testid="loading-indicator" />+ </Center>+ ) : (+ activeText+ )+ ) : result === "success" ? (+ <span>+ {forceActiveStyle ? null : <Icon name="check" size={12} />}+ <span className={CS.ml1}>{successText}</span>+ </span>+ ) : result === "failed" ? (+ failedText+ ) : (+ children || normalText+ )}+ </Button>+ );+ },+);++// eslint-disable-next-line import/no-default-export -- legacy usage+export default ActionButton;diff --git a/frontend/src/metabase/common/components/ActionButton/index.tsx b/frontend/src/metabase/common/components/ActionButton/index.tsxindex f5482a51c5d..a818f4275aa 100644--- a/frontend/src/metabase/common/components/ActionButton/index.tsx+++ b/frontend/src/metabase/common/components/ActionButton/index.tsx@@ -1,2 +1,3 @@// eslint-disable-next-line import/no-default-export -- deprecated usageexport { default } from "./ActionButton";+export * from "./ActionButton";diff --git a/frontend/src/metabase/lib/promise.ts b/frontend/src/metabase/lib/promise.tsindex 0ba4651b386..0943890413e 100644--- a/frontend/src/metabase/lib/promise.ts+++ b/frontend/src/metabase/lib/promise.ts@@ -1,10 +1,13 @@import { noop } from "underscore";-type CancellablePromise<T> = Promise<T> & {+export type CancellablePromise<T> = Promise<T> & {cancel: () => void;};-// return a promise wrapping the provided one but with a "cancel" method+/**+ * @deprecated - this is stupid don't use it+ * returns a promise wrapping the provided one but with a "cancel" method+ */export function cancelable<T>(promise: Promise<T>): CancellablePromise<T> {let canceled = false;