diff --git a/vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md b/vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md new file mode 100644 index 000000000..d57e34cc2 --- /dev/null +++ b/vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md @@ -0,0 +1,42 @@ + + + + + + + + diff --git a/vizro-core/docs/pages/user_guides/custom_charts.md b/vizro-core/docs/pages/user_guides/custom_charts.md index 337b6424b..0c8219be6 100644 --- a/vizro-core/docs/pages/user_guides/custom_charts.md +++ b/vizro-core/docs/pages/user_guides/custom_charts.md @@ -153,3 +153,10 @@ The below examples shows a more involved use-case. We create and style a waterfa [![Graph3]][Graph3] [Graph3]: ../../assets/user_guides/custom_charts/custom_chart_waterfall.png + + +???+ warning + + Please note that users of this package are responsible for the content of any custom-created component, + function or integration they write - especially with regard to leaking any sensitive information or exposing to + any security threat during implementation. diff --git a/vizro-core/docs/pages/user_guides/custom_components.md b/vizro-core/docs/pages/user_guides/custom_components.md index 315c19484..dc3fdc805 100644 --- a/vizro-core/docs/pages/user_guides/custom_components.md +++ b/vizro-core/docs/pages/user_guides/custom_components.md @@ -7,11 +7,6 @@ In general, you can create a custom component based on any dash-compatible compo [dash-bootstrap-components](https://dash-bootstrap-components.opensource.faculty.ai/), [dash-html-components](https://github.com/plotly/dash/tree/dev/components/dash-html-components), etc.). -!!!warning - When creating your own custom components, you are responsible for the security of your component (e.g. prevent setting HTML from code which might expose users to cross-site scripting). Vizro cannot guarantee - the security of custom created components, so make sure you keep this in mind when publicly deploying your dashboard. - - Vizro's public API is deliberately kept small in order to facilitate quick and easy configuration of a dashboard. However, at the same time, Vizro is easily extensible, so that you can tweak any component to your liking or even create entirely new ones. @@ -354,3 +349,11 @@ vm.Page.add_type("components", Jumbotron) [![CustomComponent2]][CustomComponent2] [CustomComponent2]: ../../assets/user_guides/custom_components/customcomponent_2.png + + + +???+ warning + + Please note that users of this package are responsible for the content of any custom-created component, + function or integration they write - especially with regard to leaking any sensitive information or exposing to + any security threat during implementation. diff --git a/vizro-core/docs/pages/user_guides/integration.md b/vizro-core/docs/pages/user_guides/integration.md index 202a5ba1c..c987f9091 100644 --- a/vizro-core/docs/pages/user_guides/integration.md +++ b/vizro-core/docs/pages/user_guides/integration.md @@ -45,3 +45,11 @@ register the datasets with [`kedro_datasets.pandas`](https://docs.kedro.org/en/s for dataset_name, dataset in kedro_integration.datasets_from_catalog(catalog).items(): data_manager[dataset_name] = dataset ``` + + + +???+ warning + + Please note that users of this package are responsible for the content of any custom-created component, + function or integration they write - especially with regard to leaking any sensitive information or exposing to + any security threat during implementation.