Merge pull request #2819 from insistence/insistence-dev

Add dash subcomponents receive additional parameters passed by the pa…

Author: T4rk1n

@plotly/dash-test-components/src/components/AddPropsComponent.js

@@ -0,0 +1,23 @@
+import React from "react";
+import PropTypes from "prop-types";
+
+const AddPropsComponent = (props) => {
+    const {children, id} = props;
+
+
+    return (
+        <div id={id}>
+            {React.cloneElement(children, {
+                receive: `Element #${id} pass`,
+                id: id,
+            })}
+        </div>
+    );
+};
+
+AddPropsComponent.propTypes = {
+    id: PropTypes.string,
+    children: PropTypes.node,
+};
+
+export default AddPropsComponent;

@plotly/dash-test-components/src/components/ReceivePropsComponent.js

@@ -0,0 +1,19 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+const ReceivePropsComponent = (props) => {
+    const {id, text, receive} = props;
+
+    return (
+        <div id={id}>
+            {receive || text}
+        </div>
+    );
+}
+ReceivePropsComponent.propTypes = {
+    id: PropTypes.string,
+    text: PropTypes.string,
+    receive: PropTypes.string,
+}
+
+export default ReceivePropsComponent;

@plotly/dash-test-components/src/index.js

@@ -7,6 +7,8 @@ import MyPersistedComponentNested from './components/MyPersistedComponentNested'
 import StyledComponent from './components/StyledComponent';
 import WidthComponent from './components/WidthComponent';
 import ComponentAsProp from './components/ComponentAsProp';
+import AddPropsComponent from "./components/AddPropsComponent";
+import ReceivePropsComponent from "./components/ReceivePropsComponent";
 
 export {
     AsyncComponent,
@@ -18,4 +20,6 @@ export {
     StyledComponent,
     WidthComponent,
     ComponentAsProp,
+    AddPropsComponent,
+    ReceivePropsComponent
 };

CHANGELOG.md

@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## Added
 
+- [#2819](https://github.com/plotly/dash/pull/2819) Add dash subcomponents receive additional parameters passed by the parent component. Fixes [#2814](https://github.com/plotly/dash/issues/2814).
 - [#2826](https://github.com/plotly/dash/pull/2826) When using Pages, allows for `app.title` and (new) `app.description` to be used as defaults for the page title and description. Fixes [#2811](https://github.com/plotly/dash/issues/2811).
 - [#2795](https://github.com/plotly/dash/pull/2795) Allow list of components to be passed as layout.
 - [#2760](https://github.com/plotly/dash/pull/2760) New additions to dcc.Loading resolving multiple issues:

dash/dash-renderer/src/TreeContainer.js

@@ -16,6 +16,7 @@ import {
     map,
     mapObjIndexed,
     mergeRight,
+    omit,
     pick,
     pickBy,
     propOr,
@@ -237,7 +238,13 @@ class BaseTreeContainer extends Component {
         );
     }
 
-    getComponent(_dashprivate_layout, children, loading_state, setProps) {
+    getComponent(
+        _dashprivate_layout,
+        children,
+        loading_state,
+        setProps,
+        _extraProps
+    ) {
         const {_dashprivate_config, _dashprivate_dispatch, _dashprivate_error} =
             this.props;
 
@@ -262,7 +269,10 @@ class BaseTreeContainer extends Component {
             ],
             _dashprivate_config
         );
-        let props = dissoc('children', _dashprivate_layout.props);
+        let props = mergeRight(
+            _extraProps,
+            dissoc('children', _dashprivate_layout.props)
+        );
 
         for (let i = 0; i < childrenProps.length; i++) {
             const childrenProp = childrenProps[i];
@@ -481,6 +491,21 @@ class BaseTreeContainer extends Component {
             _dashprivate_path
         } = this.props;
 
+        const _extraProps = omit(
+            [
+                '_dashprivate_error',
+                '_dashprivate_layout',
+                '_dashprivate_loadingState',
+                '_dashprivate_loadingStateHash',
+                '_dashprivate_path',
+                '_dashprivate_config',
+                '_dashprivate_dispatch',
+                '_dashprivate_graphs',
+                '_dashprivate_loadingMap'
+            ],
+            this.props
+        );
+
         const layoutProps = this.getLayoutProps();
 
         const children = this.getChildren(
@@ -492,7 +517,8 @@ class BaseTreeContainer extends Component {
             _dashprivate_layout,
             children,
             _dashprivate_loadingState,
-            this.setProps
+            this.setProps,
+            _extraProps
         );
     }
 }

tests/integration/renderer/test_add_receive_props.py

@@ -0,0 +1,74 @@
+from dash import Dash, html, Input, Output, no_update
+
+from dash_test_components import AddPropsComponent, ReceivePropsComponent
+
+
+def test_rdarp001_add_receive_props(dash_duo):
+    app = Dash(__name__)
+    app.layout = html.Div(
+        [
+            AddPropsComponent(
+                ReceivePropsComponent(
+                    id="test-receive1",
+                    text="receive component1",
+                ),
+                id="test-add",
+            ),
+            ReceivePropsComponent(
+                id="test-receive2",
+                text="receive component2",
+            ),
+            html.Button(
+                "load no pass props",
+                id="load-no-pass-props",
+            ),
+            html.Pre("load-no-pass-props-output"),
+            html.Div(id="load-no-pass-props-output"),
+            html.Button(
+                "load pass props",
+                id="load-pass-props",
+            ),
+            html.Pre("load-pass-props-output"),
+            html.Div(id="load-pass-props-output"),
+        ]
+    )
+
+    @app.callback(
+        Output("load-no-pass-props-output", "children"),
+        Input("load-no-pass-props", "n_clicks"),
+    )
+    def load_no_pass_props(n_clicks):
+        if n_clicks:
+            return ReceivePropsComponent(
+                id="test-receive-no-pass",
+                text="receive component no pass",
+            )
+        return no_update
+
+    @app.callback(
+        Output("load-pass-props-output", "children"),
+        Input("load-pass-props", "n_clicks"),
+    )
+    def load_pass_props(n_clicks):
+        if n_clicks:
+            return AddPropsComponent(
+                ReceivePropsComponent(
+                    id="test-receive-pass",
+                    text="receive component pass",
+                ),
+                id="test-add-pass",
+            )
+        return no_update
+
+    dash_duo.start_server(app)
+    dash_duo.wait_for_text_to_equal("#test-receive1", "Element #test-add pass")
+    dash_duo.wait_for_text_to_equal("#test-receive2", "receive component2")
+
+    clicker_no_pass = dash_duo.wait_for_element("#load-no-pass-props")
+    clicker_no_pass.click()
+    dash_duo.wait_for_text_to_equal(
+        "#test-receive-no-pass", "receive component no pass"
+    )
+    clicker_pass = dash_duo.wait_for_element("#load-pass-props")
+    clicker_pass.click()
+    dash_duo.wait_for_text_to_equal("#test-receive-pass", "Element #test-add-pass pass")