kongponents
kongponents copied to clipboard
docs(kselect): add missing documentation slots [KHCP-4631]
Summary
This PR adds loading
and empty
slots docs.
I noticed we have another items
slot that replaces all the KSelectItem
s. It seems if the user decides to use this slot, they'll have to deal with handleItemSelect
logic themselves, which is not easy. Do you have any idea how we should document this slot? @adamdehaven
PR Checklist
- [ ] Does not introduce dependencies
- [ ] Functional: all changes do not break existing APIs and if so, bump major version.
- [ ] Tests pass: check the output of yarn test packages/<Kongponent>
- [ ] Naming: the files and the method and prop variables use the same naming conventions as other Kongponents
- [ ] Framework style: abides by the essential rules in Vue's style guide
- [ ] Cleanliness: does not have formatting issues, unused code (e.g., console.logs), or leftover comments
- [ ] Docs: includes a technically accurate README, uses JSDOC where appropriate
Deploy Preview for kongponents ready!
Name | Link |
---|---|
Latest commit | a55bac613c5bccc0911176f2103ac2690ba107e4 |
Latest deploy log | https://app.netlify.com/sites/kongponents/deploys/63174126dafb2f0009ee1a15 |
Deploy Preview | https://deploy-preview-777--kongponents.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
I noticed we have another
items
slot that replaces all theKSelectItem
s. It seems if the user decides to use this slot, they'll have to deal withhandleItemSelect
logic themselves, which is not easy. Do you have any idea how we should document this slot?
Well I already approved the main
branch PR 😬
Hmm, I'm not sure really. @kaiarrowood any ideas? Do we even use the items
slot anywhere?
I noticed we have another
items
slot that replaces all theKSelectItem
s. It seems if the user decides to use this slot, they'll have to deal withhandleItemSelect
logic themselves, which is not easy. Do you have any idea how we should document this slot?Well I already approved the
main
branch PR 😬Hmm, I'm not sure really. @kaiarrowood any ideas? Do we even use the
items
slot anywhere?
I don't believe we do... it may be better to yank if we aren't actually documenting the slot and no easy way to handle the selection... Otherwise we need to handle with logic similar to how we do for the selectionMenu
appearance in KDropdownMenu
: https://kongponents.konghq.com/components/dropdown-menu.html#appearance
The items
slot needs to return the handleSelection
function for the user.
So do we have a conclusion about the items
slot? Is there anything I can do in this PR?
So do we have a conclusion about the
items
slot? Is there anything I can do in this PR?
Can you investigate how easy it would be to follow the pattern we are using in KDropdownMenu? I wouldn't spend more than a half day on it. If it's too difficult to add the support, lets just yank the slot.
EDIT: Also, let's NOT backport this support to main
. On main
let's remove the items
slot. If we decide we can support it for KSelect
, let's only support in beta
.
Does this work for you @adamdehaven ?
EDIT2: Ignore my first suggestion! Discussed with Adam, let's completely remove the items
slot from both main
and beta
in favor of item-template
slot.
@kaiarrowood if we're going to yank the items
slot on main
branch, I'd say let's remove it completely from beta
as well. We (Kong) aren't using it anywhere, and if we ever need it in the future, we can always add it back.
We have the item-template
slot already, so I think that satisfies our needs.
@Leopoldthecoder would you want to remove the items
slot on both main
and beta
? (This PR we will approve and merge, and you can do the work in KHCP-4668)
No problem, will do.
Hi, I removed the items
slot in #782 and #783.
:tada: This PR is included in version 8.0.0-beta.8 :tada:
The release is available on:
Your semantic-release bot :package::rocket: