feat:scoped支持调用amis动作

hsm-lv · Nov 23, 2023 · aa280f8 · aa280f8
1 parent ce3b325
commit aa280f8
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 9 deletions.
diff --git a/docs/zh-CN/start/getting-started.md b/docs/zh-CN/start/getting-started.md
@@ -230,6 +230,59 @@ let amisScoped = amis.embed(
 
 还可以通过 `amisScoped.getComponentByName('page1.form1').setValues({'name1': 'othername'})` 来修改表单中的值。
 
+### 调用 amis 动作
+
+可以通过`amisScoped.doAction(actions, ctx)`来调用 amis 中的通用动作和目标组件的动作。了解事件动作机制可以查看[事件动作](../../docs/concepts/event-action)。参数说明如下：
+
+- `actions`：动作列表，支持执行单个或多个动作
+- `ctx`：上下文，它可以为动作配置补充上下文数据，例如下面`toast`动作中`msg`配置中的`${myName}`就来自于补充上下文`ctx`
+
+下面的例子中依次执行了`toast提示`、`ajax请求`、`dialog弹窗`、`给目标组件赋值`动作。
+
+```js
+amisScoped.doAction(
+  [
+    {
+      actionType: 'toast',
+      args: {
+        msg: '${amisUser.name}, ${myName}'
+      }
+    },
+    {
+      actionType: 'ajax',
+      api: {
+        url: 'https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/mock2/form/saveForm',
+        method: 'post'
+      }
+    },
+    {
+      actionType: 'dialog',
+      dialog: {
+        type: 'dialog',
+        title: '弹窗',
+        body: [
+          {
+            type: 'tpl',
+            tpl: '<p>对，你打开了弹窗</p>',
+            inline: false
+          }
+        ]
+      }
+    },
+    {
+      actionType: 'setValue',
+      componentId: 'name',
+      args: {
+        value: '${myName}'
+      }
+    }
+  ],
+  {
+    myName: 'amis'
+  }
+);
+```
+
 ### 更新属性
 
 可以通过 amisScoped 对象的 updateProps 方法来更新下发到 amis 的属性。

diff --git a/packages/amis-core/src/Scoped.tsx b/packages/amis-core/src/Scoped.tsx
@@ -21,7 +21,8 @@ import {
 } from './utils/helper';
 import {RendererData, ActionObject} from './types';
 import {isPureVariable} from './utils/isPureVariable';
-import {filter} from './utils';
+import {createObject, createRendererEvent, filter} from './utils';
+import {ListenerAction, runActions} from './actions';
 
 /**
  * target 里面可能包含 ?xxx=xxx，这种情况下，需要把 ?xxx=xxx 保留下来，然后对前面的部分进行 filter
@@ -75,6 +76,7 @@ export interface IScopedContext {
     session: string,
     path: string
   ) => ScopedComponentType[];
+  doAction: (actions: ListenerAction | ListenerAction[], ctx: any) => void;
 }
 type AliasIScopedContext = IScopedContext;
 
@@ -355,6 +357,23 @@ function createScopedTools(
       if (component && component.props.show) {
         closeDialog(component);
       }
+    },
+
+    async doAction(actions: ListenerAction | ListenerAction[], ctx: any) {
+      debugger;
+      const renderer = this.getComponents()[0]; // 直接拿最顶层
+      const rendererEvent = createRendererEvent('embed', {
+        env,
+        nativeEvent: undefined,
+        data: createObject(renderer.props.data, ctx),
+        scoped: this
+      });
+
+      await runActions(actions, renderer, rendererEvent);
+
+      if (rendererEvent.prevented) {
+        return;
+      }
     }
   };
 

diff --git a/packages/amis-core/src/actions/AjaxAction.ts b/packages/amis-core/src/actions/AjaxAction.ts
@@ -39,7 +39,7 @@ export class AjaxAction implements RendererAction {
     renderer: ListenerContext,
     event: RendererEvent<any>
   ) {
-    if (!renderer.props.env?.fetcher) {
+    if (!event.context.env?.fetcher) {
       throw new Error('env.fetcher is required!');
     }
 

diff --git a/packages/amis-core/src/actions/CmptAction.ts b/packages/amis-core/src/actions/CmptAction.ts
@@ -40,7 +40,7 @@ export class CmptAction implements RendererAction {
 
     /** 如果args中携带path参数, 则认为是全局变量赋值, 否则认为是组件变量赋值 */
     if (action.actionType === 'setValue' && path && typeof path === 'string') {
-      const beforeSetData = renderer?.props?.env?.beforeSetData;
+      const beforeSetData = event?.context?.env?.beforeSetData;
       if (beforeSetData && typeof beforeSetData === 'function') {
         const res = await beforeSetData(renderer, action, event);
 

diff --git a/packages/amis-core/src/actions/CopyAction.ts b/packages/amis-core/src/actions/CopyAction.ts
@@ -28,12 +28,12 @@ export class CopyAction implements RendererAction {
     renderer: ListenerContext,
     event: RendererEvent<any>
   ) {
-    if (!renderer.props.env?.copy) {
+    if (!event.context.env?.copy) {
       throw new Error('env.copy is required!');
     }
 
     if (action.args?.content) {
-      renderer.props.env.copy?.(action.args.content, {
+      event.context.env?.copy?.(action.args.content, {
         format: action.args?.copyFormat ?? 'text/html'
       });
     }

diff --git a/packages/amis-core/src/actions/LinkAction.ts b/packages/amis-core/src/actions/LinkAction.ts
@@ -34,7 +34,7 @@ export class LinkAction implements RendererAction {
     renderer: ListenerContext,
     event: RendererEvent<any>
   ) {
-    if (!renderer.props.env?.jumpTo) {
+    if (!event.context.env?.jumpTo) {
       throw new Error('env.jumpTo is required!');
     }
 
@@ -53,7 +53,7 @@ export class LinkAction implements RendererAction {
       }
     );
 
-    renderer.props.env.jumpTo(
+    event.context.env?.jumpTo(
       urlObj.url,
       {
         actionType: action.actionType,

diff --git a/packages/amis-core/src/actions/ToastAction.ts b/packages/amis-core/src/actions/ToastAction.ts
@@ -34,11 +34,11 @@ export class ToastAction implements RendererAction {
     renderer: ListenerContext,
     event: RendererEvent<any>
   ) {
-    if (!renderer.props.env?.notify) {
+    if (!event.context.env?.notify) {
       throw new Error('env.notify is required!');
     }
 
-    event.context.env.notify?.(
+    event.context.env?.notify?.(
       action.args?.msgType || 'info',
       String(action.args?.msg),
       action.args