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
JS docs formatting tweaks #31337
JS docs formatting tweaks #31337
Conversation
We should make the table responsive BTW. EDIT: And maybe use normal font-size? Not sure what the rationale behind this choice was. |
I knocked down the font-size to ideally help with readability. Bump it up in the inspector and see how it feels for you. For me it really helped with reading a table to downsize the font vs the body text. These tables are super content dense as well, and my secondary goal is to show more table contents to make it easier to scan the whole thing. |
@rohit2sharma95 summarized everything here: #30838 (comment) |
It just feels weird not having the tables responsive though. |
Oh sorry, oversight on my part. I'll revisit and update. |
e0c53d9
to
82bef4b
Compare
After we merge #31803, I can switch to responsive tables in this branch, assuming we no longer use raw HTML tables. |
82bef4b
to
2a308e3
Compare
@mdo I rebased this and switched to responsive tables too. Needs a thorough review just in case I missed something in the rebase (we should also check the whole docs again for more instances). Otherwise, I'd say we can proceed with this. EDIT: it seems we need to tweak the docs CSS for responsive tables to work properly. |
785d15a
to
8b864b2
Compare
4d356ef
to
296621c
Compare
8146d96
to
cd6776b
Compare
cd6776b
to
b620a1f
Compare
@ffoodd what's your take on this? Mostly the CSS stuff. I say we land this as is and we migrate any missing components later, otherwise we'll have this hanging forever. |
I think it needs some tweaks, e.g. the content table doesn't overflow properly and makes body overflow. Not sure what happens for now. |
f04a67a
to
d202523
Compare
Wasn't wrapped with Added some more, and wrapped these that use html customization inside. |
fac3f30
to
db44d9a
Compare
Co-Authored-By: XhmikosR <xhmikosr@gmail.com> Co-Authored-By: GeoSot <geo.sotis@gmail.com>
Updated this with some new copy changes to clean up |
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.
Nice work! This'll be really helpful 🚀
Let's land this and revisit any remaining instances later :) |
This PR revisits the options, methods, and events sections for each component's JS section. Builds off @rohit2sharma95's suggested changes for the dispose method and takes a more holistic approach to the sections.
bs-table
short code to add our.table-*
classes as neededI'm waiting on @Johann-S or someone else to tell me what happens with dispose before calling content final here, but wanted to open the PR for when we're ready.
TODO:
markdown
shortcode is still usedPreview: https://deploy-preview-31337--twbs-bootstrap.netlify.app/
Fixes #31189