Add documentation pages for KResponsiveWindow and KResponsiveElement #362
Conversation
MisRob
force-pushed
the
document-mixins
branch
from
246fc09 to
f37ea0a
Compare
MisRob
requested review from
marcellamaki,
jtamiace,
radinamatic,
akolson and
nucleogenesis
|
Nice worthy additions, docs build well locally, and I did not notice any overt grammar errors:
Given that the KDS documentation is a 👶🏽 of many with varying parenting (writing 🙂) styles that we never had bandwidth to unify from the technical writing point of view, I'm vary of making styling and editing suggestions for these specific components as those will probably be valid for all the rest. |
There was a problem hiding this comment.
This is excellent @MisRob - I really love the "change your browser size to see this in action" example you gave :)
|
@nucleogenesis I just moved that example from the Layouts page, and I suspect that @indirectlylit is its author :) |
There was a problem hiding this comment.
looks great!
just a heads up that #358 might start getting a bit stale as the docs evolve
| <DocsShowCode language="javascript"> | ||
| import KResponsiveWindowMixin from 'kolibri-design-system/lib/KResponsiveWindowMixin'; | ||
|
|
||
| export default { | ||
| mixins: [KResponsiveWindowMixin] | ||
| }; | ||
| </DocsShowCode> |
There was a problem hiding this comment.
the scrollbar/layout issue below is addressed here:
| <DocsShowCode language="html"> | ||
| <div class="box" :style="boxStyle"> | ||
| Box 1 | ||
| </div> | ||
| <div class="box" :style="boxStyle"> | ||
| Box 2 | ||
| </div> | ||
| </DocsShowCode> |
There was a problem hiding this comment.
|
Ah I'm sorry @indirectlylit, I knew about that PR. I will assign myself and will do my best to review soon and resolve conflicts. |
|
Thanks for pointing out those places |
|
no worries! just wanted to give a heads up - I know there are always a lot of things happening |
Description
Updates library documentation:
KResponsiveWindowMixinwere moved to its new page, and Layouts page now only contains general breakpoints information with newly added references to the two new pages.Two new pages were prepared with keeping #288 (allow mixins logic to be used via composition API) in mind. Therefore, pages are called KResponsiveWindow/KResponsiveElement and not
KResponsiveWindowMixin/KResponsiveElementMixinsince in the near future we should be able to access this logic in an alternative way to mixins, via composables (useKResponsiveWindow,useKResponsiveElement). Relatedly, all information provided on new pages is presented in a way applicable to both existing mixins as well as to new composables to be implemented. Usage details specific to mixins can be found in the Usage -> As mixins section of pages. This prepares the ground for a new sub-section, Usage-> As composables to be added as part of #288.Issue addressed
I mentioned performance troubles on KResponsiveElement page so this also closes #237
Steps to test
Read
Is it easy to follow? Can you spot any typos, recommend grammar improvements?
Testing checklist
changelogReviewer guidance
Post-merge updates and tracking
Comments