Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate ReactTemplate, IDOM pane and Viewable.app #4293

Merged
merged 2 commits into from Jan 25, 2023
Merged

Conversation

philippjfr
Copy link
Member

@philippjfr philippjfr commented Jan 16, 2023

After some discussion I've decided to execute a few deprecations ahead of the 1.0 release.

For templates I've simply decided that we do not need 5 different ListTemplate implementations and multiple grid template implementations. Deprecating some of these implementations will allow us to better focus on styling existing templates and reduces the maintenance burden.

Here are the deprecations I'm suggesting:

  • IDOM pane: We only support version 0.24 currently which is very old. Since we do not have a maintainer who could update it and Reacton fills the same niche I've decided to remove it. It may be it could be re-added later in a panel-idom package but without anyone requesting support I think the right decision is to remove it.
  • ReactTemplate: The ReactTemplate is overall pretty nice BUT the naming is terrible (it's built on top of a React library but it doesn't actually allow you to use React or anything so really that's an implementation detail. Secondly, the FastGridTemplate lets you do the exact same thing but looks prettier.
  • Viewable.app: The .app method allows starting a server in Jupyter and then embedding it as an iframe. This relies on the port being accessible and to specify the notebook_url. This is brittle without much benefit at all because you already get interactivity in a notebook without running a server. I've left the function that will let you do the same thing but we don't need a method on all objects to do this.

Please chime in with thoughts and/or objections.

Ping @MarcSkovMadsen, @jbednar, @maximlt, @hoxbro

@MarcSkovMadsen
Copy link
Collaborator

Sounds sensible. You could collect the bereaking changes you want to do. Announce them on discourse, Twitter and LinkedIn.

Then its hard for users to get upset if they did not react. And if you overlooked something you could get the feedback.

@hoxbro
Copy link
Member

hoxbro commented Jan 16, 2023

I have no objection to the removal of these.

Does this mean that VTK is being kept in Panel 1.0?

@philippjfr
Copy link
Member Author

Does this mean that VTK is being kept in Panel 1.0?

I had planned to write a panel-extension-cookiecutter and then use it to distribute panel-vtk but I doubt I'll have time.

@jbednar
Copy link
Member

jbednar commented Jan 17, 2023

Sounds reasonable to me.

@philippjfr philippjfr changed the title Deprecate VanillaTemplate, ReactTemplate, IDOM pane and Viewable.app Deprecate ReactTemplate, IDOM pane and Viewable.app Jan 25, 2023
@philippjfr philippjfr merged commit 3f1ee7e into main Jan 25, 2023
@philippjfr philippjfr deleted the v1.0_deprecations branch January 25, 2023 14:31
philippjfr added a commit that referenced this pull request Jan 26, 2023
* Deprecate VanillaTemplate, ReactTemplate, IDOM pane and Viewable.app

* Back out of VanillaTemplate deprecation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants