-
Notifications
You must be signed in to change notification settings - Fork 83
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
KTable - Week 2 #649
KTable - Week 2 #649
Conversation
type: Array, | ||
required: true, | ||
}, | ||
caption: { |
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.
Regarding caption prop, this is good approach. In the final version, caption and any other strings will need to be received via prop from products, such as Kolibri, because KDS doesn't contain mechanism for translations.
KTableGridItem, | ||
}, | ||
props: { | ||
headers: { |
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.
No need to do it now, rather a note for when we're finalizing API (that is shortly before using the table in Kolibri) - I recommend documenting props, slots, and events with JSDocs comments.
Some examples
- https://github.com/learningequality/kolibri-design-system/blob/release-v4/lib/KImg/index.vue#L177-L201
- https://github.com/learningequality/kolibri-design-system/blob/release-v4/lib/KImg/index.vue#L15
- https://github.com/learningequality/kolibri-design-system/blob/release-v4/lib/KImg/index.vue#L364-L366
The documentation will then use these to auto-generate the bottom section of the documentation page https://design-system.learningequality.org/kimg/#props
export default { | ||
name: 'KTableGridItem', | ||
props: { | ||
content: { |
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.
In the next iteration, I'd recommend using slot rather than content
prop, since we will need to work with rich HTML content. This will make transitioning towards exposing scoped slots easier.
Looking great, @BabyElias! I left a few notes you can have a look later and will merge it now (but if you had any questions or things to chat about in more detail, we can still discuss here) |
Description