Documentation

Signed-off-by: Jitendra Gundaniya <[email protected]>
kedro-org · Oct 29, 2024 · be54fa5 · be54fa5
1 parent 97f9918
commit be54fa5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.npm.md b/README.npm.md
@@ -140,6 +140,9 @@ The example below demonstrates how to configure your kedro-viz using different `
       tag: {
         enabled: {companies: true}
       },
+      modeOptions: { 
+        reFocus: true,
+      },
       theme: "dark"
     }}
 />
@@ -161,6 +164,8 @@ The example below demonstrates how to configure your kedro-viz using different `
 | `sidebar`                  | boolean                                                                            | true                                                     | Show/Hide Sidebar and action toolbar                                                                                                                          |
 | `zoomToolbar`              | boolean                                                                            | true                                                     | Show/Hide zoom-in, zoom-out and zoom reset buttons together                                                                                                   |
 | options.expandAllPipelines | boolean                                                                            | false                                                    | Expand/Collapse Modular pipelines on first load                                                                                                               |
+| options.modeOptions            |                                                                                    |                                                          |                                                                                                                                                               |
+| `reFocus`       | boolean                                                                            | true                                                     | Enable/Disable node re-focus on click 
 | options.nodeType           | `{disabled: {parameters: boolean,task: boolean,data: boolean}}`                    | `{disabled: {parameters: true,task: false,data: false}}` | Configuration for node type options                                                                                                                           |
 | options.tag                | `{enabled: {<tagName>: boolean}}`                                                  | -                                                        | Configuration for tag options                                                                                                                                 |
 | options.theme              | string                                                                             | dark                                                     | select `Kedro-Viz` theme : dark/light                                                                                                                         |

diff --git a/src/components/app/app.js b/src/components/app/app.js
@@ -119,6 +119,12 @@ App.propTypes = {
     tag: PropTypes.shape({
       enabled: PropTypes.objectOf(PropTypes.bool),
     }),
+    /**
+     * Whether to re-focus the graph when a node is clicked
+     */
+    modeOptions: PropTypes.shape({
+      reFocus: PropTypes.bool,
+    }),
     /**
      * Override the default enabled/disabled node types
      */