-
Notifications
You must be signed in to change notification settings - Fork 86
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
Add KSelect to KDS. #355
Add KSelect to KDS. #355
Conversation
94f5ec7
to
fbed7a8
Compare
Thank you @rtibbles. Before I proceed to the code review, could you update the changelog and documentation? Regarding documentation, you don't need to write an elaborate page but at least having a page with a basic summary to make sure everyone knows that this component is available in KDS and what's its basic API (the API part of the page will get automatically generated from JSDoc comments) |
Here's the preview of the docs associated with this PR https://deploy-preview-355--kolibri-design-system.netlify.app/
|
The "Overview" section can be brief and would ideally contain the component visualized, for example like here https://deploy-preview-355--kolibri-design-system.netlify.app/krouterlink/#overview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ commented above
And regarding the changelog, if you rebase on top of the latest |
I did try to add this in the initial PR but it broke the docs build, I'll reinstate what I had previously, and perhaps you can advise. |
fbed7a8
to
5338ba1
Compare
Updated both - it seems the docs issue I was having was because the docs build seemed not to provide a required prop to the component at one point, I assume when doing introspection for JSDocs? |
5338ba1
to
53c878b
Compare
53c878b
to
325262b
Compare
PR updated with documentation text authored by @jtamiace. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code successfully migrated, docs look great 🎉 and now finally KDS shall be whole again
Documentation and changelog has been updated, thank you
Description
commonCoreStrings
mixin in Kolibri, so this is substituted by having a prop to provide text for the clear action.There is almost certainly some refactor that can be done here to avoid the extra component nesting that still exists here, but that seemed better to defer to later for ease of review.
Issue addressed
Fixes #339
Before/after screenshots
Linked KSelect seems to function as before:
Steps to test
Link to Kolibri PR learningequality/kolibri#9667
Check instances of KSelect.
The
clearable
/clearText
props are only used in the resource search panelTesting checklist
changelog
Reviewer guidance
Post-merge updates and tracking
Comments