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

Feature/improve documentation #85

Open PaxPax opened 3 years ago

PaxPax commented 3 years ago

Added details for slots, events, and disptach events; also added more events to be forwarded. I didn't want to do all of them at once, I figured it would be too large of a pr. Let me know what you think!

Wolfr commented 3 years ago

Thanks the inspiration and work!

I used this as a base to work on this branch: https://github.com/Wolfr/sveltekit-jui/tree/forward-events

Not sure about forwarding a click event on the Badge or Avatar; I think it might be better to provide an interactive avatar instead (with an element) and then put the click on the element.

Same for badge, where I can imagine a badge having a tooltip, or being clickable. Then that means we need to add an interactive variant and a variant where there is an aria role of tooltip added (in case of tooltip used).

I will also need to look at the visual display of the table with forwarded events, so that's why I didn't commit it to main yet.