learningequality / kolibri-design-system

Kolibri Design System
https://design-system.learningequality.org
31 stars 75 forks source link

KSelect: Add documentation about the new events and slots #664

Open AlexVelezLl opened 5 months ago

AlexVelezLl commented 5 months ago

🌱 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.

kselect

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 by KeenUiSelect in KSelect, 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.

yeshwanth235 commented 1 week ago

Hi @AlexVelezLl, Please assign this issue to my name

ozer550 commented 1 week ago

Thanks for volunteering on this @yeshwanth235! assigning this to you.

yeshwanth235 commented 1 week ago

Please review. If everything looks good, I'll raise the PR.

Props Image Events Image Slots And Methods Image

yeshwanth235 commented 1 week ago

Is there a playground where we can use Kolibri components? If so, please share the link.

AlexVelezLl commented 1 week ago

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