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

Rework docs landing page #446

Closed
rmorshea opened this issue Jul 26, 2021 · 7 comments
Closed

Rework docs landing page #446

rmorshea opened this issue Jul 26, 2021 · 7 comments

Comments

@rmorshea
Copy link
Collaborator

  • For most things don't need to know JS/HTML/CSS
  • If users don't know what React is, what is IDOM?
  • Why use IDOM?
  • Why use IDOM instead of Python + React?
    • IDOM is simpler (not more performant)
  • Great for data science dashboards
  • Integrates with most React components without extra work
  • Remove the code-block, but call out examples (there's an examples tab for a reason)
  • Add a grid of GIFs that link to the associated examples instead of the code-block.
  • Link to the "getting started" and "the basics" pages
@rafaellichen
Copy link

rafaellichen commented Aug 5, 2021

I am able to build my own react component and publish it on NPM to use with IDOM. This technically means I can put a full-fledged react web app directly inside jupyter notebook with IDOM. I love this library ❤️ thank you so much.

@rmorshea
Copy link
Collaborator Author

@rafaellichen that's great to hear! It'd be cool to learn how your using IDOM - just start a discussion and I'd be happy to chat about it.

@rmorshea
Copy link
Collaborator Author

Closed by: 6b8119b

@rafaellichen
Copy link

@rafaellichen that's great to hear! It'd be cool to learn how your using IDOM - just start a discussion and I'd be happy to chat about it.

this is probably a very late response 😅 but here is the template for how we used this library to make jupyter notebook widget.
https://github.com/megagonlabs/react-jupyter-cookiecutter

@rmorshea
Copy link
Collaborator Author

Interesting! Is there anything in idom-jupyter you felt was lacking that motivated you to create this template? I was hoping people would be able to use idom-jupyter along with this JS component template repo without any modifications, but perhaps there's some issue I'm not aware of.

@rafaellichen
Copy link

rafaellichen commented Jan 4, 2023

Interesting! Is there anything in idom-jupyter you felt was lacking that motivated you to create this template? I was hoping people would be able to use idom-jupyter along with this JS component template repo without any modifications, but perhaps there's some issue I'm not aware of.

mostly minor details:

  1. reload UI widget in notebook without restarting the notebook kernel. example
  2. we noticed that rollup build time can be lengthy as the react app gets bigger. it takes 10-15+ seconds to build every time for our project. we used webpack for a different project and the build time gets reduced significantly. so we are planning to switch to webpack eventually.

@rmorshea
Copy link
Collaborator Author

rmorshea commented Jan 5, 2023

reload UI widget in notebook without restarting the notebook kernel

From what I can tell, I'm guessing that this is useful while developing the widget? If so, I think this is a feature that could be built into the core of IDOM. The idea would be to create a thin wrapper around any exported components that would, on some cadence, check to see if the source file the component originates from has been modified and trigger a re-render.

we noticed that rollup build time can be lengthy

I'd be open to a contribution that would allow users of IDOM's template repo to select their preferred bundler. We could use a post_gen_project.py hook to accomplish this as see in this example.

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

No branches or pull requests

2 participants