-
Notifications
You must be signed in to change notification settings - Fork 773
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
feat: document the slots of a component #1362
Comments
Seems like a good idea! Right now we can support this use case, using the
but it would be great to provide this as a end-to-end feature:
|
@manucorporat How soon can you add this? I need it tomorrow. |
If I were able to implement the fully baked solution proposed, would a PR be welcomed? 😉 Ideally I'd like to see this provide slot documentation even in cases where no comments are present. We should be able to glean the docs data from the markup used in the template if that's AST parse-able. |
Nice idea, it would be great to immediately understand if component supports slots |
This has been added in Stencil, you can see it in action here: https://github.com/ionic-team/ionic/blob/6e0b9c45489889266620ee2ca38c33fdf8ce3f3b/core/src/components/button/button.tsx#L12-L15 We haven't added it to be displayed in the docs yet, but the data is there for the site to use. |
Thanks |
Stencil version:
I'm submitting a:
[ ] bug report
[x] feature request
[ ] support request => Please do not submit support requests here, use one of these channels: https://stencil-worldwide.herokuapp.com/ or https://forum.ionicframework.com/
It would be nice to document the
slot
options on a component, something like this could go above the component:The text was updated successfully, but these errors were encountered: