plotly / dash

Data Apps & Dashboards for Python. No JavaScript Required.
https://plotly.com/dash
MIT License
21.45k stars 2.07k forks source link

Document assets_folder more widely #2022

Open alexlenail opened 2 years ago

alexlenail commented 2 years ago

I started building my app with JupyterDash. I put the assets in a folder called assets next to my notebook. CSS/JS in the assets folder show up in my dash app. If I move them and do app = JupyterDash(__name__, assets_url_path="/relative/path/") it doesn't work. Ditto for os.cwd()+"/relative/path/" and "/absolute/path/".

If i run the application with python dash_app.py, changing app = JupyterDash(...) to app = Dash(assets_url_path=...), None of the option above work. Only if I put an assets folder next to dash_app.py do I see my styles applied.

I think the documentation for assets_url_path could be improved a little -- it's only quickly mentioned here.

dash                              2.0.0
dash-bio                          0.7.1
dash-bootstrap-components         1.0.0
dash-core-components              2.0.0
dash-html-components              2.0.0
dash-renderer                     1.9.1
dash-table                        5.0.0
jupyter-dash                      0.4.0
alexcjohnson commented 2 years ago

Yes, we could probably be clearer about that. I think you want assets_folder, which tells dash where the assets are on disk, instead of assets_url_path which just changes how the browser references them.

alexlenail commented 2 years ago

@alexcjohnson this resolved my issue -- would recommend slightly more documentation about it.

alexcjohnson commented 2 years ago

cc @LiamConnors