-
Notifications
You must be signed in to change notification settings - Fork 82
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
KSelect: Add documentation about the new events and slots #664
Comments
Hi @AlexVelezLl, |
Thanks for volunteering on this @yeshwanth235! assigning this to you. |
Is there a playground where we can use Kolibri components? If so, please share the link. |
Hey @yeshwanth235! Yes, this looks like the right change. Please raise a PR so we can have a better look.
Yes! Here you can find our playground page: https://github.com/LearningEquality/Kolibri-Design-System/blob/develop/docs/pages/playground/index.vue. And you can see it rendered in |
Closed by #821 |
🌱 Are you new to the codebase? Welcome and please see the contributing guidelines.
Summary
Document all props, slots, events, and public methods of KSelect that are not documented yet.
Context
In #549 we introduced an important refactor of KSelect as part of moving away from
KeenUiSelect
vendored component, and as a result we ended up having all the events, slots and public methods exposed byKeenUiSelect
inKSelect
, and the most of them doesn't have any description in our docs.Desired behavior
Would be great to have this new API documented, so anyone that reads them can understand it.
Guidance
Note that the props, slots, and events documentation is auto-generated from JSDoc strings in the Vue component - so that's the right place where to document it all. See https://github.com/learningequality/kolibri-design-system/blob/release-v4/dev_docs/04_how_to_update_docs.md#updating-the-library-components-documentation.
The text was updated successfully, but these errors were encountered: