Skip to content

Commit

Permalink
Add disclaimer for custom created components and integrations (#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
huong-li-nguyen authored Oct 25, 2023
1 parent 1cfa247 commit bc3a57d
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Removed
- A bullet item for the Removed category.
-->
<!--
### Added
- A bullet item for the Added category.
-->
<!--
### Changed
- A bullet item for the Changed category.
-->
<!--
### Deprecated
- A bullet item for the Deprecated category.
-->
<!--
### Fixed
- A bullet item for the Fixed category.
-->
<!--
### Security
- A bullet item for the Security category.
-->
7 changes: 7 additions & 0 deletions vizro-core/docs/pages/user_guides/custom_charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 8 additions & 5 deletions vizro-core/docs/pages/user_guides/custom_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
8 changes: 8 additions & 0 deletions vizro-core/docs/pages/user_guides/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit bc3a57d

Please sign in to comment.