sveltekit-jui icon indicating copy to clipboard operation
sveltekit-jui copied to clipboard

Docs Improvement

Open PaxPax opened this issue 4 years ago • 5 comments

I think it would be helpful to show all components with an option to toggle the source code shown and all props, events, and slots that are applicable.

PaxPax avatar Apr 14 '21 17:04 PaxPax

Do you mean every component should have source code and a props table? A related issue is #2 .

Wolfr avatar Apr 14 '21 18:04 Wolfr

yes, along with what events are forwarded and what are dispatched and what values to expect from dispatch.

*edit: I really like how ibm carbon components show it. example https://carbon-svelte.vercel.app/components/TextInput

PaxPax avatar Apr 14 '21 18:04 PaxPax

I am fully along with doing it this way, and Carbon is a good reference. Now we just need people to help do the work :-)

Wolfr avatar Apr 15 '21 08:04 Wolfr

so implementing something that would look like image What are your thoughts?

PaxPax avatar Apr 16 '21 03:04 PaxPax

I think that's a great improvement to have! Especially for highly interactive elements.

BTW all those scroll bars that you see, seems like I have to set overflow: auto; instead of scroll. You shouldn't need a horizontal scrollbar on your screen shot.

Wolfr avatar Apr 16 '21 07:04 Wolfr