search

svelteuidev / svelteui

SvelteUI Monorepo
https://svelteui.dev
MIT License
1.28k stars 64 forks source link

[Feature Request] Docs to contain full API of component props #387

Open KevinHodder opened 1 year ago

KevinHodder commented 1 year ago

Usage example, including component, action, motion, or utility API

Just a docs update to make the available props of the components more clear, in the sprit of Material UI's API docs

I found several useful and otherwise undocumented features in the .d.ts files that would be good to surface clearly.

Possible implementation - describe how the feature can be implemented

Most likely: a somewhat painstaking manual process, which I am willing to help with.

Do you want to contribute this feature and create a pull request

Yes

BeeMargarida commented 1 year ago

This was in the roadmap without being in the roadmap itself, so I just added it to the board. A possible implementation of this could be adding tabs, one for the demos like we have, and another for a table listing all the props and events a component has

khalibloo commented 1 year ago

A Table component will also be needed for this.

BeeMargarida commented 1 year ago

Yap, it's in the pipeline