fixup

equinor · May 31, 2024 · ee3ee03 · ee3ee03
1 parent d8cc86b
commit ee3ee03
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 0 deletions.
diff --git a/packages/dm-core-plugins/docs/JobControlPlugin/Documentation.md b/packages/dm-core-plugins/docs/JobControlPlugin/Documentation.md
@@ -0,0 +1,27 @@
+Lists display information where objects listed are structured the same. In dm applications it's also a great way for user to navigate nested items and objects.
+
+## Table of contents
+- [Passing data](#passing-data)
+    - [Scope to list](#scope)
+    - [Headers](#headers)
+
+## Passing data \{#passing-data}
+
+### Scope to list \{#scope}
+List expects an array of objects. Array is passed to the plugin by using the scope method in ViewConfig.
+```json {4}
+"viewConfig": {
+    "type": "CORE:ViewConfig",
+    "recipe": {…},
+    "scope": "array_attribute_name"
+}
+```
+
+### Headers \{#headers}
+Select data fields by passing attribute name in `headers` config.
+```json {3}
+"config": {
+    "type": "PLUGINS:dm-core-plugins/table/ListPluginConfig",
+    "headers": ["first_name", "last_name", "age"]
+}
+```
diff --git a/packages/dm-core-plugins/docs/JobControlPlugin/blueprints.json b/packages/dm-core-plugins/docs/JobControlPlugin/blueprints.json
@@ -0,0 +1,4 @@
+{
+  "folder": "job",
+  "main": "ControlConfig"
+}
diff --git a/packages/dm-core-plugins/docs/JobCreatePlugin/Documentation.md b/packages/dm-core-plugins/docs/JobCreatePlugin/Documentation.md
@@ -0,0 +1,27 @@
+Lists display information where objects listed are structured the same. In dm applications it's also a great way for user to navigate nested items and objects.
+
+## Table of contents
+- [Passing data](#passing-data)
+    - [Scope to list](#scope)
+    - [Headers](#headers)
+
+## Passing data \{#passing-data}
+
+### Scope to list \{#scope}
+List expects an array of objects. Array is passed to the plugin by using the scope method in ViewConfig.
+```json {4}
+"viewConfig": {
+    "type": "CORE:ViewConfig",
+    "recipe": {…},
+    "scope": "array_attribute_name"
+}
+```
+
+### Headers \{#headers}
+Select data fields by passing attribute name in `headers` config.
+```json {3}
+"config": {
+    "type": "PLUGINS:dm-core-plugins/table/ListPluginConfig",
+    "headers": ["first_name", "last_name", "age"]
+}
+```
diff --git a/packages/dm-core-plugins/docs/JobCreatePlugin/blueprints.json b/packages/dm-core-plugins/docs/JobCreatePlugin/blueprints.json
@@ -0,0 +1,4 @@
+{
+  "folder": "job",
+  "main": "CreateConfig"
+}