Skip to content

A Q&A platform software for teams at any scales. Whether it's a community forum, help center, or knowledge management platform, you can always count on Apache Answer.

feat(SchemaForm): Optimising the action feedback of the Button component

haitaooc843dddf0b87
diff --git a/ui/src/components/SchemaForm/components/Button.tsx b/ui/src/components/SchemaForm/components/Button.tsx
index ea24c7aa..8ae3b704 100644
--- a/ui/src/components/SchemaForm/components/Button.tsx
+++ b/ui/src/components/SchemaForm/components/Button.tsx
@@ -1,9 +1,10 @@
-import React, { FC, useState } from 'react';
-import { Button, ButtonProps } from 'react-bootstrap';
+import React, { FC, useLayoutEffect, useState } from 'react';
+import { Button, ButtonProps, Spinner } from 'react-bootstrap';
import { request } from '@/utils';
import type * as Type from '@/common/interface';
-import type { UIAction } from '../index.d';
+import type { UIAction } from '../types';
+import { useToast } from '@/hooks';
interface Props {
fieldName: string;
@@ -24,17 +25,51 @@ const Index: FC<Props> = ({
variant = 'primary',
size,
}) => {
+ const Toast = useToast();
const [isLoading, setLoading] = useState(false);
- const handleAction = async () => {
+ const handleNotify = (msg, type: 'success' | 'danger' = 'success') => {
+ const tm = action?.toastMessage;
+ if (tm === false || !msg) {
+ return;
+ }
+ Toast.onShow({
+ msg,
+ variant: type,
+ });
+ };
+ const handleAction = () => {
if (!action) {
return;
}
setLoading(true);
- const method = action.method || 'get';
- await request[method](action.url);
- setLoading(false);
+ request
+ .request({
+ method: action.method,
+ url: action.url,
+ timeout: 0,
+ })
+ .then((resp) => {
+ if ('message' in resp) {
+ handleNotify(resp.message, 'success');
+ }
+ })
+ .catch((ex) => {
+ if (ex && 'msg' in ex) {
+ handleNotify(ex.msg, 'danger');
+ }
+ })
+ .finally(() => {
+ setLoading(false);
+ });
};
+ useLayoutEffect(() => {
+ if (action?.loading?.state === 'pending') {
+ setLoading(true);
+ }
+ }, []);
+ const loadingText = action?.loading?.text || text;
const disabled = isLoading || readOnly;
+
return (
<div className="d-flex">
<Button
@@ -43,8 +78,19 @@ const Index: FC<Props> = ({
disabled={disabled}
size={size}
variant={variant}>
- {text || fieldName}
- {isLoading ? '...' : ''}
+ {isLoading ? (
+ <>
+ <Spinner
+ className="align-middle me-2"
+ animation="border"
+ size="sm"
+ variant={variant}
+ />
+ {loadingText}
+ </>
+ ) : (
+ text
+ )}
</Button>
</div>
);
diff --git a/ui/src/components/SchemaForm/index.d.ts b/ui/src/components/SchemaForm/index.d.ts
deleted file mode 100644
index 2c525579..00000000
--- a/ui/src/components/SchemaForm/index.d.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-export interface UIAction {
- url: string;
- method?: 'get' | 'post' | 'put' | 'delete';
- event?: 'click' | 'change';
- handler?: ({evt, formData, request}) => Promise<void>
-}
diff --git a/ui/src/components/SchemaForm/index.tsx b/ui/src/components/SchemaForm/index.tsx
index c6e9faa4..b7d13112 100644
--- a/ui/src/components/SchemaForm/index.tsx
+++ b/ui/src/components/SchemaForm/index.tsx
@@ -11,7 +11,7 @@ import classnames from 'classnames';
import type * as Type from '@/common/interface';
-import type { UIAction } from './index.d';
+import type { UIAction } from './types';
import {
Legend,
Select,
diff --git a/ui/src/components/SchemaForm/types.ts b/ui/src/components/SchemaForm/types.ts
new file mode 100644
index 00000000..80d62986
--- /dev/null
+++ b/ui/src/components/SchemaForm/types.ts
@@ -0,0 +1,28 @@
+/**
+ * A few notes on button control:
+ * - Mainly used to send a request and notify the result of the request, and to update the data as required
+ * - A scenario where a message notification is displayed directly after a click without sending a request, implementing a dedicated control
+ * - Scenarios where the page jumps directly after a click without sending a request, implementing a dedicated control
+ *
+ * @field url : Target address for sending requests
+ * @field method : Method for sending requests, default `get`
+ * @field callback: Button event handler function that will fully take over the button events when this field is configured
+ * *** Incomplete, DO NOT USE ***
+ * @field loading: Set button loading information
+ * @field notify: Configure how button action processing results are prompted
+ */
+
+/**
+ * TODO:
+ * - Refining the type of `notify.options`
+ */
+export interface UIAction {
+ url: string;
+ method?: 'get' | 'post' | 'put' | 'delete';
+ callback?: () => Promise<void>;
+ loading?: {
+ text: string;
+ state?: 'none' | 'pending' | 'completed';
+ }
+ toastMessage?: boolean;
+}