Skip to content
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

Use of .bg-white class in docs makes theming difficult in v5 - replace with .bg-body #32810

Closed
silvinor opened this issue Jan 15, 2021 · 7 comments · Fixed by #32815
Closed

Comments

@silvinor
Copy link
Contributor

A few of the example files make use of the .bg-white class to define visual aspects of the examples. Using this makes theming tests problematic without modification either to the docs source, or defining theme colors unintuitively (e.g. .bg-white is black?)

Use of directly calling color classes should be discouraged - i.e for the examples, .bg-body should be used instead.

The following files make use of .bg-white:

  • site/content/docs/5.0/utilities/shadows.md
  • site/content/docs/5.0/examples/product/index.html
  • site/content/docs/5.0/examples/offcanvas/index.html
  • site/content/docs/5.0/examples/cover/index.html
  • site/content/docs/5.0/examples/pricing/index.html
  • site/content/docs/5.0/examples/cheatsheet/index.html
  • site/content/docs/5.0/examples/cheatsheet-rtl/index.html

Also, site/content/docs/5.0/utilities/colors.md file does not document the use of the .bg-body class ... it's missing.

@ffoodd
Copy link
Member

ffoodd commented Jan 15, 2021

@ErlendCat PR welcome 👌 Please read our contributing guidelines carefully before you start.

@mdo
Copy link
Member

mdo commented Jan 15, 2021

Would love a .bg-body class—great idea.

@silvinor
Copy link
Contributor Author

@mdo ... it's already there. Gets generated in _utilities.scss, line 474 (beta 1 code).
Just never been documented.

@mdo
Copy link
Member

mdo commented Jan 16, 2021

Hahaha, I'm the one that added it too lol. #29511

@silvinor
Copy link
Contributor Author

Created a pull request if you need one... #32815

@silvinor
Copy link
Contributor Author

PR #32815 generated

@ffoodd
Copy link
Member

ffoodd commented Jan 21, 2021

Issue will close automatically as soon as the PR gets merged.

@ffoodd ffoodd reopened this Jan 21, 2021
@ffoodd ffoodd added the has-pr label Jan 21, 2021
mdo pushed a commit that referenced this issue Jan 25, 2021
Response to issue #32810

Use of the .bg-white class to define visual aspects of the examples
would be unintuitive for theme builders to test themes on.
This replaces instances of .bg-white with .bg-body in the examples.

- Edited examples to replace use .bg-white class with .bg-body class
  - product
  - offcanvas
  - pricing
  - cheatsheet
  - cheatsheet-rtl
- Edited utilities colors.md & shadows.md to include .bg-body class
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants