search

Wolfr / sveltekit-jui

Sveltekit-JUI is a kit of UI components to be used in conjunction with Svelte and Svelte Kit
https://sveltekit-jui-wolfr.vercel.app/
Other
44 stars 3 forks source link

Docs Improvement #80

Open PaxPax opened 3 years ago

PaxPax commented 3 years ago

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.

Wolfr commented 3 years ago

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

PaxPax commented 3 years ago

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

Wolfr commented 3 years ago

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 :-)

PaxPax commented 3 years ago

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

Wolfr commented 3 years ago

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.