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

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

Closed
AlexVelezLl opened this issue Jun 18, 2024 · 6 comments
Closed

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

AlexVelezLl opened this issue Jun 18, 2024 · 6 comments
Assignees
Labels
category: library Shared code library Component: KSelect good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome

Comments

@AlexVelezLl
Copy link
Member

AlexVelezLl commented Jun 18, 2024

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

@AlexVelezLl AlexVelezLl added category: library Shared code library Component: KSelect good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome labels Jun 18, 2024
@yeshwanth235
Copy link
Contributor

Hi @AlexVelezLl,
Please assign this issue to my name

@ozer550
Copy link
Member

ozer550 commented Nov 11, 2024

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

@yeshwanth235
Copy link
Contributor

yeshwanth235 commented Nov 12, 2024

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

Props
Image
Events
Image
Slots And Methods
Image

@yeshwanth235
Copy link
Contributor

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

@AlexVelezLl
Copy link
Member Author

AlexVelezLl commented Nov 12, 2024

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

@MisRob
Copy link
Member

MisRob commented Dec 2, 2024

Closed by #821

@MisRob MisRob closed this as completed Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: library Shared code library Component: KSelect good first issue Self-contained, straightforward, low-complexity help wanted Open source contributors welcome
Projects
None yet
Development

No branches or pull requests

4 participants