docs: add info how to render input type column (splunk#638)

Harshit1q1 · Feb 10, 2023 · a47f6ec · a47f6ec
1 parent d07f487
commit a47f6ec
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/modular_input_type_column.md b/docs/modular_input_type_column.md
@@ -0,0 +1,24 @@
+# Modular Input Type column
+
+If your add-on has multiple modular inputs there is a way to render an additional 
+column to show the input type of each input created.
+
+Go to `header` field under `pages > inputs > table` and add another element there.
+
+```text
+"header": [
+    ...
+    {
+        "label": "Input Type",
+        "field": "serviceName",
+        "mapping": {
+            "input_name_1": "Input name 1",
+            "input_name_2": "Input name 2"
+        }
+    }
+    ...
+]
+```
+
+The key under `mapping` field is the name of your modular input and the value is
+how it will be rendered in the UI.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -28,6 +28,7 @@ nav:
   - Components: "components.md"
   - Tabs: "tabs.md"
   - Additional packaging: "additional_packaging.md"
+  - Modular Input Type column: "modular_input_type_column.md"
   - Custom UI Extensions:
     - Custom Hook: "custom_ui_extensions/custom_hook.md"
     - Custom Control: "custom_ui_extensions/custom_control.md"