Create tree plugin - Githubissues

voila-dashboards / voila

Voilà turns Jupyter notebooks into standalone web applications

https://voila.readthedocs.io

Other

5.33k stars 497 forks source link

Create tree plugin #1374

Closed trungleduc closed 11 months ago

trungleduc commented 11 months ago

References

Closes https://github.com/voila-dashboards/voila/issues/1372

tree

Code changes

pyzmq is pinned to 25.1.0 on the Mac OS pipeline because 25.1.1 is not available as wheel yet on Mac OS

User-facing changes

The default tree page of Voila is now using the file browser widget of JupyterLab
The jinja-based tree page is still supported, but users need to activate it with the --classic-tree CLI option, the VoilaConfiguration.classic_tree config or ?classic-tree=True in the query string.
JupyterLab custom theme is supported with the new tree page, for the classic tree page, only the light and dark theme are supported.

Backwards-incompatible changes

Users need to activate the classic tree to use existing tree templates.

github-actions[bot] commented 11 months ago

:point_left: Launch a Binder on branch trungleduc/voila/tree-page

jtpio commented 11 months ago

@trungleduc you mentioned offline that interacting with the file browser items in this PR only requires 1 click, instead of the double click like in JupyterLab?

There is an issue to add this behavior in JupyterLab so that it could be configured, which would be especially useful for Notebook 7: https://github.com/jupyterlab/jupyterlab/issues/14071

Do you think this could be implemented upstream? This could go in JupyterLab 4.1 as a new feature.

trungleduc commented 11 months ago

@trungleduc you mentioned offline that interacting with the file browser items in this PR only requires 1 click, instead of the double click like in JupyterLab?

There is an issue to add this behavior in JupyterLab so that it could be configured, which would be especially useful for Notebook 7: jupyterlab/jupyterlab#14071

Do you think this could be implemented upstream? This could go in JupyterLab 4.1 as a new feature.

I was able to implement this feature since in the case of voila, I don't need other interactions like multiple selections or drag/drop. So I just need to overwrite the single click handler and disable all others.

Upstreaming this is not a technical problem but I think we need more UX studies before adding the single click behavior to Lab.

jtpio commented 11 months ago

Upstreaming this is not a technical problem but I think we need more UX studies before adding the single click behavior to Lab.

Maybe it would be fine if it is behind a user setting (opt-in)?

trungleduc commented 11 months ago

Upstreaming this is not a technical problem but I think we need more UX studies before adding the single click behavior to Lab.

Maybe it would be fine if it is behind a user setting (opt-in)?

Indeed, I've just realized that we don't have any advanced interactions (drag/drop, ...) in the Notebook v6 browser. I'll open a PR after finishing this one.

I'll keep the implementation here to release Voila ASAP and will reuse the upstream version once it's released.

jtpio commented 11 months ago

Indeed, I've just realized that we don't have any advanced interactions (drag/drop, ...) in the Notebook v6 browser. I'll open a PR after finishing this one.

Yes, and in Notebook 7 we can use the checkboxes to select multiple items.

I'll keep the implementation here to release Voila ASAP and will reuse the upstream version once it's released.

Makes sense, it might take a little while to get this released in JupyterLab.

Thanks!

trungleduc commented 11 months ago

Please update galata references

trungleduc commented 11 months ago

Please update galata references

trungleduc commented 11 months ago

@jtpio could you re-take a look at this PR? I will release RC after this PR and update the documentation after that.

jtpio commented 11 months ago

update the documentation after that.

Nice. Maybe a note in the changelog (as a highlight) would also be useful (but could also be done later).

edit: opened https://github.com/voila-dashboards/voila/issues/1377