Refactoring proposal for streamlit-folium: feedback requested

[hansthen]

@randyzwitch @blackary

Some time ago javascript event handlers were added as first level objects to the Folium library. These have the potential to make the internal structure of streamlit-folium simpler.

At present streamlit-folium is somewhat binary. It supports a number of plugins (like draw and side-by-side), but that support is also activated when we do not use these plugins. This can cause some problems. There was a minor conflict between the extensions for the Draw plugin when I added the Geoman plugin to Folium.

If we use the Folium event handlers we can make modularize this. Modularization will make the internal structure of the streamlit component more comprehensible. (I also think it will no longer be necessary to use regex expressions to make the naming conventions uniform.)

I have a few ideas to implement this which I would like to discuss with you. But the main and first question would be: are you open for this? It would be a major refactoring. If so, do you have secondary requirements like backwards compatibility?

[randyzwitch]

Hi @hansthen!

We're absolutely open to refactoring/improvements. While I think backwards compatibility is important, I do think an effort like this would be a great move towards a "1.0" type release.

Let me see how to add you as a collaborator, so that you can make branches directly on this repo, and @blackary and/or myself will start to let the community know about what we're thinking about.

Obviously, if there are trivial changes, we're happy to just merge them in the current release structure as well, to keep this from being a massive project to start.

Best,
Randy

[hansthen]

Thanks for adding me as a collaborator! It is greatly appreciated. I think I will start with a few proof-of-concept examples to show what I mean.

[blackary]

One thing for your consideration, @hansthen -- there's a new version of components coming soon streamlit/streamlit#11354

It offers some really nice features which could make this component a lot better, especially around state management, multiple triggers, etc.

There's not a definite date when it will be officially released, but it might be worth considering switching to components v2 as part of a "1.0" release

[hansthen]

@blackary Thanks for the heads up. I did not know Components 2.0 was already in preview. The new specification looks like a big improvement.

[randyzwitch]

Yeah, whatever makes sense in terms of timing, wasn't trying to stress anyone out