search

reflex-dev / reflex

🕸️ Web apps in pure Python 🐍
https://reflex.dev
Apache License 2.0
17.99k stars 997 forks source link

Issue with Custom Components #3239

Open TheMagiCan1 opened 2 months ago

TheMagiCan1 commented 2 months ago

Path: /docs/custom-components

Reflex is designed to be "simple and easy to use" and a really good alternative especially for hobby - devs (like me) to get started with web development. But it is a fairly young module. Hence the possibility for reflex not providing "a standard component" that you need is high. This is where your cunstom component system is comming into place. I tried to use 2 of them. Both offering me eexactly what I needed. But in both cases they provided no documentation at all. So I guess: Most of the custom components do not have a proper documentation. You 'll alway have to dig through a ton of code from a demo page (which is not necessarily a fully working, or well commented one) to work with these components. As a hobby - dev this is really annoying and causes frustration using reflex and / or the custom components!

So please make sure, that the creators of the custom components have to provide a proper documentation of their components, showing us how to use them in an fully functionable (possibly simple) reflex app!

Thanks!

TheMagiCan1 commented 2 months ago

Sorry for my english! Comming from a nightshift and english is not my native language!

Lendemor commented 2 months ago

HI, thanks for the feedback!

I'm not sure if we can really force the users to add documentation to their package (even if it would be way more convenient) since at the end of the day it's their own package.

What we could try however is to make sure they specify a correct link to the repo where the 3rd party component is wrapped, so people can open issues there to get a proper README.md.

For the ones wrapped by the team to get the custom components started, we'll check them and add README.md where missing.

You can also ask for help on our Discord when a component cause you trouble, maybe you can get help that way.