Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
KevinHodder opened this issue May 25, 2023 · 3 comments
Open

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

KevinHodder opened this issue May 25, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request roadmap

Comments

@KevinHodder
Copy link

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 BeeMargarida added documentation Improvements or additions to documentation enhancement New feature or request roadmap labels Jun 1, 2023
@BeeMargarida BeeMargarida moved this to Features on the Roadmap in SvelteUI board Jun 1, 2023
@BeeMargarida
Copy link
Member

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
Copy link
Contributor

A Table component will also be needed for this.

@BeeMargarida
Copy link
Member

Yap, it's in the pipeline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request roadmap
Projects
Status: Features on the Roadmap
Development

No branches or pull requests

3 participants