docs(schema): supplementary scope variable (#3869)

alibaba · Jun 28, 2023 · 061ad21 · 061ad21
1 parent 3349815
commit 061ad21
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 2 deletions.
diff --git a/packages/react/docs/api/shared/Schema.md b/packages/react/docs/api/shared/Schema.md
@@ -851,7 +851,7 @@ Writing method two, linkage of adjacent elements
   "items": {
     "type": "object",
     "properties": {
-     "source": {
+      "source": {
         "type": "string",
         "x-component": "Input"
       },
@@ -961,6 +961,18 @@ Represents the top-level form data, which can be used in ordinary attribute expr
 
 Represents the current Form instance, which can be used in ordinary attribute expressions, and can also be used in x-reactions
 
+### $observable
+
+It is used to create reactive objects in the same way as observable
+
+### $memo
+
+Used to create persistent reference data in the same way as autorun.memo
+
+### $effect
+
+The timing of the next microtask in response to autorun's first execution and the dispose in response to autorun are used in the same way as autorun.effect
+
 ### $dependencies
 
 It can only be consumed by expressions in x-reactions, corresponding to the dependencies defined by x-reactions, and the sequence of the array is the same

diff --git a/packages/react/docs/api/shared/Schema.zh-CN.md b/packages/react/docs/api/shared/Schema.zh-CN.md
@@ -851,7 +851,7 @@ type SchemaReactions<Field = any> =
   "items": {
     "type": "object",
     "properties": {
-     "source": {
+      "source": {
         "type": "string",
         "x-component": "Input"
       },
@@ -961,6 +961,18 @@ type SchemaReactions<Field = any> =
 
 代表当前 Form 实例，可以在普通属性表达式中使用，也能在 x-reactions 中使用
 
+### $observable
+
+用于创建响应式对象，使用方式与 observable 一致
+
+### $memo
+
+用于创建持久引用数据，使用方式与 autorun.memo 一致
+
+### $effect
+
+用于响应 autorun 第一次执行的下一个微任务时机与响应 autorun 的 dispose，使用方式与 autorun.effect 一致
+
 ### $dependencies
 
 只能在 x-reactions 中的表达式消费，与 x-reactions 定义的 dependencies 对应，数组顺序一致

diff --git a/packages/vue/docs/api/shared/schema.md b/packages/vue/docs/api/shared/schema.md
@@ -957,6 +957,18 @@ type SchemaReactions<Field = any> =
 
 代表当前 Form 实例，可以在普通属性表达式中使用，也能在 x-reactions 中使用
 
+### $observable
+
+用于创建响应式对象，使用方式与 observable 一致
+
+### $memo
+
+用于创建持久引用数据，使用方式与 autorun.memo 一致
+
+### $effect
+
+用于响应 autorun 第一次执行的下一个微任务时机与响应 autorun 的 dispose，使用方式与 autorun.effect 一致
+
 ### $dependencies
 
 只能在 x-reactions 中的表达式消费，与 x-reactions 定义的 dependencies 对应，数组顺序一致