Open AlexVelezLl opened 5 months ago
Hi @AlexVelezLl, Please assign this issue to my name
Thanks for volunteering on this @yeshwanth235! assigning this to you.
Please review. If everything looks good, I'll raise the PR.
Props Events Slots And Methods
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.
Is there a playground where we can use Kolibri components? If so, please share the link.
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 http://localhost:4000/playground
🌱 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.